@toolproof-npm/schema 0.1.19 → 0.1.20

package/dist/_lib/types/ResourceData_Job.d.ts

@@ -1,8 +1,8 @@
 // Auto-generated strict composite type. Do not edit.
-export type ResourceData_Job = ResourceDataMetaBase & {
+export type ResourceData_Job = ResourceCanonicalMetaBase & {
   extractedData: Job;
 };
-export type ResourceDataMetaBase = ResourceBase &
+export type ResourceCanonicalMetaBase = ResourceBase &
   ResourceKind & {
     kind: "realized";
   } & Path &

package/dist/_lib/types/types.d.ts

@@ -3,6 +3,7 @@
 export type CombinedEntry =
   | BranchStep
   | BranchStepId
+  | CanonicalRef
   | ConditionalWrapper
   | CreationContext
   | Description
@@ -27,19 +28,18 @@ export type CombinedEntry =
   | MeritValue
   | Name
   | Path
+  | PendingRef
   | ResourceBase
+  | ResourceCanonicalMeta
+  | ResourceCanonicalMetaBase
   | ResourceData
-  | ResourceDataMeta
-  | ResourceDataMetaBase
   | ResourceId
   | ResourceKind
   | ResourceMap
-  | ResourceMapPointer
   | ResourceMeta
   | ResourcePotentialInput
   | ResourcePotentialOutput
   | ResourceSocket
-  | ResourceStoragePointer
   | RoleBindingMap
   | RoleBindingsInner
   | RoleBindingsOuter1
@@ -308,30 +308,30 @@ export type ResourceBase = Identifiable & {
  * via the `definition` "TypeId".
  */
 export type TypeId = `TYPE-${string}`;
+export type ResourceCanonicalMeta = ResourceBase &
+  ResourceKind & {
+    kind: "realized";
+} & Path &
+  Timestamp;
+/**
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
+ * via the `definition` "ResourceCanonicalMetaBase".
+ */
+export type ResourceCanonicalMetaBase = ResourceBase &
+  ResourceKind & {
+    kind: "realized";
+} & Path &
+  Timestamp;
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "ResourceData".
  */
-export type ResourceData = ResourceDataMetaBase & {
+export type ResourceData = ResourceCanonicalMetaBase & {
   extractedData: {
     identity: string | number | boolean;
     [k: string]: JsonValue;
   };
 };
-/**
- * This interface was referenced by `GenesisJson`'s JSON-Schema
- * via the `definition` "ResourceDataMetaBase".
- */
-export type ResourceDataMetaBase = ResourceBase &
-  ResourceKind & {
-    kind: "realized";
-} & Path &
-  Timestamp;
-export type ResourceDataMeta = ResourceBase &
-  ResourceKind & {
-    kind: "realized";
-} & Path &
-  Timestamp;
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "ResourcePotentialInput".
@@ -339,7 +339,7 @@ export type ResourceDataMeta = ResourceBase &
 export type ResourcePotentialInput = ResourceBase &
   ResourceKind & {
     kind: "potential-input";
-} & ResourceMapPointer;
+} & PendingRef;
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "ResourcePotentialOutput".
@@ -352,7 +352,7 @@ export type ResourcePotentialOutput = ResourceBase &
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "ResourceMeta".
  */
-export type ResourceMeta = ResourceBase & ResourceStoragePointer & Timestamp;
+export type ResourceMeta = ResourceBase & CanonicalRef & Timestamp;
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "RoleLiteral".
@@ -434,9 +434,9 @@ export type WorkflowSpec = Identifiable & {
 export type WorkflowSpecId = `WORKFLOWSPEC-${string}`;
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
- * via the `definition` "ResourceDataMeta".
+ * via the `definition` "ResourceCanonicalMeta".
  */
-export type ResourceDataMetaBase1 = ResourceBase &
+export type ResourceCanonicalMetaBase1 = ResourceBase &
   ResourceKind & {
     kind: "realized";
 } & Path &
@@ -479,6 +479,13 @@ export interface RoleBindingsInner {
  * via the `definition` "RoleBindingMap".
  */
 export type RoleBindingMap = Record<RoleId, ResourceId>;
+/**
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
+ * via the `definition` "CanonicalRef".
+ */
+export interface CanonicalRef {
+  canonicalRef: string;
+}
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "CreationContext".
@@ -584,6 +591,17 @@ export interface Job_RoleMap {
 export interface Job_Uri {
   uri: string;
 }
+/**
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
+ * via the `definition` "PendingRef".
+ */
+export interface PendingRef {
+  pendingRef: ResourceSocket1;
+}
+export interface ResourceSocket1 {
+  executionId: ExecutionId;
+  roleId: RoleId;
+}
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "ResourceKind".
@@ -603,24 +621,6 @@ export interface Timestamp {
  * via the `definition` "ResourceMap".
  */
 export type ResourceMap = Record<ExecutionId, Record<RoleId, ResourcePotential | ResourceData>>;
-/**
- * This interface was referenced by `GenesisJson`'s JSON-Schema
- * via the `definition` "ResourceMapPointer".
- */
-export interface ResourceMapPointer {
-  resourceMapPointer: ResourceSocket1;
-}
-export interface ResourceSocket1 {
-  executionId: ExecutionId;
-  roleId: RoleId;
-}
-/**
- * This interface was referenced by `GenesisJson`'s JSON-Schema
- * via the `definition` "ResourceStoragePointer".
- */
-export interface ResourceStoragePointer {
-  resourceStoragePointer: string;
-}
 /**
  * This interface was referenced by `GenesisJson`'s JSON-Schema
  * via the `definition` "RoleBindingsOuter".

package/dist/schemas/Genesis.json

@@ -45,6 +45,20 @@
             "$anchor": "BranchStepId",
             "pattern": "^BRANCHSTEP-.+$"
         },
+        "CanonicalRef": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "canonicalRef": {
+                    "$comment": "This points to the canonical resource with an identical contentHash as this one. If no such resource exists, this resource will itself be the canonical resource and point to itself (i.e. canonicalRef = id).",
+                    "$ref": "#/$defs/ResourceId"
+                }
+            },
+            "required": [
+                "canonicalRef"
+            ],
+            "$anchor": "CanonicalRef"
+        },
         "ConditionalWrapper": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "object",
@@ -545,6 +559,20 @@
             ],
             "$anchor": "Path"
         },
+        "PendingRef": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "pendingRef": {
+                    "$comment": "This points to a resource created at a previous step in the same workflow. This resource is not yet realized at the time of defining the workflow, but will be realized when the step using this resource is executed.The Engine resolves this pointer at runtime.",
+                    "$ref": "#/$defs/ResourceSocket"
+                }
+            },
+            "required": [
+                "pendingRef"
+            ],
+            "$anchor": "PendingRef"
+        },
         "ResourceBase": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "object",
@@ -578,12 +606,48 @@
             ],
             "$anchor": "ResourceBase"
         },
+        "ResourceCanonicalMeta": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "unevaluatedProperties": false,
+            "$anchor": "ResourceCanonicalMeta",
+            "$ref": "#/$defs/ResourceCanonicalMetaBase"
+        },
+        "ResourceCanonicalMetaBase": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/ResourceBase"
+                },
+                {
+                    "$ref": "#/$defs/ResourceKind"
+                },
+                {
+                    "properties": {
+                        "kind": {
+                            "const": "realized"
+                        }
+                    },
+                    "required": [
+                        "kind"
+                    ]
+                },
+                {
+                    "$ref": "#/$defs/Path"
+                },
+                {
+                    "$ref": "#/$defs/Timestamp"
+                }
+            ],
+            "$anchor": "ResourceCanonicalMetaBase"
+        },
         "ResourceData": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "object",
             "allOf": [
                 {
-                    "$ref": "#/$defs/ResourceDataMetaBase"
+                    "$ref": "#/$defs/ResourceCanonicalMetaBase"
                 },
                 {
                     "properties": {
@@ -615,42 +679,6 @@
             "unevaluatedProperties": false,
             "$anchor": "ResourceData"
         },
-        "ResourceDataMeta": {
-            "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "type": "object",
-            "unevaluatedProperties": false,
-            "$anchor": "ResourceDataMeta",
-            "$ref": "#/$defs/ResourceDataMetaBase"
-        },
-        "ResourceDataMetaBase": {
-            "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "type": "object",
-            "allOf": [
-                {
-                    "$ref": "#/$defs/ResourceBase"
-                },
-                {
-                    "$ref": "#/$defs/ResourceKind"
-                },
-                {
-                    "properties": {
-                        "kind": {
-                            "const": "realized"
-                        }
-                    },
-                    "required": [
-                        "kind"
-                    ]
-                },
-                {
-                    "$ref": "#/$defs/Path"
-                },
-                {
-                    "$ref": "#/$defs/Timestamp"
-                }
-            ],
-            "$anchor": "ResourceDataMetaBase"
-        },
         "ResourceId": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "string",
@@ -702,20 +730,6 @@
                 "$ref": "#/$defs/ExecutionId"
             }
         },
-        "ResourceMapPointer": {
-            "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "type": "object",
-            "properties": {
-                "resourceMapPointer": {
-                    "$comment": "This points to a resource created at a previous step in the same workflow. This resource is not yet realized at the time of defining the workflow, but will be realized when the step using this resource is executed.The Engine resolves this pointer at runtime.",
-                    "$ref": "#/$defs/ResourceSocket"
-                }
-            },
-            "required": [
-                "resourceMapPointer"
-            ],
-            "$anchor": "ResourceMapPointer"
-        },
         "ResourceMeta": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "object",
@@ -724,7 +738,7 @@
                     "$ref": "#/$defs/ResourceBase"
                 },
                 {
-                    "$ref": "#/$defs/ResourceStoragePointer"
+                    "$ref": "#/$defs/CanonicalRef"
                 },
                 {
                     "$ref": "#/$defs/Timestamp"
@@ -754,7 +768,7 @@
                     ]
                 },
                 {
-                    "$ref": "#/$defs/ResourceMapPointer"
+                    "$ref": "#/$defs/PendingRef"
                 }
             ],
             "unevaluatedProperties": false,
@@ -801,20 +815,6 @@
             ],
             "$anchor": "ResourceSocket"
         },
-        "ResourceStoragePointer": {
-            "$schema": "https://json-schema.org/draft/2020-12/schema",
-            "type": "object",
-            "properties": {
-                "resourceStoragePointer": {
-                    "$comment": "This points to the canonical resource with an identical contentHash as this one. If no such resource exists, this resource will itself be the canonical resource and point to itself (i.e. resourceStoragePointer = id).",
-                    "$ref": "#/$defs/ResourceId"
-                }
-            },
-            "required": [
-                "resourceStoragePointer"
-            ],
-            "$anchor": "ResourceStoragePointer"
-        },
         "RoleBindingMap": {
             "$schema": "https://json-schema.org/draft/2020-12/schema",
             "type": "object",

package/dist/scripts/generateResourceData.js

@@ -52,7 +52,7 @@ async function main() {
         title: `ResourceData_${name}`,
         type: 'object',
         allOf: [
-            { $ref: './Genesis.json#/$defs/ResourceDataMetaBase' },
+            { $ref: './Genesis.json#/$defs/ResourceCanonicalMetaBase' },
             {
                 type: 'object',
                 required: ['extractedData'],

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@toolproof-npm/schema",
-    "version": "0.1.19",
+    "version": "0.1.20",
     "description": "JSON schemas and TypeScript types for ToolProof",
     "keywords": ["toolproof", "schemas", "json-schema", "typescript"],
     "author": "ToolProof Team",