@kungfu-tech/kfd 1.0.0-alpha.2 → 1.0.0-alpha.21

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 (44) hide show
  1. package/.buildchain/kfd-1/contract-world.witness.json +753 -0
  2. package/.buildchain/kfd-2/kfd-foundation.trust-assessment.json +238 -0
  3. package/.buildchain/kfd-2/kfd-foundation.trust-claims.json +225 -0
  4. package/.buildchain/kfd-2/public-release-trust.claim.json +131 -0
  5. package/.buildchain/kfd-3/collaboration-interface.artifact.json +774 -0
  6. package/.buildchain/kfd-3/collaboration-interface.json +421 -0
  7. package/.buildchain/kfd-3/collaboration-interface.prebuild.json +1141 -0
  8. package/README.md +153 -29
  9. package/TRADEMARKS.md +60 -0
  10. package/buildchain.contract-lock.json +86 -0
  11. package/buildchain.release-propagation.json +32 -0
  12. package/decisions/{kfd-1.md → KFD-1.md} +77 -35
  13. package/decisions/{kfd-2.md → KFD-2.md} +63 -11
  14. package/decisions/{kfd-3.md → KFD-3.md} +54 -16
  15. package/decisions/KFD-4.md +209 -0
  16. package/docs/KFD-1-usage.md +37 -0
  17. package/docs/KFD-2-usage.md +123 -0
  18. package/docs/KFD-3-usage.md +98 -0
  19. package/docs/KFD-4-usage.md +45 -0
  20. package/docs/MAP.md +20 -3
  21. package/docs/release-governance.md +28 -0
  22. package/kfd.release.json +13 -0
  23. package/package.json +28 -2
  24. package/registry.json +15 -5
  25. package/release-impact.json +113 -0
  26. package/schemas/kfd-1/contract-world.schema.json +67 -4
  27. package/schemas/kfd-1/witness.schema.json +113 -0
  28. package/schemas/kfd-2/release-claims.schema.json +331 -0
  29. package/schemas/kfd-2/release-trust-passport.schema.json +276 -0
  30. package/schemas/kfd-2/trust-assessment.schema.json +313 -0
  31. package/schemas/kfd-2/trust-claims.schema.json +334 -0
  32. package/schemas/kfd-2/trust-taxonomy.schema.json +219 -0
  33. package/schemas/kfd-3/collaboration-interface.schema.json +542 -0
  34. package/schemas/kfd-3/witness.schema.json +167 -0
  35. package/schemas/kfd-4/observer-perspective.schema.json +300 -0
  36. package/schemas/kfd-standards.schema.json +163 -0
  37. package/scripts/check.mjs +930 -0
  38. package/scripts/npm-publish-transaction.mjs +220 -0
  39. package/scripts/update-kfd-1-witness.mjs +35 -0
  40. package/scripts/update-kfd-2-claim.mjs +304 -0
  41. package/scripts/update-kfd-3-witness.mjs +261 -0
  42. package/scripts/update-site-bundle.mjs +353 -0
  43. package/site/kfd-site.json +251 -12
  44. package/standards.json +776 -15
@@ -0,0 +1,542 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://kfd.libkungfu.dev/schemas/kfd-3/collaboration-interface.schema.json",
4
+ "title": "KFD-3 collaboration interface",
5
+ "type": "object",
6
+ "required": [
7
+ "schemaVersion",
8
+ "contract",
9
+ "standard",
10
+ "product",
11
+ "sourceRegistry",
12
+ "participants",
13
+ "minimalEntrypoints",
14
+ "surfaces",
15
+ "valueEvidence",
16
+ "transparentConstraints",
17
+ "choicePaths",
18
+ "closure"
19
+ ],
20
+ "properties": {
21
+ "schemaVersion": {
22
+ "const": 1
23
+ },
24
+ "contract": {
25
+ "const": "kfd-3-collaboration-interface"
26
+ },
27
+ "standard": {
28
+ "const": "kfd-3"
29
+ },
30
+ "product": {
31
+ "type": "object",
32
+ "required": [
33
+ "name",
34
+ "version"
35
+ ],
36
+ "properties": {
37
+ "name": {
38
+ "type": "string",
39
+ "minLength": 1
40
+ },
41
+ "version": {
42
+ "type": "string",
43
+ "minLength": 1
44
+ },
45
+ "repository": {
46
+ "type": "string",
47
+ "minLength": 1
48
+ }
49
+ },
50
+ "additionalProperties": true
51
+ },
52
+ "sourceRegistry": {
53
+ "$ref": "#/$defs/artifactPointer"
54
+ },
55
+ "factSources": {
56
+ "type": "array",
57
+ "items": {
58
+ "$ref": "#/$defs/factSource"
59
+ }
60
+ },
61
+ "participants": {
62
+ "type": "array",
63
+ "minItems": 1,
64
+ "items": {
65
+ "$ref": "#/$defs/participant"
66
+ }
67
+ },
68
+ "minimalEntrypoints": {
69
+ "type": "array",
70
+ "minItems": 1,
71
+ "items": {
72
+ "$ref": "#/$defs/entrypoint"
73
+ }
74
+ },
75
+ "surfaces": {
76
+ "type": "array",
77
+ "minItems": 1,
78
+ "items": {
79
+ "$ref": "#/$defs/surface"
80
+ }
81
+ },
82
+ "valueEvidence": {
83
+ "type": "array",
84
+ "minItems": 1,
85
+ "items": {
86
+ "$ref": "#/$defs/valueEvidence"
87
+ }
88
+ },
89
+ "transparentConstraints": {
90
+ "type": "array",
91
+ "items": {
92
+ "$ref": "#/$defs/transparentConstraint"
93
+ }
94
+ },
95
+ "choicePaths": {
96
+ "type": "array",
97
+ "items": {
98
+ "$ref": "#/$defs/choicePath"
99
+ }
100
+ },
101
+ "extensionRequests": {
102
+ "type": "array",
103
+ "items": {
104
+ "$ref": "#/$defs/extensionRequest"
105
+ }
106
+ },
107
+ "closure": {
108
+ "type": "object",
109
+ "required": [
110
+ "classificationMode",
111
+ "unclassifiedEntrypointsPolicy"
112
+ ],
113
+ "properties": {
114
+ "classificationMode": {
115
+ "enum": [
116
+ "closed-world",
117
+ "declared-open"
118
+ ]
119
+ },
120
+ "unclassifiedEntrypointsPolicy": {
121
+ "enum": [
122
+ "fail",
123
+ "warn",
124
+ "documented-open"
125
+ ]
126
+ },
127
+ "reachableSurfaceSource": {
128
+ "type": "string",
129
+ "minLength": 1
130
+ }
131
+ },
132
+ "additionalProperties": true
133
+ }
134
+ },
135
+ "additionalProperties": true,
136
+ "$defs": {
137
+ "artifactPointer": {
138
+ "type": "object",
139
+ "required": [
140
+ "path"
141
+ ],
142
+ "properties": {
143
+ "path": {
144
+ "type": "string",
145
+ "minLength": 1
146
+ },
147
+ "schemaId": {
148
+ "type": "string",
149
+ "format": "uri"
150
+ },
151
+ "sha256": {
152
+ "type": "string",
153
+ "pattern": "^[0-9a-f]{64}$"
154
+ }
155
+ },
156
+ "additionalProperties": true
157
+ },
158
+ "participant": {
159
+ "type": "object",
160
+ "required": [
161
+ "id",
162
+ "kind",
163
+ "description"
164
+ ],
165
+ "properties": {
166
+ "id": {
167
+ "type": "string",
168
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
169
+ },
170
+ "kind": {
171
+ "enum": [
172
+ "human",
173
+ "agent",
174
+ "operator",
175
+ "extension-author",
176
+ "api-consumer",
177
+ "hosted-service-user",
178
+ "service-integrator",
179
+ "maintainer",
180
+ "other"
181
+ ]
182
+ },
183
+ "description": {
184
+ "type": "string",
185
+ "minLength": 1
186
+ }
187
+ },
188
+ "additionalProperties": true
189
+ },
190
+ "factSource": {
191
+ "type": "object",
192
+ "required": [
193
+ "id",
194
+ "kind",
195
+ "repository",
196
+ "loadBearingCoordinate"
197
+ ],
198
+ "properties": {
199
+ "id": {
200
+ "type": "string",
201
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
202
+ },
203
+ "kind": {
204
+ "enum": [
205
+ "git-repository",
206
+ "package",
207
+ "site",
208
+ "release-passport",
209
+ "other"
210
+ ]
211
+ },
212
+ "host": {
213
+ "type": "string",
214
+ "minLength": 1
215
+ },
216
+ "repository": {
217
+ "type": "string",
218
+ "minLength": 1
219
+ },
220
+ "url": {
221
+ "type": "string",
222
+ "format": "uri"
223
+ },
224
+ "loadBearingCoordinate": {
225
+ "type": "string",
226
+ "minLength": 1
227
+ },
228
+ "stableRenderedIndex": {
229
+ "type": "string",
230
+ "format": "uri"
231
+ },
232
+ "canonicalPaths": {
233
+ "type": "array",
234
+ "items": {
235
+ "type": "string",
236
+ "minLength": 1
237
+ }
238
+ },
239
+ "projectionSurfaces": {
240
+ "type": "array",
241
+ "items": {
242
+ "type": "string",
243
+ "minLength": 1
244
+ }
245
+ },
246
+ "extensionRequestNote": {
247
+ "type": "string",
248
+ "minLength": 1
249
+ }
250
+ },
251
+ "additionalProperties": true
252
+ },
253
+ "entrypoint": {
254
+ "type": "object",
255
+ "required": [
256
+ "id",
257
+ "surface",
258
+ "participants"
259
+ ],
260
+ "properties": {
261
+ "id": {
262
+ "type": "string",
263
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
264
+ },
265
+ "surface": {
266
+ "type": "string",
267
+ "minLength": 1
268
+ },
269
+ "participants": {
270
+ "type": "array",
271
+ "minItems": 1,
272
+ "items": {
273
+ "type": "string",
274
+ "minLength": 1
275
+ }
276
+ },
277
+ "purpose": {
278
+ "type": "string",
279
+ "minLength": 1
280
+ }
281
+ },
282
+ "additionalProperties": true
283
+ },
284
+ "surface": {
285
+ "type": "object",
286
+ "required": [
287
+ "id",
288
+ "kind",
289
+ "participants",
290
+ "value",
291
+ "discoverability"
292
+ ],
293
+ "properties": {
294
+ "id": {
295
+ "type": "string",
296
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
297
+ },
298
+ "kind": {
299
+ "enum": [
300
+ "cli-command",
301
+ "json-api",
302
+ "markdown-doc",
303
+ "skill",
304
+ "gui",
305
+ "web",
306
+ "config",
307
+ "envelope",
308
+ "package",
309
+ "protocol",
310
+ "other"
311
+ ]
312
+ },
313
+ "participants": {
314
+ "type": "array",
315
+ "minItems": 1,
316
+ "items": {
317
+ "type": "string",
318
+ "minLength": 1
319
+ }
320
+ },
321
+ "value": {
322
+ "type": "string",
323
+ "minLength": 1
324
+ },
325
+ "discoverability": {
326
+ "type": "object",
327
+ "required": [
328
+ "fromMinimalEntrypoint"
329
+ ],
330
+ "properties": {
331
+ "fromMinimalEntrypoint": {
332
+ "type": "boolean"
333
+ },
334
+ "path": {
335
+ "type": "string",
336
+ "minLength": 1
337
+ }
338
+ },
339
+ "additionalProperties": true
340
+ },
341
+ "maturity": {
342
+ "type": "string",
343
+ "minLength": 1
344
+ }
345
+ },
346
+ "additionalProperties": true
347
+ },
348
+ "valueEvidence": {
349
+ "type": "object",
350
+ "required": [
351
+ "id",
352
+ "claim",
353
+ "participants",
354
+ "facts",
355
+ "evidence"
356
+ ],
357
+ "properties": {
358
+ "id": {
359
+ "type": "string",
360
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
361
+ },
362
+ "claim": {
363
+ "type": "string",
364
+ "minLength": 1
365
+ },
366
+ "participants": {
367
+ "type": "array",
368
+ "minItems": 1,
369
+ "items": {
370
+ "type": "string",
371
+ "minLength": 1
372
+ }
373
+ },
374
+ "facts": {
375
+ "type": "array",
376
+ "minItems": 1,
377
+ "items": {
378
+ "$ref": "#/$defs/artifactPointer"
379
+ }
380
+ },
381
+ "evidence": {
382
+ "type": "array",
383
+ "minItems": 1,
384
+ "items": {
385
+ "$ref": "#/$defs/artifactPointer"
386
+ }
387
+ },
388
+ "trustAssessment": {
389
+ "$ref": "#/$defs/artifactPointer"
390
+ },
391
+ "residualRisk": {
392
+ "type": "array",
393
+ "items": {
394
+ "$ref": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-taxonomy.schema.json#/$defs/residualRisk"
395
+ }
396
+ }
397
+ },
398
+ "additionalProperties": true
399
+ },
400
+ "transparentConstraint": {
401
+ "type": "object",
402
+ "required": [
403
+ "id",
404
+ "appliesTo",
405
+ "restriction",
406
+ "rationale",
407
+ "reviewPath"
408
+ ],
409
+ "properties": {
410
+ "id": {
411
+ "type": "string",
412
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
413
+ },
414
+ "appliesTo": {
415
+ "type": "array",
416
+ "minItems": 1,
417
+ "items": {
418
+ "type": "string",
419
+ "minLength": 1
420
+ }
421
+ },
422
+ "restriction": {
423
+ "type": "string",
424
+ "minLength": 1
425
+ },
426
+ "rationale": {
427
+ "type": "string",
428
+ "minLength": 1
429
+ },
430
+ "reviewPath": {
431
+ "type": "string",
432
+ "minLength": 1
433
+ }
434
+ },
435
+ "additionalProperties": true
436
+ },
437
+ "choicePath": {
438
+ "type": "object",
439
+ "required": [
440
+ "id",
441
+ "participants",
442
+ "choices"
443
+ ],
444
+ "properties": {
445
+ "id": {
446
+ "type": "string",
447
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
448
+ },
449
+ "participants": {
450
+ "type": "array",
451
+ "minItems": 1,
452
+ "items": {
453
+ "type": "string",
454
+ "minLength": 1
455
+ }
456
+ },
457
+ "choices": {
458
+ "type": "array",
459
+ "minItems": 1,
460
+ "items": {
461
+ "type": "object",
462
+ "required": [
463
+ "id",
464
+ "label"
465
+ ],
466
+ "properties": {
467
+ "id": {
468
+ "type": "string",
469
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
470
+ },
471
+ "label": {
472
+ "type": "string",
473
+ "minLength": 1
474
+ }
475
+ },
476
+ "additionalProperties": true
477
+ }
478
+ }
479
+ },
480
+ "additionalProperties": true
481
+ },
482
+ "extensionRequest": {
483
+ "type": "object",
484
+ "required": [
485
+ "id",
486
+ "participants",
487
+ "trigger",
488
+ "requestPath"
489
+ ],
490
+ "properties": {
491
+ "id": {
492
+ "type": "string",
493
+ "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$"
494
+ },
495
+ "participants": {
496
+ "type": "array",
497
+ "minItems": 1,
498
+ "items": {
499
+ "type": "string",
500
+ "minLength": 1
501
+ }
502
+ },
503
+ "trigger": {
504
+ "type": "string",
505
+ "minLength": 1
506
+ },
507
+ "requestPath": {
508
+ "type": "object",
509
+ "required": [
510
+ "kind",
511
+ "target"
512
+ ],
513
+ "properties": {
514
+ "kind": {
515
+ "enum": [
516
+ "github-issue",
517
+ "github-discussion",
518
+ "repository-pr",
519
+ "maintainer-channel",
520
+ "other"
521
+ ]
522
+ },
523
+ "target": {
524
+ "type": "string",
525
+ "minLength": 1
526
+ },
527
+ "template": {
528
+ "type": "string",
529
+ "minLength": 1
530
+ }
531
+ },
532
+ "additionalProperties": true
533
+ },
534
+ "expectedOutcome": {
535
+ "type": "string",
536
+ "minLength": 1
537
+ }
538
+ },
539
+ "additionalProperties": true
540
+ }
541
+ }
542
+ }
@@ -0,0 +1,167 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://kfd.libkungfu.dev/schemas/kfd-3/witness.schema.json",
4
+ "title": "KFD-3 witness",
5
+ "type": "object",
6
+ "required": [
7
+ "schemaVersion",
8
+ "contract",
9
+ "standard",
10
+ "collaborationInterface",
11
+ "sourceRegistry",
12
+ "evidence",
13
+ "closure"
14
+ ],
15
+ "properties": {
16
+ "schemaVersion": {
17
+ "const": 1
18
+ },
19
+ "contract": {
20
+ "const": "kfd-3-witness"
21
+ },
22
+ "standard": {
23
+ "const": "kfd-3"
24
+ },
25
+ "collaborationInterface": {
26
+ "type": "object",
27
+ "required": [
28
+ "schemaId",
29
+ "digest"
30
+ ],
31
+ "properties": {
32
+ "schemaId": {
33
+ "const": "https://kfd.libkungfu.dev/schemas/kfd-3/collaboration-interface.schema.json"
34
+ },
35
+ "digest": {
36
+ "type": "string",
37
+ "minLength": 1
38
+ }
39
+ },
40
+ "additionalProperties": false
41
+ },
42
+ "sourceRegistry": {
43
+ "$ref": "#/$defs/artifactPointer"
44
+ },
45
+ "evidence": {
46
+ "type": "object",
47
+ "required": [
48
+ "minimalEntrypoints",
49
+ "discoverability",
50
+ "valueEvidence",
51
+ "transparentConstraints",
52
+ "choicePaths"
53
+ ],
54
+ "properties": {
55
+ "minimalEntrypoints": {
56
+ "type": "array",
57
+ "minItems": 1,
58
+ "items": {
59
+ "$ref": "#/$defs/artifactPointer"
60
+ }
61
+ },
62
+ "discoverability": {
63
+ "type": "array",
64
+ "items": {
65
+ "$ref": "#/$defs/artifactPointer"
66
+ }
67
+ },
68
+ "valueEvidence": {
69
+ "type": "array",
70
+ "minItems": 1,
71
+ "items": {
72
+ "$ref": "#/$defs/artifactPointer"
73
+ }
74
+ },
75
+ "transparentConstraints": {
76
+ "type": "array",
77
+ "items": {
78
+ "$ref": "#/$defs/artifactPointer"
79
+ }
80
+ },
81
+ "choicePaths": {
82
+ "type": "array",
83
+ "items": {
84
+ "$ref": "#/$defs/artifactPointer"
85
+ }
86
+ },
87
+ "manuals": {
88
+ "type": "array",
89
+ "items": {
90
+ "$ref": "#/$defs/artifactPointer"
91
+ }
92
+ }
93
+ },
94
+ "additionalProperties": true
95
+ },
96
+ "closure": {
97
+ "type": "object",
98
+ "required": [
99
+ "classificationMode",
100
+ "reachableEntrypoints",
101
+ "classifiedEntrypoints",
102
+ "unclassifiedEntrypoints"
103
+ ],
104
+ "properties": {
105
+ "classificationMode": {
106
+ "const": "closed-world"
107
+ },
108
+ "reachableEntrypoints": {
109
+ "type": "array",
110
+ "items": {
111
+ "type": "string",
112
+ "minLength": 1
113
+ }
114
+ },
115
+ "classifiedEntrypoints": {
116
+ "type": "array",
117
+ "items": {
118
+ "type": "string",
119
+ "minLength": 1
120
+ }
121
+ },
122
+ "unclassifiedEntrypoints": {
123
+ "type": "array",
124
+ "maxItems": 0
125
+ }
126
+ },
127
+ "additionalProperties": true
128
+ },
129
+ "result": {
130
+ "enum": [
131
+ "pass",
132
+ "fail",
133
+ "warning"
134
+ ]
135
+ },
136
+ "residualRisk": {
137
+ "type": "array",
138
+ "items": {
139
+ "$ref": "https://kfd.libkungfu.dev/schemas/kfd-2/trust-taxonomy.schema.json#/$defs/residualRisk"
140
+ }
141
+ }
142
+ },
143
+ "additionalProperties": true,
144
+ "$defs": {
145
+ "artifactPointer": {
146
+ "type": "object",
147
+ "required": [
148
+ "path"
149
+ ],
150
+ "properties": {
151
+ "path": {
152
+ "type": "string",
153
+ "minLength": 1
154
+ },
155
+ "sha256": {
156
+ "type": "string",
157
+ "pattern": "^[0-9a-f]{64}$"
158
+ },
159
+ "description": {
160
+ "type": "string",
161
+ "minLength": 1
162
+ }
163
+ },
164
+ "additionalProperties": true
165
+ }
166
+ }
167
+ }