@sdd-method/author-cli 0.0.0-stage → 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 (203) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +17 -0
  3. package/README.md +6 -2
  4. package/dist/author-bin.js +8 -0
  5. package/dist/author-program.js +99 -0
  6. package/dist/lib/adr-origin.js +59 -0
  7. package/dist/lib/agent-harness.js +37 -0
  8. package/dist/lib/api-surface/__fixtures__/serverless-repo/serverless/serverless.yml +18 -0
  9. package/dist/lib/api-surface/analyzers/library.js +95 -0
  10. package/dist/lib/api-surface/analyzers/serverless.js +336 -0
  11. package/dist/lib/api-surface/analyzers/spring.js +237 -0
  12. package/dist/lib/api-surface/analyzers/terraform.js +109 -0
  13. package/dist/lib/api-surface/detect.js +25 -0
  14. package/dist/lib/api-surface/emit.js +109 -0
  15. package/dist/lib/api-surface/file-set.js +43 -0
  16. package/dist/lib/api-surface/index.js +134 -0
  17. package/dist/lib/api-surface/types.js +17 -0
  18. package/dist/lib/briefing/index.js +13 -0
  19. package/dist/lib/briefing/render.js +132 -0
  20. package/dist/lib/briefing/variables.js +92 -0
  21. package/dist/lib/catalogue/application-archetype/vocabulary.js +177 -0
  22. package/dist/lib/catalogue/archetype/maps/android.yaml +66 -0
  23. package/dist/lib/catalogue/archetype/maps/swiftui.yaml +58 -0
  24. package/dist/lib/catalogue/archetype/maps/uikit.yaml +48 -0
  25. package/dist/lib/catalogue/archetype/maps/web-generic.yaml +86 -0
  26. package/dist/lib/catalogue/archetype/openui-archetype-vocabulary.yaml +46 -0
  27. package/dist/lib/catalogue/archetype/resolver.js +103 -0
  28. package/dist/lib/catalogue/archetype/wireframe.js +418 -0
  29. package/dist/lib/catalogue/baseline-check.js +151 -0
  30. package/dist/lib/catalogue/build.js +1502 -0
  31. package/dist/lib/catalogue/builders/adr-supersedes.js +103 -0
  32. package/dist/lib/catalogue/builders/adrs.js +222 -0
  33. package/dist/lib/catalogue/builders/application-conformance-coverage.js +47 -0
  34. package/dist/lib/catalogue/builders/application-data-plane-bindings.js +115 -0
  35. package/dist/lib/catalogue/builders/c4-components.js +229 -0
  36. package/dist/lib/catalogue/builders/c4-containers.js +240 -0
  37. package/dist/lib/catalogue/builders/c4-entity-rollups.js +87 -0
  38. package/dist/lib/catalogue/builders/c4-external-systems.js +194 -0
  39. package/dist/lib/catalogue/builders/c4-l1-candidates.js +107 -0
  40. package/dist/lib/catalogue/builders/c4-systems.js +98 -0
  41. package/dist/lib/catalogue/builders/capabilities.js +488 -0
  42. package/dist/lib/catalogue/builders/capability-domain-model.js +74 -0
  43. package/dist/lib/catalogue/builders/capability-edges.js +256 -0
  44. package/dist/lib/catalogue/builders/capability-spec-walker.js +99 -0
  45. package/dist/lib/catalogue/builders/capability-spec.js +348 -0
  46. package/dist/lib/catalogue/builders/container-dependency.js +183 -0
  47. package/dist/lib/catalogue/builders/contracts.js +402 -0
  48. package/dist/lib/catalogue/builders/data-items.js +344 -0
  49. package/dist/lib/catalogue/builders/data-store-mapping.js +113 -0
  50. package/dist/lib/catalogue/builders/domain-models.js +175 -0
  51. package/dist/lib/catalogue/builders/domains.js +119 -0
  52. package/dist/lib/catalogue/builders/edge-label-merge.js +19 -0
  53. package/dist/lib/catalogue/builders/entities-manifest.js +160 -0
  54. package/dist/lib/catalogue/builders/entities-mermaid.js +189 -0
  55. package/dist/lib/catalogue/builders/entity-persistence.js +102 -0
  56. package/dist/lib/catalogue/builders/entity-slug.js +47 -0
  57. package/dist/lib/catalogue/builders/event-catalog-walker.js +186 -0
  58. package/dist/lib/catalogue/builders/event-edges.js +327 -0
  59. package/dist/lib/catalogue/builders/events.js +168 -0
  60. package/dist/lib/catalogue/builders/evidence-class.js +43 -0
  61. package/dist/lib/catalogue/builders/evidence-target-repo.js +67 -0
  62. package/dist/lib/catalogue/builders/external-system-exemption.js +120 -0
  63. package/dist/lib/catalogue/builders/feature-contract.js +77 -0
  64. package/dist/lib/catalogue/builders/feature-domain-model.js +50 -0
  65. package/dist/lib/catalogue/builders/feature-grounding-walker.js +254 -0
  66. package/dist/lib/catalogue/builders/feature-grounding.js +391 -0
  67. package/dist/lib/catalogue/builders/feature-groups.js +63 -0
  68. package/dist/lib/catalogue/builders/feature-subscription-channels.js +228 -0
  69. package/dist/lib/catalogue/builders/feature-tree-walker.js +295 -0
  70. package/dist/lib/catalogue/builders/features.js +300 -0
  71. package/dist/lib/catalogue/builders/glossary-xref.js +378 -0
  72. package/dist/lib/catalogue/builders/glossary.js +204 -0
  73. package/dist/lib/catalogue/builders/implementations.js +214 -0
  74. package/dist/lib/catalogue/builders/index.js +64 -0
  75. package/dist/lib/catalogue/builders/integration-components.js +344 -0
  76. package/dist/lib/catalogue/builders/integrations.js +181 -0
  77. package/dist/lib/catalogue/builders/persona-c4system.js +149 -0
  78. package/dist/lib/catalogue/builders/persona-container.js +133 -0
  79. package/dist/lib/catalogue/builders/persona-journey-edges.js +133 -0
  80. package/dist/lib/catalogue/builders/personas.js +152 -0
  81. package/dist/lib/catalogue/builders/product-edges.js +106 -0
  82. package/dist/lib/catalogue/builders/product-platform-dependencies.js +405 -0
  83. package/dist/lib/catalogue/builders/products.js +162 -0
  84. package/dist/lib/catalogue/builders/quality-scores.js +635 -0
  85. package/dist/lib/catalogue/builders/repo-capability-exemption.js +61 -0
  86. package/dist/lib/catalogue/builders/repo-dependency.js +127 -0
  87. package/dist/lib/catalogue/builders/repo-edges.js +340 -0
  88. package/dist/lib/catalogue/builders/repositories.js +458 -0
  89. package/dist/lib/catalogue/builders/scaffolds.js +197 -0
  90. package/dist/lib/catalogue/builders/screen-tree.js +222 -0
  91. package/dist/lib/catalogue/builders/screens.js +396 -0
  92. package/dist/lib/catalogue/builders/service-capability-exemption.js +63 -0
  93. package/dist/lib/catalogue/builders/service-contract-consumes.js +186 -0
  94. package/dist/lib/catalogue/builders/service-contract.js +74 -0
  95. package/dist/lib/catalogue/builders/service-entity-tables.js +187 -0
  96. package/dist/lib/catalogue/builders/services.js +232 -0
  97. package/dist/lib/catalogue/builders/system-external-dependency.js +115 -0
  98. package/dist/lib/catalogue/builders/user-journeys.js +253 -0
  99. package/dist/lib/catalogue/canonical-schema.yaml +4117 -0
  100. package/dist/lib/catalogue/cli-version.js +10 -0
  101. package/dist/lib/catalogue/contract-id.js +49 -0
  102. package/dist/lib/catalogue/coverage-predicates.js +603 -0
  103. package/dist/lib/catalogue/coverage-render.js +552 -0
  104. package/dist/lib/catalogue/coverage-run.js +115 -0
  105. package/dist/lib/catalogue/csv-reader.js +97 -0
  106. package/dist/lib/catalogue/csv-writer.js +96 -0
  107. package/dist/lib/catalogue/data-plane-coherence.js +77 -0
  108. package/dist/lib/catalogue/ddl-generator.js +233 -0
  109. package/dist/lib/catalogue/dedupe-keyed-tables.js +0 -0
  110. package/dist/lib/catalogue/engine-validator.js +239 -0
  111. package/dist/lib/catalogue/ext-id.js +76 -0
  112. package/dist/lib/catalogue/feature-grounding-aliases-loader.js +65 -0
  113. package/dist/lib/catalogue/feature-repo-zero-resolution-summary.js +31 -0
  114. package/dist/lib/catalogue/finding-identity.js +183 -0
  115. package/dist/lib/catalogue/findings.js +46 -0
  116. package/dist/lib/catalogue/fk-validator.js +136 -0
  117. package/dist/lib/catalogue/freshness.js +70 -0
  118. package/dist/lib/catalogue/gate-checks.js +338 -0
  119. package/dist/lib/catalogue/graph-projection.js +346 -0
  120. package/dist/lib/catalogue/impact-run.js +228 -0
  121. package/dist/lib/catalogue/manifest-loader.js +435 -0
  122. package/dist/lib/catalogue/platform-scope.js +7 -0
  123. package/dist/lib/catalogue/population-checks.js +87 -0
  124. package/dist/lib/catalogue/relationship-semantics.js +66 -0
  125. package/dist/lib/catalogue/reverse-product-quality.js +99 -0
  126. package/dist/lib/catalogue/rubric-coverage-map.yaml +871 -0
  127. package/dist/lib/catalogue/runway-vocabulary-loader.js +56 -0
  128. package/dist/lib/catalogue/scaffold-delta.js +261 -0
  129. package/dist/lib/catalogue/schema-compat.js +52 -0
  130. package/dist/lib/catalogue/schema-loader.js +87 -0
  131. package/dist/lib/catalogue/scores-coverage.js +573 -0
  132. package/dist/lib/catalogue/screen-validation-loader.js +89 -0
  133. package/dist/lib/catalogue/service-architecture-parser.js +193 -0
  134. package/dist/lib/catalogue/service-contract-aliases-loader.js +109 -0
  135. package/dist/lib/catalogue/staleness-verdicts.js +345 -0
  136. package/dist/lib/catalogue/traceability-loader.js +350 -0
  137. package/dist/lib/catalogue/validate.js +200 -0
  138. package/dist/lib/catalogue/version.js +18 -0
  139. package/dist/lib/conformance/binding.js +70 -0
  140. package/dist/lib/conformance/finding.js +69 -0
  141. package/dist/lib/conformance/index.js +578 -0
  142. package/dist/lib/context-pull/index.js +191 -0
  143. package/dist/lib/context-pull/resolve.js +70 -0
  144. package/dist/lib/context-pull/retired-mcp-setup.js +7 -0
  145. package/dist/lib/contracts-availability/index.js +267 -0
  146. package/dist/lib/generate-briefing/index.js +77 -0
  147. package/dist/lib/list/discover.js +100 -0
  148. package/dist/lib/list/format.js +84 -0
  149. package/dist/lib/list/index.js +16 -0
  150. package/dist/lib/lock-file.js +437 -0
  151. package/dist/lib/pack/log.js +18 -0
  152. package/dist/lib/pack/schema.js +121 -0
  153. package/dist/lib/pack/seed.js +182 -0
  154. package/dist/lib/pack/validate.js +49 -0
  155. package/dist/lib/package-version.js +92 -0
  156. package/dist/lib/plan/index.js +69 -0
  157. package/dist/lib/plan/read-sdd.js +102 -0
  158. package/dist/lib/plan/render-template.js +84 -0
  159. package/dist/lib/repo-kind.js +129 -0
  160. package/dist/lib/scaffold/domain.js +234 -0
  161. package/dist/lib/scaffold/registry.js +136 -0
  162. package/dist/lib/scripts.js +7 -0
  163. package/dist/lib/sdd-index/repo-config.js +245 -0
  164. package/dist/lib/sdd-reader.js +91 -0
  165. package/dist/lib/snapshot/advance.js +454 -0
  166. package/dist/lib/snapshot/diff.js +190 -0
  167. package/dist/lib/snapshot/fold.js +208 -0
  168. package/dist/lib/snapshot/land.js +178 -0
  169. package/dist/lib/snapshot/manifest.js +206 -0
  170. package/dist/lib/snapshot/targets.js +169 -0
  171. package/dist/lib/snapshot/verify.js +91 -0
  172. package/dist/lib/sync/briefing-merge.js +106 -0
  173. package/dist/lib/sync/bundle-cache.js +109 -0
  174. package/dist/lib/sync/yaml-block-merge.js +120 -0
  175. package/dist/lib/validate/aggregate.js +51 -0
  176. package/dist/lib/validate/bundle-coherence.js +74 -0
  177. package/dist/lib/validate/dispatch.js +243 -0
  178. package/dist/lib/validate/index.js +110 -0
  179. package/dist/lib/validate/plan.js +54 -0
  180. package/dist/lib/validate/runner.js +85 -0
  181. package/dist/lib/validate/yaml-parse.js +112 -0
  182. package/dist/maintain-version.json +4 -0
  183. package/dist/verbs/api-surface.js +71 -0
  184. package/dist/verbs/catalogue-check.js +28 -0
  185. package/dist/verbs/catalogue-verify.js +114 -0
  186. package/dist/verbs/conformance.js +34 -0
  187. package/dist/verbs/context.js +39 -0
  188. package/dist/verbs/contracts.js +34 -0
  189. package/dist/verbs/generate-briefing.js +29 -0
  190. package/dist/verbs/list.js +45 -0
  191. package/dist/verbs/pack-validate.js +17 -0
  192. package/dist/verbs/path-option.js +25 -0
  193. package/dist/verbs/plan.js +42 -0
  194. package/dist/verbs/render.js +87 -0
  195. package/dist/verbs/scaffold.js +83 -0
  196. package/dist/verbs/snapshot.js +134 -0
  197. package/dist/verbs/validate.js +48 -0
  198. package/dist/verify-program.js +122 -0
  199. package/dist/verify-version.json +4 -0
  200. package/package.json +32 -4
  201. package/scripts/validate-app-dependencies.sh +664 -0
  202. package/scripts/validate-app-docs.sh +199 -0
  203. package/scripts/validate-integration-docs.sh +505 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,17 @@
1
+ sdd-cli
2
+ Copyright 2026 Tom Foster
3
+
4
+ This product includes software developed as part of the SDD method
5
+ distribution (https://github.com/tomfosteruk/sdd-method).
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,7 @@
1
- # Temporary Holding Version
1
+ # @sdd-method/author-cli
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ `sdd-author` is for the people and agents who own one SDD's content. It re-authors that content and **cannot move the baseline or rebuild the model** (M-ADR 0220).
4
+
5
+ Verbs: everything in `@sdd-method/verify-cli`, plus `scaffold domain`, `plan`, `contracts attest`, `conformance`, `api-surface`, the `snapshot` verbs, `render screen`, `generate-briefing`, `context pull` and `catalogue check`.
6
+
7
+ `catalogue check` reports whether the committed catalogues are what the committed specifications build to, and writes nothing. Rebuilding them (`catalogue build`), `sync` and `pack build` are in `@sdd-method/maintain-cli`; `init` and the administrator's verbs are in `@sdd-method/sdd-cli`. They are not present in this package, and invoking one fails with exit 1.
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env node
2
+ import { runAuthor } from "./author-program.js";
3
+ runAuthor(process.argv.slice(2)).catch((err) => {
4
+ const message = err instanceof Error ? err.message : String(err);
5
+ process.stderr.write(`sdd-author: ${message}\n`);
6
+ process.exit(1);
7
+ });
8
+ //# sourceMappingURL=author-bin.js.map
@@ -0,0 +1,99 @@
1
+ // Fifth entrypoint: the AUTHOR surface — M-ADR 0220 §4.1–4.3.
2
+ //
3
+ // The binary for the people and agents who own one SDD's content: it re-authors that content and
4
+ // cannot move the baseline or rebuild the model. Author and maintain are SIBLINGS, not a nesting
5
+ // (0220 §4.1): both carry the whole verify surface, and the author adds what 0220 §4.2 gives it —
6
+ // new artefacts and plans (`scaffold`, `plan`), the evidence and findings it triages (`contracts`,
7
+ // `conformance`, `api-surface`, the `snapshot` verbs), the projections maintain also holds
8
+ // (`render screen`, `generate-briefing`, `context pull`), and `catalogue check`, which reports a
9
+ // stale model and writes nothing.
10
+ //
11
+ // Not here, by design: `sync`, `catalogue build | aggregate | graph | diff` and `pack build`
12
+ // (maintain's), and `init`, `metamodel roundtrip` and `catalogue migration-map` (sdd-cli's,
13
+ // the ADMIN artefact). As with sdd-verify and sdd-maintain, the boundary is ABSENCE, not a menu:
14
+ // the package ships only the import closure of author-bin.js, so registration imports
15
+ // per-subcommand registrars, never a barrel that re-exports a writer.
16
+ import { Command, CommanderError } from "commander";
17
+ import { getPackageVersion } from "./lib/package-version.js";
18
+ import { registerVerifySurface, rejectOutsideSurface, VERIFY_SURFACE } from "./verify-program.js";
19
+ import { registerApiSurface } from "./verbs/api-surface.js";
20
+ import { registerCatalogueCheck } from "./verbs/catalogue-check.js";
21
+ import { registerConformance } from "./verbs/conformance.js";
22
+ import { registerContext } from "./verbs/context.js";
23
+ import { registerContracts } from "./verbs/contracts.js";
24
+ import { registerGenerateBriefing } from "./verbs/generate-briefing.js";
25
+ import { registerPlan } from "./verbs/plan.js";
26
+ import { registerRender } from "./verbs/render.js";
27
+ import { registerScaffold } from "./verbs/scaffold.js";
28
+ import { registerSnapshot } from "./verbs/snapshot.js";
29
+ const SPEC_URL = "https://github.com/tomfosteruk/sdd-method/blob/main/docs/method/cli/sdd-cli-specification.md";
30
+ /** The verbs the author adds to verify, as `<verb>` or `<verb> <subcommand>` (M-ADR 0220 §4.2). Asserted by test. */
31
+ export const AUTHOR_ONLY_SURFACE = [
32
+ "scaffold domain",
33
+ "plan",
34
+ "contracts attest",
35
+ "conformance",
36
+ "api-surface",
37
+ "snapshot fold",
38
+ "snapshot land",
39
+ "snapshot verify",
40
+ "snapshot diff",
41
+ "snapshot targets",
42
+ "snapshot advance",
43
+ "render screen",
44
+ "generate-briefing",
45
+ "context pull",
46
+ "catalogue check",
47
+ ];
48
+ /** The full surface: verify's, plus the author's own. */
49
+ export const AUTHOR_SURFACE = [...VERIFY_SURFACE, ...AUTHOR_ONLY_SURFACE];
50
+ const OUTSIDE = "is not part of sdd-author, which re-authors one SDD's content but cannot move its baseline or rebuild its model. " +
51
+ "Sync, catalogue build and pack build are in @sdd-method/maintain-cli; init and the rest are in @sdd-method/sdd-cli.";
52
+ export async function runAuthor(argv) {
53
+ const program = buildAuthorProgram();
54
+ if (argv.length === 0) {
55
+ program.outputHelp();
56
+ return;
57
+ }
58
+ rejectOutsideSurface(program, argv, OUTSIDE);
59
+ try {
60
+ await program.parseAsync([...argv], { from: "user" });
61
+ }
62
+ catch (err) {
63
+ if (err instanceof CommanderError) {
64
+ if (err.code === "commander.help" || err.code === "commander.helpDisplayed" || err.code === "commander.version") {
65
+ return;
66
+ }
67
+ }
68
+ throw err;
69
+ }
70
+ }
71
+ export function buildAuthorProgram() {
72
+ const program = new Command();
73
+ program
74
+ .name("sdd-author")
75
+ .description("Re-author one SDD's content — scaffold, plan, contracts, conformance, api-surface, snapshots, briefings, catalogue check — plus every read-only verify verb. Cannot sync the baseline or rebuild the catalogues.")
76
+ .version(getPackageVersion(), "-v, --version")
77
+ .addHelpText("after", `\nSpec: ${SPEC_URL}\nSync, catalogue build and pack build are in @sdd-method/maintain-cli; init and the administrator's verbs are in @sdd-method/sdd-cli.`)
78
+ .exitOverride()
79
+ .configureOutput({
80
+ writeOut: (str) => process.stdout.write(str),
81
+ writeErr: (str) => process.stderr.write(str),
82
+ });
83
+ // The verify surface first, from verify's own registration: verify ⊂ author is structural.
84
+ registerVerifySurface(program);
85
+ registerScaffold(program);
86
+ registerPlan(program);
87
+ registerContracts(program);
88
+ registerConformance(program);
89
+ registerApiSurface(program);
90
+ registerSnapshot(program);
91
+ registerRender(program);
92
+ registerGenerateBriefing(program);
93
+ registerContext(program);
94
+ const catalogue = program.commands.find((c) => c.name() === "catalogue");
95
+ catalogue.description("Validate and query per-SDD catalogues (ADR 0134), and check them for staleness — never rebuilds");
96
+ registerCatalogueCheck(catalogue);
97
+ return program;
98
+ }
99
+ //# sourceMappingURL=author-program.js.map
@@ -0,0 +1,59 @@
1
+ // Single source of truth for ADR origin prefixes (M-ADR 0140 §4.1 / M-ADR 0186).
2
+ //
3
+ // The origin prefix is CANONICAL and marks the producer tier — method /
4
+ // reference-architecture / adopter-platform / adopter-domain. It is derived two
5
+ // ways, by design (M-ADR 0186 §4.3):
6
+ // - PRODUCER prefixes are a pure function of the NUMBER band, because
7
+ // `0xxx`/`9xxx` are globally-unique producer namespaces (disjoint ranges).
8
+ // - ADOPTER prefixes (`P-`/`D-`) are a function of SCOPE — where the ADR lives
9
+ // — because adopter numbers are a flat local sequence (`1000–8999`, M-ADR
10
+ // 0140) that does not globally encode platform-vs-domain. A platform ADR is
11
+ // `P-ADR` and a domain ADR is `D-ADR` at whatever number it holds.
12
+ //
13
+ // Every ADR detection/parse point resolves by NUMBER and treats the prefix as an
14
+ // interchangeable origin marker, so a bare `ADR NNNN` (legacy / unmigrated /
15
+ // human) and any prefixed form map to the same `ADR-NNNN` identity during the
16
+ // dual-resolution window. Adding a future tier is a one-line change here.
17
+ /**
18
+ * The producer origin prefix for an ADR number, by globally-unique band:
19
+ * `0000–0999` → `M-ADR` (method)
20
+ * `9000–9999` → `RA-ADR` (reference architecture)
21
+ * Adopter numbers (`1000–8999`) are NOT number-derivable — their prefix depends
22
+ * on scope; see `originPrefixForPath`. Returns `null` for them.
23
+ */
24
+ export function originPrefixForNumber(num) {
25
+ if (/^0\d{3}$/.test(num))
26
+ return "M-ADR";
27
+ if (/^9\d{3}$/.test(num))
28
+ return "RA-ADR";
29
+ return null;
30
+ }
31
+ /**
32
+ * The canonical origin prefix for an ADR at a repo-relative path (M-ADR 0186):
33
+ * producer ADRs by number band; adopter ADRs by SCOPE (directory) — a domain
34
+ * ADR (`docs/domains/<d>/…/adr/`) is `D-ADR`, a platform ADR (`docs/platform/adr/`)
35
+ * is `P-ADR`. `docs/method/platform-adr/` holds method (`0xxx`) ADRs, resolved by
36
+ * number to `M-ADR` before the scope check. Returns `null` if undeterminable.
37
+ */
38
+ export function originPrefixForPath(relPath, num) {
39
+ const byNum = originPrefixForNumber(num);
40
+ if (byNum)
41
+ return byNum;
42
+ if (/\/domains\/[^/]+\/(?:.*\/)?adr\//.test(relPath))
43
+ return "D-ADR";
44
+ if (/\/platform\/adr\//.test(relPath))
45
+ return "P-ADR";
46
+ return null;
47
+ }
48
+ /**
49
+ * Regex source matching the optional origin prefix that precedes `ADR` in a
50
+ * filename, heading, or reference — `M-`, `RA-`, `P-`, `D-`, or none (a bare or
51
+ * not-yet-migrated identifier). Non-capturing, so composing it does not shift a
52
+ * caller's group indices.
53
+ */
54
+ export const ORIGIN_PREFIX_SRC = "(?:M-|RA-|P-|D-)?";
55
+ /** Strip a leading origin prefix (`M-ADR 0044` → `ADR 0044`); a bare id is returned unchanged. */
56
+ export function stripOriginPrefix(id) {
57
+ return id.replace(/^(?:M-|RA-|P-|D-)(?=ADR\b)/i, "");
58
+ }
59
+ //# sourceMappingURL=adr-origin.js.map
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Agent-harness identifiers — the value space of `--agent-harness` on
3
+ * `sdd-cli init`, `sdd-cli sync` and `context pull` per ADR 0141 §4.6.
4
+ *
5
+ * Claude Code is the one supported harness (M-ADR 0220 §4.6) and the default. The GitHub Copilot
6
+ * CLI value is retired: passing it fails, naming that record. Every SDD and code repository also
7
+ * gets an AGENTS.md pointer to agent-instructions.md, with no flag; it is a pointer, not support
8
+ * for another harness. Adopters binding any other harness implement the portable contracts
9
+ * themselves (ADR 0141 §4.5).
10
+ */
11
+ export const AGENT_HARNESSES = ["claude-code"];
12
+ export const DEFAULT_AGENT_HARNESS = "claude-code";
13
+ /** Retired values, each with the record that retired it. */
14
+ export const RETIRED_AGENT_HARNESSES = {
15
+ "github-copilot-cli": "M-ADR 0220 §4.6",
16
+ };
17
+ export function isAgentHarness(value) {
18
+ return AGENT_HARNESSES.includes(value);
19
+ }
20
+ /**
21
+ * Resolve an optional CLI input to a concrete harness, falling back to
22
+ * the reference default when unset. Throws on an unsupported or retired
23
+ * value so the CLI can surface a clear error to the caller.
24
+ */
25
+ export function resolveAgentHarness(input) {
26
+ if (input === undefined)
27
+ return DEFAULT_AGENT_HARNESS;
28
+ const retired = RETIRED_AGENT_HARNESSES[input];
29
+ if (retired !== undefined) {
30
+ throw new Error(`--agent-harness "${input}" is retired (${retired}): Claude Code is the one supported harness, and every repository gets an AGENTS.md pointer to agent-instructions.md without a flag. Supported: ${AGENT_HARNESSES.join(", ")}.`);
31
+ }
32
+ if (!isAgentHarness(input)) {
33
+ throw new Error(`Unsupported --agent-harness "${input}". Supported: ${AGENT_HARNESSES.join(", ")}.`);
34
+ }
35
+ return input;
36
+ }
37
+ //# sourceMappingURL=agent-harness.js.map
@@ -0,0 +1,18 @@
1
+ {{- $vpc := .Values.Vpc | default "true" -}}
2
+ service: demo-sms
3
+ provider:
4
+ name: aws
5
+ runtime: nodejs18.x
6
+ functions:
7
+ sendSms:
8
+ handler: src/sendSms.handler
9
+ events:
10
+ - http:
11
+ method: POST
12
+ path: /sms/
13
+ resources:
14
+ Resources:
15
+ OutboundQueue:
16
+ Type: "AWS::SQS::Queue"
17
+ Properties:
18
+ QueueName: 'demo-outbound-sqs'
@@ -0,0 +1,95 @@
1
+ import { dirname } from "node:path";
2
+ import { allBySuffix, findBySuffix } from "../file-set.js";
3
+ // library analyzer. A repo with a build manifest but no endpoints: a shared library / API client.
4
+ // pom.xml → package_name = <groupId>:<artifactId>; exports = top-level Java packages.
5
+ // package.json → package_name = name; exports from `main`/`exports`.
6
+ // `consumed_by` is left [] with a TODO marker — it cannot be known from the repo alone (no fabrication).
7
+ const CONSUMED_BY_TODO = "TODO: consumed_by unknown from repo alone — fill from catalogue/aggregate";
8
+ export async function analyzeLibrary(fileSet) {
9
+ const pom = findBySuffix(fileSet.files, "pom.xml");
10
+ if (pom) {
11
+ return analyzeMaven(fileSet, pom);
12
+ }
13
+ const pkg = findBySuffix(fileSet.files, "package.json");
14
+ if (pkg) {
15
+ return analyzeNpm(fileSet, pkg);
16
+ }
17
+ // Fallback: build.gradle library.
18
+ const gradle = findBySuffix(fileSet.files, "build.gradle");
19
+ if (gradle) {
20
+ return analyzeGradle(fileSet, gradle);
21
+ }
22
+ return emptyLibrary();
23
+ }
24
+ async function analyzeMaven(fileSet, pomPath) {
25
+ const pom = await fileSet.read(pomPath);
26
+ const groupId = pom.match(/<groupId>\s*([^<]+)<\/groupId>/)?.[1]?.trim() ?? "";
27
+ const artifactId = pom.match(/<artifactId>\s*([^<]+)<\/artifactId>/)?.[1]?.trim() ?? "";
28
+ const packageName = [groupId, artifactId].filter(Boolean).join(":") || artifactId;
29
+ const exports = topLevelJavaPackages(fileSet);
30
+ return libraryResult({ package_name: packageName, exports });
31
+ }
32
+ async function analyzeNpm(fileSet, pkgPath) {
33
+ const raw = await fileSet.read(pkgPath);
34
+ let pkg = {};
35
+ try {
36
+ pkg = JSON.parse(raw);
37
+ }
38
+ catch {
39
+ pkg = {};
40
+ }
41
+ const packageName = typeof pkg["name"] === "string" ? pkg["name"] : "";
42
+ const exports = [];
43
+ if (typeof pkg["main"] === "string") {
44
+ exports.push({ name: pkg["main"], type: "entrypoint", description: "main" });
45
+ }
46
+ const exp = pkg["exports"];
47
+ if (typeof exp === "string") {
48
+ exports.push({ name: exp, type: "entrypoint", description: "exports" });
49
+ }
50
+ else if (exp && typeof exp === "object") {
51
+ for (const key of Object.keys(exp)) {
52
+ exports.push({ name: key, type: "export-path", description: "exports" });
53
+ }
54
+ }
55
+ return libraryResult({ package_name: packageName, exports });
56
+ }
57
+ async function analyzeGradle(fileSet, gradlePath) {
58
+ const src = await fileSet.read(gradlePath);
59
+ const group = src.match(/group\s*=?\s*['"]([^'"]+)['"]/)?.[1] ?? "";
60
+ // Artifact name is usually the repo dir; use the gradle file's parent dir basename.
61
+ const artifact = dirname(gradlePath).split("/").pop() ?? "";
62
+ const packageName = [group, artifact].filter(Boolean).join(":") || artifact;
63
+ return libraryResult({ package_name: packageName, exports: topLevelJavaPackages(fileSet) });
64
+ }
65
+ function topLevelJavaPackages(fileSet) {
66
+ const javaFiles = allBySuffix(fileSet.files, ".java").filter((f) => !/(^|\/)(target|build|test)\//.test(f) && !/Test\.java$/.test(f));
67
+ const packages = new Set();
68
+ for (const f of javaFiles) {
69
+ // Derive a package from `src/main/java/<a>/<b>/<c>/File.java` → a.b.c (cap at 4 segments).
70
+ const m = f.match(/src\/main\/java\/(.+)\/[^/]+\.java$/);
71
+ if (!m)
72
+ continue;
73
+ const segments = m[1].split("/").slice(0, 4);
74
+ packages.add(segments.join("."));
75
+ }
76
+ return [...packages]
77
+ .sort()
78
+ .map((p) => ({ name: p, type: "java-package", description: "exported package" }));
79
+ }
80
+ function libraryResult(publicApi) {
81
+ return {
82
+ stack: "library",
83
+ component_type: "library",
84
+ endpoints: [],
85
+ dependencies: { downstream: [], upstream: [] },
86
+ external_contracts: [],
87
+ deployment: { runtime: "", shared_infra: [], notes: [CONSUMED_BY_TODO] },
88
+ public_api: publicApi,
89
+ consumed_by: [],
90
+ };
91
+ }
92
+ function emptyLibrary() {
93
+ return libraryResult({ package_name: "", exports: [] });
94
+ }
95
+ //# sourceMappingURL=library.js.map