@openplanr/protocol 0.7.3 → 0.9.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.
Files changed (77) hide show
  1. package/README.md +22 -0
  2. package/package.json +21 -1
  3. package/registries/commands.json +11 -11
  4. package/registries/skills.json +89 -11
  5. package/registry/v1.17.0/commands.json +88 -0
  6. package/schemas/v1.15.0/diagram-review-bundle.schema.json +1280 -0
  7. package/schemas/v1.15.0/diagram-review-feedback.schema.json +157 -0
  8. package/schemas/v1.15.0/diagram-review-workspace.schema.json +108 -0
  9. package/schemas/v1.15.0/diagram-workspace-create.schema.json +170 -0
  10. package/schemas/v1.15.0/diagram-workspace-event.schema.json +97 -0
  11. package/schemas/v1.15.0/diagram-workspace-revision.schema.json +56 -0
  12. package/schemas/v1.16.0/artifact-envelope.schema.json +408 -0
  13. package/schemas/v1.16.0/design-review-bundle.schema.json +590 -0
  14. package/schemas/v1.17.0/artifact-paste-v2.schema.json +52 -0
  15. package/schemas/v1.17.0/artifact-room-append-v3.schema.json +159 -0
  16. package/schemas/v1.17.0/artifact-room-create-v3.schema.json +111 -0
  17. package/schemas/v1.17.0/artifact-room-descriptor-v3.schema.json +92 -0
  18. package/schemas/v1.17.0/artifact-room-event-v3.schema.json +130 -0
  19. package/schemas/v1.17.0/artifact-room-management-v3.schema.json +47 -0
  20. package/schemas/v1.17.0/artifact-room-read-page-v3.schema.json +308 -0
  21. package/schemas/v1.17.0/company-resource-manifest.schema.json +128 -0
  22. package/schemas/v1.17.0/company-resource-upload-prepare.schema.json +164 -0
  23. package/schemas/v1.17.0/company-resource-upload-receipt.schema.json +63 -0
  24. package/schemas/v1.17.0/company-resource-upload-status.schema.json +123 -0
  25. package/schemas/v1.17.0/diagram-authoring-bundle.schema.json +1117 -0
  26. package/schemas/v1.17.0/diagram-edit-transaction.schema.json +3295 -0
  27. package/schemas/v1.17.0/diagram-presentation.schema.json +37 -0
  28. package/schemas/v1.17.0/diagram-review-bundle.schema.json +2439 -0
  29. package/schemas/v1.17.0/encrypted-resource-manifest.schema.json +131 -0
  30. package/schemas/v1.17.0/encrypted-upload-commit.schema.json +38 -0
  31. package/schemas/v1.17.0/encrypted-upload-prepare.schema.json +234 -0
  32. package/schemas/v1.17.0/encrypted-upload-receipt.schema.json +54 -0
  33. package/schemas/v1.17.0/encrypted-upload-status.schema.json +129 -0
  34. package/schemas/v1.17.0/encrypted-workspace-event-v2.schema.json +79 -0
  35. package/schemas/v1.17.0/encrypted-workspace-v2.schema.json +91 -0
  36. package/schemas/v1.17.0/enterprise-agent-handoff.schema.json +985 -0
  37. package/schemas/v1.17.0/enterprise-artifact-revision.schema.json +115 -0
  38. package/schemas/v1.17.0/enterprise-change-proposal.schema.json +379 -0
  39. package/schemas/v1.17.0/enterprise-evidence-reference.schema.json +159 -0
  40. package/schemas/v1.17.0/enterprise-review-thread.schema.json +298 -0
  41. package/schemas/v1.17.0/enterprise-sync-state.schema.json +189 -0
  42. package/schemas/v1.17.0/preview-bridge-message.schema.json +197 -0
  43. package/schemas/v1.17.0/resource-catalog.schema.json +145 -0
  44. package/schemas/v1.17.0/sharing-crypto-aad.schema.json +36 -0
  45. package/schemas/v1.17.0/workspace-management-v2.schema.json +45 -0
  46. package/schemas/v1.17.0/workspace-rotation-v2.schema.json +61 -0
  47. package/src/bounded-json-data.d.mts +2 -0
  48. package/src/bounded-json-data.mjs +56 -0
  49. package/src/browser-contracts.d.mts +23 -1
  50. package/src/browser-contracts.mjs +52 -0
  51. package/src/canonical-json.mjs +17 -16
  52. package/src/contracts.d.mts +1 -0
  53. package/src/contracts.mjs +106 -5
  54. package/src/diagram-authoring-contracts.d.mts +12 -0
  55. package/src/diagram-authoring-contracts.mjs +174 -1
  56. package/src/diagram-review-contracts.d.mts +73 -0
  57. package/src/diagram-review-contracts.mjs +250 -0
  58. package/src/enterprise-contract-validation.d.mts +44 -0
  59. package/src/enterprise-contract-validation.mjs +279 -0
  60. package/src/enterprise-contracts.mjs +25 -231
  61. package/src/enterprise-resource-contracts.d.mts +72 -0
  62. package/src/enterprise-resource-contracts.mjs +202 -0
  63. package/src/generated/artifact-envelope-metadata.mjs +769 -0
  64. package/src/generated/canonical-registries.mjs +100 -22
  65. package/src/index.d.mts +22 -0
  66. package/src/index.mjs +26 -0
  67. package/src/large-object-contracts.d.mts +107 -0
  68. package/src/large-object-contracts.mjs +473 -0
  69. package/src/large-object-limits.d.mts +16 -0
  70. package/src/large-object-limits.mjs +17 -0
  71. package/src/registries.mjs +1 -0
  72. package/src/review-experience-contracts.d.mts +1 -0
  73. package/src/review-experience-contracts.mjs +25 -4
  74. package/src/sharing-security-contracts.d.mts +63 -0
  75. package/src/sharing-security-contracts.mjs +403 -0
  76. package/src/studio-presentation-contracts.d.mts +92 -0
  77. package/src/studio-presentation-contracts.mjs +287 -0
@@ -0,0 +1,408 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://openplanr.dev/schemas/v1.16.0/artifact-envelope.schema.json",
4
+ "title": "OpenPlanr shared-source artifact envelope",
5
+ "type": "object",
6
+ "additionalProperties": false,
7
+ "required": [
8
+ "schemaVersion",
9
+ "artifacts",
10
+ "viewer",
11
+ "sources"
12
+ ],
13
+ "properties": {
14
+ "schemaVersion": {
15
+ "const": "1.1.0"
16
+ },
17
+ "artifacts": {
18
+ "type": "array",
19
+ "minItems": 1,
20
+ "maxItems": 4096,
21
+ "items": {
22
+ "type": "object",
23
+ "additionalProperties": false,
24
+ "required": [
25
+ "id",
26
+ "kind",
27
+ "title",
28
+ "sha256",
29
+ "viewport",
30
+ "colorScheme",
31
+ "sourceId"
32
+ ],
33
+ "properties": {
34
+ "id": {
35
+ "type": "string",
36
+ "minLength": 1,
37
+ "maxLength": 128,
38
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
39
+ },
40
+ "kind": {
41
+ "const": "html"
42
+ },
43
+ "title": {
44
+ "type": "string",
45
+ "minLength": 1,
46
+ "maxLength": 512
47
+ },
48
+ "sha256": {
49
+ "type": "string",
50
+ "pattern": "^[a-f0-9]{64}$"
51
+ },
52
+ "viewport": {
53
+ "type": "object",
54
+ "additionalProperties": false,
55
+ "required": [
56
+ "width",
57
+ "height"
58
+ ],
59
+ "properties": {
60
+ "width": {
61
+ "type": "integer",
62
+ "minimum": 1,
63
+ "maximum": 16384
64
+ },
65
+ "height": {
66
+ "type": "integer",
67
+ "minimum": 1,
68
+ "maximum": 16384
69
+ }
70
+ }
71
+ },
72
+ "colorScheme": {
73
+ "type": "string",
74
+ "enum": [
75
+ "light",
76
+ "dark"
77
+ ]
78
+ },
79
+ "sourceId": {
80
+ "type": "string",
81
+ "minLength": 1,
82
+ "maxLength": 128,
83
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
84
+ }
85
+ }
86
+ }
87
+ },
88
+ "viewer": {
89
+ "type": "object",
90
+ "additionalProperties": false,
91
+ "required": [
92
+ "mode",
93
+ "activeArtifactId"
94
+ ],
95
+ "properties": {
96
+ "mode": {
97
+ "type": "string",
98
+ "enum": [
99
+ "single",
100
+ "variants"
101
+ ]
102
+ },
103
+ "activeArtifactId": {
104
+ "type": "string",
105
+ "minLength": 1,
106
+ "maxLength": 128
107
+ },
108
+ "presentation": {
109
+ "type": "string",
110
+ "enum": [
111
+ "document",
112
+ "canvas"
113
+ ]
114
+ }
115
+ }
116
+ },
117
+ "review": {
118
+ "type": "object",
119
+ "additionalProperties": false,
120
+ "required": [
121
+ "schemaVersion",
122
+ "reviewId",
123
+ "reviewOf",
124
+ "decision",
125
+ "overall",
126
+ "pins"
127
+ ],
128
+ "properties": {
129
+ "schemaVersion": {
130
+ "const": "1.0.0"
131
+ },
132
+ "reviewId": {
133
+ "type": "string",
134
+ "minLength": 1,
135
+ "maxLength": 128
136
+ },
137
+ "reviewOf": {
138
+ "type": "string",
139
+ "pattern": "^[a-f0-9]{64}$"
140
+ },
141
+ "decision": {
142
+ "type": "string",
143
+ "enum": [
144
+ "pending",
145
+ "approved",
146
+ "changes_requested"
147
+ ]
148
+ },
149
+ "overall": {
150
+ "type": "string",
151
+ "maxLength": 65536
152
+ },
153
+ "createdAt": {
154
+ "type": "string",
155
+ "format": "date-time"
156
+ },
157
+ "updatedAt": {
158
+ "type": "string",
159
+ "format": "date-time"
160
+ },
161
+ "pins": {
162
+ "type": "array",
163
+ "maxItems": 10000,
164
+ "items": {
165
+ "type": "object",
166
+ "additionalProperties": false,
167
+ "required": [
168
+ "id",
169
+ "author",
170
+ "artifactId",
171
+ "region",
172
+ "viewport",
173
+ "intent",
174
+ "status",
175
+ "comment",
176
+ "replies",
177
+ "createdAt",
178
+ "updatedAt"
179
+ ],
180
+ "properties": {
181
+ "id": {
182
+ "type": "string",
183
+ "minLength": 1,
184
+ "maxLength": 128
185
+ },
186
+ "author": {
187
+ "type": "object",
188
+ "additionalProperties": false,
189
+ "required": [
190
+ "name"
191
+ ],
192
+ "properties": {
193
+ "id": {
194
+ "type": "string",
195
+ "minLength": 1,
196
+ "maxLength": 128
197
+ },
198
+ "name": {
199
+ "type": "string",
200
+ "minLength": 1,
201
+ "maxLength": 256
202
+ }
203
+ }
204
+ },
205
+ "artifactId": {
206
+ "type": "string",
207
+ "minLength": 1,
208
+ "maxLength": 128
209
+ },
210
+ "variant": {
211
+ "type": "string",
212
+ "minLength": 1,
213
+ "maxLength": 128
214
+ },
215
+ "region": {
216
+ "type": "object",
217
+ "additionalProperties": false,
218
+ "required": [
219
+ "x",
220
+ "y",
221
+ "w",
222
+ "h"
223
+ ],
224
+ "properties": {
225
+ "x": {
226
+ "type": "number",
227
+ "minimum": 0,
228
+ "maximum": 1
229
+ },
230
+ "y": {
231
+ "type": "number",
232
+ "minimum": 0,
233
+ "maximum": 1
234
+ },
235
+ "w": {
236
+ "type": "number",
237
+ "minimum": 0,
238
+ "maximum": 1
239
+ },
240
+ "h": {
241
+ "type": "number",
242
+ "minimum": 0,
243
+ "maximum": 1
244
+ }
245
+ }
246
+ },
247
+ "viewport": {
248
+ "type": "object",
249
+ "additionalProperties": false,
250
+ "required": [
251
+ "width",
252
+ "height"
253
+ ],
254
+ "properties": {
255
+ "width": {
256
+ "type": "integer",
257
+ "minimum": 1,
258
+ "maximum": 16384
259
+ },
260
+ "height": {
261
+ "type": "integer",
262
+ "minimum": 1,
263
+ "maximum": 262144
264
+ }
265
+ }
266
+ },
267
+ "anchor": {
268
+ "type": "object",
269
+ "additionalProperties": false,
270
+ "required": [
271
+ "planrId"
272
+ ],
273
+ "properties": {
274
+ "planrId": {
275
+ "type": "string",
276
+ "minLength": 1,
277
+ "maxLength": 512
278
+ },
279
+ "screen": {
280
+ "type": "string",
281
+ "minLength": 1,
282
+ "maxLength": 128
283
+ }
284
+ }
285
+ },
286
+ "intent": {
287
+ "type": "string",
288
+ "enum": [
289
+ "fix",
290
+ "improve",
291
+ "question"
292
+ ]
293
+ },
294
+ "status": {
295
+ "type": "string",
296
+ "enum": [
297
+ "open",
298
+ "addressed",
299
+ "resolved"
300
+ ]
301
+ },
302
+ "comment": {
303
+ "type": "string",
304
+ "minLength": 1,
305
+ "maxLength": 65536
306
+ },
307
+ "replies": {
308
+ "type": "array",
309
+ "maxItems": 10000,
310
+ "items": {
311
+ "type": "object",
312
+ "additionalProperties": false,
313
+ "required": [
314
+ "id",
315
+ "author",
316
+ "comment",
317
+ "createdAt"
318
+ ],
319
+ "properties": {
320
+ "id": {
321
+ "type": "string",
322
+ "minLength": 1,
323
+ "maxLength": 128
324
+ },
325
+ "author": {
326
+ "type": "object",
327
+ "additionalProperties": false,
328
+ "required": [
329
+ "name"
330
+ ],
331
+ "properties": {
332
+ "id": {
333
+ "type": "string",
334
+ "minLength": 1,
335
+ "maxLength": 128
336
+ },
337
+ "name": {
338
+ "type": "string",
339
+ "minLength": 1,
340
+ "maxLength": 256
341
+ }
342
+ }
343
+ },
344
+ "comment": {
345
+ "type": "string",
346
+ "minLength": 1,
347
+ "maxLength": 65536
348
+ },
349
+ "createdAt": {
350
+ "type": "string",
351
+ "format": "date-time"
352
+ }
353
+ }
354
+ }
355
+ },
356
+ "createdAt": {
357
+ "type": "string",
358
+ "format": "date-time"
359
+ },
360
+ "updatedAt": {
361
+ "type": "string",
362
+ "format": "date-time"
363
+ }
364
+ }
365
+ }
366
+ }
367
+ }
368
+ },
369
+ "sources": {
370
+ "type": "array",
371
+ "minItems": 1,
372
+ "maxItems": 256,
373
+ "items": {
374
+ "type": "object",
375
+ "additionalProperties": false,
376
+ "required": [
377
+ "id",
378
+ "kind",
379
+ "sha256",
380
+ "html"
381
+ ],
382
+ "properties": {
383
+ "id": {
384
+ "type": "string",
385
+ "minLength": 1,
386
+ "maxLength": 128,
387
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
388
+ },
389
+ "kind": {
390
+ "const": "html"
391
+ },
392
+ "sha256": {
393
+ "type": "string",
394
+ "pattern": "^[a-f0-9]{64}$"
395
+ },
396
+ "html": {
397
+ "type": "string",
398
+ "minLength": 1
399
+ }
400
+ }
401
+ }
402
+ }
403
+ },
404
+ "x-openplanr-contract": {
405
+ "id": "artifact-envelope",
406
+ "version": "1.16.0"
407
+ }
408
+ }