arcane-os 0.1.0-dev.5

package/runtime/strong-type/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "strong-type",
+  "version": "1.1.0",
+  "type": "module",
+  "description": "allows easy type enforcement for all JS types objects and classes. it is also extensible and provides simple to use type checks for your own custom classes and types",
+  "main": "index.js",
+  "directories": {
+    "example": "example"
+  },
+  "engines": {
+    "node": ">=12.21.0"
+  },
+  "scripts": {
+    "test": "npm i && c8 -r lcov -r html node test/CI.js && c8 report && node ./lcov.js",
+    "start": "npm run emulate && node-http-server port=8000 verbose=true",
+    "emulate": "npm i && copyfiles -V \"./!(node_modules)/*\" \"./**!(node_modules)\"  \"./example/node_modules/strong-type/\" && copyfiles -V \"./node_modules/**/*\" \"./example/\" && copyfiles -V \"./!(node_modules)/*\" \"./**!(node_modules)\"",
+    "nodeExample": "node ./example/node/typecheck.js",
+    "coverage": "echo 'See your coverage report at http://localhost:8080' && node-http-server port=8080 root=./coverage/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RIAEvangelist/strong-type.git"
+  },
+  "keywords": [
+    "strong",
+    "type",
+    "validation",
+    "validate",
+    "check",
+    "checking"
+  ],
+  "author": "Brandon Nozaki Miller",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/RIAEvangelist/strong-type/issues"
+  },
+  "homepage": "https://github.com/RIAEvangelist/strong-type#readme",
+  "devDependencies": {
+    "c8": "^7.6.0",
+    "copyfiles": "*",
+    "lcov2badge": "^0.1.2",
+    "node-http-server": "^8.1.3",
+    "vanilla-test": "*"
+  }
+}

package/schemas/arcane-app-bundle.schema.json

@@ -0,0 +1,125 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/TheWizardNexus/arcane-os-sdk/schemas/arcane-app-bundle.schema.json",
+  "title": "Arcane external application release bundle",
+  "description": "Deterministic USTAR+gzip envelope binding one authored schema-2 descriptor to one verified Arcane browser release.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "kind",
+    "format",
+    "sdk",
+    "app",
+    "descriptor",
+    "release",
+    "payload"
+  ],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "kind": { "const": "arcane-app-release-bundle" },
+    "format": { "const": "ustar+gzip" },
+    "sdk": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "version"],
+      "properties": {
+        "name": { "const": "arcane-os" },
+        "version": { "$ref": "#/$defs/semver" }
+      }
+    },
+    "app": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version"],
+      "properties": {
+        "id": { "$ref": "#/$defs/appId" },
+        "version": { "$ref": "#/$defs/semver" }
+      }
+    },
+    "descriptor": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "schemaVersion",
+        "canonicalSha256",
+        "packageSha256",
+        "fileSha256",
+        "bytes"
+      ],
+      "properties": {
+        "path": { "const": "arcane-app.json" },
+        "schemaVersion": { "const": 2 },
+        "canonicalSha256": { "$ref": "#/$defs/sha256" },
+        "packageSha256": { "$ref": "#/$defs/sha256" },
+        "fileSha256": { "$ref": "#/$defs/sha256" },
+        "bytes": { "type": "integer", "minimum": 1, "maximum": 4194304 }
+      }
+    },
+    "release": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "schemaVersion",
+        "builder",
+        "policySha256",
+        "manifestSha256",
+        "contentSha256",
+        "fileCount",
+        "totalBytes"
+      ],
+      "properties": {
+        "path": { "const": "payload/ARCANE_APP_RELEASE.json" },
+        "schemaVersion": { "const": 1 },
+        "builder": { "const": "arcane-app-packager-v1" },
+        "policySha256": { "$ref": "#/$defs/sha256" },
+        "manifestSha256": { "$ref": "#/$defs/sha256" },
+        "contentSha256": { "$ref": "#/$defs/sha256" },
+        "fileCount": { "type": "integer", "minimum": 1, "maximum": 16381 },
+        "totalBytes": { "type": "integer", "minimum": 1, "maximum": 1073741824 }
+      }
+    },
+    "payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["root", "fileCount", "totalBytes", "files"],
+      "properties": {
+        "root": { "const": "payload" },
+        "fileCount": { "type": "integer", "minimum": 1, "maximum": 16381 },
+        "totalBytes": { "type": "integer", "minimum": 1, "maximum": 1073741824 },
+        "files": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 16381,
+          "items": { "$ref": "#/$defs/file" }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "appId": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" },
+    "semver": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
+    },
+    "sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^(?!.*\\\\)(?!.*:)(?!.*[<>\"|?*])(?!.*(?:^|/)(?:\\.{1,2}|(?:[Cc][Oo][Nn]|[Pp][Rr][Nn]|[Aa][Uu][Xx]|[Nn][Uu][Ll]|[Cc][Ll][Oo][Cc][Kk]\\$|[Cc][Oo][Nn][Ii][Nn]\\$|[Cc][Oo][Nn][Oo][Uu][Tt]\\$|[Cc][Oo][Mm][1-9¹²³]|[Ll][Pp][Tt][1-9¹²³])(?:\\.[^/]*)?)(?:/|$))(?!.*[. ](?:/|$))[^/\\u0000-\\u001f\\u007f]+(?:/[^/\\u0000-\\u001f\\u007f]+)*$"
+    },
+    "file": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "bytes", "sha256"],
+      "properties": {
+        "path": { "$ref": "#/$defs/relativePath" },
+        "bytes": { "type": "integer", "minimum": 0, "maximum": 536870912 },
+        "sha256": { "$ref": "#/$defs/sha256" }
+      }
+    }
+  }
+}

package/schemas/arcane-app.schema.json

@@ -0,0 +1,329 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/TheWizardNexus/arcane-os-sdk/schemas/arcane-app.schema.json",
+  "title": "Arcane application descriptor",
+  "description": "Canonical application-owned descriptor projected into browser packaging and native Arcane admission inputs.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "id",
+    "displayName",
+    "description",
+    "version",
+    "publisher",
+    "package",
+    "permissions",
+    "security",
+    "native",
+    "requirements",
+    "targets"
+  ],
+  "properties": {
+    "schemaVersion": { "const": 2 },
+    "id": { "$ref": "#/$defs/appId" },
+    "displayName": { "$ref": "#/$defs/presentationText" },
+    "description": { "$ref": "#/$defs/description" },
+    "version": { "$ref": "#/$defs/semver" },
+    "publisher": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "name"],
+      "properties": {
+        "id": { "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" },
+        "name": { "$ref": "#/$defs/presentationText" }
+      }
+    },
+    "package": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["entry", "strategy", "include", "exclude", "shared"],
+      "properties": {
+        "entry": { "$ref": "#/$defs/relativePath" },
+        "strategy": { "enum": ["static", "adapter"] },
+        "localAIModelPolicy": { "$ref": "#/$defs/localAIModelPolicy" },
+        "include": { "$ref": "#/$defs/nonemptyPathList" },
+        "exclude": { "$ref": "#/$defs/pathList" },
+        "shared": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 64,
+          "uniqueItems": true,
+          "items": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" }
+        },
+        "adapter": {
+          "allOf": [
+            { "$ref": "#/$defs/relativePath" },
+            { "pattern": "^scripts/[A-Za-z0-9._/-]+\\.mjs$" }
+          ]
+        }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "strategy": { "const": "adapter" } }, "required": ["strategy"] },
+          "then": { "required": ["adapter"] },
+          "else": { "not": { "required": ["adapter"] } }
+        }
+      ]
+    },
+    "permissions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["capabilities", "methods"],
+      "properties": {
+        "capabilities": {
+          "allOf": [
+            { "$ref": "#/$defs/permissionList" },
+            {
+              "not": {
+                "allOf": [
+                  { "contains": { "const": "external.open" } },
+                  { "contains": { "const": "web.embed" } }
+                ]
+              }
+            }
+          ]
+        },
+        "methods": { "$ref": "#/$defs/methodList" }
+      }
+    },
+    "security": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["connectOrigins", "frameOrigins", "mediaOrigins"],
+      "properties": {
+        "connectOrigins": { "$ref": "#/$defs/connectOriginList" },
+        "frameOrigins": { "$ref": "#/$defs/frameOriginList" },
+        "mediaOrigins": { "$ref": "#/$defs/httpsOriginList" }
+      }
+    },
+    "native": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "icon", "order", "bundledApps"],
+      "properties": {
+        "type": { "const": "app" },
+        "icon": {
+          "description": "A safe raster image path. Native targets require a non-null value. Coverage by package.include is enforced by the runtime validator because JSON Schema cannot compare property values or path prefixes.",
+          "oneOf": [{ "$ref": "#/$defs/rasterIcon" }, { "type": "null" }]
+        },
+        "order": { "type": "integer", "minimum": 0, "maximum": 10000 },
+        "bundledApps": {
+          "type": "array",
+          "maxItems": 16,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/appId" }
+        },
+        "documentCatalog": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "policy": { "enum": ["empty-unpublished", "public-only"] },
+            "release": { "$ref": "#/$defs/relativePath" },
+            "destination": { "$ref": "#/$defs/relativePath" },
+            "originals": { "$ref": "#/$defs/relativePath" },
+            "manifest": { "type": "string", "pattern": "^[^/\\\\]+\\.json$" },
+            "expectedCount": { "type": "integer", "minimum": 1, "maximum": 512 }
+          },
+          "allOf": [
+            {
+              "if": { "properties": { "policy": { "const": "empty-unpublished" } }, "required": ["policy"] },
+              "then": {
+                "required": ["policy", "destination", "manifest"],
+                "not": { "anyOf": [{ "required": ["release"] }, { "required": ["originals"] }, { "required": ["expectedCount"] }] }
+              },
+              "else": { "required": ["policy", "release", "destination", "originals", "manifest", "expectedCount"] }
+            }
+          ]
+        }
+      }
+    },
+    "requirements": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["arcaneProtocol", "minimumCoreVersion", "features"],
+      "properties": {
+        "arcaneProtocol": { "const": "arcane/1" },
+        "minimumCoreVersion": { "$ref": "#/$defs/semver" },
+        "features": {
+          "type": "array",
+          "maxItems": 128,
+          "uniqueItems": true,
+          "items": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$" }
+        }
+      }
+    },
+    "targets": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 6,
+      "uniqueItems": true,
+      "items": {
+        "enum": ["android-arm64", "browser", "linux-arm64", "linux-x64", "portable", "windows-x64"]
+      }
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "targets": { "contains": { "not": { "const": "browser" } } }
+        },
+        "required": ["targets"]
+      },
+      "then": {
+        "properties": {
+          "native": {
+            "properties": {
+              "icon": { "$ref": "#/$defs/rasterIcon" }
+            },
+            "required": ["icon"]
+          }
+        },
+        "required": ["native"]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "security": {
+            "properties": {
+              "frameOrigins": { "minItems": 1 }
+            },
+            "required": ["frameOrigins"]
+          }
+        },
+        "required": ["security"]
+      },
+      "then": {
+        "properties": {
+          "permissions": {
+            "properties": {
+              "capabilities": { "contains": { "const": "web.embed" } }
+            },
+            "required": ["capabilities"]
+          }
+        },
+        "required": ["permissions"]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "id": { "not": { "const": "browser" } }
+        },
+        "required": ["id"]
+      },
+      "then": {
+        "properties": {
+          "security": {
+            "properties": {
+              "frameOrigins": {
+                "not": { "contains": { "const": "https:" } }
+              }
+            },
+            "required": ["frameOrigins"]
+          }
+        },
+        "required": ["security"]
+      }
+    }
+  ],
+  "$defs": {
+    "appId": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" },
+    "presentationText": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 160,
+      "pattern": "^(?=.*\\S)[^<>\\u0000-\\u001f\\u007f]+$"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "pattern": "^(?=.*\\S)[^<>\\u0000-\\u001f\\u007f]+$"
+    },
+    "semver": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
+    },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^(?!.*\\\\)(?!.*:)(?!.*[<>\"|?*])(?!.*(?:^|/)(?:\\.{1,2}|(?:[Cc][Oo][Nn]|[Pp][Rr][Nn]|[Aa][Uu][Xx]|[Nn][Uu][Ll]|[Cc][Ll][Oo][Cc][Kk]\\$|[Cc][Oo][Nn][Ii][Nn]\\$|[Cc][Oo][Nn][Oo][Uu][Tt]\\$|[Cc][Oo][Mm][1-9¹²³]|[Ll][Pp][Tt][1-9¹²³])(?:\\.[^/]*)?)(?:/|$))(?!.*[. ](?:/|$))[^/\\u0000-\\u001f\\u007f]+(?:/[^/\\u0000-\\u001f\\u007f]+)*$"
+    },
+    "rasterIcon": {
+      "allOf": [
+        { "$ref": "#/$defs/relativePath" },
+        {
+          "maxLength": 160,
+          "pattern": "\\.(?:[Ii][Cc][Oo]|[Jj][Pp][Ee]?[Gg]|[Pp][Nn][Gg]|[Ww][Ee][Bb][Pp])$"
+        }
+      ]
+    },
+    "pathList": {
+      "type": "array",
+      "maxItems": 512,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/relativePath" }
+    },
+    "nonemptyPathList": {
+      "allOf": [{ "$ref": "#/$defs/pathList" }, { "minItems": 1 }]
+    },
+    "permissionList": {
+      "type": "array",
+      "maxItems": 256,
+      "uniqueItems": true,
+      "items": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:\\.[a-z][a-z0-9]*)+$" }
+    },
+    "methodList": {
+      "type": "array",
+      "maxItems": 512,
+      "uniqueItems": true,
+      "items": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:\\.[a-z][a-zA-Z0-9]*)+$" }
+    },
+    "connectOriginList": {
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "pattern": "^(?:https://[^/?#]+|http://(?:127\\.0\\.0\\.1|\\[::1\\])(?::[0-9]{1,5})?)$"
+      }
+    },
+    "httpsOriginList": {
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": { "type": "string", "pattern": "^https://[^/?#]+$" }
+    },
+    "frameOriginList": {
+      "type": "array",
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": { "type": "string", "pattern": "^(?:https:|https://[^/?#]+)$" }
+    },
+    "localAIModelPolicy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["verified_only", "models"],
+      "properties": {
+        "verified_only": { "type": "boolean" },
+        "models": {
+          "type": "array",
+          "maxItems": 64,
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "definition"],
+            "properties": {
+              "name": { "type": "string", "minLength": 1, "maxLength": 256 },
+              "definition": { "$ref": "#/$defs/relativePath" }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/arcane-lock.schema.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/TheWizardNexus/arcane-os-sdk/schemas/arcane-lock.schema.json",
+  "title": "Arcane SDK workspace lock",
+  "description": "Pins an authored workspace to one SDK runtime and protocol state.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "sdk",
+    "runtime",
+    "protocols"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "const": 1
+    },
+    "sdk": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "version"
+      ],
+      "properties": {
+        "name": {
+          "const": "arcane-os"
+        },
+        "version": {
+          "const": "0.1.0-dev.5"
+        }
+      }
+    },
+    "runtime": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "manifest",
+        "contentSha256",
+        "upstreamCommit"
+      ],
+      "properties": {
+        "manifest": {
+          "const": "node_modules/arcane-os/runtime/ARCANE_RUNTIME_RELEASE.json"
+        },
+        "contentSha256": {
+          "$ref": "#/$defs/sha256"
+        },
+        "upstreamCommit": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{40}$"
+        }
+      }
+    },
+    "protocols": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "arcane",
+        "cliEvents",
+        "targetAdapter"
+      ],
+      "properties": {
+        "arcane": {
+          "const": "arcane/1"
+        },
+        "cliEvents": {
+          "const": "arcane-cli-events/1"
+        },
+        "targetAdapter": {
+          "const": "arcane-target-adapter/1"
+        }
+      }
+    }
+  },
+  "$defs": {
+    "semver": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    }
+  }
+}