@toolproof-core/schema 1.0.0

package/src/Roadmap.json

@@ -0,0 +1,102 @@
+{
+    "Tasks": [
+        {
+            "name": "Familiarization",
+            "comment": "Familiarize yourself with the new schema structure and the changes made. Consult the 'Notes' section for specific changes in naming and structure. This will help you understand how to adapt the existing codebase to work with the new schema. Prepare a list of any questions or clarifications needed regarding the new schema structure and we'll discuss them."
+        },
+        {
+            "name": "Scripts",
+            "comment": "Implement the scripts specified in the 'Scripts' section so that they work with the new schema structure. Try to do it with business logic contained in reusable pure functions as much as possible, and with clear separation between this and file I/O. In the future, we might let Ajv take over some of this work since it already has a lot of this functionality built-in (dereferencing, $defs bundling, etc.)."
+        },
+        {
+            "name": "NPM Publishing",
+            "comment": "Publish the schema package to the new npm organization 'toolproof-core' (I have sent you an invite). Take a pull of the latest master and merge it into your branch. For schema/package.json, keep my 'name' change. The package is now called '@toolproof-core/schema' instead of '@toolproof-npm/schema'. The reason for this change is that we can now name all core packages with the '@toolproof-core' prefix, regardless of whether they are published to npm or not. I've also done one change in Genesis.json. ShellMaterializedBase now has a required 'version' property with const value 1. This should not cause any merge conflicts since you've only done changes inside scripts/ and generated/ (in addition to package.json). The only thing that needs to be changed in scripts/ is the generateResourceShells script to add the version property (with value 1)when wrapping ResourceTypes in a ShellMaterialized. Note that while we call the new ToolProof version 'v2' during development, it will officially be called 'v1'. The old version (current 'v1') will be degraded to 'v0' and deprecated. This aligns with our npm package naming, where we've till now given the packages a '0.x.x' version. In the new npm organization 'toolproof-core', we will start with version '1.0.0' for all packages. Note that I've also updated other packages (console, engine, validation, visualization), but that should not cause any merge conflicts."
+        },
+        {
+            "name": "GitHub Actions",
+            "comment": "Create a GitHub Actions workflow for the schema package (like we have in the old ToolProof repository). We'll create actions for other packages later."
+        }
+    ],
+    "Notes": [
+        {
+            "oldName": "-Wrapper",
+            "newName": "-Facet",
+            "comment": "The 'Wrapper' suffix is changed to 'Facet' everywhere."
+        },
+        {
+            "oldName": "Name&DescriptionWrapper",
+            "newName": "DocumentationFacet"
+        },
+        {
+            "oldName": "extractionSchema",
+            "newName": "nucleusSchema",
+            "comment": "This is now a maximum-permissive 'true' schema. We'll validate user-written schemas in a much better way separately."
+        },
+        {
+            "oldName": "extractedData",
+            "newName": "nucleus"
+        },
+        {
+            "oldName": "Execution",
+            "newName": "JobRun"
+        },
+        {
+            "oldName": "WorkStep",
+            "newName": "JobStep"
+        },
+        {
+            "oldName": "ResourceMeta",
+            "newName": "ShellMaterialized"
+        },
+        {
+            "oldName": "StatelessStrategy",
+            "newName": "StepsFacet",
+            "comment": "This is a different concept. We no longer have the concept of Stateless vs Stateful strategies. We'll rather allow RunnableStrategies to be reused with new bindings."
+        },
+        {
+            "oldName": "StatefulStrategy",
+            "newName": "RawStrategy"
+        },
+        {
+            "oldName": "RunRecording",
+            "newName": "StrategyRun"
+        }
+    ],
+    "Scripts": {
+        "rewriteAnchors": {
+            "newName": "rewriteAnchors",
+            "comment": "Rewrites anchor-style refs (e.g. #SomeAnchor) inside Genesis.json’s nucleusSchema to JSON Pointer refs (e.g. #/$defs/SomeAnchor) for stricter tooling compatibility. Outputs normalized Genesis.json written to the configured location.",
+            "status": "Done, In PR"
+        },
+        "extractSchemas": {
+            "newName": "extractSchemas",
+            "comment": "Takes the (normalized) Genesis.json document (expects a top-level nucleusSchema), unwraps nested ResourceTypes into raw JSON Schemas. Outputs a flattened Genesis.json at the configured location.",
+            "status": "Done, In PR"
+        },
+        "extractSubSchemaWithDefs": {
+            "newName": "extractSubSchemaWithDefs",
+            "comment": "Extracts a single $defs.<Name> from the flattened Genesis.json and bundles it into a standalone schema including all direct + transitive local $defs dependencies referenced via #/$defs/...",
+            "status": "Done, In PR"
+        },
+        "generateSchemaShims": {
+            "newName": "generateSchemaShims",
+            "comment": "Generates .ts shim files next to generated .json files so TypeScript/NodeNext can import JSON schemas/resources via import assertions consistently."
+        },
+        "generateResourceEnvelopes": {
+            "newName": "generateResourceShells",
+            "comment": "Wraps every Genesis.nucleusSchema.$defs[DefName] schema in a Resource shell (ToolProof resource object). Special-cases Genesis with nucleus: {} to avoid duplicating all $defs."
+        },
+        "generateTypes": {
+            "newName": "generateTypes",
+            "comment": "Runs json-schema-to-typescript across the extracted schemas directory, with a custom resolver so absolute $id URLs map to local files (no network). Applies a few normalizations (e.g., allOf sibling keyword handling), prunes noisy generated names, and overlays template-literal types for ...Identity/...Ref patterns when possible. Ensures runtime .js shims exist alongside .d.ts. Note that some of this additional processing might be unnecessary or might not fit the new schema structure."
+        },
+        "generateResourceTypeType": {
+            "newName": "generateResourceTypeType",
+            "comment": "Generates a typed Resource variant Resource_<Name> where nucleus is typed to the extracted nucleusSchema <Name>.json."
+        },
+        "generateDependencies": {
+            "newName": "generateDependencies",
+            "comment": "Generates a list of dependencies for each schema."
+        }
+    }
+}

package/src/generated/dependencies.json

@@ -0,0 +1,299 @@
+{
+    "Boolean": [
+        "BooleanIdentity"
+    ],
+    "BooleanIdentity": [],
+    "BranchStep": [
+        "StepKindFacet",
+        "Conditional",
+        "BranchStepIdentity"
+    ],
+    "BranchStepIdentity": [],
+    "Conditional": [
+        "JobStep"
+    ],
+    "CreationContext": [
+        "JobRunIdentity",
+        "ResourceRoleIdentity"
+    ],
+    "CreationContextFacet": [
+        "CreationContext"
+    ],
+    "Description": [],
+    "DescriptionFacet": [
+        "Description"
+    ],
+    "DocumentationFacet": [
+        "NameFacet",
+        "DescriptionFacet"
+    ],
+    "Domain": [],
+    "DomainFacet": [
+        "Domain"
+    ],
+    "Error": [
+        "DocumentationFacet"
+    ],
+    "ForStep": [
+        "StepKindFacet",
+        "Conditional",
+        "ForStepIdentity"
+    ],
+    "ForStepIdentity": [],
+    "Goal": [
+        "DomainFacet",
+        "JobIdentity",
+        "GoalIdentity"
+    ],
+    "GoalIdentity": [],
+    "GraphEndRunEvent": [
+        "RunEventBase"
+    ],
+    "GraphStartRunEvent": [
+        "RunEventBase",
+        "RunnableStrategy"
+    ],
+    "InterruptRunEvent": [
+        "RunEventBase"
+    ],
+    "Job": [
+        "DocumentationFacet",
+        "DomainFacet",
+        "RolesFacet",
+        "JobIdentity",
+        "Uri"
+    ],
+    "JobIdentity": [],
+    "JobRun": [
+        "RoleBindingsFacet",
+        "JobRunIdentity",
+        "JobIdentity"
+    ],
+    "JobRunIdentity": [],
+    "JobRunSocket": [
+        "Resource",
+        "ResourceRoleIdentity"
+    ],
+    "JobStep": [
+        "StepKindFacet",
+        "JobStepIdentity",
+        "JobRun"
+    ],
+    "JobStepIdentity": [],
+    "JsonData": [],
+    "Name": [],
+    "NameFacet": [
+        "Name"
+    ],
+    "Natural": [
+        "NaturalIdentity"
+    ],
+    "NaturalIdentity": [],
+    "Nucleus": [
+        "JsonData"
+    ],
+    "NucleusFacet": [
+        "Nucleus"
+    ],
+    "Path": [],
+    "PathFacet": [
+        "Path"
+    ],
+    "RawStrategy": [
+        "StepsFacet",
+        "StrategyStateFacet"
+    ],
+    "Resource": [
+        "ResourceMissing",
+        "ResourceInputPotential",
+        "ResourceOutputPotential",
+        "ResourceMaterialized"
+    ],
+    "ResourceBase": [
+        "ResourceIdentity",
+        "ResourceTypeIdentity"
+    ],
+    "ResourceIdentity": [],
+    "ResourceInputPotential": [
+        "ShellInputPotential"
+    ],
+    "ResourceKind": [],
+    "ResourceKindFacet": [
+        "ResourceKind"
+    ],
+    "ResourceMaterialized": [
+        "ShellMaterializedBase",
+        "NucleusFacet"
+    ],
+    "ResourceMissing": [
+        "ShellMissing"
+    ],
+    "ResourceOutputPotential": [
+        "ShellOutputPotential"
+    ],
+    "ResourceRoleIdentity": [],
+    "ResourceRoleValue": [
+        "ResourceTypeIdentity",
+        "DocumentationFacet"
+    ],
+    "ResourceType": [
+        "DocumentationFacet",
+        "ResourceTypeImplementationKindFacet",
+        "Uri",
+        "ResourceTypeIdentity"
+    ],
+    "ResourceTypeIdentity": [],
+    "ResourceTypeImplementationKind": [],
+    "ResourceTypeImplementationKindFacet": [
+        "ResourceTypeImplementationKind"
+    ],
+    "RoleBindingArray": [
+        "ResourceRoleIdentity"
+    ],
+    "RoleBindings": [
+        "RoleBindingArray"
+    ],
+    "RoleBindingsFacet": [
+        "RoleBindings"
+    ],
+    "RoleMap": [
+        "ResourceRoleValue",
+        "ResourceRoleIdentity"
+    ],
+    "Roles": [
+        "RoleMap",
+        "ResourceRoleValue"
+    ],
+    "RolesFacet": [
+        "Roles"
+    ],
+    "RunEvent": [
+        "GraphStartRunEvent",
+        "TickRunEvent",
+        "InterruptRunEvent",
+        "GraphEndRunEvent"
+    ],
+    "RunEventBase": [
+        "RunEventCounters",
+        "Timestamp",
+        "RunEventKind",
+        "RunnableStrategyIdentity",
+        "RunEventStepMetadata",
+        "StrategyThreadIdentity",
+        "RunEventUpdates"
+    ],
+    "RunEventCounters": [],
+    "RunEventKind": [],
+    "RunEventStepMetadata": [
+        "JobIdentity",
+        "JobRunIdentity",
+        "StepIdentity",
+        "StepKind"
+    ],
+    "RunEventUpdates": [
+        "StrategyStateDelta",
+        "StepArray"
+    ],
+    "RunnableStrategy": [
+        "StrategyThreadMapFacet",
+        "StrategyStateFacet",
+        "RunnableStrategyIdentity",
+        "RunnableStrategyContext"
+    ],
+    "RunnableStrategyContext": [
+        "Timestamp",
+        "RunnableStrategyStatus"
+    ],
+    "RunnableStrategyIdentity": [],
+    "RunnableStrategyStatus": [],
+    "RunnableStrategyUpdate": [
+        "StrategyStateDelta",
+        "RunnableStrategy",
+        "RunnableStrategyIdentity"
+    ],
+    "ShellInputPotential": [
+        "ResourceBase",
+        "CreationContextFacet",
+        "ResourceKindFacet"
+    ],
+    "ShellMaterialized": [
+        "ShellMaterializedBase"
+    ],
+    "ShellMaterializedBase": [
+        "ResourceBase",
+        "CreationContextFacet",
+        "ResourceKindFacet",
+        "TimestampFacet",
+        "PathFacet"
+    ],
+    "ShellMissing": [
+        "ResourceBase",
+        "ResourceKindFacet"
+    ],
+    "ShellOutputPotential": [
+        "ResourceBase",
+        "CreationContextFacet",
+        "ResourceKindFacet"
+    ],
+    "Step": [
+        "JobStep",
+        "BranchStep",
+        "WhileStep",
+        "ForStep"
+    ],
+    "StepArray": [
+        "Step"
+    ],
+    "StepIdentity": [
+        "JobStepIdentity",
+        "BranchStepIdentity",
+        "WhileStepIdentity",
+        "ForStepIdentity"
+    ],
+    "StepKind": [],
+    "StepKindFacet": [
+        "StepKind"
+    ],
+    "StepsFacet": [
+        "StepArray"
+    ],
+    "StrategyRun": [
+        "StrategyRunIdentity",
+        "Timestamp",
+        "RunEvent",
+        "RunnableStrategyIdentity"
+    ],
+    "StrategyRunIdentity": [],
+    "StrategyState": [
+        "JobRunSocket",
+        "JobRunIdentity"
+    ],
+    "StrategyStateDelta": [
+        "StrategyState"
+    ],
+    "StrategyStateFacet": [
+        "StrategyState"
+    ],
+    "StrategyThreadIdentity": [],
+    "StrategyThreadMap": [
+        "StepArray",
+        "StrategyThreadIdentity"
+    ],
+    "StrategyThreadMapFacet": [
+        "StrategyThreadMap"
+    ],
+    "TickRunEvent": [
+        "RunEventBase"
+    ],
+    "Timestamp": [],
+    "TimestampFacet": [
+        "Timestamp"
+    ],
+    "Uri": [],
+    "WhileStep": [
+        "StepKindFacet",
+        "Conditional",
+        "WhileStepIdentity"
+    ],
+    "WhileStepIdentity": []
+}