@openplanr/protocol 0.4.0 → 0.5.0

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openplanr/protocol",
3
- "version": "0.4.0",
3
+ "version": "0.5.0",
4
4
  "type": "module",
5
5
  "description": "Canonical OpenPlanr schemas, registries, typed errors, and portable contract validation",
6
6
  "license": "MIT",
@@ -47,6 +47,10 @@
47
47
  "types": "./src/design-publication-contracts.d.mts",
48
48
  "import": "./src/design-publication-contracts.mjs"
49
49
  },
50
+ "./design-handoff-contracts": {
51
+ "types": "./src/design-handoff-contracts.d.mts",
52
+ "import": "./src/design-handoff-contracts.mjs"
53
+ },
50
54
  "./registries": {
51
55
  "types": "./src/registries.d.mts",
52
56
  "import": "./src/registries.mjs"
@@ -356,7 +356,7 @@
356
356
  "ownerPackage": "openplanr",
357
357
  "source": {
358
358
  "path": "skills/planr-plan/SKILL.md",
359
- "digest": "sha256:7cfff1b795f68e07c2fcd852c2acea0956aa4bef0d96e15a6a595aeb030cbe30"
359
+ "digest": "sha256:eb92df1829191cc3423bf6063f36247126838f7098ccc593ddae20692651e94d"
360
360
  },
361
361
  "authorityClass": "workflow",
362
362
  "machineJson": false,
@@ -587,7 +587,7 @@
587
587
  "ownerPackage": "openplanr",
588
588
  "source": {
589
589
  "path": "skills/planr-plan/SKILL.md",
590
- "digest": "sha256:7cfff1b795f68e07c2fcd852c2acea0956aa4bef0d96e15a6a595aeb030cbe30"
590
+ "digest": "sha256:eb92df1829191cc3423bf6063f36247126838f7098ccc593ddae20692651e94d"
591
591
  },
592
592
  "authorityClass": "workflow",
593
593
  "machineJson": false,
@@ -797,7 +797,7 @@
797
797
  "ownerPackage": "openplanr",
798
798
  "source": {
799
799
  "path": "packages/cli/src/cli/commands/spec.ts",
800
- "digest": "sha256:4176ac9497403e7077d465a6843427e110c3ba6cdf07fcd21ce667f1c2dce6f5"
800
+ "digest": "sha256:44d37d296459ce05273e3c0cdba32a6a03288c020074e447d2bc4d0ea0deebae"
801
801
  },
802
802
  "authorityClass": "workflow",
803
803
  "machineJson": false,
@@ -1028,7 +1028,7 @@
1028
1028
  "ownerPackage": "planr-pipeline",
1029
1029
  "source": {
1030
1030
  "path": "skills/planr-design/SKILL.md",
1031
- "digest": "sha256:e21e82a8f216c3a06a938965cdbeac5786e3b74776e821260b2630919106ae4d"
1031
+ "digest": "sha256:a8554f6ac7fcbe6760153f34ab18d533ff4ff36d3556dad55687b3c3b6d33aab"
1032
1032
  },
1033
1033
  "authorityClass": "compatibility-router",
1034
1034
  "machineJson": false,
@@ -1070,7 +1070,7 @@
1070
1070
  "ownerPackage": "planr-pipeline",
1071
1071
  "source": {
1072
1072
  "path": "skills/planr-design-review/SKILL.md",
1073
- "digest": "sha256:a018e9a80e104cd444a6475514e7ac4231ca460d7a1ecbec604b0e173de608d0"
1073
+ "digest": "sha256:1c4e6e8dcb750bb20c04b2b05fb433fe6866bc4fb5554cb82fa357077d27c242"
1074
1074
  },
1075
1075
  "authorityClass": "compatibility-router",
1076
1076
  "machineJson": false,
@@ -1091,7 +1091,7 @@
1091
1091
  "ownerPackage": "planr-pipeline",
1092
1092
  "source": {
1093
1093
  "path": "skills/planr-plan/SKILL.md",
1094
- "digest": "sha256:7cfff1b795f68e07c2fcd852c2acea0956aa4bef0d96e15a6a595aeb030cbe30"
1094
+ "digest": "sha256:eb92df1829191cc3423bf6063f36247126838f7098ccc593ddae20692651e94d"
1095
1095
  },
1096
1096
  "authorityClass": "compatibility-router",
1097
1097
  "machineJson": false,
@@ -1112,7 +1112,7 @@
1112
1112
  "ownerPackage": "planr-pipeline",
1113
1113
  "source": {
1114
1114
  "path": "skills/planr-ship/SKILL.md",
1115
- "digest": "sha256:b0b1dcedcfa936432c5c4dcb672310ecbaa8d958159b6fcb81586692500bbb3d"
1115
+ "digest": "sha256:649272ea8cad3096012acaa9ec16a3ce6288f557e404fedbe9646aefb3b2c8ba"
1116
1116
  },
1117
1117
  "authorityClass": "compatibility-router",
1118
1118
  "machineJson": false,
@@ -1948,5 +1948,5 @@
1948
1948
  ]
1949
1949
  }
1950
1950
  ],
1951
- "documentDigest": "sha256:7ffb9b909de9618cbace6cfad748408d97e773dd20e0b439f2795da99c985ace"
1951
+ "documentDigest": "sha256:ae3955232bf3a97fd1cae7ca01deec957232a64c0c2c3c2fb25a14963c93e310"
1952
1952
  }
@@ -619,12 +619,12 @@
619
619
  },
620
620
  {
621
621
  "skillId": "planr-design",
622
- "skillVersion": "2.0.0",
622
+ "skillVersion": "2.1.0",
623
623
  "description": "Design a polished product interface through adaptive consultation, a shared canvas/prototype/walkthrough studio, and an implementation-ready specification. Use for a new design or an existing interface that needs a coherent direction.",
624
624
  "lifecycle": "active",
625
625
  "authorityClass": "planning-write",
626
626
  "source": "skills/planr-design/openplanr.skill.json",
627
- "sourceDigest": "sha256:208206addf0dc8337f1914256ba6b655edf570d7cdfb7ebd62c73b29299fba95",
627
+ "sourceDigest": "sha256:83457207042925d16148dd28054ef69f00c4358136da7eaadc286f01bc6a0797",
628
628
  "triggerPolicy": {
629
629
  "include": [
630
630
  "Create an initial product design direction",
@@ -685,7 +685,7 @@
685
685
  "lifecycle": "active",
686
686
  "authorityClass": "planning-write",
687
687
  "source": "skills/planr-design-loop/openplanr.skill.json",
688
- "sourceDigest": "sha256:8e4eeb36590194963d6e8f6448e8d991658bf93a2070b0cb446b45ad793e3a49",
688
+ "sourceDigest": "sha256:cecdbd16879f58de70d1158b776fb47ac5520e22c2d6c0d01b3c6b8c4c843ced",
689
689
  "triggerPolicy": {
690
690
  "include": [
691
691
  "Explore multiple design directions or variants",
@@ -741,12 +741,12 @@
741
741
  },
742
742
  {
743
743
  "skillId": "planr-design-review",
744
- "skillVersion": "2.0.0",
744
+ "skillVersion": "2.1.0",
745
745
  "description": "Review and revise an existing product design using stable board pins and scoped browser-verified changes. Use for focused improvements while preserving unrelated screens and feedback.",
746
746
  "lifecycle": "active",
747
747
  "authorityClass": "review-evidence",
748
748
  "source": "skills/planr-design-review/openplanr.skill.json",
749
- "sourceDigest": "sha256:11c7f60feaba70cb6bc439244164ec946ae76c68c4bf46bd4d1d8c916d80ee90",
749
+ "sourceDigest": "sha256:6ac49ca8fd2f709aff25f192f55e9c530b95715a626af01afef2ed1d2170e340",
750
750
  "triggerPolicy": {
751
751
  "include": [
752
752
  "Review or critique an existing OpenPlanr design",
@@ -802,12 +802,12 @@
802
802
  },
803
803
  {
804
804
  "skillId": "planr-diagram",
805
- "skillVersion": "1.0.0",
805
+ "skillVersion": "1.1.0",
806
806
  "description": "Create, inspect, verify, or rerender professional offline diagrams. Use for architecture, process, sequence, data, state, or relationship visuals from intent or source.",
807
807
  "lifecycle": "active",
808
808
  "authorityClass": "artifact-authoring",
809
809
  "source": "skills/planr-diagram/openplanr.skill.json",
810
- "sourceDigest": "sha256:e66b2adbd7c1621d056fbd77ff24973eac57ffdc6aca04fbd6c013afc9c71b1c",
810
+ "sourceDigest": "sha256:1d8b8127914dd7a637ea475257c109a72544f860ddf5ec40c3a78563831a9906",
811
811
  "triggerPolicy": {
812
812
  "include": [
813
813
  "Create a professional diagram from English intent or Mermaid",
@@ -1174,12 +1174,12 @@
1174
1174
  },
1175
1175
  {
1176
1176
  "skillId": "planr-plan",
1177
- "skillVersion": "1.1.1",
1177
+ "skillVersion": "1.2.0",
1178
1178
  "description": "Turn a Protocol-compatible specification or product intent into schema-compatible OpenPlanr stories and implementation tasks. Use for planning and decomposition, not implementation.",
1179
1179
  "lifecycle": "active",
1180
1180
  "authorityClass": "planning-write",
1181
1181
  "source": "skills/planr-plan/openplanr.skill.json",
1182
- "sourceDigest": "sha256:18ed9de64dccee4d48bb9e94074cade3c6cda46e3c5eb9957eb96f4d319695a8",
1182
+ "sourceDigest": "sha256:a1e090540db3a4edc2694e1a24c6fc0af85838eb7ee3138cdc53f4be69803479",
1183
1183
  "triggerPolicy": {
1184
1184
  "include": [
1185
1185
  "Decompose a specification into user stories and implementation tasks",
@@ -1356,12 +1356,12 @@
1356
1356
  },
1357
1357
  {
1358
1358
  "skillId": "planr-ship",
1359
- "skillVersion": "1.1.0",
1359
+ "skillVersion": "1.2.0",
1360
1360
  "description": "Implement an OpenPlanr plan, specification, task, or clearly stated request end to end in the current repository. Use when the user asks to build, implement, fix, finish, or ship local work.",
1361
1361
  "lifecycle": "active",
1362
1362
  "authorityClass": "implementation",
1363
1363
  "source": "skills/planr-ship/openplanr.skill.json",
1364
- "sourceDigest": "sha256:1a2c6b2f7c69b364bbf6f2e7cc90abfcf75eaac4e8d10f4d4fd60af7d101e3a8",
1364
+ "sourceDigest": "sha256:4ad07e8b30a574bd7f12f87fe3852103c20241dd1e73dfcdb25e250c6b7d28f4",
1365
1365
  "triggerPolicy": {
1366
1366
  "include": [
1367
1367
  "Implement a plan, specification, task, fix, or clearly stated local request",
@@ -1664,5 +1664,5 @@
1664
1664
  }
1665
1665
  ],
1666
1666
  "compatibilityAliases": [],
1667
- "documentDigest": "sha256:f4110fb706b84192deaef1ee5238cc10477b1d91f0003040a33221e490312cc7"
1667
+ "documentDigest": "sha256:afe78935afba9b34e9a5cfe15f4821a424334c90213292252b1b068ba66db958"
1668
1668
  }
@@ -0,0 +1,398 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.11.0/design-handoff-readiness.schema.json",
4
+ "x-openplanr-contract": {
5
+ "id": "design-handoff-readiness",
6
+ "version": "1.11.0"
7
+ },
8
+ "oneOf": [
9
+ {
10
+ "type": "object",
11
+ "additionalProperties": false,
12
+ "properties": {
13
+ "kind": {
14
+ "const": "openplanr-design-handoff-readiness"
15
+ },
16
+ "schemaVersion": {
17
+ "const": "1.0.0"
18
+ },
19
+ "scope": {
20
+ "const": "design-originated"
21
+ },
22
+ "authority": {
23
+ "const": "none"
24
+ },
25
+ "designId": {
26
+ "type": "string",
27
+ "minLength": 1,
28
+ "maxLength": 160,
29
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
30
+ },
31
+ "sourceRevision": {
32
+ "anyOf": [
33
+ {
34
+ "type": "string",
35
+ "pattern": "^sha256:[a-f0-9]{64}$"
36
+ },
37
+ {
38
+ "type": "null"
39
+ }
40
+ ]
41
+ },
42
+ "selectedVariant": {
43
+ "anyOf": [
44
+ {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "maxLength": 160,
48
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
49
+ },
50
+ {
51
+ "type": "null"
52
+ }
53
+ ]
54
+ },
55
+ "status": {
56
+ "enum": [
57
+ "ready",
58
+ "attention",
59
+ "blocked",
60
+ "stale"
61
+ ]
62
+ },
63
+ "continuation": {
64
+ "type": "object",
65
+ "additionalProperties": false,
66
+ "properties": {
67
+ "action": {
68
+ "const": "prepare-plan"
69
+ },
70
+ "available": {
71
+ "type": "boolean"
72
+ }
73
+ },
74
+ "required": [
75
+ "action",
76
+ "available"
77
+ ]
78
+ },
79
+ "checks": {
80
+ "type": "array",
81
+ "items": {
82
+ "type": "object",
83
+ "additionalProperties": false,
84
+ "properties": {
85
+ "id": {
86
+ "enum": [
87
+ "current-revision",
88
+ "selected-direction",
89
+ "design-specification",
90
+ "rendered-verification",
91
+ "review-freshness",
92
+ "review-dispositions",
93
+ "unresolved-blockers",
94
+ "approved-review-handoff"
95
+ ]
96
+ },
97
+ "status": {
98
+ "enum": [
99
+ "pass",
100
+ "attention",
101
+ "blocked",
102
+ "stale"
103
+ ]
104
+ },
105
+ "message": {
106
+ "type": "string",
107
+ "minLength": 1,
108
+ "maxLength": 240
109
+ },
110
+ "evidenceRefs": {
111
+ "type": "array",
112
+ "items": {
113
+ "type": "string",
114
+ "minLength": 1,
115
+ "maxLength": 160,
116
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
117
+ },
118
+ "maxItems": 64
119
+ },
120
+ "recoveryAction": {
121
+ "type": "object",
122
+ "additionalProperties": false,
123
+ "properties": {
124
+ "id": {
125
+ "type": "string",
126
+ "minLength": 1,
127
+ "maxLength": 160,
128
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
129
+ },
130
+ "label": {
131
+ "type": "string",
132
+ "minLength": 1,
133
+ "maxLength": 240
134
+ }
135
+ },
136
+ "required": [
137
+ "id",
138
+ "label"
139
+ ]
140
+ }
141
+ },
142
+ "required": [
143
+ "id",
144
+ "status",
145
+ "message",
146
+ "evidenceRefs"
147
+ ]
148
+ },
149
+ "maxItems": 8
150
+ },
151
+ "evidence": {
152
+ "type": "array",
153
+ "items": {
154
+ "type": "object",
155
+ "additionalProperties": false,
156
+ "properties": {
157
+ "id": {
158
+ "type": "string",
159
+ "minLength": 1,
160
+ "maxLength": 160,
161
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
162
+ },
163
+ "kind": {
164
+ "enum": [
165
+ "design-revision",
166
+ "selected-direction",
167
+ "design-specification",
168
+ "rendered-verification",
169
+ "review-context",
170
+ "review-feedback",
171
+ "review-metadata",
172
+ "review-handoff",
173
+ "screen",
174
+ "frame",
175
+ "component",
176
+ "state",
177
+ "flow",
178
+ "token",
179
+ "review-decision",
180
+ "element-anchor"
181
+ ]
182
+ },
183
+ "path": {
184
+ "type": "string",
185
+ "minLength": 1,
186
+ "maxLength": 4096
187
+ },
188
+ "revision": {
189
+ "type": "string",
190
+ "pattern": "^sha256:[a-f0-9]{64}$"
191
+ },
192
+ "digest": {
193
+ "type": "string",
194
+ "pattern": "^sha256:[a-f0-9]{64}$"
195
+ },
196
+ "anchor": {
197
+ "oneOf": [
198
+ {
199
+ "type": "object",
200
+ "additionalProperties": false,
201
+ "properties": {
202
+ "section": {
203
+ "type": "string",
204
+ "minLength": 1,
205
+ "maxLength": 160,
206
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
207
+ }
208
+ },
209
+ "required": [
210
+ "section"
211
+ ]
212
+ },
213
+ {
214
+ "type": "object",
215
+ "additionalProperties": false,
216
+ "properties": {
217
+ "screenId": {
218
+ "type": "string",
219
+ "minLength": 1,
220
+ "maxLength": 160,
221
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
222
+ }
223
+ },
224
+ "required": [
225
+ "screenId"
226
+ ]
227
+ },
228
+ {
229
+ "type": "object",
230
+ "additionalProperties": false,
231
+ "properties": {
232
+ "screenId": {
233
+ "type": "string",
234
+ "minLength": 1,
235
+ "maxLength": 160,
236
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
237
+ },
238
+ "elementId": {
239
+ "type": "string",
240
+ "minLength": 1,
241
+ "maxLength": 160,
242
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
243
+ }
244
+ },
245
+ "required": [
246
+ "screenId",
247
+ "elementId"
248
+ ]
249
+ },
250
+ {
251
+ "type": "object",
252
+ "additionalProperties": false,
253
+ "properties": {
254
+ "reviewId": {
255
+ "type": "string",
256
+ "minLength": 1,
257
+ "maxLength": 160,
258
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
259
+ },
260
+ "pinId": {
261
+ "type": "string",
262
+ "minLength": 1,
263
+ "maxLength": 160,
264
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
265
+ }
266
+ },
267
+ "required": [
268
+ "reviewId",
269
+ "pinId"
270
+ ]
271
+ }
272
+ ]
273
+ }
274
+ },
275
+ "required": [
276
+ "id",
277
+ "kind",
278
+ "path"
279
+ ]
280
+ },
281
+ "maxItems": 10000
282
+ },
283
+ "blockers": {
284
+ "type": "array",
285
+ "items": {
286
+ "enum": [
287
+ "current-revision",
288
+ "selected-direction",
289
+ "design-specification",
290
+ "rendered-verification",
291
+ "review-freshness",
292
+ "review-dispositions",
293
+ "unresolved-blockers",
294
+ "approved-review-handoff"
295
+ ]
296
+ },
297
+ "maxItems": 8
298
+ },
299
+ "nextActions": {
300
+ "type": "array",
301
+ "items": {
302
+ "type": "object",
303
+ "additionalProperties": false,
304
+ "properties": {
305
+ "id": {
306
+ "type": "string",
307
+ "minLength": 1,
308
+ "maxLength": 160,
309
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
310
+ },
311
+ "label": {
312
+ "type": "string",
313
+ "minLength": 1,
314
+ "maxLength": 240
315
+ }
316
+ },
317
+ "required": [
318
+ "id",
319
+ "label"
320
+ ]
321
+ },
322
+ "maxItems": 8
323
+ }
324
+ },
325
+ "required": [
326
+ "kind",
327
+ "schemaVersion",
328
+ "scope",
329
+ "authority",
330
+ "designId",
331
+ "sourceRevision",
332
+ "selectedVariant",
333
+ "status",
334
+ "continuation",
335
+ "checks",
336
+ "evidence",
337
+ "blockers",
338
+ "nextActions"
339
+ ]
340
+ },
341
+ {
342
+ "type": "object",
343
+ "additionalProperties": false,
344
+ "properties": {
345
+ "kind": {
346
+ "const": "openplanr-design-handoff-readiness-absence"
347
+ },
348
+ "schemaVersion": {
349
+ "const": "1.0.0"
350
+ },
351
+ "status": {
352
+ "const": "absent"
353
+ },
354
+ "reason": {
355
+ "enum": [
356
+ "not-computed",
357
+ "not-applicable",
358
+ "unavailable"
359
+ ]
360
+ },
361
+ "message": {
362
+ "type": "string",
363
+ "minLength": 1,
364
+ "maxLength": 240
365
+ },
366
+ "nextAction": {
367
+ "type": "object",
368
+ "additionalProperties": false,
369
+ "properties": {
370
+ "id": {
371
+ "type": "string",
372
+ "minLength": 1,
373
+ "maxLength": 160,
374
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$"
375
+ },
376
+ "label": {
377
+ "type": "string",
378
+ "minLength": 1,
379
+ "maxLength": 240
380
+ }
381
+ },
382
+ "required": [
383
+ "id",
384
+ "label"
385
+ ]
386
+ }
387
+ },
388
+ "required": [
389
+ "kind",
390
+ "schemaVersion",
391
+ "status",
392
+ "reason",
393
+ "message",
394
+ "nextAction"
395
+ ]
396
+ }
397
+ ]
398
+ }