@open-agent-toolkit/cli 0.2.4 → 0.2.6
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/assets/docs/cli-utilities/configuration.md +40 -0
- package/assets/docs/cli-utilities/tool-packs.md +31 -0
- package/assets/docs/workflows/projects/artifacts.md +27 -0
- package/assets/docs/workflows/projects/implementation-execution.md +30 -5
- package/assets/docs/workflows/skills/explainer-kit.md +125 -0
- package/assets/docs/workflows/skills/index.md +4 -0
- package/assets/migration/pjm-restructure.md +12 -0
- package/assets/public-package-versions.json +4 -4
- package/assets/skills/explainer-kit/SKILL.md +95 -0
- package/assets/skills/explainer-kit/examples/project-explainer/content.md +31 -0
- package/assets/skills/explainer-kit/examples/project-explainer/fact-base.md +22 -0
- package/assets/skills/explainer-kit/examples/project-recap/content.md +34 -0
- package/assets/skills/explainer-kit/examples/project-recap/fact-base.md +22 -0
- package/assets/skills/explainer-kit/examples/theme-bundle.json +87 -0
- package/assets/skills/explainer-kit/palettes/ember.json +37 -0
- package/assets/skills/explainer-kit/palettes/forest.json +37 -0
- package/assets/skills/explainer-kit/palettes/neutral.json +37 -0
- package/assets/skills/explainer-kit/palettes/ocean.json +37 -0
- package/assets/skills/explainer-kit/palettes/violet.json +37 -0
- package/assets/skills/explainer-kit/profiles/clean.json +42 -0
- package/assets/skills/explainer-kit/profiles/editorial.json +42 -0
- package/assets/skills/explainer-kit/profiles/technical.json +39 -0
- package/assets/skills/explainer-kit/recipes/engineer-tour.json +33 -0
- package/assets/skills/explainer-kit/recipes/program-recap.json +34 -0
- package/assets/skills/explainer-kit/recipes/project-explainer.json +33 -0
- package/assets/skills/explainer-kit/recipes/project-recap.json +34 -0
- package/assets/skills/explainer-kit/references/contracts.md +101 -0
- package/assets/skills/explainer-kit/references/destination-contract.md +94 -0
- package/assets/skills/explainer-kit/references/extension-contract.md +71 -0
- package/assets/skills/explainer-kit/references/fact-base-contract.md +119 -0
- package/assets/skills/explainer-kit/schemas/build-record.schema.json +92 -0
- package/assets/skills/explainer-kit/schemas/durability-evidence.schema.json +53 -0
- package/assets/skills/explainer-kit/schemas/fact-base.schema.json +129 -0
- package/assets/skills/explainer-kit/schemas/manifest.schema.json +193 -0
- package/assets/skills/explainer-kit/schemas/publish-receipt.schema.json +97 -0
- package/assets/skills/explainer-kit/schemas/publish-request.schema.json +32 -0
- package/assets/skills/explainer-kit/schemas/run-request.schema.json +132 -0
- package/assets/skills/explainer-kit/schemas/theme.schema.json +217 -0
- package/assets/skills/explainer-kit/scripts/lib/content-approval.mjs +180 -0
- package/assets/skills/explainer-kit/scripts/lib/contracts.mjs +680 -0
- package/assets/skills/explainer-kit/scripts/lib/durability.mjs +538 -0
- package/assets/skills/explainer-kit/scripts/lib/fact-base.mjs +494 -0
- package/assets/skills/explainer-kit/scripts/lib/fs-safe.mjs +218 -0
- package/assets/skills/explainer-kit/scripts/lib/qa.mjs +512 -0
- package/assets/skills/explainer-kit/scripts/lib/recipes.mjs +289 -0
- package/assets/skills/explainer-kit/scripts/lib/records.mjs +231 -0
- package/assets/skills/explainer-kit/scripts/lib/render.mjs +485 -0
- package/assets/skills/explainer-kit/scripts/lib/s3-static.mjs +587 -0
- package/assets/skills/explainer-kit/scripts/lib/safe-paths.mjs +96 -0
- package/assets/skills/explainer-kit/scripts/lib/theme.mjs +332 -0
- package/assets/skills/explainer-kit/scripts/publish.mjs +76 -0
- package/assets/skills/explainer-kit/scripts/record-durability.mjs +64 -0
- package/assets/skills/explainer-kit/scripts/render-qa.mjs +273 -0
- package/assets/skills/explainer-kit/scripts/run.mjs +778 -0
- package/assets/skills/explainer-kit/scripts/validate.mjs +59 -0
- package/assets/skills/explainer-kit/templates/deck-shell.html +233 -0
- package/assets/skills/explainer-kit/templates/diagram-shell.html +219 -0
- package/assets/skills/explainer-kit/templates/engineer-tour.html +273 -0
- package/assets/skills/explainer-kit/templates/house-style.html +218 -0
- package/assets/skills/oat-explainer-kit/SKILL.md +92 -0
- package/assets/skills/oat-explainer-kit/references/config-contract.md +67 -0
- package/assets/skills/oat-explainer-kit/references/lifecycle-contract.md +143 -0
- package/assets/skills/oat-explainer-kit/references/migration.md +143 -0
- package/assets/skills/oat-explainer-kit/scripts/bind-project-sources.mjs +103 -0
- package/assets/skills/oat-explainer-kit/scripts/check-core.mjs +127 -0
- package/assets/skills/oat-explainer-kit/scripts/finalize-tracked-run.mjs +392 -0
- package/assets/skills/oat-explainer-kit/scripts/persist-intent.mjs +130 -0
- package/assets/skills/oat-explainer-kit/scripts/resolve-config.mjs +293 -0
- package/assets/skills/oat-explainer-kit/scripts/resolve-intent.mjs +209 -0
- package/assets/skills/oat-explainer-kit/scripts/resolve-paths.mjs +166 -0
- package/assets/skills/oat-explainer-kit/scripts/run.mjs +284 -0
- package/assets/skills/oat-project-autonomous/SKILL.md +22 -1
- package/assets/skills/oat-project-autonomous/references/gate-inventory.md +5 -1
- package/assets/skills/oat-project-complete/SKILL.md +166 -28
- package/assets/skills/oat-project-document/references/docs/autonomy-contract.md +5 -1
- package/assets/skills/oat-project-implement/SKILL.md +1 -1
- package/assets/skills/oat-project-implement/references/completion-and-closeout.md +84 -9
- package/assets/skills/oat-project-implement/references/docs/autonomy-contract.md +5 -1
- package/assets/skills/oat-project-next/SKILL.md +31 -11
- package/assets/skills/oat-project-plan/SKILL.md +30 -1
- package/assets/skills/oat-project-pr-final/references/docs/autonomy-contract.md +5 -1
- package/assets/skills/oat-project-quick-start/references/docs/autonomy-contract.md +5 -1
- package/assets/skills/oat-project-summary/SKILL.md +20 -1
- package/assets/templates/state.md +4 -1
- package/dist/commands/config/index.d.ts.map +1 -1
- package/dist/commands/config/index.js +232 -1
- package/dist/commands/init/tools/shared/skill-manifest.d.ts +2 -2
- package/dist/commands/init/tools/shared/skill-manifest.d.ts.map +1 -1
- package/dist/commands/init/tools/shared/skill-manifest.js +2 -0
- package/dist/commands/project/archive/archive-utils.d.ts +12 -0
- package/dist/commands/project/archive/archive-utils.d.ts.map +1 -1
- package/dist/commands/project/archive/archive-utils.js +320 -8
- package/dist/commands/project/archive/index.d.ts.map +1 -1
- package/dist/commands/project/archive/index.js +1 -0
- package/dist/commands/project/archive/push-runner.d.ts +1 -0
- package/dist/commands/project/archive/push-runner.d.ts.map +1 -1
- package/dist/commands/project/archive/push-runner.js +9 -2
- package/dist/config/oat-config.d.ts +26 -0
- package/dist/config/oat-config.d.ts.map +1 -1
- package/dist/config/oat-config.js +88 -0
- package/dist/config/resolve.d.ts.map +1 -1
- package/dist/config/resolve.js +18 -0
- package/dist/validation/project-state.d.ts +3 -0
- package/dist/validation/project-state.d.ts.map +1 -1
- package/dist/validation/project-state.js +91 -0
- package/package.json +2 -2
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "explainer-kit.manifest/v1",
|
|
4
|
+
"title": "ArtifactManifestV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"runId",
|
|
10
|
+
"slug",
|
|
11
|
+
"recipe",
|
|
12
|
+
"createdAt",
|
|
13
|
+
"source",
|
|
14
|
+
"theme",
|
|
15
|
+
"artifacts",
|
|
16
|
+
"immutableHashes",
|
|
17
|
+
"outcome",
|
|
18
|
+
"buildRecord",
|
|
19
|
+
"warnings"
|
|
20
|
+
],
|
|
21
|
+
"properties": {
|
|
22
|
+
"schemaVersion": { "const": "explainer-kit.manifest/v1" },
|
|
23
|
+
"runId": { "type": "string", "minLength": 1 },
|
|
24
|
+
"slug": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
|
|
27
|
+
},
|
|
28
|
+
"recipe": {
|
|
29
|
+
"type": "object",
|
|
30
|
+
"additionalProperties": false,
|
|
31
|
+
"required": ["id", "version"],
|
|
32
|
+
"properties": {
|
|
33
|
+
"id": { "type": "string", "minLength": 1 },
|
|
34
|
+
"version": { "type": "string", "minLength": 1 }
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"createdAt": { "type": "string", "format": "date-time" },
|
|
38
|
+
"source": {
|
|
39
|
+
"type": "object",
|
|
40
|
+
"additionalProperties": false,
|
|
41
|
+
"required": ["factBasePath", "factBaseHash", "inputHashes"],
|
|
42
|
+
"properties": {
|
|
43
|
+
"factBasePath": { "$ref": "#/$defs/safeRelativePath" },
|
|
44
|
+
"factBaseHash": { "$ref": "#/$defs/hash" },
|
|
45
|
+
"sourceRevision": { "type": "string", "minLength": 1 },
|
|
46
|
+
"inputHashes": { "$ref": "#/$defs/hashMap" }
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"theme": {
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": false,
|
|
52
|
+
"required": ["path", "hash", "derived"],
|
|
53
|
+
"properties": {
|
|
54
|
+
"path": { "const": "theme.resolved.json" },
|
|
55
|
+
"hash": { "$ref": "#/$defs/hash" },
|
|
56
|
+
"derived": { "type": "boolean" }
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"artifacts": {
|
|
60
|
+
"type": "array",
|
|
61
|
+
"items": { "$ref": "#/$defs/artifactEntry" },
|
|
62
|
+
"uniqueItems": true
|
|
63
|
+
},
|
|
64
|
+
"immutableHashes": { "$ref": "#/$defs/hashMap" },
|
|
65
|
+
"outcome": {
|
|
66
|
+
"enum": ["built-durable", "built-not-durable", "failed", "incomplete"]
|
|
67
|
+
},
|
|
68
|
+
"buildRecord": {
|
|
69
|
+
"type": "object",
|
|
70
|
+
"additionalProperties": false,
|
|
71
|
+
"required": ["path", "hash"],
|
|
72
|
+
"properties": {
|
|
73
|
+
"path": { "const": "build-record.json" },
|
|
74
|
+
"hash": { "$ref": "#/$defs/hash" }
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
"publishReceipt": {
|
|
78
|
+
"type": "object",
|
|
79
|
+
"additionalProperties": false,
|
|
80
|
+
"required": ["path", "hash"],
|
|
81
|
+
"properties": {
|
|
82
|
+
"path": { "const": "publish-receipt.json" },
|
|
83
|
+
"hash": { "$ref": "#/$defs/hash" }
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"warnings": {
|
|
87
|
+
"type": "array",
|
|
88
|
+
"items": { "type": "string", "minLength": 1 }
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
"$defs": {
|
|
92
|
+
"hash": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"pattern": "^sha256:[a-f0-9]{64}$"
|
|
95
|
+
},
|
|
96
|
+
"safeRelativePath": {
|
|
97
|
+
"type": "string",
|
|
98
|
+
"minLength": 1,
|
|
99
|
+
"pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
|
|
100
|
+
},
|
|
101
|
+
"hashMap": {
|
|
102
|
+
"type": "object",
|
|
103
|
+
"propertyNames": { "$ref": "#/$defs/safeRelativePath" },
|
|
104
|
+
"additionalProperties": { "$ref": "#/$defs/hash" }
|
|
105
|
+
},
|
|
106
|
+
"failure": {
|
|
107
|
+
"type": "object",
|
|
108
|
+
"additionalProperties": false,
|
|
109
|
+
"required": ["code", "message", "recovery"],
|
|
110
|
+
"properties": {
|
|
111
|
+
"code": { "type": "string", "minLength": 1 },
|
|
112
|
+
"message": { "type": "string", "minLength": 1 },
|
|
113
|
+
"recovery": {
|
|
114
|
+
"type": "array",
|
|
115
|
+
"items": { "type": "string", "minLength": 1 },
|
|
116
|
+
"minItems": 1
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
"durableEvidence": {
|
|
121
|
+
"type": "object",
|
|
122
|
+
"additionalProperties": false,
|
|
123
|
+
"required": ["kind", "ref", "paths", "attestedAt"],
|
|
124
|
+
"properties": {
|
|
125
|
+
"kind": { "enum": ["commit", "publish"] },
|
|
126
|
+
"ref": { "type": "string", "minLength": 1 },
|
|
127
|
+
"paths": {
|
|
128
|
+
"type": "array",
|
|
129
|
+
"items": { "$ref": "#/$defs/safeRelativePath" },
|
|
130
|
+
"minItems": 1,
|
|
131
|
+
"uniqueItems": true
|
|
132
|
+
},
|
|
133
|
+
"attestedAt": { "type": "string", "format": "date-time" },
|
|
134
|
+
"supersedes": {
|
|
135
|
+
"type": "object",
|
|
136
|
+
"additionalProperties": false,
|
|
137
|
+
"required": ["ref", "paths"],
|
|
138
|
+
"properties": {
|
|
139
|
+
"ref": { "type": "string", "minLength": 1 },
|
|
140
|
+
"paths": {
|
|
141
|
+
"type": "array",
|
|
142
|
+
"items": { "$ref": "#/$defs/safeRelativePath" },
|
|
143
|
+
"minItems": 1,
|
|
144
|
+
"uniqueItems": true
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
"rebuild": {
|
|
151
|
+
"type": "object",
|
|
152
|
+
"additionalProperties": false,
|
|
153
|
+
"required": ["argv", "cwd", "inputHashes"],
|
|
154
|
+
"properties": {
|
|
155
|
+
"argv": {
|
|
156
|
+
"type": "array",
|
|
157
|
+
"items": { "type": "string" },
|
|
158
|
+
"minItems": 1
|
|
159
|
+
},
|
|
160
|
+
"cwd": { "type": "string", "minLength": 1 },
|
|
161
|
+
"inputHashes": { "$ref": "#/$defs/hashMap" }
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"artifactEntry": {
|
|
165
|
+
"type": "object",
|
|
166
|
+
"additionalProperties": false,
|
|
167
|
+
"required": ["id", "type", "contentPath", "status", "rebuildable"],
|
|
168
|
+
"properties": {
|
|
169
|
+
"id": { "type": "string", "minLength": 1 },
|
|
170
|
+
"type": { "enum": ["hub", "diagram", "explainer", "deck", "catalog"] },
|
|
171
|
+
"contentPath": { "$ref": "#/$defs/safeRelativePath" },
|
|
172
|
+
"renderedPath": {
|
|
173
|
+
"allOf": [
|
|
174
|
+
{ "$ref": "#/$defs/safeRelativePath" },
|
|
175
|
+
{ "pattern": "^site/" }
|
|
176
|
+
],
|
|
177
|
+
"pattern": "^site/"
|
|
178
|
+
},
|
|
179
|
+
"mediaType": { "type": "string", "minLength": 1 },
|
|
180
|
+
"status": { "enum": ["built", "failed", "skipped"] },
|
|
181
|
+
"hash": { "$ref": "#/$defs/hash" },
|
|
182
|
+
"rebuildable": { "type": "boolean" },
|
|
183
|
+
"rebuild": { "$ref": "#/$defs/rebuild" },
|
|
184
|
+
"durableEvidence": {
|
|
185
|
+
"type": "array",
|
|
186
|
+
"items": { "$ref": "#/$defs/durableEvidence" },
|
|
187
|
+
"uniqueItems": true
|
|
188
|
+
},
|
|
189
|
+
"failure": { "$ref": "#/$defs/failure" }
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "explainer-kit.publish-receipt/v1",
|
|
4
|
+
"title": "PublishReceiptV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"provider",
|
|
10
|
+
"publishedAt",
|
|
11
|
+
"roots",
|
|
12
|
+
"sentinel",
|
|
13
|
+
"artifacts"
|
|
14
|
+
],
|
|
15
|
+
"properties": {
|
|
16
|
+
"schemaVersion": { "const": "explainer-kit.publish-receipt/v1" },
|
|
17
|
+
"provider": { "const": "s3-static" },
|
|
18
|
+
"publishedAt": { "type": "string", "format": "date-time" },
|
|
19
|
+
"roots": {
|
|
20
|
+
"type": "object",
|
|
21
|
+
"additionalProperties": false,
|
|
22
|
+
"required": ["s3Uri", "publicBaseUrl"],
|
|
23
|
+
"properties": {
|
|
24
|
+
"s3Uri": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"pattern": "^s3://[^/\\s]+(?:/[^\\s]*)?$"
|
|
27
|
+
},
|
|
28
|
+
"publicBaseUrl": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"pattern": "^https://[^\\s]+$"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"sentinel": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"additionalProperties": false,
|
|
37
|
+
"required": [
|
|
38
|
+
"relativePath",
|
|
39
|
+
"uploadVerified",
|
|
40
|
+
"publicVerified",
|
|
41
|
+
"deleted"
|
|
42
|
+
],
|
|
43
|
+
"properties": {
|
|
44
|
+
"relativePath": { "$ref": "#/$defs/safeRelativePath" },
|
|
45
|
+
"uploadVerified": { "type": "boolean" },
|
|
46
|
+
"publicVerified": { "type": "boolean" },
|
|
47
|
+
"deleted": { "type": "boolean" }
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"artifacts": {
|
|
51
|
+
"type": "array",
|
|
52
|
+
"items": { "$ref": "#/$defs/artifact" },
|
|
53
|
+
"uniqueItems": true
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
"$defs": {
|
|
57
|
+
"hash": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"pattern": "^sha256:[a-f0-9]{64}$"
|
|
60
|
+
},
|
|
61
|
+
"safeRelativePath": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"minLength": 1,
|
|
64
|
+
"pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
|
|
65
|
+
},
|
|
66
|
+
"artifact": {
|
|
67
|
+
"type": "object",
|
|
68
|
+
"additionalProperties": false,
|
|
69
|
+
"required": [
|
|
70
|
+
"relativePath",
|
|
71
|
+
"hash",
|
|
72
|
+
"s3Uri",
|
|
73
|
+
"publicUrl",
|
|
74
|
+
"httpStatus",
|
|
75
|
+
"contentType"
|
|
76
|
+
],
|
|
77
|
+
"properties": {
|
|
78
|
+
"relativePath": { "$ref": "#/$defs/safeRelativePath" },
|
|
79
|
+
"hash": { "$ref": "#/$defs/hash" },
|
|
80
|
+
"s3Uri": {
|
|
81
|
+
"type": "string",
|
|
82
|
+
"pattern": "^s3://[^/\\s]+/.+$"
|
|
83
|
+
},
|
|
84
|
+
"publicUrl": {
|
|
85
|
+
"type": "string",
|
|
86
|
+
"pattern": "^https://[^\\s]+$"
|
|
87
|
+
},
|
|
88
|
+
"httpStatus": {
|
|
89
|
+
"type": "integer",
|
|
90
|
+
"minimum": 200,
|
|
91
|
+
"maximum": 299
|
|
92
|
+
},
|
|
93
|
+
"contentType": { "type": "string", "minLength": 1 }
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "explainer-kit.publish-request/v1",
|
|
4
|
+
"title": "S3StaticPublishRequestV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"provider",
|
|
10
|
+
"s3Uri",
|
|
11
|
+
"publicBaseUrl",
|
|
12
|
+
"awsRegion",
|
|
13
|
+
"siteRoot",
|
|
14
|
+
"manifestPath"
|
|
15
|
+
],
|
|
16
|
+
"properties": {
|
|
17
|
+
"schemaVersion": { "const": "explainer-kit.publish-request/v1" },
|
|
18
|
+
"provider": { "const": "s3-static" },
|
|
19
|
+
"s3Uri": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"pattern": "^s3://[^/\\s]+(?:/[^\\s]*)?$"
|
|
22
|
+
},
|
|
23
|
+
"publicBaseUrl": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"pattern": "^https://[^\\s]+$"
|
|
26
|
+
},
|
|
27
|
+
"awsRegion": { "type": "string", "minLength": 1 },
|
|
28
|
+
"awsProfile": { "type": "string", "minLength": 1 },
|
|
29
|
+
"siteRoot": { "type": "string", "minLength": 1 },
|
|
30
|
+
"manifestPath": { "type": "string", "minLength": 1 }
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "explainer-kit.run-request/v1",
|
|
4
|
+
"title": "ExplainerRunRequestV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"recipe",
|
|
10
|
+
"slug",
|
|
11
|
+
"outputRoot",
|
|
12
|
+
"factBase",
|
|
13
|
+
"mode"
|
|
14
|
+
],
|
|
15
|
+
"properties": {
|
|
16
|
+
"schemaVersion": {
|
|
17
|
+
"const": "explainer-kit.run-request/v1"
|
|
18
|
+
},
|
|
19
|
+
"recipe": {
|
|
20
|
+
"type": "object",
|
|
21
|
+
"additionalProperties": false,
|
|
22
|
+
"required": ["id", "version"],
|
|
23
|
+
"properties": {
|
|
24
|
+
"id": { "type": "string", "minLength": 1 },
|
|
25
|
+
"version": { "type": "string", "minLength": 1 }
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"slug": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
|
|
31
|
+
},
|
|
32
|
+
"outputRoot": { "$ref": "#/$defs/relativeOrAbsolutePath" },
|
|
33
|
+
"factBase": { "$ref": "#/$defs/factBaseBinding" },
|
|
34
|
+
"theme": { "$ref": "#/$defs/themeSelection" },
|
|
35
|
+
"publicBaseUrl": { "type": "string", "format": "uri" },
|
|
36
|
+
"durability": {
|
|
37
|
+
"type": "object",
|
|
38
|
+
"additionalProperties": false,
|
|
39
|
+
"required": ["strategy"],
|
|
40
|
+
"properties": {
|
|
41
|
+
"strategy": {
|
|
42
|
+
"enum": ["none", "commit", "publish"]
|
|
43
|
+
},
|
|
44
|
+
"publish": {
|
|
45
|
+
"$ref": "explainer-kit.publish-request/v1"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"privacy": {
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": false,
|
|
52
|
+
"required": ["retainRawArtDirection"],
|
|
53
|
+
"properties": {
|
|
54
|
+
"retainRawArtDirection": { "type": "boolean" }
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"mode": { "enum": ["interactive", "unattended"] }
|
|
58
|
+
},
|
|
59
|
+
"$defs": {
|
|
60
|
+
"relativeOrAbsolutePath": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"minLength": 1
|
|
63
|
+
},
|
|
64
|
+
"safeRelativePath": {
|
|
65
|
+
"type": "string",
|
|
66
|
+
"minLength": 1,
|
|
67
|
+
"pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
|
|
68
|
+
},
|
|
69
|
+
"sourceBinding": {
|
|
70
|
+
"type": "object",
|
|
71
|
+
"additionalProperties": false,
|
|
72
|
+
"required": ["id", "kind", "locator", "role", "sourceSetId"],
|
|
73
|
+
"properties": {
|
|
74
|
+
"id": { "type": "string", "minLength": 1 },
|
|
75
|
+
"kind": {
|
|
76
|
+
"enum": ["file", "directory", "git", "github", "session", "other"]
|
|
77
|
+
},
|
|
78
|
+
"locator": { "type": "string", "minLength": 1 },
|
|
79
|
+
"role": { "type": "string", "minLength": 1 },
|
|
80
|
+
"sourceSetId": { "type": "string", "minLength": 1 },
|
|
81
|
+
"revision": { "type": "string", "minLength": 1 },
|
|
82
|
+
"authoritativeFor": {
|
|
83
|
+
"type": "array",
|
|
84
|
+
"items": { "type": "string", "minLength": 1 },
|
|
85
|
+
"uniqueItems": true
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
"factBaseBinding": {
|
|
90
|
+
"type": "object",
|
|
91
|
+
"additionalProperties": false,
|
|
92
|
+
"required": ["mode", "freshnessPolicy"],
|
|
93
|
+
"properties": {
|
|
94
|
+
"mode": { "enum": ["supplied", "federated"] },
|
|
95
|
+
"path": { "$ref": "#/$defs/relativeOrAbsolutePath" },
|
|
96
|
+
"sources": {
|
|
97
|
+
"type": "array",
|
|
98
|
+
"items": { "$ref": "#/$defs/sourceBinding" },
|
|
99
|
+
"minItems": 1
|
|
100
|
+
},
|
|
101
|
+
"freshnessPolicy": { "const": "live-wins" }
|
|
102
|
+
},
|
|
103
|
+
"oneOf": [
|
|
104
|
+
{
|
|
105
|
+
"required": ["path"],
|
|
106
|
+
"properties": { "mode": { "const": "supplied" } }
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"required": ["sources"],
|
|
110
|
+
"properties": { "mode": { "const": "federated" } }
|
|
111
|
+
}
|
|
112
|
+
]
|
|
113
|
+
},
|
|
114
|
+
"themeSelection": {
|
|
115
|
+
"type": "object",
|
|
116
|
+
"additionalProperties": false,
|
|
117
|
+
"properties": {
|
|
118
|
+
"palette": { "type": "string", "minLength": 1 },
|
|
119
|
+
"visualProfile": { "type": "string", "minLength": 1 },
|
|
120
|
+
"suppliedBundlePath": {
|
|
121
|
+
"$ref": "#/$defs/relativeOrAbsolutePath"
|
|
122
|
+
},
|
|
123
|
+
"artDirection": { "type": "string", "minLength": 1 },
|
|
124
|
+
"defaultMode": { "enum": ["light", "dark"] },
|
|
125
|
+
"renderStrategy": {
|
|
126
|
+
"enum": ["default-only", "user-switchable"],
|
|
127
|
+
"default": "default-only"
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "explainer-kit.theme/v1",
|
|
4
|
+
"title": "ResolvedThemeV1",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"name",
|
|
10
|
+
"defaultMode",
|
|
11
|
+
"modes",
|
|
12
|
+
"provenance",
|
|
13
|
+
"typography",
|
|
14
|
+
"spacing",
|
|
15
|
+
"geometry",
|
|
16
|
+
"elevation",
|
|
17
|
+
"density",
|
|
18
|
+
"motion",
|
|
19
|
+
"diagrams",
|
|
20
|
+
"bundleHash"
|
|
21
|
+
],
|
|
22
|
+
"properties": {
|
|
23
|
+
"schemaVersion": { "const": "explainer-kit.theme/v1" },
|
|
24
|
+
"name": { "type": "string", "minLength": 1 },
|
|
25
|
+
"defaultMode": { "enum": ["light", "dark"] },
|
|
26
|
+
"modes": {
|
|
27
|
+
"type": "object",
|
|
28
|
+
"additionalProperties": false,
|
|
29
|
+
"required": ["light", "dark"],
|
|
30
|
+
"properties": {
|
|
31
|
+
"light": { "$ref": "#/$defs/colors" },
|
|
32
|
+
"dark": { "$ref": "#/$defs/colors" }
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"provenance": { "$ref": "#/$defs/provenance" },
|
|
36
|
+
"typography": {
|
|
37
|
+
"type": "object",
|
|
38
|
+
"additionalProperties": false,
|
|
39
|
+
"required": ["sans", "serif", "mono", "scale", "lineHeight"],
|
|
40
|
+
"properties": {
|
|
41
|
+
"sans": { "$ref": "#/$defs/fontList" },
|
|
42
|
+
"serif": { "$ref": "#/$defs/fontList" },
|
|
43
|
+
"mono": { "$ref": "#/$defs/fontList" },
|
|
44
|
+
"scale": { "$ref": "#/$defs/stringMap" },
|
|
45
|
+
"lineHeight": { "$ref": "#/$defs/positiveNumberMap" }
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"spacing": {
|
|
49
|
+
"type": "object",
|
|
50
|
+
"additionalProperties": false,
|
|
51
|
+
"required": ["unit", "scale"],
|
|
52
|
+
"properties": {
|
|
53
|
+
"unit": { "type": "number", "exclusiveMinimum": 0, "maximum": 64 },
|
|
54
|
+
"scale": { "$ref": "#/$defs/positiveNumberMap" }
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"geometry": {
|
|
58
|
+
"type": "object",
|
|
59
|
+
"additionalProperties": false,
|
|
60
|
+
"required": ["radius", "borderWidth"],
|
|
61
|
+
"properties": {
|
|
62
|
+
"radius": { "$ref": "#/$defs/nonNegativeNumberMap" },
|
|
63
|
+
"borderWidth": {
|
|
64
|
+
"type": "number",
|
|
65
|
+
"minimum": 0,
|
|
66
|
+
"maximum": 16
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"elevation": {
|
|
71
|
+
"type": "object",
|
|
72
|
+
"additionalProperties": false,
|
|
73
|
+
"required": ["shadows"],
|
|
74
|
+
"properties": {
|
|
75
|
+
"shadows": { "$ref": "#/$defs/stringMap" }
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"density": { "enum": ["compact", "comfortable", "spacious"] },
|
|
79
|
+
"motion": {
|
|
80
|
+
"type": "object",
|
|
81
|
+
"additionalProperties": false,
|
|
82
|
+
"required": ["enabled", "durationMs", "easing", "reducedMotion"],
|
|
83
|
+
"properties": {
|
|
84
|
+
"enabled": { "type": "boolean" },
|
|
85
|
+
"durationMs": { "$ref": "#/$defs/nonNegativeNumberMap" },
|
|
86
|
+
"easing": { "$ref": "#/$defs/stringMap" },
|
|
87
|
+
"reducedMotion": { "const": "disable-nonessential" }
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
"diagrams": {
|
|
91
|
+
"type": "object",
|
|
92
|
+
"additionalProperties": false,
|
|
93
|
+
"required": ["lineWidth", "nodeGap", "arrowStyle", "labelTreatment"],
|
|
94
|
+
"properties": {
|
|
95
|
+
"lineWidth": {
|
|
96
|
+
"type": "number",
|
|
97
|
+
"exclusiveMinimum": 0,
|
|
98
|
+
"maximum": 16
|
|
99
|
+
},
|
|
100
|
+
"nodeGap": {
|
|
101
|
+
"type": "number",
|
|
102
|
+
"exclusiveMinimum": 0,
|
|
103
|
+
"maximum": 512
|
|
104
|
+
},
|
|
105
|
+
"arrowStyle": { "enum": ["straight", "curved"] },
|
|
106
|
+
"labelTreatment": { "enum": ["inline", "boxed"] }
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"bundleHash": {
|
|
110
|
+
"$ref": "#/$defs/hash",
|
|
111
|
+
"pattern": "^sha256:[a-f0-9]{64}$"
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"$defs": {
|
|
115
|
+
"hash": {
|
|
116
|
+
"type": "string",
|
|
117
|
+
"pattern": "^sha256:[a-f0-9]{64}$"
|
|
118
|
+
},
|
|
119
|
+
"color": {
|
|
120
|
+
"type": "string",
|
|
121
|
+
"pattern": "^#[0-9a-fA-F]{6}$"
|
|
122
|
+
},
|
|
123
|
+
"colors": {
|
|
124
|
+
"type": "object",
|
|
125
|
+
"additionalProperties": false,
|
|
126
|
+
"required": ["surface", "ink", "accent", "status", "diagramSeries"],
|
|
127
|
+
"properties": {
|
|
128
|
+
"surface": {
|
|
129
|
+
"type": "object",
|
|
130
|
+
"additionalProperties": false,
|
|
131
|
+
"required": ["canvas", "panel", "elevated"],
|
|
132
|
+
"properties": {
|
|
133
|
+
"canvas": { "$ref": "#/$defs/color" },
|
|
134
|
+
"panel": { "$ref": "#/$defs/color" },
|
|
135
|
+
"elevated": { "$ref": "#/$defs/color" }
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
"ink": {
|
|
139
|
+
"type": "object",
|
|
140
|
+
"additionalProperties": false,
|
|
141
|
+
"required": ["primary", "muted", "inverse"],
|
|
142
|
+
"properties": {
|
|
143
|
+
"primary": { "$ref": "#/$defs/color" },
|
|
144
|
+
"muted": { "$ref": "#/$defs/color" },
|
|
145
|
+
"inverse": { "$ref": "#/$defs/color" }
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"accent": {
|
|
149
|
+
"type": "object",
|
|
150
|
+
"additionalProperties": false,
|
|
151
|
+
"required": ["primary", "secondary"],
|
|
152
|
+
"properties": {
|
|
153
|
+
"primary": { "$ref": "#/$defs/color" },
|
|
154
|
+
"secondary": { "$ref": "#/$defs/color" }
|
|
155
|
+
}
|
|
156
|
+
},
|
|
157
|
+
"status": {
|
|
158
|
+
"type": "object",
|
|
159
|
+
"additionalProperties": false,
|
|
160
|
+
"required": ["success", "warning", "danger", "info"],
|
|
161
|
+
"properties": {
|
|
162
|
+
"success": { "$ref": "#/$defs/color" },
|
|
163
|
+
"warning": { "$ref": "#/$defs/color" },
|
|
164
|
+
"danger": { "$ref": "#/$defs/color" },
|
|
165
|
+
"info": { "$ref": "#/$defs/color" }
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"diagramSeries": {
|
|
169
|
+
"type": "array",
|
|
170
|
+
"items": { "$ref": "#/$defs/color" },
|
|
171
|
+
"minItems": 1,
|
|
172
|
+
"uniqueItems": true
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
"provenance": {
|
|
177
|
+
"type": "object",
|
|
178
|
+
"additionalProperties": false,
|
|
179
|
+
"required": ["derived"],
|
|
180
|
+
"properties": {
|
|
181
|
+
"palette": { "type": "string", "minLength": 1 },
|
|
182
|
+
"visualProfile": { "type": "string", "minLength": 1 },
|
|
183
|
+
"derived": { "type": "boolean" },
|
|
184
|
+
"instructionHash": { "$ref": "#/$defs/hash" },
|
|
185
|
+
"suppliedBundleHash": { "$ref": "#/$defs/hash" }
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
"fontList": {
|
|
189
|
+
"type": "array",
|
|
190
|
+
"items": { "type": "string", "minLength": 1 },
|
|
191
|
+
"minItems": 1
|
|
192
|
+
},
|
|
193
|
+
"stringMap": {
|
|
194
|
+
"type": "object",
|
|
195
|
+
"propertyNames": { "minLength": 1 },
|
|
196
|
+
"additionalProperties": { "type": "string", "minLength": 1 }
|
|
197
|
+
},
|
|
198
|
+
"positiveNumberMap": {
|
|
199
|
+
"type": "object",
|
|
200
|
+
"propertyNames": { "minLength": 1 },
|
|
201
|
+
"additionalProperties": {
|
|
202
|
+
"type": "number",
|
|
203
|
+
"exclusiveMinimum": 0,
|
|
204
|
+
"maximum": 1024
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"nonNegativeNumberMap": {
|
|
208
|
+
"type": "object",
|
|
209
|
+
"propertyNames": { "minLength": 1 },
|
|
210
|
+
"additionalProperties": {
|
|
211
|
+
"type": "number",
|
|
212
|
+
"minimum": 0,
|
|
213
|
+
"maximum": 10000
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
}
|