@toolproof-npm/schema 0.1.29 → 0.1.31

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.
Files changed (9) hide show
  1. package/README.md +59 -59
  2. package/dist/_lib/test.js +4 -4
  3. package/dist/_lib/types/ResourceData_Job.d.ts +1 -1
  4. package/dist/_lib/types/types.d.ts +8 -8
  5. package/dist/index.d.ts +1 -1
  6. package/dist/schemas/Genesis.json +8 -8
  7. package/dist/schemas/Job.json +3 -3
  8. package/dist/scripts/brandFactories.d.ts +2 -2
  9. package/package.json +50 -45
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
+
package/dist/_lib/test.js CHANGED
@@ -69,7 +69,7 @@ const resourceDataJobAlpha = {
69
69
  id: 'RESOURCE-1',
70
70
  resourceTypeId: 'RT-ID',
71
71
  creationContext: {
72
- resourceResourceRoleId: 'RR-ID',
72
+ resourceRoleId: 'RR-ID',
73
73
  executionId: 'EXECUTION-ID',
74
74
  },
75
75
  kind: 'realized',
@@ -83,7 +83,7 @@ const resourceDataJobAlpha2 = {
83
83
  id: 'RESOURCE-3',
84
84
  resourceTypeId: 'RT-ID',
85
85
  creationContext: {
86
- resourceResourceRoleId: 'RR-ID',
86
+ resourceRoleId: 'RR-ID',
87
87
  executionId: 'EXECUTION-ID',
88
88
  },
89
89
  kind: 'realized',
@@ -97,7 +97,7 @@ const resourceDataJobAlpha3 = {
97
97
  id: 'RESOURCE-2',
98
98
  resourceTypeId: 'RT-ID',
99
99
  creationContext: {
100
- resourceResourceRoleId: 'RR-ID',
100
+ resourceRoleId: 'RR-ID',
101
101
  executionId: 'EXECUTION-ID',
102
102
  },
103
103
  kind: 'realized',
@@ -110,7 +110,7 @@ const resourceDataJobBeta = {
110
110
  id: 'RESOURCE-4',
111
111
  resourceTypeId: 'RT-ID',
112
112
  creationContext: {
113
- resourceResourceRoleId: 'RR-ID',
113
+ resourceRoleId: 'RR-ID',
114
114
  executionId: 'EXECUTION-ID',
115
115
  },
116
116
  kind: 'realized',
package/dist/_lib/types/ResourceData_Job.d.ts CHANGED
@@ -41,7 +41,7 @@ export interface CreationContext {
41
41
  }
42
42
  export interface ResourceSocket {
43
43
  executionId: string;
44
- resourceResourceRoleId: string;
44
+ resourceRoleId: string;
45
45
  }
46
46
  export interface ResourceKind {
47
47
  kind: "potential-input" | "potential-output" | "realized";
package/dist/_lib/types/types.d.ts CHANGED
@@ -39,7 +39,7 @@ export type CombinedEntry =
39
39
  | ResourceMeta
40
40
  | ResourcePotentialInput
41
41
  | ResourcePotentialOutput
42
- | ResourceResourceRoleId
42
+ | ResourceRoleId
43
43
  | ResourceRoleValue
44
44
  | ResourceSocket
45
45
  | ResourceTypeData
@@ -74,7 +74,7 @@ export type CombinedEntry =
74
74
  | Job_RolesInner
75
75
  | Job_RoleMap
76
76
  | Job_ResourceRoleValue
77
- | Job_ResourceResourceRoleId
77
+ | Job_ResourceRoleId
78
78
  | Job_ResourceTypeId;
79
79
  /**
80
80
  * This interface was referenced by `GenesisJson`'s JSON-Schema
@@ -129,9 +129,9 @@ export type WorkStepId = string;
129
129
  export type BranchStepId = string;
130
130
  /**
131
131
  * This interface was referenced by `GenesisJson`'s JSON-Schema
132
- * via the `definition` "ResourceResourceRoleId".
132
+ * via the `definition` "ResourceRoleId".
133
133
  */
134
- export type ResourceResourceRoleId = string;
134
+ export type ResourceRoleId = string;
135
135
  /**
136
136
  * This interface was referenced by `GenesisJson`'s JSON-Schema
137
137
  * via the `definition` "Documented".
@@ -268,9 +268,9 @@ export type Job_ResourceRoleValue = {
268
268
  export type Job_ResourceTypeId = string;
269
269
  /**
270
270
  * This interface was referenced by `undefined`'s JSON-Schema
271
- * via the `definition` "ResourceResourceRoleId".
271
+ * via the `definition` "ResourceRoleId".
272
272
  */
273
- export type Job_ResourceResourceRoleId = string;
273
+ export type Job_ResourceRoleId = string;
274
274
  /**
275
275
  * This interface was referenced by `GenesisJson`'s JSON-Schema
276
276
  * via the `definition` "JsonValue".
@@ -499,7 +499,7 @@ export interface CreationContext {
499
499
  */
500
500
  export interface ResourceSocket {
501
501
  executionId: ExecutionId;
502
- resourceResourceRoleId: ResourceResourceRoleId;
502
+ resourceRoleId: ResourceRoleId;
503
503
  }
504
504
  /**
505
505
  * This interface was referenced by `GenesisJson`'s JSON-Schema
@@ -600,7 +600,7 @@ export interface PendingRef {
600
600
  }
601
601
  export interface ResourceSocket1 {
602
602
  executionId: ExecutionId;
603
- resourceResourceRoleId: ResourceResourceRoleId;
603
+ resourceRoleId: ResourceRoleId;
604
604
  }
605
605
  /**
606
606
  * This interface was referenced by `GenesisJson`'s JSON-Schema
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export { default as GenesisSchema } from './schemas/Genesis.js';
2
2
  export { default as JobSchema } from './schemas/Job.js';
3
3
  export type { ResourceData_Job as ResourceData_JobJson } from './_lib/types/ResourceData_Job.js';
4
- export type { Identifiable as IdentifiableJson, Documented as DocumentedJson, IdentifiableDocumented as IdentifiableDocumentedJson, ResourceFormatId as ResourceFormatIdJson, ResourceFormatMeta as ResourceFormatMetaJson, ResourceFormatData as ResourceFormatDataJson, ExtractionSchema as ExtractionSchemaJson, ExtractionSchemaValue as ExtractionSchemaValueJson, IdentityProp as IdentityPropJson, MeritProp as MeritPropJson, ResourceTypeId as ResourceTypeIdJson, ResourceTypeMeta as ResourceTypeMetaJson, ResourceTypeData as ResourceTypeDataJson, ResourceResourceRoleId as ResourceResourceRoleIdJson, ResourceRoleValue as ResourceRoleValueJson, ExecutionId as ExecutionIdJson, Execution as ExecutionJson, ConditionalWrapper as ConditionalWrapperJson, RoleMap as RoleMapJson, RolesOuter as RolesOuterJson, RoleBindingMap as RoleBindingMapJson, RoleBindingsOuter as RoleBindingsOuterJson, ResourceId as ResourceIdJson, WorkStepId as WorkStepIdJson, BranchStepId as BranchStepIdJson, WhileStepId as WhileStepIdJson, ForStepId as ForStepIdJson, WorkStep as WorkStepJson, BranchStep as BranchStepJson, WhileStep as WhileStepJson, ForStep as ForStepJson, StepId as StepIdJson, Step as StepJson, ResourceSocket as ResourceSocketJson, ResourcePotentialInput as ResourcePotentialInputJson, ResourcePotentialOutput as ResourcePotentialOutputJson, ResourceMeta as ResourceMetaJson, ResourceData as ResourceDataJson, ResourceMap as ResourceMapJson, WorkflowId as WorkflowIdJson, Workflow as WorkflowJson, WorkflowSpecId as WorkflowSpecIdJson, WorkflowSpec as WorkflowSpecJson, Job as JobJson, JsonValue as JsonValueJson, } from './_lib/types/types.js';
4
+ export type { Identifiable as IdentifiableJson, Documented as DocumentedJson, IdentifiableDocumented as IdentifiableDocumentedJson, ResourceFormatId as ResourceFormatIdJson, ResourceFormatMeta as ResourceFormatMetaJson, ResourceFormatData as ResourceFormatDataJson, ExtractionSchema as ExtractionSchemaJson, ExtractionSchemaValue as ExtractionSchemaValueJson, IdentityProp as IdentityPropJson, MeritProp as MeritPropJson, ResourceTypeId as ResourceTypeIdJson, ResourceTypeMeta as ResourceTypeMetaJson, ResourceTypeData as ResourceTypeDataJson, ResourceRoleId as ResourceRoleIdJson, ResourceRoleValue as ResourceRoleValueJson, ExecutionId as ExecutionIdJson, Execution as ExecutionJson, ConditionalWrapper as ConditionalWrapperJson, RoleMap as RoleMapJson, RolesOuter as RolesOuterJson, RoleBindingMap as RoleBindingMapJson, RoleBindingsOuter as RoleBindingsOuterJson, ResourceId as ResourceIdJson, WorkStepId as WorkStepIdJson, BranchStepId as BranchStepIdJson, WhileStepId as WhileStepIdJson, ForStepId as ForStepIdJson, WorkStep as WorkStepJson, BranchStep as BranchStepJson, WhileStep as WhileStepJson, ForStep as ForStepJson, StepId as StepIdJson, Step as StepJson, ResourceSocket as ResourceSocketJson, ResourcePotentialInput as ResourcePotentialInputJson, ResourcePotentialOutput as ResourcePotentialOutputJson, ResourceMeta as ResourceMetaJson, ResourceData as ResourceDataJson, ResourceMap as ResourceMapJson, WorkflowId as WorkflowIdJson, Workflow as WorkflowJson, WorkflowSpecId as WorkflowSpecIdJson, WorkflowSpec as WorkflowSpecJson, Job as JobJson, JsonValue as JsonValueJson, } from './_lib/types/types.js';
5
5
  export { unsafeBrand, asResourceTypeId, asResourceRoleId, asExecutionId, asResourceId, asWorkStepId, asBranchStepId, asForStepId, asResourceFormatId, asWhileStepId, asWorkflowId, asWorkflowSpecId, asResourceTypeIds, asResourceRoleIds, asExecutionIds, asResourceIds, asWorkStepIds, asBranchStepIds, asForStepIds, asResourceFormatIds, asWhileStepIds, asWorkflowIds, asWorkflowSpecIds, } from './scripts/brandFactories.js';
package/dist/schemas/Genesis.json CHANGED
@@ -722,7 +722,7 @@
722
722
  ]
723
723
  },
724
724
  "propertyNames": {
725
- "$ref": "#/$defs/ResourceResourceRoleId"
725
+ "$ref": "#/$defs/ResourceRoleId"
726
726
  }
727
727
  },
728
728
  "$anchor": "ResourceMap",
@@ -798,10 +798,10 @@
798
798
  "unevaluatedProperties": false,
799
799
  "$anchor": "ResourcePotentialOutput"
800
800
  },
801
- "ResourceResourceRoleId": {
801
+ "ResourceRoleId": {
802
802
  "$schema": "https://json-schema.org/draft/2020-12/schema",
803
803
  "type": "string",
804
- "$anchor": "ResourceResourceRoleId",
804
+ "$anchor": "ResourceRoleId",
805
805
  "pattern": "^RR-.+$"
806
806
  },
807
807
  "ResourceRoleValue": {
@@ -831,12 +831,12 @@
831
831
  "executionId": {
832
832
  "$ref": "#/$defs/ExecutionId"
833
833
  },
834
- "resourceResourceRoleId": {
835
- "$ref": "#/$defs/ResourceResourceRoleId"
834
+ "resourceRoleId": {
835
+ "$ref": "#/$defs/ResourceRoleId"
836
836
  }
837
837
  },
838
838
  "required": [
839
- "resourceResourceRoleId",
839
+ "resourceRoleId",
840
840
  "executionId"
841
841
  ],
842
842
  "$anchor": "ResourceSocket"
@@ -900,7 +900,7 @@
900
900
  },
901
901
  "$anchor": "RoleBindingMap",
902
902
  "propertyNames": {
903
- "$ref": "#/$defs/ResourceResourceRoleId"
903
+ "$ref": "#/$defs/ResourceRoleId"
904
904
  }
905
905
  },
906
906
  "RoleBindingsInner": {
@@ -942,7 +942,7 @@
942
942
  },
943
943
  "$anchor": "RoleMap",
944
944
  "propertyNames": {
945
- "$ref": "#/$defs/ResourceResourceRoleId"
945
+ "$ref": "#/$defs/ResourceRoleId"
946
946
  }
947
947
  },
948
948
  "RolesInner": {
package/dist/schemas/Job.json CHANGED
@@ -122,7 +122,7 @@
122
122
  },
123
123
  "$anchor": "RoleMap",
124
124
  "propertyNames": {
125
- "$ref": "#/$defs/ResourceResourceRoleId"
125
+ "$ref": "#/$defs/ResourceRoleId"
126
126
  }
127
127
  },
128
128
  "ResourceRoleValue": {
@@ -145,10 +145,10 @@
145
145
  ],
146
146
  "$anchor": "ResourceRoleValue"
147
147
  },
148
- "ResourceResourceRoleId": {
148
+ "ResourceRoleId": {
149
149
  "$schema": "https://json-schema.org/draft/2020-12/schema",
150
150
  "type": "string",
151
- "$anchor": "ResourceResourceRoleId",
151
+ "$anchor": "ResourceRoleId",
152
152
  "pattern": "^RR-.+$"
153
153
  },
154
154
  "ResourceTypeId": {
package/dist/scripts/brandFactories.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { ExecutionId, ResourceId, WorkStepId, BranchStepId, ForStepId, ResourceFormatId, ResourceTypeId, ResourceResourceRoleId, WhileStepId, WorkflowId, WorkflowSpecId } from "../_lib/types/types.js";
1
+ import type { ExecutionId, ResourceId, WorkStepId, BranchStepId, ForStepId, ResourceFormatId, ResourceTypeId, ResourceRoleId, WhileStepId, WorkflowId, WorkflowSpecId } from "../_lib/types/types.js";
2
2
  /** Generic unsafe brand helper when a bespoke factory is not available. */
3
3
  export declare function unsafeBrand<T extends string>(s: string): T;
4
4
  export declare const asResourceTypeId: (s: string) => string;
@@ -13,7 +13,7 @@ export declare const asWhileStepId: (s: string) => string;
13
13
  export declare const asWorkflowId: (s: string) => string;
14
14
  export declare const asWorkflowSpecId: (s: string) => string;
15
15
  export declare const asResourceTypeIds: (xs: string[]) => ResourceTypeId[];
16
- export declare const asResourceRoleIds: (xs: string[]) => ResourceResourceRoleId[];
16
+ export declare const asResourceRoleIds: (xs: string[]) => ResourceRoleId[];
17
17
  export declare const asExecutionIds: (xs: string[]) => ExecutionId[];
18
18
  export declare const asResourceIds: (xs: string[]) => ResourceId[];
19
19
  export declare const asWorkStepIds: (xs: string[]) => WorkStepId[];
package/package.json CHANGED
@@ -1,48 +1,53 @@
1
1
  {
2
- "name": "@toolproof-npm/schema",
3
- "version": "0.1.29",
4
- "description": "JSON schemas and TypeScript types for ToolProof",
5
- "keywords": ["toolproof", "schemas", "json-schema", "typescript"],
6
- "author": "ToolProof Team",
7
- "license": "MIT",
8
- "repository": {
9
- "type": "git",
10
- "url": "https://github.com/ToolProof/core.git",
11
- "directory": "packages/_schemas"
12
- },
13
- "homepage": "https://github.com/ToolProof/core#readme",
14
- "bugs": {
15
- "url": "https://github.com/ToolProof/core/issues"
16
- },
17
- "type": "module",
18
- "main": "dist/index.js",
19
- "types": "dist/index.d.ts",
20
- "exports": {
21
- ".": {
22
- "import": "./dist/index.js",
23
- "types": "./dist/index.d.ts"
24
- }
25
- },
26
- "scripts": {
27
- "build": "tsc -b",
28
- "build:scripts": "tsc -p tsconfig.scripts.json",
29
- "extractSchemas": "node ./dist/scripts/extractSchemas.js",
30
- "extractSubschema": "node ./dist/scripts/extractSubschemaWithDefs.js",
31
- "generateTypes": "node ./dist/scripts/generateTypes.js",
32
- "generateResourceData": "node ./dist/scripts/generateResourceData.js",
33
- "update": "rimraf /s /q dist && pnpm run build:scripts && pnpm run extractSchemas -- --in src/genesis/Genesis.json --out src/schemas/Genesis.json --id 'https://schemas.toolproof.com/v0/Genesis.json' && pnpm run extractSubschema -- --name Job && pnpm run generateTypes && pnpm run generateResourceData -- --name Job && pnpm run build"
34
- },
35
- "files": [
36
- "dist",
37
- "README.md"
38
- ],
39
- "devDependencies": {
40
- "@apidevtools/json-schema-ref-parser": "^14.2.1",
41
- "@types/node": "^20.8.1",
42
- "ajv-cli": "^5.0.0",
43
- "ajv-formats": "^3.0.1",
44
- "json-schema-to-typescript": "^15.0.4",
45
- "rimraf": "^5.0.0",
46
- "typescript": "^5.0.0"
2
+ "name": "@toolproof-npm/schema",
3
+ "version": "0.1.31",
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"
47
29
  }
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
+ "extractSchemas": "node ./dist/scripts/extractSchemas.js",
48
+ "extractSubschema": "node ./dist/scripts/extractSubschemaWithDefs.js",
49
+ "generateTypes": "node ./dist/scripts/generateTypes.js",
50
+ "generateResourceData": "node ./dist/scripts/generateResourceData.js",
51
+ "update": "rimraf /s /q dist && pnpm run build:scripts && pnpm run extractSchemas -- --in src/genesis/Genesis.json --out src/schemas/Genesis.json --id 'https://schemas.toolproof.com/v0/Genesis.json' && pnpm run extractSubschema -- --name Job && pnpm run generateTypes && pnpm run generateResourceData -- --name Job && pnpm run build"
52
+ }
48
53
  }