@runeditrun/rer 0.0.0-stage → 0.1.1

package/onboarding/schema/SETUP.schema.json

@@ -0,0 +1,514 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:rer:setup:1",
+  "title": "Setup manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "title",
+    "groups",
+    "fields",
+    "steps"
+  ],
+  "properties": {
+    "schema": {
+      "const": 1
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1
+    },
+    "groups": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/group"
+      },
+      "uniqueItems": true
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/field"
+      },
+      "minItems": 1
+    },
+    "runtime": {
+      "$ref": "#/$defs/runtime"
+    },
+    "steps": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/step"
+      },
+      "minItems": 1
+    },
+    "provides": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[a-z][a-z0-9-]*@[1-9][0-9]*$"
+      },
+      "uniqueItems": true
+    },
+    "dependencies": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/dependency"
+      },
+      "uniqueItems": true
+    },
+    "dependencyGraph": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "dependencies"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "minLength": 1
+            },
+            "uniqueItems": true
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "group": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "label"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,63}$"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "help": {
+          "type": "string"
+        },
+        "presentations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/groupPresentation"
+          },
+          "minItems": 1
+        }
+      }
+    },
+    "field": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "label",
+        "kind"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "kind": {
+          "enum": [
+            "text",
+            "email",
+            "url",
+            "select",
+            "colour",
+            "timezone",
+            "secret"
+          ]
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "help": {
+          "type": "string"
+        },
+        "placeholder": {
+          "type": "string"
+        },
+        "default": {
+          "type": "string"
+        },
+        "order": {
+          "type": "integer"
+        },
+        "group": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,63}$"
+        },
+        "when": {
+          "$ref": "#/$defs/condition"
+        },
+        "runtimeEditable": {
+          "type": "boolean"
+        },
+        "prefill": {
+          "const": "account-email"
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/option"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "presentations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/fieldPresentation"
+          },
+          "minItems": 1
+        },
+        "generate": {
+          "enum": [
+            "hex",
+            "base64"
+          ]
+        },
+        "ownerVisible": {
+          "type": "boolean"
+        },
+        "input": {
+          "enum": [
+            "entered",
+            "managed"
+          ]
+        },
+        "localDefault": {
+          "type": [
+            "string",
+            "object"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "generate": {
+              "enum": [
+                "hex",
+                "base64"
+              ]
+            },
+            "from": {
+              "const": "origin"
+            }
+          }
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "const": "secret"
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "required": [
+              "required",
+              "ownerVisible"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "const": "select"
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "required": [
+              "options"
+            ]
+          }
+        }
+      ]
+    },
+    "option": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "label"
+      ],
+      "properties": {
+        "value": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "fieldPresentation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "when"
+      ],
+      "properties": {
+        "when": {
+          "$ref": "#/$defs/condition"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "help": {
+          "type": "string"
+        },
+        "placeholder": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "order": {
+          "type": "integer"
+        }
+      }
+    },
+    "groupPresentation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "when"
+      ],
+      "properties": {
+        "when": {
+          "$ref": "#/$defs/condition"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1
+        },
+        "help": {
+          "type": "string"
+        }
+      }
+    },
+    "condition": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "field"
+      ],
+      "properties": {
+        "field": {
+          "type": "string",
+          "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+        },
+        "equals": {
+          "type": "string"
+        },
+        "nonEmpty": {
+          "const": true
+        }
+      }
+    },
+    "runtime": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "additionalFields"
+      ],
+      "properties": {
+        "additionalFields": {
+          "type": "boolean"
+        },
+        "exclude": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+          },
+          "uniqueItems": true
+        }
+      }
+    },
+    "step": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "owner-claim",
+            "extension"
+          ]
+        },
+        "mode": {
+          "enum": [
+            "signed",
+            "setup-token",
+            "idp"
+          ]
+        },
+        "emailField": {
+          "type": "string",
+          "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+        },
+        "tokenField": {
+          "type": "string",
+          "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+        },
+        "path": {
+          "type": "string",
+          "pattern": "^/[A-Za-z0-9._~/-]*$"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,63}$"
+        },
+        "dependency": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]*@[1-9][0-9]*$"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "owner-claim"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "mode",
+              "emailField"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "extension"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "id"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "mode": {
+                "const": "signed"
+              }
+            },
+            "required": [
+              "mode"
+            ]
+          },
+          "then": {
+            "required": [
+              "tokenField",
+              "path"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "mode": {
+                "const": "idp"
+              }
+            },
+            "required": [
+              "mode"
+            ]
+          },
+          "then": {
+            "required": [
+              "dependency",
+              "path"
+            ]
+          }
+        }
+      ]
+    },
+    "dependency": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "interface",
+        "optional",
+        "cardinality",
+        "address",
+        "paths"
+      ],
+      "properties": {
+        "interface": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]*@[1-9][0-9]*$"
+        },
+        "optional": {
+          "type": "boolean"
+        },
+        "cardinality": {
+          "const": 1
+        },
+        "address": {
+          "type": "string",
+          "pattern": "^[A-Z][A-Z0-9_]{0,127}$"
+        },
+        "paths": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "pattern": "^/[A-Za-z0-9._~/-]+$"
+          }
+        }
+      }
+    }
+  }
+}

package/onboarding/schema/dependencies.mjs

@@ -0,0 +1,35 @@
+// The caller supplies the complete selected graph, including optional edges.
+// Nodes are stable installation identifiers; references never resolve by label.
+export function validateDependencyGraph(nodes) {
+ if(!Array.isArray(nodes))throw Error('Dependency graph must be a list');
+ const graph=new Map();
+ for(const node of nodes) {
+  if(!node || typeof node.id!=='string' || !node.id || graph.has(node.id) || !Array.isArray(node.dependencies))throw Error('Invalid or duplicate dependency node');
+  if(new Set(node.dependencies).size!==node.dependencies.length || node.dependencies.some(id=>typeof id!=='string'))throw Error('Invalid dependency references');
+  graph.set(node.id,node.dependencies);
+ }
+ const visiting=new Set(),visited=new Set();
+ function visit(id) {
+  if(!graph.has(id))throw Error('Unknown dependency reference');
+  if(visiting.has(id))throw Error('Dependency graph contains a cycle');
+  if(visited.has(id))return;
+  visiting.add(id);for(const next of graph.get(id))visit(next);visiting.delete(id);visited.add(id);
+ }
+ for(const id of graph.keys())visit(id);
+ return nodes;
+}
+export function dependencyErrors(data) {
+ const errors=[],fail=message=>errors.push('$.dependencies: '+message);
+ const provides=data.provides??[],dependencies=data.dependencies??[];
+ const seen=new Set();
+ for(const d of dependencies) {
+  if(seen.has(d.interface))fail('interfaces must be unique');seen.add(d.interface);
+  if(provides.includes(d.interface))fail('a provider cannot depend on its own interface');
+  const field=data.fields.find(f=>f.name===d.address);
+  if(!field || field.kind!=='url' || field.runtimeEditable===true)fail('address must reference a declared immutable URL answer');
+  if(!d.optional && field?.required!==true)fail('a required dependency address must be a required answer');
+  if(d.paths.some(p=>!/^\/[A-Za-z0-9_~/-]+$/.test(p) || p.startsWith('//') || p.split('/').some(v=>v==='.'||v==='..')))fail('registration paths must be safe same-origin paths');
+ }
+ if(data.dependencyGraph)try{validateDependencyGraph(data.dependencyGraph);}catch(e){fail(e.message);}
+ return errors;
+}