@0disoft/mensor-contract 0.2.1 → 0.10.0

package/README.md

@@ -17,7 +17,9 @@ import {
   parseCheckOutputV2,
   parseProjectContract,
   parseRouteIndex,
+  parseRuntimeManifest,
   serializeRouteIndex,
+  serializeRuntimeManifest,
 } from "@0disoft/mensor-contract";
 ```
 
@@ -33,6 +35,9 @@ const projectSchema = import.meta.resolve(
 const checkOutputSchema = import.meta.resolve(
   "@0disoft/mensor-contract/schemas/check-output-v2.schema.json",
 );
+const runtimeManifestSchema = import.meta.resolve(
+  "@0disoft/mensor-contract/schemas/runtime-manifest-v1.schema.json",
+);
 ```
 
 ## Documentation
@@ -40,5 +45,6 @@ const checkOutputSchema = import.meta.resolve(
 - [Contract authoring](https://github.com/0disoft/mensor/blob/main/packages/contract/spec/README.md)
 - [Public API and compatibility](https://github.com/0disoft/mensor/blob/main/docs/library/public-api.md)
 - [RouteIndex v1](https://github.com/0disoft/mensor/blob/main/docs/architecture/route-index-v1.md)
+- [RuntimeManifest v1](https://github.com/0disoft/mensor/blob/main/docs/architecture/runtime-manifest-v1.md)
 
 Mensor is licensed under Apache-2.0.

package/dist/spec/check-output-v2.schema.json

@@ -81,7 +81,7 @@
                             "type": "object",
                             "properties": {
                                 "state": { "const": "checked" },
-                                "basis": { "const": "static-html-form-index" }
+                                "basis": { "enum": ["form-index", "static-html-form-index"] }
                             }
                         }
                     ]

package/dist/spec/diagnostic-report-v1.schema.json

@@ -446,14 +446,14 @@
                     "minLength": 1
                 },
                 "controlKind": {
-                    "enum": ["input", "select"]
+                    "enum": ["input", "select", "textarea"]
                 },
                 "controlCount": { "type": "integer", "minimum": 2 },
                 "controlType": {
                     "type": "string"
                 },
                 "decoderKind": {
-                    "const": "text"
+                    "enum": ["text", "integer-base10", "decimal", "checkbox", "enum", "repeat"]
                 },
                 "fieldName": {
                     "type": "string",

package/dist/spec/feature-contract-v1.schema.json

@@ -64,10 +64,7 @@
             "required": ["template", "id"],
             "properties": {
                 "template": {
-                    "allOf": [
-                        { "$ref": "#/$defs/relativePath" },
-                        { "type": "string", "pattern": "\\.html$" }
-                    ]
+                    "$ref": "#/$defs/relativePath"
                 },
                 "id": {
                     "type": "string",
@@ -113,6 +110,74 @@
                 }
             }
         },
+        "integerSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind"],
+            "properties": {
+                "kind": { "const": "integer" },
+                "minimum": { "type": "integer" },
+                "maximum": { "type": "integer" }
+            }
+        },
+        "numberSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind"],
+            "properties": {
+                "kind": { "const": "number" },
+                "minimum": { "type": "number" },
+                "maximum": { "type": "number" }
+            }
+        },
+        "booleanSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind"],
+            "properties": {
+                "kind": { "const": "boolean" }
+            }
+        },
+        "enumSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "values"],
+            "properties": {
+                "kind": { "const": "enum" },
+                "values": {
+                    "type": "array",
+                    "minItems": 1,
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            }
+        },
+        "scalarSchema": {
+            "oneOf": [
+                { "$ref": "#/$defs/stringSchema" },
+                { "$ref": "#/$defs/integerSchema" },
+                { "$ref": "#/$defs/numberSchema" },
+                { "$ref": "#/$defs/booleanSchema" },
+                { "$ref": "#/$defs/enumSchema" }
+            ]
+        },
+        "arraySchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "items"],
+            "properties": {
+                "kind": { "const": "array" },
+                "items": { "$ref": "#/$defs/scalarSchema" },
+                "minItems": { "type": "integer", "minimum": 0 },
+                "maxItems": { "type": "integer", "minimum": 0 }
+            }
+        },
+        "propertySchema": {
+            "oneOf": [
+                { "$ref": "#/$defs/scalarSchema" },
+                { "$ref": "#/$defs/arraySchema" }
+            ]
+        },
         "objectSchema": {
             "type": "object",
             "additionalProperties": false,
@@ -125,7 +190,7 @@
                     "type": "object",
                     "minProperties": 1,
                     "additionalProperties": {
-                        "$ref": "#/$defs/stringSchema"
+                        "$ref": "#/$defs/propertySchema"
                     }
                 },
                 "required": {
@@ -154,6 +219,78 @@
                 }
             }
         },
+        "integerDecoder": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind"],
+            "properties": {
+                "kind": { "const": "integer-base10" }
+            }
+        },
+        "decimalDecoder": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind"],
+            "properties": {
+                "kind": { "const": "decimal" }
+            }
+        },
+        "checkboxDecoder": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "trueValues", "missing"],
+            "properties": {
+                "kind": { "const": "checkbox" },
+                "trueValues": {
+                    "type": "array",
+                    "minItems": 1,
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                },
+                "missing": { "type": "boolean" }
+            }
+        },
+        "enumDecoder": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "values"],
+            "properties": {
+                "kind": { "const": "enum" },
+                "values": {
+                    "type": "array",
+                    "minItems": 1,
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            }
+        },
+        "repeatItemDecoder": {
+            "oneOf": [
+                { "$ref": "#/$defs/textDecoder" },
+                { "$ref": "#/$defs/integerDecoder" },
+                { "$ref": "#/$defs/decimalDecoder" },
+                { "$ref": "#/$defs/enumDecoder" }
+            ]
+        },
+        "repeatDecoder": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "items"],
+            "properties": {
+                "kind": { "const": "repeat" },
+                "items": { "$ref": "#/$defs/repeatItemDecoder" }
+            }
+        },
+        "formDecoder": {
+            "oneOf": [
+                { "$ref": "#/$defs/textDecoder" },
+                { "$ref": "#/$defs/integerDecoder" },
+                { "$ref": "#/$defs/decimalDecoder" },
+                { "$ref": "#/$defs/checkboxDecoder" },
+                { "$ref": "#/$defs/enumDecoder" },
+                { "$ref": "#/$defs/repeatDecoder" }
+            ]
+        },
         "binding": {
             "type": "object",
             "additionalProperties": false,
@@ -172,7 +309,7 @@
                     }
                 },
                 "decode": {
-                    "$ref": "#/$defs/textDecoder"
+                    "$ref": "#/$defs/formDecoder"
                 }
             }
         },

package/dist/spec/form-index-v1.schema.json

@@ -0,0 +1,284 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "form-index-v1.schema.json",
+    "title": "Mensor FormIndex v1",
+    "type": "object",
+    "additionalProperties": false,
+    "required": ["schemaVersion", "producer", "documents"],
+    "properties": {
+        "schemaVersion": { "const": 1 },
+        "producer": { "$ref": "#/$defs/producer" },
+        "documents": {
+            "type": "array",
+            "items": { "$ref": "#/$defs/document" }
+        }
+    },
+    "$defs": {
+        "identifier": {
+            "type": "string",
+            "pattern": "^[a-z0-9](?:[a-z0-9._/-]{0,127})$"
+        },
+        "version": {
+            "type": "string",
+            "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9._+-]{0,127})$"
+        },
+        "relativePath": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^(?!/)(?![A-Za-z]:)(?!.*(?:^|/)\\.\\.(?:/|$))(?!.*\\\\)(?!.*//)(?!.*[\\u0000-\\u001f\\u007f]).+$"
+        },
+        "digest": {
+            "type": "string",
+            "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "position": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["line", "character"],
+            "properties": {
+                "line": { "type": "integer", "minimum": 0 },
+                "character": { "type": "integer", "minimum": 0 }
+            }
+        },
+        "range": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["start", "end"],
+            "properties": {
+                "start": { "$ref": "#/$defs/position" },
+                "end": { "$ref": "#/$defs/position" }
+            }
+        },
+        "dynamicReason": {
+            "enum": [
+                "computed-attribute",
+                "conditional-presence",
+                "custom-helper-semantics",
+                "dynamic-interpolation",
+                "repeated-generation"
+            ]
+        },
+        "unsupportedReason": {
+            "enum": [
+                "file-input",
+                "named-submitter",
+                "provider-resource-limit",
+                "submitter-route-override",
+                "unsupported-control-kind"
+            ]
+        },
+        "unresolvedReason": {
+            "oneOf": [
+                { "$ref": "#/$defs/dynamicReason" },
+                { "$ref": "#/$defs/unsupportedReason" }
+            ]
+        },
+        "knownString": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "value", "range"],
+            "properties": {
+                "state": { "const": "known" },
+                "value": { "type": "string" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "knownNonEmptyString": {
+            "allOf": [
+                { "$ref": "#/$defs/knownString" },
+                {
+                    "type": "object",
+                    "properties": {
+                        "value": { "type": "string", "minLength": 1 }
+                    }
+                }
+            ]
+        },
+        "knownBoolean": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "value", "range"],
+            "properties": {
+                "state": { "const": "known" },
+                "value": { "type": "boolean" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "knownControlKind": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "value", "range"],
+            "properties": {
+                "state": { "const": "known" },
+                "value": { "enum": ["button", "input", "select", "textarea"] },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "knownMultiplicity": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "value", "range"],
+            "properties": {
+                "state": { "const": "known" },
+                "value": { "enum": ["mutually-exclusive", "repeated", "scalar"] },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "absent": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state"],
+            "properties": {
+                "state": { "const": "absent" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "dynamic": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "reason", "range"],
+            "properties": {
+                "state": { "const": "dynamic" },
+                "reason": { "$ref": "#/$defs/dynamicReason" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "unsupported": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["state", "reason", "range"],
+            "properties": {
+                "state": { "const": "unsupported" },
+                "reason": { "$ref": "#/$defs/unsupportedReason" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "stringEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/knownString" },
+                { "$ref": "#/$defs/absent" },
+                { "$ref": "#/$defs/dynamic" },
+                { "$ref": "#/$defs/unsupported" }
+            ]
+        },
+        "nonEmptyStringEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/knownNonEmptyString" },
+                { "$ref": "#/$defs/absent" },
+                { "$ref": "#/$defs/dynamic" },
+                { "$ref": "#/$defs/unsupported" }
+            ]
+        },
+        "booleanEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/knownBoolean" },
+                { "$ref": "#/$defs/absent" },
+                { "$ref": "#/$defs/dynamic" },
+                { "$ref": "#/$defs/unsupported" }
+            ]
+        },
+        "controlKindEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/knownControlKind" },
+                { "$ref": "#/$defs/absent" },
+                { "$ref": "#/$defs/dynamic" },
+                { "$ref": "#/$defs/unsupported" }
+            ]
+        },
+        "multiplicityEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/knownMultiplicity" },
+                { "$ref": "#/$defs/absent" },
+                { "$ref": "#/$defs/dynamic" },
+                { "$ref": "#/$defs/unsupported" }
+            ]
+        },
+        "actionEvidence": {
+            "oneOf": [
+                { "$ref": "#/$defs/stringEvidence" },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": ["state", "range"],
+                    "properties": {
+                        "state": { "const": "current-document" },
+                        "range": { "$ref": "#/$defs/range" }
+                    }
+                }
+            ]
+        },
+        "producer": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "version"],
+            "properties": {
+                "name": { "$ref": "#/$defs/identifier" },
+                "version": { "$ref": "#/$defs/version" }
+            }
+        },
+        "inspection": {
+            "oneOf": [
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": ["state"],
+                    "properties": { "state": { "const": "complete" } }
+                },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": ["state", "reason"],
+                    "properties": {
+                        "state": { "const": "incomplete" },
+                        "reason": { "$ref": "#/$defs/unresolvedReason" },
+                        "range": { "$ref": "#/$defs/range" }
+                    }
+                }
+            ]
+        },
+        "control": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "controlKind", "inputType", "multiple", "multiplicity", "successful", "range"],
+            "properties": {
+                "name": { "$ref": "#/$defs/nonEmptyStringEvidence" },
+                "controlKind": { "$ref": "#/$defs/controlKindEvidence" },
+                "inputType": { "$ref": "#/$defs/stringEvidence" },
+                "multiple": { "$ref": "#/$defs/booleanEvidence" },
+                "multiplicity": { "$ref": "#/$defs/multiplicityEvidence" },
+                "successful": { "$ref": "#/$defs/booleanEvidence" },
+                "range": { "$ref": "#/$defs/range" }
+            }
+        },
+        "form": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["identity", "method", "action", "range", "controls"],
+            "properties": {
+                "identity": { "$ref": "#/$defs/nonEmptyStringEvidence" },
+                "method": { "$ref": "#/$defs/stringEvidence" },
+                "action": { "$ref": "#/$defs/actionEvidence" },
+                "range": { "$ref": "#/$defs/range" },
+                "controls": {
+                    "type": "array",
+                    "items": { "$ref": "#/$defs/control" }
+                }
+            }
+        },
+        "document": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["path", "contentDigest", "sourceKind", "inspection", "forms"],
+            "properties": {
+                "path": { "$ref": "#/$defs/relativePath" },
+                "contentDigest": { "$ref": "#/$defs/digest" },
+                "sourceKind": { "$ref": "#/$defs/identifier" },
+                "inspection": { "$ref": "#/$defs/inspection" },
+                "forms": {
+                    "type": "array",
+                    "items": { "$ref": "#/$defs/form" }
+                }
+            }
+        }
+    }
+}

package/dist/spec/project-contract-v1.schema.json

@@ -5,6 +5,7 @@
     "type": "object",
     "additionalProperties": false,
     "required": ["version", "sourceRoot", "featureContracts", "fileRoles"],
+    "dependentRequired": { "formIndexEvidence": ["formIndex"] },
     "properties": {
         "$schema": {
             "type": "string"
@@ -42,6 +43,16 @@
                 "$ref": "#/$defs/ownershipRule"
             }
         },
+        "formIndex": {
+            "$ref": "#/$defs/relativePath"
+        },
+        "formIndexEvidence": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "uniqueItems": true,
+            "items": { "$ref": "#/$defs/relativePath" }
+        },
         "routeIndex": {
             "$ref": "#/$defs/relativePath"
         }

package/dist/spec/runtime-manifest-v1.schema.json

@@ -0,0 +1,57 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "runtime-manifest-v1.schema.json",
+    "title": "Mensor Runtime Manifest v1",
+    "type": "object",
+    "additionalProperties": false,
+    "required": ["manifestVersion", "producer", "pages", "actions"],
+    "properties": {
+        "manifestVersion": { "const": 1 },
+        "producer": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "version"],
+            "properties": {
+                "name": { "type": "string", "minLength": 1 },
+                "version": { "type": "string", "minLength": 1 }
+            }
+        },
+        "pages": {
+            "type": "array",
+            "items": { "$ref": "#/$defs/page" }
+        },
+        "actions": {
+            "type": "array",
+            "items": { "$ref": "#/$defs/action" }
+        }
+    },
+    "$defs": {
+        "routePath": {
+            "type": "string",
+            "pattern": "^/[^?#]*$"
+        },
+        "page": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id", "method", "path", "html"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "method": { "const": "GET" },
+                "path": { "$ref": "#/$defs/routePath" },
+                "html": { "type": "string" }
+            }
+        },
+        "action": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id", "method", "path", "handlerId", "input"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "method": { "const": "POST" },
+                "path": { "$ref": "#/$defs/routePath" },
+                "handlerId": { "type": "string", "minLength": 1 },
+                "input": { "$ref": "feature-contract-v1.schema.json#/$defs/input" }
+            }
+        }
+    }
+}

package/dist/src/compare.d.ts

@@ -0,0 +1,2 @@
+export declare function compareText(left: string, right: string): number;
+//# sourceMappingURL=compare.d.ts.map

package/dist/src/compare.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../src/compare.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/D"}

package/dist/src/compare.js

@@ -0,0 +1,4 @@
+export function compareText(left, right) {
+    return left < right ? -1 : left > right ? 1 : 0;
+}
+//# sourceMappingURL=compare.js.map

package/dist/src/compare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../src/compare.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,KAAa;IACrD,OAAO,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC"}

package/dist/src/form-index.d.ts

@@ -0,0 +1,4 @@
+import type { ContractResult, FormIndex } from "./types.js";
+export declare function parseFormIndex(text: string): ContractResult<FormIndex>;
+export declare function serializeFormIndex(value: unknown): string;
+//# sourceMappingURL=form-index.d.ts.map

package/dist/src/form-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-index.d.ts","sourceRoot":"","sources":["../../src/form-index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAEV,cAAc,EACd,SAAS,EASV,MAAM,YAAY,CAAC;AAIpB,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,CAoBtE;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAYzD"}