@ecmaos/kernel 0.2.3 → 0.2.5

package/README.md

@@ -63,10 +63,12 @@ The goal is to create a kernel and supporting apps that tie together modern web
 
 - `Apps`
   - These are full applications that are developed specifically to work with ecmaOS
+  - Refer to the full list of [official published apps on npm](https://www.npmjs.com/org/ecmaos-apps)
+  - See the [./APPS.md](./APPS.md) file for a list of community apps; submit a PR to add your app!
   - An app is an npm package, in which the bin file has a shebang line of `#!ecmaos:bin:app:myappname`
   - Its default export (or exported `main` function) will be called with the `ProcessEntryParams` object
-  - They can be installed from the terminal using the `install` command, e.g. `# install @ecmaos-apps/boilerplate`
-  - Run the installed app: `# /usr/bin/boilerplate arg1 arg2` *(absolute path not required)*
+  - They can be installed from the terminal using the `install` command, e.g. `# install @ecmaos-apps/code`
+  - Run the installed app (bins are linked to `/usr/bin`): `# code /root/hello.js`
   - During development, it can be useful to run a [Verdaccio](https://github.com/verdaccio/verdaccio) server to test local packages
   - To publish to Verdaccio, run `# npm publish --registry http://localhost:4873` in your app's development environment
   - Then to install from your local registry, run `# install @myscope/mypackage --registry http://localhost:4873`
@@ -86,58 +88,74 @@ The goal is to create a kernel and supporting apps that tie together modern web
   - Some builtin commands that exist now will be moved into separate apps over time
 
 - `Devices`
+  - Refer to the full list of [official devices on npm](https://www.npmjs.com/org/ecmaos-devices)
+  - See the [./DEVICES.md](./DEVICES.md) file for a list of community devices; submit a PR to add your device!
   - Devices get loaded on boot, e.g. `/dev/bluetooth`, `/dev/random`, `/dev/battery`, etc.
   - A device can support being "run" by a user, e.g. `# /dev/battery status`
   - Devices may also be directly read/written using `fs` methods, and will behave accordingly (or have no effect if not supported)
   - An individual device module can provide multiple device drivers, e.g. `/dev/usb` provides `/dev/usb-mydevice-0001-0002`
 
+- `Generators`
+  - Generators are used to scaffold new apps, devices, modules, etc.
+  - They are located in the `turbo/generators` directory of the repository
+  - They are used by the `turbo gen` command, e.g. `turbo gen app`, `turbo gen device`, `turbo gen module`, etc.
+
 - `Jaffa`
   - Jaffa is a [Tauri](https://tauri.app) wrapper for the ecmaOS kernel
   - It's used to tie the kernel into a desktop or mobile environment, allowing for native functionality
 
 - `Kernel`
-  - Authentication (WebAuthn)
-  - Components (Web Components/Custom Elements)
-  - Devices
-  - DOM
-  - Events (CustomEvents)
-  - Filesystem (ZenFS)
-  - Internationalization (i18next)
-  - Interval Manager (setInterval)
-  - Log Manager (tslog)
-  - Memory Manager (Abstractions)
-  - Process Manager
-  - Protocol Handlers (web+ecmaos://...)
-  - Service Worker Manager
-  - Shell
-  - Storage (IndexedDB, localStorage, sessionStorage, etc.)
-  - Terminal (xterm.js)
-  - User Manager
-  - WASM Loader
-  - Window Manager (WinBox)
-  - Workers (Web Workers)
+  - The kernel ties together the various components of the system into a cohesive whole
+    - Authentication (WebAuthn)
+    - Components (Web Components/Custom Elements)
+    - Devices
+    - DOM
+    - Events (CustomEvents)
+    - Filesystem (ZenFS)
+    - Internationalization (i18next)
+    - Interval Manager (setInterval)
+    - Log Manager (tslog)
+    - Memory Manager (Abstractions)
+    - Process Manager
+    - Protocol Handlers (web+ecmaos://...)
+    - Service Worker Manager
+    - Shell
+    - Storage (IndexedDB, localStorage, sessionStorage, etc.)
+    - Terminal (xterm.js)
+    - User Manager
+    - WASM Loader
+    - Window Manager (WinBox)
+    - Workers (Web Workers)
 
 - `Metal`
   - Metal is an API server for allowing connections to physical systems from ecmaOS using [Hono](https://hono.dev)
   - Authenticated and encrypted connections with JWK/JWE/JOSE
 
 - `Modules`
+  - Refer to the full list of [official modules on npm](https://www.npmjs.com/org/ecmaos-modules)
+  - See the [./MODULES.md](./MODULES.md) file for a list of community modules; submit a PR to add your module!
   - Modules are dynamically loaded into the kernel at boot and can be enabled or disabled
+  - They are specified during build via the `VITE_KERNEL_MODULES` environment variable
+    - e.g. `VITE_KERNEL_MODULES=@ecmaos-modules/boilerplate@0.1.2,@your/package@1.2.3`
+  - Versions must be exact and are mandatory - you cannot use NPM version specifiers
   - They can provide additional functionality, devices, commands, etc.
   - They offer a [common interface](./core/types/modules.ts) for interacting with the kernel
   - Generally they should be written in [AssemblyScript](https://www.assemblyscript.org), but this isn't required
 
 - `Packages`
-  - Packages are [npm packages](https://www.npmjs.com) that are installed into the ecmaOS environment
+  - Packages are [NPM packages](https://www.npmjs.com) that are installed into the ecmaOS environment
   - They can be installed from the terminal using the `install` command, e.g. `# install jquery`
   - NPM version specifiers are supported, e.g.:
     - `# install jquery@3.7.1`
     - `# install jquery@^3.7.1`
     - `# install jquery@latest`
-  - [JSR](https://jsr.io) support is coming soon
+  - [JSR](https://jsr.io) may be used with the [NPM compatibility layer](https://jsr.io/docs/npm-compatibility):
+    - `# install @jsr/defaude__hello-jsr --registry https://npm.jsr.io`
 
 - `SWAPI`
   - The SWAPI is an API server running completely inside a service worker using [Hono](https://hono.dev)
+  - It allows for various operations including the `fs` route to fetch files via URL
+  - e.g., `# fetch /swapi/fs/home/user/hello.txt`
   - e.g., `# fetch /swapi/fake/person/fullName`
 
 - `Utils`
@@ -159,8 +177,10 @@ edit hello.txt
 env hello --set world ; env
 fetch https://ipecho.net/plain > /tmp/myip.txt
 fetch /xkcd-os.sixel # xterm.js includes sixel support
+fetch /swapi/fs/home/user/hello.txt # fetch a file from the filesystem
 fetch /swapi/fake/person/fullName # fetch a random person from the SWAPI
 install jquery
+install @ecmaos-apps/boilerplate
 ls /dev
 mkdir /tmp/zip ; cd /tmp/zip
 upload
@@ -207,6 +227,22 @@ cat /dev/zero --bytes 10 > /dev/null
 
 Note: many device implementations are incomplete, but provide a solid starting point
 
+## Code Execution Example
+
+```sh
+echo "window.alert('Hello, world!')" > /root/hello.js
+load /root/hello.js
+```
+
+## App Development
+
+The `apps` directory in the repository contains a number of examples of how to develop apps, but there are many approaches you could take.
+
+- `@ecmaos-apps/boilerplate`: A minimal boilerplate app for developing new apps
+- `@ecmaos-apps/code`: A simple code editor app using [Monaco](https://microsoft.github.io/monaco-editor/); serves as a good reference for more complex apps
+
+Basically, your app's [bin](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin) file has a `main` (or default) function export that is passed the kernel reference and can use it to interact with the system as needed. A shebang line of `#!ecmaos:bin:app:myappname` is required at the top of the bin file to identify it as an app.
+
 ## Early Days
 
 The kernel is currently in active development. It is not considered stable and the structure and API are very likely to change in unexpected and possibly unannounced ways until version 1.0.0. Use cautiously and at your own risk.

package/dist/.vite/manifest.json

@@ -1,18 +1,18 @@
 {
-  "_browser-jvtvvRnm.js": {
-    "file": "browser-jvtvvRnm.js",
+  "_browser-C0q0NWWv.js": {
+    "file": "browser-C0q0NWWv.js",
     "name": "browser",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-D1k8eaRb.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
-  "_empty-D1k8eaRb.js": {
-    "file": "empty-D1k8eaRb.js",
+  "_empty-BMkCc_7L.js": {
+    "file": "empty-BMkCc_7L.js",
     "name": "empty",
     "dynamicImports": [
-      "_topbar.min-qHiqBD75.js",
-      "_browser-jvtvvRnm.js",
+      "_topbar.min-xBbuiIjv.js",
+      "_browser-C0q0NWWv.js",
       "src/tree/lib/commands/install.ts",
       "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js"
     ]
@@ -21,12 +21,12 @@
     "file": "kernel.css",
     "src": "_kernel.css"
   },
-  "_topbar.min-qHiqBD75.js": {
-    "file": "topbar.min-qHiqBD75.js",
+  "_topbar.min-xBbuiIjv.js": {
+    "file": "topbar.min-xBbuiIjv.js",
     "name": "topbar.min",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-D1k8eaRb.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js": {
@@ -41,16 +41,16 @@
     "src": "src/tree/kernel.ts",
     "isEntry": true,
     "imports": [
-      "_empty-D1k8eaRb.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "src/tree/lib/commands/install.ts": {
-    "file": "install-DvXm00-p.js",
+    "file": "install-C64fBUI2.js",
     "name": "install",
     "src": "src/tree/lib/commands/install.ts",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-D1k8eaRb.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "src/ui.ts": {
@@ -59,7 +59,7 @@
     "src": "src/ui.ts",
     "isEntry": true,
     "imports": [
-      "_empty-D1k8eaRb.js"
+      "_empty-BMkCc_7L.js"
     ]
   }
 }

package/dist/{browser-jvtvvRnm.js → browser-C0q0NWWv.js}

@@ -1,4 +1,4 @@
-import { g as getDefaultExportFromCjs } from "./empty-D1k8eaRb.js";
+import { g as getDefaultExportFromCjs } from "./empty-BMkCc_7L.js";
 var browser$2;
 var hasRequiredBrowser;
 function requireBrowser() {
@@ -20,4 +20,4 @@ const browser$1 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePro
 export {
   browser$1 as b
 };
-//# sourceMappingURL=browser-jvtvvRnm.js.map
+//# sourceMappingURL=browser-C0q0NWWv.js.map

package/dist/{browser-jvtvvRnm.js.map → browser-C0q0NWWv.js.map}

@@ -1 +1 @@
-{"version":3,"file":"browser-jvtvvRnm.js","sources":["../node_modules/.pnpm/ws@8.18.0/node_modules/ws/browser.js"],"sourcesContent":["'use strict';\n\nmodule.exports = function () {\n  throw new Error(\n    'ws does not work in the browser. Browser clients must use the native ' +\n      'WebSocket object'\n  );\n};\n"],"names":["browser"],"mappings":";;;;;;AAEAA,cAAiB,WAAY;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IAED;AAAA,EACF;;;;;;;;;","x_google_ignoreList":[0]}
+{"version":3,"file":"browser-C0q0NWWv.js","sources":["../node_modules/.pnpm/ws@8.18.0/node_modules/ws/browser.js"],"sourcesContent":["'use strict';\n\nmodule.exports = function () {\n  throw new Error(\n    'ws does not work in the browser. Browser clients must use the native ' +\n      'WebSocket object'\n  );\n};\n"],"names":["browser"],"mappings":";;;;;;AAEAA,cAAiB,WAAY;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IAED;AAAA,EACF;;;;;;;;;","x_google_ignoreList":[0]}