@millstone/synapse-schemas 0.1.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 (36) hide show
  1. package/README.md +71 -0
  2. package/body-grammars/adr.body-grammar.json +46 -0
  3. package/body-grammars/agreement.body-grammar.json +86 -0
  4. package/body-grammars/capability.body-grammar.json +73 -0
  5. package/body-grammars/meeting.body-grammar.json +93 -0
  6. package/body-grammars/policy.body-grammar.json +58 -0
  7. package/body-grammars/prd.body-grammar.json +220 -0
  8. package/body-grammars/process.body-grammar.json +107 -0
  9. package/body-grammars/reference.body-grammar.json +16 -0
  10. package/body-grammars/runbook.body-grammar.json +77 -0
  11. package/body-grammars/scorecard.body-grammar.json +68 -0
  12. package/body-grammars/sop.body-grammar.json +75 -0
  13. package/body-grammars/sow.body-grammar.json +189 -0
  14. package/body-grammars/standard.body-grammar.json +54 -0
  15. package/body-grammars/system.body-grammar.json +79 -0
  16. package/body-grammars/tdd.body-grammar.json +176 -0
  17. package/frontmatter/adr.schema.json +30 -0
  18. package/frontmatter/agreement.schema.json +191 -0
  19. package/frontmatter/base.schema.json +79 -0
  20. package/frontmatter/capability.schema.json +25 -0
  21. package/frontmatter/meeting.schema.json +52 -0
  22. package/frontmatter/policy.schema.json +25 -0
  23. package/frontmatter/prd.schema.json +37 -0
  24. package/frontmatter/process.schema.json +49 -0
  25. package/frontmatter/reference.schema.json +77 -0
  26. package/frontmatter/runbook.schema.json +19 -0
  27. package/frontmatter/scorecard.schema.json +176 -0
  28. package/frontmatter/sop.schema.json +42 -0
  29. package/frontmatter/sow.schema.json +35 -0
  30. package/frontmatter/standard.schema.json +31 -0
  31. package/frontmatter/system.schema.json +51 -0
  32. package/frontmatter/tdd.schema.json +25 -0
  33. package/index.js +9 -0
  34. package/package.json +34 -0
  35. package/plugins/marketplace.schema.json +126 -0
  36. package/plugins/plugin.schema.json +60 -0
@@ -0,0 +1,107 @@
1
+ {
2
+ "type": "process",
3
+ "displayName": "Process Document",
4
+ "sections": [
5
+ {
6
+ "id": "purpose",
7
+ "title": "Purpose",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": [
13
+ "paragraph",
14
+ "list",
15
+ "heading",
16
+ "thematicBreak"
17
+ ]
18
+ }
19
+ },
20
+ {
21
+ "id": "scope",
22
+ "title": "Scope",
23
+ "required": true,
24
+ "order": 2,
25
+ "shape": {
26
+ "type": "flow",
27
+ "allowedNodes": [
28
+ "paragraph",
29
+ "list",
30
+ "heading",
31
+ "thematicBreak"
32
+ ]
33
+ }
34
+ },
35
+ {
36
+ "id": "roles-and-responsibilities",
37
+ "title": "Roles and Responsibilities",
38
+ "required": true,
39
+ "order": 3,
40
+ "shape": {
41
+ "type": "list",
42
+ "ordered": false,
43
+ "minItems": 1
44
+ }
45
+ },
46
+ {
47
+ "id": "triggers",
48
+ "title": "Triggers",
49
+ "required": true,
50
+ "order": 4,
51
+ "shape": {
52
+ "type": "flow",
53
+ "allowedNodes": [
54
+ "paragraph",
55
+ "list",
56
+ "heading",
57
+ "table",
58
+ "thematicBreak"
59
+ ]
60
+ }
61
+ },
62
+ {
63
+ "id": "inputs",
64
+ "title": "Inputs",
65
+ "required": true,
66
+ "order": 5,
67
+ "shape": {
68
+ "type": "list",
69
+ "ordered": false,
70
+ "minItems": 1
71
+ }
72
+ },
73
+ {
74
+ "id": "outputs",
75
+ "title": "Outputs",
76
+ "required": true,
77
+ "order": 6,
78
+ "shape": {
79
+ "type": "list",
80
+ "ordered": false,
81
+ "minItems": 1
82
+ }
83
+ },
84
+ {
85
+ "id": "steps",
86
+ "title": "Steps",
87
+ "required": true,
88
+ "order": 7,
89
+ "shape": {
90
+ "type": "list",
91
+ "ordered": true,
92
+ "minItems": 1
93
+ }
94
+ },
95
+ {
96
+ "id": "controls",
97
+ "title": "Controls",
98
+ "required": true,
99
+ "order": 8,
100
+ "shape": {
101
+ "type": "list",
102
+ "ordered": false,
103
+ "minItems": 1
104
+ }
105
+ }
106
+ ]
107
+ }
@@ -0,0 +1,16 @@
1
+ {
2
+ "type": "reference",
3
+ "displayName": "Reference",
4
+ "sections": [
5
+ {
6
+ "id": "content",
7
+ "title": "Content",
8
+ "required": false,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": ["paragraph", "list", "code", "heading", "blockquote", "table"]
13
+ }
14
+ }
15
+ ]
16
+ }
@@ -0,0 +1,77 @@
1
+ {
2
+ "type": "runbook",
3
+ "displayName": "Runbook",
4
+ "sections": [
5
+ {
6
+ "id": "service",
7
+ "title": "Service",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "list",
12
+ "ordered": false,
13
+ "minItems": 1
14
+ }
15
+ },
16
+ {
17
+ "id": "alerts",
18
+ "title": "Alerts",
19
+ "required": true,
20
+ "order": 2,
21
+ "shape": {
22
+ "type": "list",
23
+ "ordered": false,
24
+ "minItems": 1
25
+ }
26
+ },
27
+ {
28
+ "id": "diagnosis-steps",
29
+ "title": "Diagnosis Steps",
30
+ "required": true,
31
+ "order": 3,
32
+ "shape": {
33
+ "type": "list",
34
+ "ordered": true,
35
+ "minItems": 1
36
+ }
37
+ },
38
+ {
39
+ "id": "remediation-steps",
40
+ "title": "Remediation Steps",
41
+ "required": true,
42
+ "order": 4,
43
+ "shape": {
44
+ "type": "list",
45
+ "ordered": true,
46
+ "minItems": 1
47
+ }
48
+ },
49
+ {
50
+ "id": "escalation",
51
+ "title": "Escalation",
52
+ "required": true,
53
+ "order": 5,
54
+ "shape": {
55
+ "type": "flow",
56
+ "allowedNodes": [
57
+ "paragraph",
58
+ "list",
59
+ "heading",
60
+ "table",
61
+ "thematicBreak"
62
+ ]
63
+ }
64
+ },
65
+ {
66
+ "id": "dashboards",
67
+ "title": "Dashboards",
68
+ "required": true,
69
+ "order": 6,
70
+ "shape": {
71
+ "type": "list",
72
+ "ordered": false,
73
+ "minItems": 1
74
+ }
75
+ }
76
+ ]
77
+ }
@@ -0,0 +1,68 @@
1
+ {
2
+ "type": "scorecard",
3
+ "displayName": "Scorecard",
4
+ "sections": [
5
+ {
6
+ "id": "overall-summary",
7
+ "title": "Overall Summary",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": ["paragraph", "heading", "thematicBreak"]
13
+ }
14
+ },
15
+ {
16
+ "id": "dimensions",
17
+ "title": "Dimensions",
18
+ "required": true,
19
+ "order": 2,
20
+ "shape": {
21
+ "type": "flow",
22
+ "allowedNodes": ["paragraph", "list", "table", "heading", "thematicBreak"]
23
+ }
24
+ },
25
+ {
26
+ "id": "strengths",
27
+ "title": "Strengths",
28
+ "required": true,
29
+ "order": 3,
30
+ "shape": {
31
+ "type": "list",
32
+ "ordered": false,
33
+ "minItems": 1
34
+ }
35
+ },
36
+ {
37
+ "id": "top-risks",
38
+ "title": "Top Risks",
39
+ "required": true,
40
+ "order": 4,
41
+ "shape": {
42
+ "type": "list",
43
+ "ordered": false,
44
+ "minItems": 1
45
+ }
46
+ },
47
+ {
48
+ "id": "recommendation",
49
+ "title": "Recommendation",
50
+ "required": true,
51
+ "order": 5,
52
+ "shape": {
53
+ "type": "flow",
54
+ "allowedNodes": ["paragraph", "heading", "thematicBreak"]
55
+ }
56
+ },
57
+ {
58
+ "id": "action-plan",
59
+ "title": "Action Plan",
60
+ "required": true,
61
+ "order": 6,
62
+ "shape": {
63
+ "type": "flow",
64
+ "allowedNodes": ["paragraph", "list", "table", "heading", "thematicBreak"]
65
+ }
66
+ }
67
+ ]
68
+ }
@@ -0,0 +1,75 @@
1
+ {
2
+ "type": "sop",
3
+ "displayName": "Standard Operating Procedure",
4
+ "sections": [
5
+ {
6
+ "id": "preconditions",
7
+ "title": "Preconditions",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "list",
12
+ "ordered": false,
13
+ "minItems": 1
14
+ }
15
+ },
16
+ {
17
+ "id": "materials-access",
18
+ "title": "Materials/Access",
19
+ "alternativeTitles": [
20
+ "Materials",
21
+ "Access"
22
+ ],
23
+ "required": true,
24
+ "order": 2,
25
+ "shape": {
26
+ "type": "list",
27
+ "ordered": false,
28
+ "minItems": 1
29
+ }
30
+ },
31
+ {
32
+ "id": "procedure",
33
+ "title": "Procedure",
34
+ "required": true,
35
+ "order": 3,
36
+ "shape": {
37
+ "type": "list",
38
+ "ordered": true,
39
+ "minItems": 1
40
+ }
41
+ },
42
+ {
43
+ "id": "validation",
44
+ "title": "Validation",
45
+ "required": true,
46
+ "order": 4,
47
+ "shape": {
48
+ "type": "flow",
49
+ "allowedNodes": [
50
+ "paragraph",
51
+ "list",
52
+ "code",
53
+ "heading",
54
+ "thematicBreak"
55
+ ]
56
+ }
57
+ },
58
+ {
59
+ "id": "rollback",
60
+ "title": "Rollback",
61
+ "required": true,
62
+ "order": 5,
63
+ "shape": {
64
+ "type": "flow",
65
+ "allowedNodes": [
66
+ "paragraph",
67
+ "list",
68
+ "code",
69
+ "heading",
70
+ "thematicBreak"
71
+ ]
72
+ }
73
+ }
74
+ ]
75
+ }
@@ -0,0 +1,189 @@
1
+ {
2
+ "type": "sow",
3
+ "displayName": "Statement of Work",
4
+ "sections": [
5
+ {
6
+ "id": "objective",
7
+ "title": "Objective",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": [
13
+ "paragraph",
14
+ "heading",
15
+ "thematicBreak"
16
+ ]
17
+ }
18
+ },
19
+ {
20
+ "id": "scope-of-work",
21
+ "title": "Scope of Work",
22
+ "required": true,
23
+ "order": 2,
24
+ "shape": {
25
+ "type": "list",
26
+ "ordered": false,
27
+ "minItems": 1
28
+ }
29
+ },
30
+ {
31
+ "id": "deliverables",
32
+ "title": "Deliverables",
33
+ "required": true,
34
+ "order": 3,
35
+ "shape": {
36
+ "type": "list",
37
+ "ordered": false,
38
+ "minItems": 1
39
+ }
40
+ },
41
+ {
42
+ "id": "out-of-scope",
43
+ "title": "Out of Scope",
44
+ "required": true,
45
+ "order": 4,
46
+ "shape": {
47
+ "type": "list",
48
+ "ordered": false,
49
+ "minItems": 1
50
+ }
51
+ },
52
+ {
53
+ "id": "timeline-and-milestones",
54
+ "title": "Timeline and Milestones",
55
+ "required": true,
56
+ "order": 5,
57
+ "shape": {
58
+ "type": "milestoneList",
59
+ "requireH3": true,
60
+ "requiredSubsections": [
61
+ "Deliverables",
62
+ "Acceptance Criteria"
63
+ ],
64
+ "requiredFields": [
65
+ "Duration",
66
+ "Payment"
67
+ ]
68
+ }
69
+ },
70
+ {
71
+ "id": "overall-acceptance-criteria",
72
+ "title": "Overall Acceptance Criteria",
73
+ "required": true,
74
+ "order": 6,
75
+ "shape": {
76
+ "type": "list",
77
+ "ordered": false,
78
+ "minItems": 1
79
+ }
80
+ },
81
+ {
82
+ "id": "assumptions",
83
+ "title": "Assumptions",
84
+ "required": true,
85
+ "order": 7,
86
+ "shape": {
87
+ "type": "list",
88
+ "ordered": false,
89
+ "minItems": 1
90
+ }
91
+ },
92
+ {
93
+ "id": "dependencies",
94
+ "title": "Dependencies",
95
+ "required": true,
96
+ "order": 8,
97
+ "shape": {
98
+ "type": "list",
99
+ "ordered": false,
100
+ "minItems": 1
101
+ }
102
+ },
103
+ {
104
+ "id": "risks-and-mitigations",
105
+ "title": "Risks and Mitigations",
106
+ "required": true,
107
+ "order": 9,
108
+ "shape": {
109
+ "type": "list",
110
+ "ordered": false,
111
+ "minItems": 1
112
+ }
113
+ },
114
+ {
115
+ "id": "change-control",
116
+ "title": "Change Control",
117
+ "required": true,
118
+ "order": 10,
119
+ "shape": {
120
+ "type": "flow",
121
+ "allowedNodes": [
122
+ "paragraph",
123
+ "heading",
124
+ "thematicBreak"
125
+ ]
126
+ }
127
+ },
128
+ {
129
+ "id": "pricing-and-payment-terms",
130
+ "title": "Pricing and Payment Terms",
131
+ "required": true,
132
+ "order": 11,
133
+ "shape": {
134
+ "type": "flow",
135
+ "allowedNodes": [
136
+ "paragraph",
137
+ "list",
138
+ "table",
139
+ "heading",
140
+ "thematicBreak"
141
+ ]
142
+ }
143
+ },
144
+ {
145
+ "id": "ip-and-confidentiality",
146
+ "title": "IP and Confidentiality",
147
+ "required": true,
148
+ "order": 12,
149
+ "shape": {
150
+ "type": "flow",
151
+ "allowedNodes": [
152
+ "paragraph",
153
+ "heading",
154
+ "thematicBreak"
155
+ ]
156
+ }
157
+ },
158
+ {
159
+ "id": "communication-cadence",
160
+ "title": "Communication Cadence",
161
+ "required": true,
162
+ "order": 13,
163
+ "shape": {
164
+ "type": "flow",
165
+ "allowedNodes": [
166
+ "paragraph",
167
+ "list",
168
+ "heading",
169
+ "thematicBreak"
170
+ ]
171
+ }
172
+ },
173
+ {
174
+ "id": "parties",
175
+ "title": "Parties",
176
+ "required": true,
177
+ "order": 14,
178
+ "shape": {
179
+ "type": "flow",
180
+ "allowedNodes": [
181
+ "paragraph",
182
+ "list",
183
+ "heading",
184
+ "thematicBreak"
185
+ ]
186
+ }
187
+ }
188
+ ]
189
+ }
@@ -0,0 +1,54 @@
1
+ {
2
+ "type": "standard",
3
+ "displayName": "Standard Document",
4
+ "sections": [
5
+ {
6
+ "id": "area",
7
+ "title": "Area",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": [
13
+ "paragraph",
14
+ "list",
15
+ "heading",
16
+ "thematicBreak"
17
+ ]
18
+ }
19
+ },
20
+ {
21
+ "id": "controls",
22
+ "title": "Controls",
23
+ "required": true,
24
+ "order": 2,
25
+ "shape": {
26
+ "type": "list",
27
+ "ordered": false,
28
+ "minItems": 1
29
+ }
30
+ },
31
+ {
32
+ "id": "compliance-mappings",
33
+ "title": "Compliance Mappings",
34
+ "required": true,
35
+ "order": 3,
36
+ "shape": {
37
+ "type": "list",
38
+ "ordered": false,
39
+ "minItems": 1
40
+ }
41
+ },
42
+ {
43
+ "id": "related-policies",
44
+ "title": "Related Policies",
45
+ "required": true,
46
+ "order": 4,
47
+ "shape": {
48
+ "type": "list",
49
+ "ordered": false,
50
+ "minItems": 1
51
+ }
52
+ }
53
+ ]
54
+ }
@@ -0,0 +1,79 @@
1
+ {
2
+ "type": "system",
3
+ "displayName": "System",
4
+ "sections": [
5
+ {
6
+ "id": "overview",
7
+ "title": "Overview",
8
+ "required": true,
9
+ "order": 1,
10
+ "shape": {
11
+ "type": "flow",
12
+ "allowedNodes": ["paragraph", "heading", "list", "thematicBreak"]
13
+ }
14
+ },
15
+ {
16
+ "id": "architecture",
17
+ "title": "Architecture",
18
+ "required": true,
19
+ "order": 2,
20
+ "shape": {
21
+ "type": "flow",
22
+ "allowedNodes": ["paragraph", "list", "code", "heading", "table", "thematicBreak"]
23
+ }
24
+ },
25
+ {
26
+ "id": "repositories",
27
+ "title": "Repositories",
28
+ "required": true,
29
+ "order": 3,
30
+ "shape": {
31
+ "type": "list",
32
+ "ordered": false,
33
+ "minItems": 1
34
+ }
35
+ },
36
+ {
37
+ "id": "runtime-environment",
38
+ "title": "Runtime Environment",
39
+ "required": true,
40
+ "order": 4,
41
+ "shape": {
42
+ "type": "flow",
43
+ "allowedNodes": ["paragraph", "list", "code", "heading", "table", "thematicBreak"]
44
+ }
45
+ },
46
+ {
47
+ "id": "dependencies",
48
+ "title": "Dependencies",
49
+ "required": true,
50
+ "order": 5,
51
+ "shape": {
52
+ "type": "list",
53
+ "ordered": false,
54
+ "minItems": 1
55
+ }
56
+ },
57
+ {
58
+ "id": "sla",
59
+ "title": "SLA",
60
+ "required": false,
61
+ "order": 6,
62
+ "shape": {
63
+ "type": "flow",
64
+ "allowedNodes": ["paragraph", "table", "heading", "thematicBreak"]
65
+ }
66
+ },
67
+ {
68
+ "id": "runbooks",
69
+ "title": "Runbooks",
70
+ "required": false,
71
+ "order": 7,
72
+ "shape": {
73
+ "type": "list",
74
+ "ordered": false,
75
+ "minItems": 1
76
+ }
77
+ }
78
+ ]
79
+ }