@jay-framework/secure 0.5.0

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@jay-framework/secure",
+  "version": "0.5.0",
+  "type": "module",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "scripts": {
+    "build": "npm run build:js && npm run build:types",
+    "build:watch": "npm run build:cli-link && npm run build:js -- --watch",
+    "build:js": "vite build",
+    "build:types": "tsup lib/index.ts --dts-only --format esm",
+    "build:check-types": "tsc",
+    "clean": "rimraf dist",
+    "confirm": "npm run clean && npm run build && npm run build:check-types && npm run test && npm run definitions && npm run runtime",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "definitions": "run-p --continue-on-error --aggregate-output --print-label 'definitions:*'",
+    "runtime": "run-p --continue-on-error --aggregate-output --print-label 'runtime:*'",
+    "definitions:basic": "jay-cli definitions ./test/basic/regular",
+    "runtime:basic": "jay-cli runtime ./test/basic/regular",
+    "definitions:comp-in-comp": "jay-cli definitions test/comp-in-comp/regular",
+    "runtime:comp-in-comp": "jay-cli runtime test/comp-in-comp/regular",
+    "definitions:events-basic": "jay-cli definitions test/events-basic/regular",
+    "runtime:events-basic": "jay-cli runtime test/events-basic/regular",
+    "definitions:events-synthetic": "jay-cli definitions test/events-synthetic/regular",
+    "runtime:events-synthetic": "jay-cli runtime test/events-synthetic/regular",
+    "definitions:exec-synthetic": "jay-cli definitions test/exec-synthetic/regular",
+    "runtime:exec-synthetic": "jay-cli runtime test/exec-synthetic/regular",
+    "definitions:tree": "jay-cli definitions test/tree/regular",
+    "runtime:tree": "jay-cli runtime test/tree/regular",
+    "definitions:top-level-collection-conditions": "jay-cli definitions test/top-level-collection-conditions/regular",
+    "runtime:top-level-collection-conditions": "jay-cli runtime test/top-level-collection-conditions/regular"
+  },
+  "dependencies": {
+    "@jay-framework/component": "workspace:^",
+    "@jay-framework/json-patch": "workspace:^",
+    "@jay-framework/reactive": "workspace:^",
+    "@jay-framework/runtime": "workspace:^",
+    "@jay-framework/serialization": "workspace:^"
+  },
+  "devDependencies": {
+    "@jay-framework/dev-environment": "workspace:^",
+    "@testing-library/jest-dom": "^6.2.0",
+    "@types/node": "^20.11.5",
+    "caniuse-lite": "^1.0.30001579",
+    "npm-run-all2": "^6.1.1",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.11",
+    "vitest": "^1.2.1"
+  }
+}

package/readme.md

@@ -0,0 +1,51 @@
+# Jay Secure
+
+> EXPERIMENTAL - THE JAY-SECURE MODULE IS NOT HARDENED YET TO BE USED FOR SECURITY.
+
+The Jay Secure library is the runtime library supporting the sandbox feature of Jay - running headless Jay Components
+in a sandbox, while running the heads, the Jay Element on the main thread.
+
+The Jay Secure library includes a few runtime utilities and functions supporting the application split of main and sandbox.
+
+> In Jay, we denote main or trusted as the main window, and sandbox or worker as the worker environment.
+
+## comm channel
+
+A messaging based protocol between the main and sandbox environments, allowing for an efficient communication.
+The comm channel will batch multiple messages into a single `postMessage` browser call.
+
+When creating applications that require sandbox, the setup of the comm channel on the main side is
+
+```typescript
+const jayWorker = new Worker(new URL('jay-sandbox:./sandbox-root', import.meta.url), {
+  type: 'module',
+});
+
+window.onload = function () {
+  setMainPort(new JayPort(new HandshakeMessageJayChannel(jayWorker)));
+  // ... setup the application
+};
+```
+
+and on the sandbox or worker side as
+
+```typescript
+// import the application root jay-html file
+setWorkerPort(new JayPort(new HandshakeMessageJayChannel(this)));
+```
+
+See the [examples](../../../examples) for a complete setup.
+
+## main and sandbox
+
+The library includes various implementations of component bridges, element bridges, element creation functions and other
+utilities needed for the security module runtime.
+
+## Additional information
+
+See the following design log for explanation of the design process and "how it works":
+
+- [02 - Jay Element vs Component.md](../../../design-log/02%20-%20Jay%20Element%20vs%20Component.md)
+- [09 - Safe events.md](../../../design-log/09%20-%20Safe%20events.md)
+- [29 - algorithm to split safe code.md](../../../design-log/29%20-%20algorithm%20to%20split%20safe%20code.md)
+- [17 - main and sandbox secure contexts.md](../../../design-log/17%20-%20main%20and%20sandbox%20secure%20contexts.md)