@toolproof-npm/schema 0.1.70 → 0.1.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,59 +1,59 @@
1
- # @toolproof-npm/schema
2
-
3
- JSON schemas and TypeScript types for ToolProof...
4
-
5
- ## Installation
6
-
7
- ```bash
8
- pnpm add @toolproof-npm/schema
9
- # or
10
- npm install @toolproof-npm/schema
11
- # or
12
- yarn add @toolproof-npm/schema
13
- ```
14
-
15
- ## Usage
16
-
17
- ### Import Schemas and Types
18
-
19
- ```typescript
20
- import { /* schemas and types */ } from '@toolproof-npm/schema';
21
- ```
22
-
23
- ## Features
24
-
25
- - JSON Schema definitions with $defs subschemas
26
- - Generated TypeScript types from JSON schemas
27
- - Runtime schema validation support
28
- - Extractors for non-JSON resource types
29
- - Schema bundling utilities
30
-
31
- ## Development
32
-
33
- ### Generate Types
34
-
35
- ```bash
36
- pnpm run generateTypes
37
- ```
38
-
39
- ### Build
40
-
41
- ```bash
42
- pnpm run build
43
- ```
44
-
45
- ### Update (Clean build + generate types)
46
-
47
- ```bash
48
- pnpm run update
49
- ```
50
-
51
- ## Requirements
52
-
53
- - Node.js 16+
54
- - TypeScript 4.5+ (for TypeScript projects)
55
-
56
- ## License
57
-
58
- MIT
59
-
1
+ # @toolproof-npm/schema
2
+
3
+ JSON schemas and TypeScript types for ToolProof...
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pnpm add @toolproof-npm/schema
9
+ # or
10
+ npm install @toolproof-npm/schema
11
+ # or
12
+ yarn add @toolproof-npm/schema
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ### Import Schemas and Types
18
+
19
+ ```typescript
20
+ import { /* schemas and types */ } from '@toolproof-npm/schema';
21
+ ```
22
+
23
+ ## Features
24
+
25
+ - JSON Schema definitions with $defs subschemas
26
+ - Generated TypeScript types from JSON schemas
27
+ - Runtime schema validation support
28
+ - Extractors for non-JSON resource types
29
+ - Schema bundling utilities
30
+
31
+ ## Development
32
+
33
+ ### Generate Types
34
+
35
+ ```bash
36
+ pnpm run generateTypes
37
+ ```
38
+
39
+ ### Build
40
+
41
+ ```bash
42
+ pnpm run build
43
+ ```
44
+
45
+ ### Update (Clean build + generate types)
46
+
47
+ ```bash
48
+ pnpm run update
49
+ ```
50
+
51
+ ## Requirements
52
+
53
+ - Node.js 16+
54
+ - TypeScript 4.5+ (for TypeScript projects)
55
+
56
+ ## License
57
+
58
+ MIT
59
+
@@ -200,5 +200,11 @@
200
200
  "StrategyRunIdentity",
201
201
  "StatefulStrategyIdentity",
202
202
  "StrategyRunContext"
203
+ ],
204
+ "StrategyRunUpdate": [
205
+ "StrategyRun",
206
+ "StrategyRunIdentity",
207
+ "StrategyState",
208
+ "Resource"
203
209
  ]
204
210
  }
@@ -1986,6 +1986,54 @@
1986
1986
  ],
1987
1987
  "unevaluatedProperties": false
1988
1988
  }
1989
+ },
1990
+ "StrategyRunUpdate": {
1991
+ "identity": "TYPE-StrategyRunUpdate",
1992
+ "name": "StrategyRunUpdate",
1993
+ "description": "dummy-description",
1994
+ "resourceFormatRef": "FORMAT-ApplicationJson",
1995
+ "extractionSchema": {
1996
+ "$anchor": "StrategyRunUpdate",
1997
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1998
+ "type": "object",
1999
+ "required": [
2000
+ "strategyRunRef",
2001
+ "strategyStateUpdate"
2002
+ ],
2003
+ "properties": {
2004
+ "strategyRunRef": {
2005
+ "$ref": "#/$defs/StrategyRunIdentity"
2006
+ },
2007
+ "strategyRun": {
2008
+ "$comment": "Optional embedded snapshot; strategyRunRef remains the canonical pointer.",
2009
+ "$ref": "#/$defs/StrategyRun"
2010
+ },
2011
+ "strategyStateUpdate": {
2012
+ "$comment": "A StrategyState containing exactly one ExecutionIdentity key (an update for a single execution).",
2013
+ "allOf": [
2014
+ {
2015
+ "$ref": "#/$defs/StrategyState"
2016
+ },
2017
+ {
2018
+ "type": "object",
2019
+ "minProperties": 1,
2020
+ "maxProperties": 1
2021
+ },
2022
+ {
2023
+ "$comment": "In this update bucket, only materialized Resources are allowed (no missing/potential placeholders).",
2024
+ "type": "object",
2025
+ "additionalProperties": {
2026
+ "type": "object",
2027
+ "additionalProperties": {
2028
+ "$ref": "#/$defs/Resource"
2029
+ }
2030
+ }
2031
+ }
2032
+ ]
2033
+ }
2034
+ },
2035
+ "unevaluatedProperties": false
2036
+ }
1989
2037
  }
1990
2038
  }
1991
2039
  }
@@ -2658,5 +2658,63 @@
2658
2658
  "unevaluatedProperties": false
2659
2659
  }
2660
2660
  }
2661
+ },
2662
+ "StrategyRunUpdate": {
2663
+ "identity": "RESOURCE-StrategyRunUpdate",
2664
+ "resourceTypeRef": "TYPE-ResourceType",
2665
+ "creationContext": {
2666
+ "resourceRoleRef": "ROLE-Genesis",
2667
+ "executionRef": "EXECUTION-StrategyRunUpdate"
2668
+ },
2669
+ "kind": "materialized",
2670
+ "timestamp": "2025-11-30T00:00:00.000Z",
2671
+ "extractedData": {
2672
+ "identity": "TYPE-StrategyRunUpdate",
2673
+ "name": "StrategyRunUpdate",
2674
+ "description": "dummy-description",
2675
+ "resourceFormatRef": "FORMAT-ApplicationJson",
2676
+ "extractionSchema": {
2677
+ "$anchor": "StrategyRunUpdate",
2678
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2679
+ "type": "object",
2680
+ "required": [
2681
+ "strategyRunRef",
2682
+ "strategyStateUpdate"
2683
+ ],
2684
+ "properties": {
2685
+ "strategyRunRef": {
2686
+ "$ref": "#/$defs/StrategyRunIdentity"
2687
+ },
2688
+ "strategyRun": {
2689
+ "$comment": "Optional embedded snapshot; strategyRunRef remains the canonical pointer.",
2690
+ "$ref": "#/$defs/StrategyRun"
2691
+ },
2692
+ "strategyStateUpdate": {
2693
+ "$comment": "A StrategyState containing exactly one ExecutionIdentity key (an update for a single execution).",
2694
+ "allOf": [
2695
+ {
2696
+ "$ref": "#/$defs/StrategyState"
2697
+ },
2698
+ {
2699
+ "type": "object",
2700
+ "minProperties": 1,
2701
+ "maxProperties": 1
2702
+ },
2703
+ {
2704
+ "$comment": "In this update bucket, only materialized Resources are allowed (no missing/potential placeholders).",
2705
+ "type": "object",
2706
+ "additionalProperties": {
2707
+ "type": "object",
2708
+ "additionalProperties": {
2709
+ "$ref": "#/$defs/Resource"
2710
+ }
2711
+ }
2712
+ }
2713
+ ]
2714
+ }
2715
+ },
2716
+ "unevaluatedProperties": false
2717
+ }
2718
+ }
2661
2719
  }
2662
2720
  }
@@ -1421,6 +1421,48 @@
1421
1421
  "cancelled"
1422
1422
  ]
1423
1423
  },
1424
+ "StrategyRunUpdate": {
1425
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1426
+ "type": "object",
1427
+ "properties": {
1428
+ "strategyRun": {
1429
+ "$comment": "Optional embedded snapshot; strategyRunRef remains the canonical pointer.",
1430
+ "$ref": "#/$defs/StrategyRun"
1431
+ },
1432
+ "strategyRunRef": {
1433
+ "$ref": "#/$defs/StrategyRunIdentity"
1434
+ },
1435
+ "strategyStateUpdate": {
1436
+ "allOf": [
1437
+ {
1438
+ "$ref": "#/$defs/StrategyState"
1439
+ },
1440
+ {
1441
+ "type": "object",
1442
+ "maxProperties": 1,
1443
+ "minProperties": 1
1444
+ },
1445
+ {
1446
+ "type": "object",
1447
+ "additionalProperties": {
1448
+ "type": "object",
1449
+ "additionalProperties": {
1450
+ "$ref": "#/$defs/Resource"
1451
+ }
1452
+ },
1453
+ "$comment": "In this update bucket, only materialized Resources are allowed (no missing/potential placeholders)."
1454
+ }
1455
+ ],
1456
+ "$comment": "A StrategyState containing exactly one ExecutionIdentity key (an update for a single execution)."
1457
+ }
1458
+ },
1459
+ "required": [
1460
+ "strategyRunRef",
1461
+ "strategyStateUpdate"
1462
+ ],
1463
+ "unevaluatedProperties": false,
1464
+ "$anchor": "StrategyRunUpdate"
1465
+ },
1424
1466
  "StrategyState": {
1425
1467
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1426
1468
  "type": "object",
@@ -5,5 +5,5 @@
5
5
  "ResourceMeta",
6
6
  "Job",
7
7
  "StatefulStrategy",
8
- "StrategyRun"
8
+ "StrategyRunUpdate"
9
9
  ]
@@ -59,6 +59,7 @@ export type ResourceTypeGenesis = {
59
59
  "StrategyRunContext": ResourceType;
60
60
  "StrategyRunIdentity": ResourceType;
61
61
  "StrategyRunStatus": ResourceType;
62
+ "StrategyRunUpdate": ResourceType;
62
63
  "StrategyState": ResourceType;
63
64
  "StrategyStateWrapper": ResourceType;
64
65
  "StrategyThreadIdentity": ResourceType;
@@ -368,6 +368,13 @@ export type StrategyRunIdentity =
368
368
  */
369
369
  export type StrategyRunStatus =
370
370
  "pending" | "running" | "completed" | "failed" | "cancelled";
371
+ export type StrategyRun1 =
372
+ {
373
+ identity: StrategyRunIdentity;
374
+ statefulStrategyRef: StatefulStrategyIdentity;
375
+ strategyRunContext: StrategyRunContext;
376
+ } & StrategyThreadMapWrapper &
377
+ StrategyStateWrapper1;
371
378
  /**
372
379
  * This interface was referenced by `GenesisJson`'s JSON-Schema
373
380
  * via the `definition` "StrategyThreadIdentity".
@@ -593,6 +600,20 @@ export interface StrategyThreadMap {
593
600
  export interface StrategyStateWrapper1 {
594
601
  strategyState: StrategyState;
595
602
  }
603
+ /**
604
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
605
+ * via the `definition` "StrategyRunUpdate".
606
+ */
607
+ export interface StrategyRunUpdate {
608
+ strategyRun?: StrategyRun1;
609
+ strategyRunRef: StrategyRunIdentity;
610
+ strategyStateUpdate: StrategyState & {
611
+ } & {
612
+ [k: string]: {
613
+ [k: string]: Resource;
614
+ };
615
+ };
616
+ }
596
617
  /**
597
618
  * This interface was referenced by `GenesisJson`'s JSON-Schema
598
619
  * via the `definition` "StrategyThreadMapWrapper".
package/dist/index.d.ts CHANGED
@@ -11,5 +11,5 @@ export type { Resource_StatelessStrategy as Resource_StatelessStrategyJson } fro
11
11
  export type { Resource_StatefulStrategy as Resource_StatefulStrategyJson } from './genesis/generated/types/Resource_StatefulStrategy.js';
12
12
  export type { Resource_StrategyRun as Resource_StrategyRunJson } from './genesis/generated/types/Resource_StrategyRun.js';
13
13
  export type { Documented as DocumentedJson, ResourceFormatIdentity as ResourceFormatIdentityJson, ResourceFormat as ResourceFormatJson, ExtractionSchema as ExtractionSchemaJson, IdentityProp as IdentityPropJson, MeritProp as MeritPropJson, ResourceTypeIdentity as ResourceTypeIdentityJson, ResourceType as ResourceTypeJson, ResourceRoleIdentity as ResourceRoleIdentityJson, ResourceRoleValue as ResourceRoleValueJson, ExecutionIdentity as ExecutionIdentityJson, Execution as ExecutionJson, Conditional as ConditionalJson, RoleMap as RoleMapJson, Roles as RolesJson, RoleBindingMap as RoleBindingMapJson, RoleBindings as RoleBindingsJson, ResourceIdentity as ResourceIdentityJson, WorkStepIdentity as WorkStepIdentityJson, BranchStepIdentity as BranchStepIdentityJson, WhileStepIdentity as WhileStepIdentityJson, ForStepIdentity as ForStepIdentityJson, WorkStep as WorkStepJson, BranchStep as BranchStepJson, WhileStep as WhileStepJson, ForStep as ForStepJson, Step as StepJson, CreationContext as CreationContextJson, ResourceMissing as ResourceMissingJson, ResourcePotentialInput as ResourcePotentialInputJson, ResourcePotentialOutput as ResourcePotentialOutputJson, ResourceMetaBase as ResourceMetaJson, // ATTENTION: type not generated for ResourceMeta
14
- Resource as ResourceJson, StrategyState as StrategyStateJson, StatelessStrategyIdentity as StatelessStrategyIdentityJson, StatelessStrategy as StatelessStrategyJson, StatefulStrategyIdentity as StatefulStrategyIdentityJson, StatefulStrategy as StatefulStrategyJson, StrategyRunIdentity as StrategyRunIdentityJson, StrategyRun as StrategyRunJson, JobIdentity as JobIdentityJson, Job as JobJson, JsonData as JsonDataJson, } from './genesis/generated/types/types.js';
14
+ Resource as ResourceJson, StrategyState as StrategyStateJson, StatelessStrategyIdentity as StatelessStrategyIdentityJson, StatelessStrategy as StatelessStrategyJson, StatefulStrategyIdentity as StatefulStrategyIdentityJson, StatefulStrategy as StatefulStrategyJson, StrategyRunIdentity as StrategyRunIdentityJson, StrategyRunStatus as StrategyRunStatusJson, StrategyRun as StrategyRunJson, StrategyRunUpdate as StrategyRunUpdateJson, JobIdentity as JobIdentityJson, Job as JobJson, JsonData as JsonDataJson, } from './genesis/generated/types/types.js';
15
15
  export { unsafeBrand, asResourceTypeIdentity, asResourceRoleIdentity, asExecutionIdentity, asResourceIdentity, asWorkStepIdentity, asBranchStepIdentity, asForStepIdentity, asResourceFormatIdentity, asWhileStepIdentity, asStatelessStrategyIdentity, asStatefulStrategyIdentity, asResourceTypeIdentities, asResourceRoleIdentities, asExecutionIdentities, asResourceIdentities, asWorkStepIdentities, asBranchStepIdentities, asForStepIdentities, asResourceFormatIdentities, asWhileStepIdentities, asStatelessStrategyIdentities, asStatefulStrategyIdentities, } from './scripts/brandFactories.js';
package/package.json CHANGED
@@ -1,61 +1,61 @@
1
1
  {
2
- "name": "@toolproof-npm/schema",
3
- "version": "0.1.70",
4
- "description": "JSON schemas and TypeScript types for ToolProof",
5
- "keywords": [
6
- "toolproof",
7
- "schemas",
8
- "json-schema",
9
- "typescript"
10
- ],
11
- "author": "ToolProof Team",
12
- "license": "MIT",
13
- "repository": {
14
- "type": "git",
15
- "url": "https://github.com/ToolProof/core.git",
16
- "directory": "packages/_schemas"
17
- },
18
- "homepage": "https://github.com/ToolProof/core#readme",
19
- "bugs": {
20
- "url": "https://github.com/ToolProof/core/issues"
21
- },
22
- "type": "module",
23
- "main": "dist/index.js",
24
- "types": "dist/index.d.ts",
25
- "exports": {
26
- ".": {
27
- "import": "./dist/index.js",
28
- "types": "./dist/index.d.ts"
2
+ "name": "@toolproof-npm/schema",
3
+ "version": "0.1.72",
4
+ "description": "JSON schemas and TypeScript types for ToolProof",
5
+ "keywords": [
6
+ "toolproof",
7
+ "schemas",
8
+ "json-schema",
9
+ "typescript"
10
+ ],
11
+ "author": "ToolProof Team",
12
+ "license": "MIT",
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "https://github.com/ToolProof/core.git",
16
+ "directory": "packages/_schemas"
17
+ },
18
+ "homepage": "https://github.com/ToolProof/core#readme",
19
+ "bugs": {
20
+ "url": "https://github.com/ToolProof/core/issues"
21
+ },
22
+ "type": "module",
23
+ "main": "dist/index.js",
24
+ "types": "dist/index.d.ts",
25
+ "exports": {
26
+ ".": {
27
+ "import": "./dist/index.js",
28
+ "types": "./dist/index.d.ts"
29
+ }
30
+ },
31
+ "scripts": {
32
+ "build": "tsc -b",
33
+ "build:scripts": "tsc -p tsconfig.scripts.json",
34
+ "rewriteAnchors": "node ./dist/scripts/rewriteAnchors.js",
35
+ "extractSchemas": "node ./dist/scripts/extractSchemas.js",
36
+ "extractSubschema": "node ./dist/scripts/extractSubschemaWithDefs.js",
37
+ "resolveRefsInGenesisStory": "pnpm run build:scripts && node ./dist/scripts/resolveRefsInGenesisStory.js",
38
+ "generateTypes": "node ./dist/scripts/generateTypes.js",
39
+ "generateResourceTypeGenesisType": "node ./dist/scripts/generateResourceTypeGenesisType.js",
40
+ "generateResourceTypeType": "node ./dist/scripts/generateResourceTypeType.js",
41
+ "generateResourceEnvelopes": "node ./dist/scripts/generateResourceEnvelopes.js",
42
+ "generateSchemaShims": "node ./dist/scripts/generateSchemaShims.js",
43
+ "generateDependencies": "node ./dist/scripts/generateDependencies.js",
44
+ "generateDependenciesOrdered": "node ./dist/scripts/generateDependenciesOrdered.js",
45
+ "generateTerminals": "node ./dist/scripts/generateTerminals.js",
46
+ "update": "rimraf /s /q dist && pnpm run build:scripts && pnpm run rewriteAnchors && pnpm run generateResourceEnvelopes && pnpm run extractSchemas && pnpm run extractSubschema -- --name Job && pnpm run extractSubschema -- --name ResourceFormat && pnpm run extractSubschema -- --name ResourceType && pnpm run extractSubschema -- --name StatelessStrategy && pnpm run extractSubschema -- --name StatefulStrategy && pnpm run extractSubschema -- --name StrategyRun && pnpm run generateSchemaShims && pnpm run generateTypes && pnpm run generateResourceTypeType -- --name Job && pnpm run generateResourceTypeType -- --name ResourceFormat && pnpm run generateResourceTypeType -- --name ResourceType && pnpm run generateResourceTypeType -- --name StatelessStrategy && pnpm run generateResourceTypeType -- --name StatefulStrategy && pnpm run generateResourceTypeType -- --name StrategyRun && pnpm run generateResourceTypeGenesisType && pnpm run build && pnpm run generateDependencies && pnpm run generateDependenciesOrdered && pnpm run generateTerminals"
47
+ },
48
+ "files": [
49
+ "dist",
50
+ "README.md"
51
+ ],
52
+ "devDependencies": {
53
+ "@apidevtools/json-schema-ref-parser": "^14.2.1",
54
+ "@types/node": "^20.8.1",
55
+ "ajv-cli": "^5.0.0",
56
+ "ajv-formats": "^3.0.1",
57
+ "json-schema-to-typescript": "^15.0.4",
58
+ "rimraf": "^5.0.0",
59
+ "typescript": "^5.0.0"
29
60
  }
30
- },
31
- "files": [
32
- "dist",
33
- "README.md"
34
- ],
35
- "devDependencies": {
36
- "@apidevtools/json-schema-ref-parser": "^14.2.1",
37
- "@types/node": "^20.8.1",
38
- "ajv-cli": "^5.0.0",
39
- "ajv-formats": "^3.0.1",
40
- "json-schema-to-typescript": "^15.0.4",
41
- "rimraf": "^5.0.0",
42
- "typescript": "^5.0.0"
43
- },
44
- "scripts": {
45
- "build": "tsc -b",
46
- "build:scripts": "tsc -p tsconfig.scripts.json",
47
- "rewriteAnchors": "node ./dist/scripts/rewriteAnchors.js",
48
- "extractSchemas": "node ./dist/scripts/extractSchemas.js",
49
- "extractSubschema": "node ./dist/scripts/extractSubschemaWithDefs.js",
50
- "resolveRefsInGenesisStory": "pnpm run build:scripts && node ./dist/scripts/resolveRefsInGenesisStory.js",
51
- "generateTypes": "node ./dist/scripts/generateTypes.js",
52
- "generateResourceTypeGenesisType": "node ./dist/scripts/generateResourceTypeGenesisType.js",
53
- "generateResourceTypeType": "node ./dist/scripts/generateResourceTypeType.js",
54
- "generateResourceEnvelopes": "node ./dist/scripts/generateResourceEnvelopes.js",
55
- "generateSchemaShims": "node ./dist/scripts/generateSchemaShims.js",
56
- "generateDependencies": "node ./dist/scripts/generateDependencies.js",
57
- "generateDependenciesOrdered": "node ./dist/scripts/generateDependenciesOrdered.js",
58
- "generateTerminals": "node ./dist/scripts/generateTerminals.js",
59
- "update": "rimraf /s /q dist && pnpm run build:scripts && pnpm run rewriteAnchors && pnpm run generateResourceEnvelopes && pnpm run extractSchemas && pnpm run extractSubschema -- --name Job && pnpm run extractSubschema -- --name ResourceFormat && pnpm run extractSubschema -- --name ResourceType && pnpm run extractSubschema -- --name StatelessStrategy && pnpm run extractSubschema -- --name StatefulStrategy && pnpm run extractSubschema -- --name StrategyRun && pnpm run generateSchemaShims && pnpm run generateTypes && pnpm run generateResourceTypeType -- --name Job && pnpm run generateResourceTypeType -- --name ResourceFormat && pnpm run generateResourceTypeType -- --name ResourceType && pnpm run generateResourceTypeType -- --name StatelessStrategy && pnpm run generateResourceTypeType -- --name StatefulStrategy && pnpm run generateResourceTypeType -- --name StrategyRun && pnpm run generateResourceTypeGenesisType && pnpm run build && pnpm run generateDependencies && pnpm run generateDependenciesOrdered && pnpm run generateTerminals"
60
- }
61
- }
61
+ }