sysprom 1.0.0 → 1.0.5

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 (148) hide show
  1. package/README.md +207 -0
  2. package/dist/schema.json +510 -0
  3. package/dist/src/canonical-json.d.ts +23 -0
  4. package/dist/src/canonical-json.js +120 -0
  5. package/dist/src/cli/commands/add.d.ts +22 -0
  6. package/dist/src/cli/commands/add.js +95 -0
  7. package/dist/src/cli/commands/check.d.ts +10 -0
  8. package/dist/src/cli/commands/check.js +33 -0
  9. package/dist/src/cli/commands/graph.d.ts +15 -0
  10. package/dist/src/cli/commands/graph.js +32 -0
  11. package/dist/src/cli/commands/init.d.ts +2 -0
  12. package/dist/src/cli/commands/init.js +44 -0
  13. package/dist/src/cli/commands/json2md.d.ts +2 -0
  14. package/dist/src/cli/commands/json2md.js +60 -0
  15. package/dist/src/cli/commands/md2json.d.ts +2 -0
  16. package/dist/src/cli/commands/md2json.js +29 -0
  17. package/dist/src/cli/commands/plan.d.ts +2 -0
  18. package/dist/src/cli/commands/plan.js +227 -0
  19. package/dist/src/cli/commands/query.d.ts +2 -0
  20. package/dist/src/cli/commands/query.js +275 -0
  21. package/dist/src/cli/commands/remove.d.ts +13 -0
  22. package/dist/src/cli/commands/remove.js +50 -0
  23. package/dist/src/cli/commands/rename.d.ts +14 -0
  24. package/dist/src/cli/commands/rename.js +34 -0
  25. package/dist/src/cli/commands/search.d.ts +11 -0
  26. package/dist/src/cli/commands/search.js +37 -0
  27. package/dist/src/cli/commands/speckit.d.ts +2 -0
  28. package/dist/src/cli/commands/speckit.js +318 -0
  29. package/dist/src/cli/commands/stats.d.ts +10 -0
  30. package/dist/src/cli/commands/stats.js +51 -0
  31. package/dist/src/cli/commands/task.d.ts +2 -0
  32. package/dist/src/cli/commands/task.js +162 -0
  33. package/dist/src/cli/commands/update.d.ts +2 -0
  34. package/dist/src/cli/commands/update.js +219 -0
  35. package/dist/src/cli/commands/validate.d.ts +10 -0
  36. package/dist/src/cli/commands/validate.js +30 -0
  37. package/dist/src/cli/define-command.d.ts +34 -0
  38. package/dist/src/cli/define-command.js +237 -0
  39. package/dist/src/cli/index.d.ts +2 -0
  40. package/dist/src/cli/index.js +3 -0
  41. package/dist/src/cli/program.d.ts +4 -0
  42. package/dist/src/cli/program.js +46 -0
  43. package/dist/src/cli/shared.d.ts +26 -0
  44. package/dist/src/cli/shared.js +41 -0
  45. package/dist/src/generate-schema.d.ts +1 -0
  46. package/dist/src/generate-schema.js +9 -0
  47. package/dist/src/index.d.ts +48 -0
  48. package/dist/src/index.js +99 -0
  49. package/dist/src/io.d.ts +22 -0
  50. package/dist/src/io.js +66 -0
  51. package/dist/src/json-to-md.d.ts +26 -0
  52. package/dist/src/json-to-md.js +498 -0
  53. package/dist/src/md-to-json.d.ts +22 -0
  54. package/dist/src/md-to-json.js +548 -0
  55. package/dist/src/operations/add-node.d.ts +887 -0
  56. package/dist/src/operations/add-node.js +21 -0
  57. package/dist/src/operations/add-plan-task.d.ts +594 -0
  58. package/dist/src/operations/add-plan-task.js +25 -0
  59. package/dist/src/operations/add-relationship.d.ts +635 -0
  60. package/dist/src/operations/add-relationship.js +25 -0
  61. package/dist/src/operations/check.d.ts +301 -0
  62. package/dist/src/operations/check.js +66 -0
  63. package/dist/src/operations/define-operation.d.ts +14 -0
  64. package/dist/src/operations/define-operation.js +21 -0
  65. package/dist/src/operations/graph.d.ts +303 -0
  66. package/dist/src/operations/graph.js +71 -0
  67. package/dist/src/operations/index.d.ts +38 -0
  68. package/dist/src/operations/index.js +45 -0
  69. package/dist/src/operations/init-document.d.ts +299 -0
  70. package/dist/src/operations/init-document.js +26 -0
  71. package/dist/src/operations/json-to-markdown.d.ts +298 -0
  72. package/dist/src/operations/json-to-markdown.js +13 -0
  73. package/dist/src/operations/mark-task-done.d.ts +594 -0
  74. package/dist/src/operations/mark-task-done.js +26 -0
  75. package/dist/src/operations/mark-task-undone.d.ts +594 -0
  76. package/dist/src/operations/mark-task-undone.js +26 -0
  77. package/dist/src/operations/markdown-to-json.d.ts +298 -0
  78. package/dist/src/operations/markdown-to-json.js +13 -0
  79. package/dist/src/operations/next-id.d.ts +322 -0
  80. package/dist/src/operations/next-id.js +29 -0
  81. package/dist/src/operations/node-history.d.ts +313 -0
  82. package/dist/src/operations/node-history.js +55 -0
  83. package/dist/src/operations/plan-add-task.d.ts +595 -0
  84. package/dist/src/operations/plan-add-task.js +18 -0
  85. package/dist/src/operations/plan-gate.d.ts +351 -0
  86. package/dist/src/operations/plan-gate.js +41 -0
  87. package/dist/src/operations/plan-init.d.ts +299 -0
  88. package/dist/src/operations/plan-init.js +17 -0
  89. package/dist/src/operations/plan-progress.d.ts +313 -0
  90. package/dist/src/operations/plan-progress.js +23 -0
  91. package/dist/src/operations/plan-status.d.ts +349 -0
  92. package/dist/src/operations/plan-status.js +41 -0
  93. package/dist/src/operations/query-node.d.ts +1065 -0
  94. package/dist/src/operations/query-node.js +27 -0
  95. package/dist/src/operations/query-nodes.d.ts +594 -0
  96. package/dist/src/operations/query-nodes.js +23 -0
  97. package/dist/src/operations/query-relationships.d.ts +343 -0
  98. package/dist/src/operations/query-relationships.js +27 -0
  99. package/dist/src/operations/remove-node.d.ts +895 -0
  100. package/dist/src/operations/remove-node.js +58 -0
  101. package/dist/src/operations/remove-relationship.d.ts +622 -0
  102. package/dist/src/operations/remove-relationship.js +26 -0
  103. package/dist/src/operations/rename.d.ts +594 -0
  104. package/dist/src/operations/rename.js +113 -0
  105. package/dist/src/operations/search.d.ts +593 -0
  106. package/dist/src/operations/search.js +39 -0
  107. package/dist/src/operations/speckit-diff.d.ts +330 -0
  108. package/dist/src/operations/speckit-diff.js +89 -0
  109. package/dist/src/operations/speckit-export.d.ts +300 -0
  110. package/dist/src/operations/speckit-export.js +17 -0
  111. package/dist/src/operations/speckit-import.d.ts +299 -0
  112. package/dist/src/operations/speckit-import.js +39 -0
  113. package/dist/src/operations/speckit-sync.d.ts +900 -0
  114. package/dist/src/operations/speckit-sync.js +116 -0
  115. package/dist/src/operations/state-at.d.ts +309 -0
  116. package/dist/src/operations/state-at.js +53 -0
  117. package/dist/src/operations/stats.d.ts +324 -0
  118. package/dist/src/operations/stats.js +85 -0
  119. package/dist/src/operations/task-list.d.ts +305 -0
  120. package/dist/src/operations/task-list.js +44 -0
  121. package/dist/src/operations/timeline.d.ts +312 -0
  122. package/dist/src/operations/timeline.js +46 -0
  123. package/dist/src/operations/trace-from-node.d.ts +1197 -0
  124. package/dist/src/operations/trace-from-node.js +36 -0
  125. package/dist/src/operations/update-metadata.d.ts +593 -0
  126. package/dist/src/operations/update-metadata.js +18 -0
  127. package/dist/src/operations/update-node.d.ts +957 -0
  128. package/dist/src/operations/update-node.js +24 -0
  129. package/dist/src/operations/update-plan-task.d.ts +595 -0
  130. package/dist/src/operations/update-plan-task.js +31 -0
  131. package/dist/src/operations/validate.d.ts +310 -0
  132. package/dist/src/operations/validate.js +82 -0
  133. package/dist/src/schema.d.ts +891 -0
  134. package/dist/src/schema.js +356 -0
  135. package/dist/src/speckit/generate.d.ts +7 -0
  136. package/dist/src/speckit/generate.js +546 -0
  137. package/dist/src/speckit/index.d.ts +4 -0
  138. package/dist/src/speckit/index.js +4 -0
  139. package/dist/src/speckit/parse.d.ts +11 -0
  140. package/dist/src/speckit/parse.js +712 -0
  141. package/dist/src/speckit/plan.d.ts +125 -0
  142. package/dist/src/speckit/plan.js +636 -0
  143. package/dist/src/speckit/project.d.ts +39 -0
  144. package/dist/src/speckit/project.js +141 -0
  145. package/dist/src/text.d.ts +23 -0
  146. package/dist/src/text.js +32 -0
  147. package/package.json +86 -8
  148. package/schema.json +510 -0
@@ -0,0 +1,299 @@
1
+ import * as z from "zod";
2
+ export declare const initDocumentOp: import("./define-operation.js").DefinedOperation<z.ZodObject<{
3
+ title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
4
+ scope: z.ZodDefault<z.ZodOptional<z.ZodString>>;
5
+ }, z.core.$strip>, z.ZodObject<{
6
+ $schema: z.ZodOptional<z.ZodString>;
7
+ metadata: z.ZodOptional<z.ZodObject<{
8
+ title: z.ZodOptional<z.ZodString>;
9
+ doc_type: z.ZodOptional<z.ZodString>;
10
+ scope: z.ZodOptional<z.ZodString>;
11
+ status: z.ZodOptional<z.ZodString>;
12
+ version: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
13
+ }, z.core.$loose> & {
14
+ is(value: unknown): value is {
15
+ [x: string]: unknown;
16
+ title?: string | undefined;
17
+ doc_type?: string | undefined;
18
+ scope?: string | undefined;
19
+ status?: string | undefined;
20
+ version?: string | number | undefined;
21
+ };
22
+ }>;
23
+ nodes: z.ZodArray<z.ZodObject<{
24
+ id: z.ZodString;
25
+ type: z.ZodEnum<{
26
+ intent: "intent";
27
+ concept: "concept";
28
+ capability: "capability";
29
+ element: "element";
30
+ realisation: "realisation";
31
+ invariant: "invariant";
32
+ principle: "principle";
33
+ policy: "policy";
34
+ protocol: "protocol";
35
+ stage: "stage";
36
+ role: "role";
37
+ gate: "gate";
38
+ mode: "mode";
39
+ artefact: "artefact";
40
+ artefact_flow: "artefact_flow";
41
+ decision: "decision";
42
+ change: "change";
43
+ view: "view";
44
+ milestone: "milestone";
45
+ version: "version";
46
+ }> & {
47
+ is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
48
+ };
49
+ name: z.ZodString;
50
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
51
+ is(value: unknown): value is string | string[];
52
+ }>;
53
+ status: z.ZodOptional<z.ZodEnum<{
54
+ deprecated: "deprecated";
55
+ proposed: "proposed";
56
+ accepted: "accepted";
57
+ active: "active";
58
+ implemented: "implemented";
59
+ adopted: "adopted";
60
+ defined: "defined";
61
+ introduced: "introduced";
62
+ in_progress: "in_progress";
63
+ complete: "complete";
64
+ consolidated: "consolidated";
65
+ experimental: "experimental";
66
+ retired: "retired";
67
+ superseded: "superseded";
68
+ abandoned: "abandoned";
69
+ deferred: "deferred";
70
+ }> & {
71
+ is(value: unknown): value is "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred";
72
+ }>;
73
+ lifecycle: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>;
74
+ context: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
75
+ is(value: unknown): value is string | string[];
76
+ }>;
77
+ options: z.ZodOptional<z.ZodArray<z.ZodObject<{
78
+ id: z.ZodString;
79
+ description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
80
+ is(value: unknown): value is string | string[];
81
+ };
82
+ }, z.core.$loose> & {
83
+ is(value: unknown): value is {
84
+ [x: string]: unknown;
85
+ id: string;
86
+ description: string | string[];
87
+ };
88
+ }>>;
89
+ selected: z.ZodOptional<z.ZodString>;
90
+ rationale: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
91
+ is(value: unknown): value is string | string[];
92
+ }>;
93
+ scope: z.ZodOptional<z.ZodArray<z.ZodString>>;
94
+ operations: z.ZodOptional<z.ZodArray<z.ZodObject<{
95
+ type: z.ZodEnum<{
96
+ link: "link";
97
+ add: "add";
98
+ update: "update";
99
+ remove: "remove";
100
+ }>;
101
+ target: z.ZodOptional<z.ZodString>;
102
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
103
+ is(value: unknown): value is string | string[];
104
+ }>;
105
+ }, z.core.$loose> & {
106
+ is(value: unknown): value is {
107
+ [x: string]: unknown;
108
+ type: "link" | "add" | "update" | "remove";
109
+ target?: string | undefined;
110
+ description?: string | string[] | undefined;
111
+ };
112
+ }>>;
113
+ plan: z.ZodOptional<z.ZodArray<z.ZodObject<{
114
+ description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
115
+ is(value: unknown): value is string | string[];
116
+ };
117
+ done: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
118
+ }, z.core.$loose> & {
119
+ is(value: unknown): value is {
120
+ [x: string]: unknown;
121
+ description: string | string[];
122
+ done?: boolean | undefined;
123
+ };
124
+ }>>;
125
+ propagation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
126
+ includes: z.ZodOptional<z.ZodArray<z.ZodString>>;
127
+ input: z.ZodOptional<z.ZodString>;
128
+ output: z.ZodOptional<z.ZodString>;
129
+ external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
130
+ role: z.ZodEnum<{
131
+ output: "output";
132
+ input: "input";
133
+ context: "context";
134
+ evidence: "evidence";
135
+ source: "source";
136
+ standard: "standard";
137
+ prior_art: "prior_art";
138
+ }> & {
139
+ is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
140
+ };
141
+ identifier: z.ZodString;
142
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
143
+ is(value: unknown): value is string | string[];
144
+ }>;
145
+ node_id: z.ZodOptional<z.ZodString>;
146
+ internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
147
+ is(value: unknown): value is string | string[];
148
+ }>;
149
+ }, z.core.$strip> & {
150
+ is(value: unknown): value is {
151
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
152
+ identifier: string;
153
+ description?: string | string[] | undefined;
154
+ node_id?: string | undefined;
155
+ internalised?: string | string[] | undefined;
156
+ };
157
+ }>>;
158
+ readonly subsystem: z.ZodOptional<z.ZodObject</*elided*/ any, z.core.$strip>>;
159
+ }, z.core.$loose>>;
160
+ relationships: z.ZodOptional<z.ZodArray<z.ZodObject<{
161
+ from: z.ZodString;
162
+ to: z.ZodString;
163
+ type: z.ZodEnum<{
164
+ refines: "refines";
165
+ realises: "realises";
166
+ implements: "implements";
167
+ depends_on: "depends_on";
168
+ constrained_by: "constrained_by";
169
+ affects: "affects";
170
+ supersedes: "supersedes";
171
+ must_preserve: "must_preserve";
172
+ performs: "performs";
173
+ part_of: "part_of";
174
+ precedes: "precedes";
175
+ must_follow: "must_follow";
176
+ blocks: "blocks";
177
+ routes_to: "routes_to";
178
+ governed_by: "governed_by";
179
+ modifies: "modifies";
180
+ triggered_by: "triggered_by";
181
+ applies_to: "applies_to";
182
+ produces: "produces";
183
+ consumes: "consumes";
184
+ transforms_into: "transforms_into";
185
+ selects: "selects";
186
+ requires: "requires";
187
+ disables: "disables";
188
+ }> & {
189
+ is(value: unknown): value is "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
190
+ };
191
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
192
+ is(value: unknown): value is string | string[];
193
+ }>;
194
+ }, z.core.$loose> & {
195
+ is(value: unknown): value is {
196
+ [x: string]: unknown;
197
+ from: string;
198
+ to: string;
199
+ type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
200
+ description?: string | string[] | undefined;
201
+ };
202
+ }>>;
203
+ external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
204
+ role: z.ZodEnum<{
205
+ output: "output";
206
+ input: "input";
207
+ context: "context";
208
+ evidence: "evidence";
209
+ source: "source";
210
+ standard: "standard";
211
+ prior_art: "prior_art";
212
+ }> & {
213
+ is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
214
+ };
215
+ identifier: z.ZodString;
216
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
217
+ is(value: unknown): value is string | string[];
218
+ }>;
219
+ node_id: z.ZodOptional<z.ZodString>;
220
+ internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
221
+ is(value: unknown): value is string | string[];
222
+ }>;
223
+ }, z.core.$strip> & {
224
+ is(value: unknown): value is {
225
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
226
+ identifier: string;
227
+ description?: string | string[] | undefined;
228
+ node_id?: string | undefined;
229
+ internalised?: string | string[] | undefined;
230
+ };
231
+ }>>;
232
+ }, z.core.$strip> & {
233
+ is(value: unknown): value is {
234
+ nodes: {
235
+ [x: string]: unknown;
236
+ id: string;
237
+ type: "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
238
+ name: string;
239
+ description?: string | string[] | undefined;
240
+ status?: "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred" | undefined;
241
+ lifecycle?: Record<string, string | boolean> | undefined;
242
+ context?: string | string[] | undefined;
243
+ options?: {
244
+ [x: string]: unknown;
245
+ id: string;
246
+ description: string | string[];
247
+ }[] | undefined;
248
+ selected?: string | undefined;
249
+ rationale?: string | string[] | undefined;
250
+ scope?: string[] | undefined;
251
+ operations?: {
252
+ [x: string]: unknown;
253
+ type: "link" | "add" | "update" | "remove";
254
+ target?: string | undefined;
255
+ description?: string | string[] | undefined;
256
+ }[] | undefined;
257
+ plan?: {
258
+ [x: string]: unknown;
259
+ description: string | string[];
260
+ done?: boolean | undefined;
261
+ }[] | undefined;
262
+ propagation?: Record<string, boolean> | undefined;
263
+ includes?: string[] | undefined;
264
+ input?: string | undefined;
265
+ output?: string | undefined;
266
+ external_references?: {
267
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
268
+ identifier: string;
269
+ description?: string | string[] | undefined;
270
+ node_id?: string | undefined;
271
+ internalised?: string | string[] | undefined;
272
+ }[] | undefined;
273
+ subsystem?: /*elided*/ any | undefined;
274
+ }[];
275
+ $schema?: string | undefined;
276
+ metadata?: {
277
+ [x: string]: unknown;
278
+ title?: string | undefined;
279
+ doc_type?: string | undefined;
280
+ scope?: string | undefined;
281
+ status?: string | undefined;
282
+ version?: string | number | undefined;
283
+ } | undefined;
284
+ relationships?: {
285
+ [x: string]: unknown;
286
+ from: string;
287
+ to: string;
288
+ type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
289
+ description?: string | string[] | undefined;
290
+ }[] | undefined;
291
+ external_references?: {
292
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
293
+ identifier: string;
294
+ description?: string | string[] | undefined;
295
+ node_id?: string | undefined;
296
+ internalised?: string | string[] | undefined;
297
+ }[] | undefined;
298
+ };
299
+ }>;
@@ -0,0 +1,26 @@
1
+ import * as z from "zod";
2
+ import { defineOperation } from "./define-operation.js";
3
+ import { SysProMDocument } from "../schema.js";
4
+ export const initDocumentOp = defineOperation({
5
+ name: "initDocument",
6
+ description: "Create a new empty SysProM document with metadata.",
7
+ input: z.object({
8
+ title: z.string().optional().default("Untitled"),
9
+ scope: z.string().optional().default("system"),
10
+ }),
11
+ output: SysProMDocument,
12
+ fn({ title, scope }) {
13
+ const doc = {
14
+ metadata: {
15
+ title,
16
+ doc_type: "sysprom",
17
+ scope,
18
+ status: "active",
19
+ version: 1,
20
+ },
21
+ nodes: [],
22
+ relationships: [],
23
+ };
24
+ return doc;
25
+ },
26
+ });
@@ -0,0 +1,298 @@
1
+ import * as z from "zod";
2
+ export declare const jsonToMarkdownOp: import("./define-operation.js").DefinedOperation<z.ZodObject<{
3
+ doc: z.ZodObject<{
4
+ $schema: z.ZodOptional<z.ZodString>;
5
+ metadata: z.ZodOptional<z.ZodObject<{
6
+ title: z.ZodOptional<z.ZodString>;
7
+ doc_type: z.ZodOptional<z.ZodString>;
8
+ scope: z.ZodOptional<z.ZodString>;
9
+ status: z.ZodOptional<z.ZodString>;
10
+ version: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodInt]>>;
11
+ }, z.core.$loose> & {
12
+ is(value: unknown): value is {
13
+ [x: string]: unknown;
14
+ title?: string | undefined;
15
+ doc_type?: string | undefined;
16
+ scope?: string | undefined;
17
+ status?: string | undefined;
18
+ version?: string | number | undefined;
19
+ };
20
+ }>;
21
+ nodes: z.ZodArray<z.ZodObject<{
22
+ id: z.ZodString;
23
+ type: z.ZodEnum<{
24
+ intent: "intent";
25
+ concept: "concept";
26
+ capability: "capability";
27
+ element: "element";
28
+ realisation: "realisation";
29
+ invariant: "invariant";
30
+ principle: "principle";
31
+ policy: "policy";
32
+ protocol: "protocol";
33
+ stage: "stage";
34
+ role: "role";
35
+ gate: "gate";
36
+ mode: "mode";
37
+ artefact: "artefact";
38
+ artefact_flow: "artefact_flow";
39
+ decision: "decision";
40
+ change: "change";
41
+ view: "view";
42
+ milestone: "milestone";
43
+ version: "version";
44
+ }> & {
45
+ is(value: unknown): value is "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
46
+ };
47
+ name: z.ZodString;
48
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
49
+ is(value: unknown): value is string | string[];
50
+ }>;
51
+ status: z.ZodOptional<z.ZodEnum<{
52
+ deprecated: "deprecated";
53
+ proposed: "proposed";
54
+ accepted: "accepted";
55
+ active: "active";
56
+ implemented: "implemented";
57
+ adopted: "adopted";
58
+ defined: "defined";
59
+ introduced: "introduced";
60
+ in_progress: "in_progress";
61
+ complete: "complete";
62
+ consolidated: "consolidated";
63
+ experimental: "experimental";
64
+ retired: "retired";
65
+ superseded: "superseded";
66
+ abandoned: "abandoned";
67
+ deferred: "deferred";
68
+ }> & {
69
+ is(value: unknown): value is "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred";
70
+ }>;
71
+ lifecycle: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>;
72
+ context: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
73
+ is(value: unknown): value is string | string[];
74
+ }>;
75
+ options: z.ZodOptional<z.ZodArray<z.ZodObject<{
76
+ id: z.ZodString;
77
+ description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
78
+ is(value: unknown): value is string | string[];
79
+ };
80
+ }, z.core.$loose> & {
81
+ is(value: unknown): value is {
82
+ [x: string]: unknown;
83
+ id: string;
84
+ description: string | string[];
85
+ };
86
+ }>>;
87
+ selected: z.ZodOptional<z.ZodString>;
88
+ rationale: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
89
+ is(value: unknown): value is string | string[];
90
+ }>;
91
+ scope: z.ZodOptional<z.ZodArray<z.ZodString>>;
92
+ operations: z.ZodOptional<z.ZodArray<z.ZodObject<{
93
+ type: z.ZodEnum<{
94
+ link: "link";
95
+ add: "add";
96
+ update: "update";
97
+ remove: "remove";
98
+ }>;
99
+ target: z.ZodOptional<z.ZodString>;
100
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
101
+ is(value: unknown): value is string | string[];
102
+ }>;
103
+ }, z.core.$loose> & {
104
+ is(value: unknown): value is {
105
+ [x: string]: unknown;
106
+ type: "link" | "add" | "update" | "remove";
107
+ target?: string | undefined;
108
+ description?: string | string[] | undefined;
109
+ };
110
+ }>>;
111
+ plan: z.ZodOptional<z.ZodArray<z.ZodObject<{
112
+ description: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
113
+ is(value: unknown): value is string | string[];
114
+ };
115
+ done: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
116
+ }, z.core.$loose> & {
117
+ is(value: unknown): value is {
118
+ [x: string]: unknown;
119
+ description: string | string[];
120
+ done?: boolean | undefined;
121
+ };
122
+ }>>;
123
+ propagation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
124
+ includes: z.ZodOptional<z.ZodArray<z.ZodString>>;
125
+ input: z.ZodOptional<z.ZodString>;
126
+ output: z.ZodOptional<z.ZodString>;
127
+ external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
128
+ role: z.ZodEnum<{
129
+ output: "output";
130
+ input: "input";
131
+ context: "context";
132
+ evidence: "evidence";
133
+ source: "source";
134
+ standard: "standard";
135
+ prior_art: "prior_art";
136
+ }> & {
137
+ is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
138
+ };
139
+ identifier: z.ZodString;
140
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
141
+ is(value: unknown): value is string | string[];
142
+ }>;
143
+ node_id: z.ZodOptional<z.ZodString>;
144
+ internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
145
+ is(value: unknown): value is string | string[];
146
+ }>;
147
+ }, z.core.$strip> & {
148
+ is(value: unknown): value is {
149
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
150
+ identifier: string;
151
+ description?: string | string[] | undefined;
152
+ node_id?: string | undefined;
153
+ internalised?: string | string[] | undefined;
154
+ };
155
+ }>>;
156
+ readonly subsystem: z.ZodOptional<z.ZodObject</*elided*/ any, z.core.$strip>>;
157
+ }, z.core.$loose>>;
158
+ relationships: z.ZodOptional<z.ZodArray<z.ZodObject<{
159
+ from: z.ZodString;
160
+ to: z.ZodString;
161
+ type: z.ZodEnum<{
162
+ refines: "refines";
163
+ realises: "realises";
164
+ implements: "implements";
165
+ depends_on: "depends_on";
166
+ constrained_by: "constrained_by";
167
+ affects: "affects";
168
+ supersedes: "supersedes";
169
+ must_preserve: "must_preserve";
170
+ performs: "performs";
171
+ part_of: "part_of";
172
+ precedes: "precedes";
173
+ must_follow: "must_follow";
174
+ blocks: "blocks";
175
+ routes_to: "routes_to";
176
+ governed_by: "governed_by";
177
+ modifies: "modifies";
178
+ triggered_by: "triggered_by";
179
+ applies_to: "applies_to";
180
+ produces: "produces";
181
+ consumes: "consumes";
182
+ transforms_into: "transforms_into";
183
+ selects: "selects";
184
+ requires: "requires";
185
+ disables: "disables";
186
+ }> & {
187
+ is(value: unknown): value is "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
188
+ };
189
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
190
+ is(value: unknown): value is string | string[];
191
+ }>;
192
+ }, z.core.$loose> & {
193
+ is(value: unknown): value is {
194
+ [x: string]: unknown;
195
+ from: string;
196
+ to: string;
197
+ type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
198
+ description?: string | string[] | undefined;
199
+ };
200
+ }>>;
201
+ external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
202
+ role: z.ZodEnum<{
203
+ output: "output";
204
+ input: "input";
205
+ context: "context";
206
+ evidence: "evidence";
207
+ source: "source";
208
+ standard: "standard";
209
+ prior_art: "prior_art";
210
+ }> & {
211
+ is(value: unknown): value is "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
212
+ };
213
+ identifier: z.ZodString;
214
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
215
+ is(value: unknown): value is string | string[];
216
+ }>;
217
+ node_id: z.ZodOptional<z.ZodString>;
218
+ internalised: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]> & {
219
+ is(value: unknown): value is string | string[];
220
+ }>;
221
+ }, z.core.$strip> & {
222
+ is(value: unknown): value is {
223
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
224
+ identifier: string;
225
+ description?: string | string[] | undefined;
226
+ node_id?: string | undefined;
227
+ internalised?: string | string[] | undefined;
228
+ };
229
+ }>>;
230
+ }, z.core.$strip> & {
231
+ is(value: unknown): value is {
232
+ nodes: {
233
+ [x: string]: unknown;
234
+ id: string;
235
+ type: "intent" | "concept" | "capability" | "element" | "realisation" | "invariant" | "principle" | "policy" | "protocol" | "stage" | "role" | "gate" | "mode" | "artefact" | "artefact_flow" | "decision" | "change" | "view" | "milestone" | "version";
236
+ name: string;
237
+ description?: string | string[] | undefined;
238
+ status?: "deprecated" | "proposed" | "accepted" | "active" | "implemented" | "adopted" | "defined" | "introduced" | "in_progress" | "complete" | "consolidated" | "experimental" | "retired" | "superseded" | "abandoned" | "deferred" | undefined;
239
+ lifecycle?: Record<string, string | boolean> | undefined;
240
+ context?: string | string[] | undefined;
241
+ options?: {
242
+ [x: string]: unknown;
243
+ id: string;
244
+ description: string | string[];
245
+ }[] | undefined;
246
+ selected?: string | undefined;
247
+ rationale?: string | string[] | undefined;
248
+ scope?: string[] | undefined;
249
+ operations?: {
250
+ [x: string]: unknown;
251
+ type: "link" | "add" | "update" | "remove";
252
+ target?: string | undefined;
253
+ description?: string | string[] | undefined;
254
+ }[] | undefined;
255
+ plan?: {
256
+ [x: string]: unknown;
257
+ description: string | string[];
258
+ done?: boolean | undefined;
259
+ }[] | undefined;
260
+ propagation?: Record<string, boolean> | undefined;
261
+ includes?: string[] | undefined;
262
+ input?: string | undefined;
263
+ output?: string | undefined;
264
+ external_references?: {
265
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
266
+ identifier: string;
267
+ description?: string | string[] | undefined;
268
+ node_id?: string | undefined;
269
+ internalised?: string | string[] | undefined;
270
+ }[] | undefined;
271
+ subsystem?: /*elided*/ any | undefined;
272
+ }[];
273
+ $schema?: string | undefined;
274
+ metadata?: {
275
+ [x: string]: unknown;
276
+ title?: string | undefined;
277
+ doc_type?: string | undefined;
278
+ scope?: string | undefined;
279
+ status?: string | undefined;
280
+ version?: string | number | undefined;
281
+ } | undefined;
282
+ relationships?: {
283
+ [x: string]: unknown;
284
+ from: string;
285
+ to: string;
286
+ type: "refines" | "realises" | "implements" | "depends_on" | "constrained_by" | "affects" | "supersedes" | "must_preserve" | "performs" | "part_of" | "precedes" | "must_follow" | "blocks" | "routes_to" | "governed_by" | "modifies" | "triggered_by" | "applies_to" | "produces" | "consumes" | "transforms_into" | "selects" | "requires" | "disables";
287
+ description?: string | string[] | undefined;
288
+ }[] | undefined;
289
+ external_references?: {
290
+ role: "output" | "input" | "context" | "evidence" | "source" | "standard" | "prior_art";
291
+ identifier: string;
292
+ description?: string | string[] | undefined;
293
+ node_id?: string | undefined;
294
+ internalised?: string | string[] | undefined;
295
+ }[] | undefined;
296
+ };
297
+ };
298
+ }, z.core.$strip>, z.ZodString>;
@@ -0,0 +1,13 @@
1
+ import * as z from "zod";
2
+ import { defineOperation } from "./define-operation.js";
3
+ import { SysProMDocument } from "../schema.js";
4
+ import { jsonToMarkdownSingle } from "../json-to-md.js";
5
+ export const jsonToMarkdownOp = defineOperation({
6
+ name: "jsonToMarkdown",
7
+ description: "Convert a SysProM document to single-file Markdown",
8
+ input: z.object({
9
+ doc: SysProMDocument,
10
+ }),
11
+ output: z.string(),
12
+ fn: ({ doc }) => jsonToMarkdownSingle(doc),
13
+ });