Next

.clangd

@@ -0,0 +1,2 @@
+Diagnostics:
+  Suppress: 'pp_including_mainfile_in_preamble'

.eslintrc

@@ -1,9 +1,9 @@
 {
   "parserOptions": {
-    "ecmaVersion": 2020
+    "ecmaVersion": "latest",
+    "sourceType": "module"
   },
   "env": {
     "es6": true
-  },
-  "sourceType": "module"
+  }
 }

README.md

@@ -21,40 +21,54 @@ The `Socket runtime CLI` outputs hybrid native-web apps that combine your code w
 
 ### Compatibility Matrix
 
+Socket Supports both ESM and CommonJS
+
 > [!NOTE]
-> Socket supports many of the Node.js APIs. It is **NOT** a drop in replacement for Node.js, nor will it ever be since socket is for building software and node.js is for building servers. Below is a high level overview of partially supported APIs and modules.
-
-| Module            | Node.js    | Socket    |
-| ----------------- | ---------- | --------- |
-| assert            | ✔︎          | ⏱         |
-| async/await       | ✔︎          | ✔︎         |
-| buffer            | ✔︎          | ✔︎️         |
-| child_process     | ✔︎          | ✔︎️  \*     |
-| console           | ✔︎          | ✔︎         |
-| crypto            | ✔︎          | ✔︎  \*     |
-| dgram             | ✔︎          | ✔︎️         |
-| dns               | ✔︎          | ✔︎️         |
-| os                | ✔︎          | ✔︎️         |
-| encoding          | ✔︎          | ✔︎         |
-| events            | ✔︎          | ✔︎         |
-| fetch             | ✔︎          | ✔︎         |
-| fs/promises       | ✔︎          | ✔︎         |
-| fs                | ✔︎          | ✔︎         |
-| path              | ✔︎          | ✔︎         |
-| process           | ✔︎          | ✔︎         |
-| streams           | ✔︎          | ✔︎         |
-| string_decoder    | ✔︎          | ⏱         |
-| test              | ✔︎          | ✔︎️         |
-| timers            | ✔︎          | ⏱         |
-| uuid              | ✔︎          | ⏱         |
-| vm                | ✔︎          | ✔︎         |
-| ESM               | ✔︎          | ✔︎         |
-| CJS               | ✔︎          | ✔︎         |
-| URL               | ✔︎          | ✔︎         |
-
-_⏱ = planned support_
-_\* = Supported but Works differently; may be refactored to match the nodejs API_
-_\*\* = Use fetch instead_
+> Socket supports many of the Node.js APIs. It is **NOT** a drop in replacement for Node.js, it most likely wont ever be since Socket is for building software and node.js is for building servers. Below is a high level overview of fully or partially supported APIs and modules.
+
+| Module              | Node.js       | Socket   |
+| -----------------   | ----------    | -------- |
+| assert              | √             | ⏱        |
+| async_hooks         | √             | √        |
+| buffer              | √             | √        |
+| child_process       | √             | √        |
+| cluster             | √             | §        |
+| console             | √             | √        |
+| crypto              | √             | √ \*     |
+| dgram (udp)         | √             | √        |
+| diagnostics_channel | √             | √        |
+| dns                 | √             | √        |
+| encoding            | √             | √        |
+| events              | √             | √        |
+| fetch               | √             | √        |
+| fs                  | √             | √        |
+| fs/promises         | √             | √        |
+| http                | √             | √        |
+| http2               | √             | √        |
+| https               | √             | √        |
+| inspector           | √             | ⏱        |
+| module              | √             | √        |
+| net                 | √             | ⏱        |
+| os                  | √             | √        |
+| path                | √             | √        |
+| process             | √             | √        |
+| streams             | √             | √        |
+| string_decoder      | √             | √        |
+| test                | √             | √        |
+| timers              | √             | √        |
+| tls                 | √             | ⏱        |
+| tty                 | √             | √        |
+| URL                 | √             | √        |
+| uuid                | √             | ⏱ ☀︎      |
+| vm                  | √             | √        |
+| worker_threads      | √             | √        |
+
+| Symbol | Meaning                                                                     |
+| :----: | :-------------------------------------------------------------------------- |
+| ⏱      | Planned support                                                             |
+| §      | Not Relevant or not necessary since socket doesn't require high-concurrency |
+| \*     | Supported but Works differently; may be refactored to match the nodejs API  |
+| ☀︎      | Use `crypto.randomUUID()` instead                                           |
 
 
 ### FAQ
@@ -67,14 +81,36 @@ Check the FAQs on our [Website](https://socketsupply.co/guides/#faq) to learn mo
 `Create Socket App` is similar to React's `Create React App`, we provide a few basic boilerplates and some strong opinions so you can get coding on a production-quality app as quickly as possible.  
 Please check [create-socket-app Repo](https://github.com/socketsupply/create-socket-app) to get started and to learn more.  
 You can also check our `Examples` in the [Examples Repo](https://github.com/socketsupply/socket-examples).  
-
+§§§
 
 ### Documentation
 
 The full documentation can be found on the [Socket Runtime](https://socketsupply.co/) website.  
 The `Socket Runtime` documentation covers Socket APIs, includes examples, multiple guides (`Apple`, `Desktop`, and `Mobile`), `P2P` documentation, and more.
 
 
+### Development
+
+If you are developing socket, and you want your apps to point to your dev branch.
+
+
+#### Step 1
+
+```bash
+cd ~/projects/socket            # navigate into the location where you cloned this repo
+./bin/uninstall.sh              # remove existing installation
+npm rm -g @socketsupply/socket  # remove any global links or prior global npm installs
+npm run relink                  # this will call `./bin/publish-npm-modules.sh --link` (accepts NO_ANDROID=1, NO_IOS=1, and DEBUG=1)
+```
+
+#### Step 2
+
+```bash
+cd ~/projects/<myapp>           # navigate into your project (replacing <myapp> with whatever it's actually called
+npm link @socketsupply/socket   # link socket and you'll be ready to go.
+```
+
+
 ### Testing
 
 `Socket` provides a built-in `test runner` similar to `node:test` which outputs the test results in [TAP](https://testanything.org/) format.

VERSION.txt

@@ -1 +1 @@
-0.5.4
+0.6.0-next

api/CONFIG.md

@@ -1,14 +1,16 @@
 <!-- This file is generated by bin/docs-generator/config.js -->
 <!-- Do not edit this file directly. -->
 
-# Configuration basics
+# Configuration
+## Overview
 
-The configuration file is a simple INI `socket.ini` file in the root of the project.
-The file is read on startup and the values are used to configure the project.
-Sometimes it's useful to overide the values in `socket.ini` or keep some of the values local (e.g. `[ios] simulator_device`)
-or secret (e.g. `[ios] codesign_identity`, `[ios] provisioning_profile`, etc.)
-This can be done by creating a file called `.sscrc` in the root of the project.
-It is possible to override both Command Line Interface (CLI) and Configuration File (INI) options.
+
+The configuration file is an INI file (`socket.ini`) in the root of every Socket runtime project.
+The file is read at compile time. Sometimes it's useful to overide its values or keep some of the
+values locally, only on your computer (e.g. `[ios] simulator_device`) or secrets 
+(e.g. `[ios] codesign_identity`, `[ios] provisioning_profile`, etc.); this can be done by
+creating a file called `.sscrc` in the root of the project. It is possible to override both
+Command Line Interface (CLI) and Configuration File (INI) options.
 
 Example:
 
@@ -33,7 +35,7 @@ platform = ios ; override the `ssc build --platform` CLI option
 [settings.ios] ; override the `[ios]` section in `socket.ini`
 
 codesign_identity = "iPhone Developer: John Doe (XXXXXXXXXX)"
-distribution_method = "ad-hoc"
+distribution_method = "release-testing"
 provisioning_profile = "johndoe.mobileprovision"
 simulator_device = "iPhone 15"
 ```
@@ -45,7 +47,7 @@ simulator_device = "iPhone 15"
     Use the full path instead.
 </tonic-toaster-inline>
 
-# `build`
+### `build`
 
 Key | Default Value | Description
 :--- | :--- | :---
@@ -58,39 +60,49 @@ name |  |  The name of the program and executable to be output. Can't contain sp
 output | "build" |  The binary output path. It's recommended to add this path to .gitignore.
 script |  |  The build script. It runs before the `[build] copy` phase.
 
-# `build.script`
+### `build.script`
 
 Key | Default Value | Description
 :--- | :--- | :---
 forward_arguments | false |  If true, it will pass build arguments to the build script. WARNING: this could be deprecated in the future.
 
-# `build.watch`
+### `build.watch`
 
 Key | Default Value | Description
 :--- | :--- | :---
 sources[] |  |  Configure your project to watch for sources that could change when running `ssc`. Could be a string or an array of strings
 
-# `webview`
+### `webview`
 
 Key | Default Value | Description
 :--- | :--- | :---
-headers[] | "" | 
+root | "/" |  Make root open index.html
+default_index | "" |  Set default 'index.html' path to open for implicit routes
+watch | false |  Tell the webview to watch for changes in its resources
+headers[] | "" |  Custom headers injected on all webview routes
 
-# `webview.watch`
+### `webview.watch`
 
 Key | Default Value | Description
 :--- | :--- | :---
 reload | true |  Configure webview to reload when a file changes
+service_worker_reload_timeout | 500 |  Timeout in milliseconds to wait for service worker to reload before reloading webview
 
-# `webview.navigator.mounts`
+### `webview.navigator.mounts`
 
 Key | Default Value | Description
 :--- | :--- | :---
 $HOST_HOME/directory-in-home-folder/ |  | 
 $HOST_CONTAINER/directory-app-container/ |  | 
 $HOST_PROCESS_WORKING_DIRECTORY/directory-in-app-process-working-directory/ |  | 
 
-# `permissions`
+### `webview.navigator.policies`
+
+Key | Default Value | Description
+:--- | :--- | :---
+allowed[] |  | 
+
+### `permissions`
 
 Key | Default Value | Description
 :--- | :--- | :---
@@ -107,13 +119,13 @@ allow_data_access | true |  Allow/Disallow data access in application
 allow_airplay | true |  Allow/Disallow AirPlay access in application (macOS/iOS) only
 allow_hotkeys | true |  Allow/Disallow HotKey binding registration (desktop only)
 
-# `debug`
+### `debug`
 
 Key | Default Value | Description
 :--- | :--- | :---
 flags |  |  Advanced Compiler Settings for debug purposes (ie C++ compiler -g, etc).
 
-# `meta`
+### `meta`
 
 Key | Default Value | Description
 :--- | :--- | :---
@@ -128,11 +140,10 @@ title |  |  The title of the app used in metadata files. This is NOT a window ti
 type | "" |  Builds an extension when set to "extension".
 version |  |  A string that indicates the version of the application. It should be a semver triple like 1.2.3. Defaults to 1.0.0.
 
-# `android`
+### `android`
 
 Key | Default Value | Description
 :--- | :--- | :---
-icon |  |  The icon to use for identifying your app on Android.
 aapt_no_compress |  |  Extensions of files that will not be stored compressed in the APK.
 enable_standard_ndk_build |  |  Enables gradle based ndk build rather than using external native build (standard ndk is the old slow way)
 main_activity |  |  Name of the MainActivity class. Could be overwritten by custom native code.
@@ -142,85 +153,99 @@ native_cflags |  |  Used for adding custom source files and related compiler att
 native_sources |  | 
 native_makefile |  | 
 sources |  | 
+icon |  |  The icon to use for identifying your app on Android.
+icon_sizes |  |  The various sizes and scales of the icons to create, required minimum are listed by default.
 
-# `ios`
+### `ios`
 
 Key | Default Value | Description
 :--- | :--- | :---
 codesign_identity |  |  signing guide: https://socketsupply.co/guides/#ios-1
-distribution_method |  |  Describes how Xcode should export the archive. Available options: app-store, package, ad-hoc, enterprise, development, and developer-id.
+distribution_method |  |  Describes how Xcode should export the archive. Available options: app-store, package, release-testing, enterprise, development, and developer-id.
 provisioning_profile |  |  A path to the provisioning profile used for signing iOS app.
 simulator_device |  |  which device to target when building for the simulator.
 nonexempt_encryption | false |  Indicate to Apple if you are using encryption that is not exempt.
+icon |  |  The icon to use for identifying your app on iOS.
+icon_sizes |  |  The various sizes and scales of the icons to create, required minimum are listed by default.
 
-# `linux`
+### `linux`
 
 Key | Default Value | Description
 :--- | :--- | :---
 categories |  |  Helps to make your app searchable in Linux desktop environments.
 cmd |  |  The command to execute to spawn the "back-end" process.
 icon |  |  The icon to use for identifying your app in Linux desktop environments.
+icon_sizes |  |  The various sizes and scales of the icons to create, required minimum are listed by default.
 
-# `mac`
+### `mac`
 
 Key | Default Value | Description
 :--- | :--- | :---
 category |  |  A category in the App Store
 cmd |  |  The command to execute to spawn the "back-end" process.
-icon |  |  The icon to use for identifying your app on MacOS.
 codesign_identity |  |  TODO Signing guide: https://socketsupply.co/guides/#code-signing-certificates
 codesign_paths |  |  Additional paths to codesign
 minimum_supported_version | "13.0.0" |  Minimum supported MacOS version
+window_control_offsets |  |  If titlebar_style is "hiddenInset", this will determine the x and y offsets of the window controls (traffic lights).
+icon |  |  The icon to use for identifying your app on MacOS.
+icon_sizes |  |  The various sizes and scales of the icons to create, required minimum are listed by default.
 
-# `native`
+### `native`
 
 Key | Default Value | Description
 :--- | :--- | :---
 files |  |  Files that should be added to the compile step.
 headers |  |  Extra Headers
 
-# `win`
+### `win`
 
 Key | Default Value | Description
 :--- | :--- | :---
 cmd |  |  The command to execute to spawn the “back-end” process.
-icon |  |  The icon to use for identifying your app on Windows.
 logo |  |  The icon to use for identifying your app on Windows, relative to copied path resources
 pfx |  |  A relative path to the pfx file used for signing.
+icon |  |  The signing information needed by the appx api. The icon to use for identifying your app on Windows.
+icon_sizes |  |  The various sizes and scales of the icons to create, required minimum are listed by default.
 
-# `window`
+### `window`
 
 Key | Default Value | Description
 :--- | :--- | :---
 height |  |  The initial height of the first window in pixels or as a percentage of the screen.
 width |  |  The initial width of the first window in pixels or as a percentage of the screen.
+backgroundColorDark | "" |  The initial color of the window in dark mode. If not provided, matches the current theme.
+backgroundColorLight | "" |  The initial color of the window in light mode. If not provided, matches the current theme.
+titlebar_style | "" |  Determine if the titlebar style (hidden, hiddenInset)
 max_height | 100% |  Maximum height of the window in pixels or as a percentage of the screen.
 max_width | 100% |  Maximum width of the window in pixels or as a percentage of the screen.
 min_height | 0 |  Minimum height of the window in pixels or as a percentage of the screen.
 min_width | 0 |  Minimum width of the window in pixels or as a percentage of the screen.
-resizable | true |  If the window is resizable or not.
-frameless | false |  If the window has a title bar or not.
-utility | false |  If the window is utility window or not.
+frameless | false |  Determines if the window has a title bar and border.
+resizable | true |  Determines if the window is resizable.
+maximizable | true |  Determines if the window is maximizable.
+minimizable | true |  Determines if the window is minimizable.
+closable | true |  Determines if the window is closable.
+utility | false |  Determines the window is utility window.
 
-# `window.alert`
+### `window.alert`
 
 Key | Default Value | Description
 :--- | :--- | :---
 title |  |  The title that appears in the 'alert', 'prompt', and 'confirm' dialogs. If this value is not present, then the application title is used instead. Currently only supported on iOS/macOS. defalut value = ""
 
-# `application`
+### `application`
 
 Key | Default Value | Description
 :--- | :--- | :---
 agent | false |  If agent is set to true, the app will not display in the tab/window switcher or dock/task-bar etc. Useful if you are building a tray-only app.
 
-# `tray`
+### `tray`
 
 Key | Default Value | Description
 :--- | :--- | :---
 icon |  |  The icon to be displayed in the operating system tray. On Windows, you may need to use ICO format. defalut value = ""
 
-# `headless`
+### `headless`
 
 Key | Default Value | Description
 :--- | :--- | :---