@toolproof-npm/schema 0.1.64 → 0.1.66
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 +59 -59
- package/dist/index.d.ts +4 -1
- package/package.json +56 -56
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/index.d.ts
CHANGED
|
@@ -5,6 +5,9 @@ export type { ResourceTypeGenesis as ResourceTypeGenesisJson } from './genesis/g
|
|
|
5
5
|
export type { Resource_ResourceFormat as Resource_ResourceFormatJson } from './genesis/generated/types/Resource_ResourceFormat.js';
|
|
6
6
|
export type { Resource_ResourceType as Resource_ResourceTypeJson } from './genesis/generated/types/Resource_ResourceType.js';
|
|
7
7
|
export type { Resource_Job as Resource_JobJson } from './genesis/generated/types/Resource_Job.js';
|
|
8
|
+
export type { Resource_StatelessStrategy as Resource_StatelessStrategyJson } from './genesis/generated/types/Resource_StatelessStrategy.js';
|
|
9
|
+
export type { Resource_StatefulStrategy as Resource_StatefulStrategyJson } from './genesis/generated/types/Resource_StatefulStrategy.js';
|
|
10
|
+
export type { Resource_StrategyRun as Resource_StrategyRunJson } from './genesis/generated/types/Resource_StrategyRun.js';
|
|
8
11
|
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
|
|
9
|
-
Resource as ResourceJson, StrategyState as StrategyStateJson, StatelessStrategyIdentity as StatelessStrategyIdentityJson, StatelessStrategy as StatelessStrategyJson, StatefulStrategyIdentity as StatefulStrategyIdentityJson, StatefulStrategy as StatefulStrategyJson, JobIdentity as JobIdentityJson, Job as JobJson, JsonData as JsonDataJson, } from './genesis/generated/types/types.js';
|
|
12
|
+
Resource as ResourceJson, StrategyState as StrategyStateJson, StatelessStrategyIdentity as StatelessStrategyIdentityJson, StatelessStrategy as StatelessStrategyJson, StatefulStrategyIdentity as StatefulStrategyIdentityJson, StatefulStrategy as StatefulStrategyJson, StrategyRun as StrategyRunJson, JobIdentity as JobIdentityJson, Job as JobJson, JsonData as JsonDataJson, } from './genesis/generated/types/types.js';
|
|
10
13
|
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,58 +1,58 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
2
|
+
"name": "@toolproof-npm/schema",
|
|
3
|
+
"version": "0.1.66",
|
|
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
|
+
"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"
|
|
44
|
+
},
|
|
45
|
+
"files": [
|
|
46
|
+
"dist",
|
|
47
|
+
"README.md"
|
|
48
|
+
],
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@apidevtools/json-schema-ref-parser": "^14.2.1",
|
|
51
|
+
"@types/node": "^20.8.1",
|
|
52
|
+
"ajv-cli": "^5.0.0",
|
|
53
|
+
"ajv-formats": "^3.0.1",
|
|
54
|
+
"json-schema-to-typescript": "^15.0.4",
|
|
55
|
+
"rimraf": "^5.0.0",
|
|
56
|
+
"typescript": "^5.0.0"
|
|
29
57
|
}
|
|
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
|
-
"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"
|
|
57
|
-
}
|
|
58
|
-
}
|
|
58
|
+
}
|