ai-spector 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 (168) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +150 -0
  3. package/dist/cli.d.ts +3 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +173 -0
  6. package/dist/cli.js.map +1 -0
  7. package/dist/commands/analyze.d.ts +9 -0
  8. package/dist/commands/analyze.d.ts.map +1 -0
  9. package/dist/commands/analyze.js +62 -0
  10. package/dist/commands/analyze.js.map +1 -0
  11. package/dist/commands/bootstrap.d.ts +4 -0
  12. package/dist/commands/bootstrap.d.ts.map +1 -0
  13. package/dist/commands/bootstrap.js +58 -0
  14. package/dist/commands/bootstrap.js.map +1 -0
  15. package/dist/commands/graph-impact.d.ts +10 -0
  16. package/dist/commands/graph-impact.d.ts.map +1 -0
  17. package/dist/commands/graph-impact.js +31 -0
  18. package/dist/commands/graph-impact.js.map +1 -0
  19. package/dist/commands/graph-merge.d.ts +11 -0
  20. package/dist/commands/graph-merge.d.ts.map +1 -0
  21. package/dist/commands/graph-merge.js +88 -0
  22. package/dist/commands/graph-merge.js.map +1 -0
  23. package/dist/commands/graph-query.d.ts +10 -0
  24. package/dist/commands/graph-query.d.ts.map +1 -0
  25. package/dist/commands/graph-query.js +31 -0
  26. package/dist/commands/graph-query.js.map +1 -0
  27. package/dist/commands/graph-visualize.d.ts +10 -0
  28. package/dist/commands/graph-visualize.d.ts.map +1 -0
  29. package/dist/commands/graph-visualize.js +72 -0
  30. package/dist/commands/graph-visualize.js.map +1 -0
  31. package/dist/commands/init.d.ts +6 -0
  32. package/dist/commands/init.d.ts.map +1 -0
  33. package/dist/commands/init.js +47 -0
  34. package/dist/commands/init.js.map +1 -0
  35. package/dist/commands/validate.d.ts +10 -0
  36. package/dist/commands/validate.d.ts.map +1 -0
  37. package/dist/commands/validate.js +89 -0
  38. package/dist/commands/validate.js.map +1 -0
  39. package/dist/config/load.d.ts +21 -0
  40. package/dist/config/load.d.ts.map +1 -0
  41. package/dist/config/load.js +77 -0
  42. package/dist/config/load.js.map +1 -0
  43. package/dist/config/types.d.ts +22 -0
  44. package/dist/config/types.d.ts.map +1 -0
  45. package/dist/config/types.js +2 -0
  46. package/dist/config/types.js.map +1 -0
  47. package/dist/graph/InMemoryGraph.d.ts +20 -0
  48. package/dist/graph/InMemoryGraph.d.ts.map +1 -0
  49. package/dist/graph/InMemoryGraph.js +181 -0
  50. package/dist/graph/InMemoryGraph.js.map +1 -0
  51. package/dist/graph/defaults.d.ts +10 -0
  52. package/dist/graph/defaults.d.ts.map +1 -0
  53. package/dist/graph/defaults.js +10 -0
  54. package/dist/graph/defaults.js.map +1 -0
  55. package/dist/graph/impact.d.ts +32 -0
  56. package/dist/graph/impact.d.ts.map +1 -0
  57. package/dist/graph/impact.js +88 -0
  58. package/dist/graph/impact.js.map +1 -0
  59. package/dist/graph/knowledge.d.ts +53 -0
  60. package/dist/graph/knowledge.d.ts.map +1 -0
  61. package/dist/graph/knowledge.js +79 -0
  62. package/dist/graph/knowledge.js.map +1 -0
  63. package/dist/graph/load.d.ts +4 -0
  64. package/dist/graph/load.d.ts.map +1 -0
  65. package/dist/graph/load.js +12 -0
  66. package/dist/graph/load.js.map +1 -0
  67. package/dist/graph/loadGraph.d.ts +3 -0
  68. package/dist/graph/loadGraph.d.ts.map +1 -0
  69. package/dist/graph/loadGraph.js +7 -0
  70. package/dist/graph/loadGraph.js.map +1 -0
  71. package/dist/graph/merge.d.ts +15 -0
  72. package/dist/graph/merge.d.ts.map +1 -0
  73. package/dist/graph/merge.js +63 -0
  74. package/dist/graph/merge.js.map +1 -0
  75. package/dist/graph/query.d.ts +18 -0
  76. package/dist/graph/query.d.ts.map +1 -0
  77. package/dist/graph/query.js +132 -0
  78. package/dist/graph/query.js.map +1 -0
  79. package/dist/registry/build.d.ts +3 -0
  80. package/dist/registry/build.d.ts.map +1 -0
  81. package/dist/registry/build.js +53 -0
  82. package/dist/registry/build.js.map +1 -0
  83. package/dist/registry/slug.d.ts +4 -0
  84. package/dist/registry/slug.d.ts.map +1 -0
  85. package/dist/registry/slug.js +16 -0
  86. package/dist/registry/slug.js.map +1 -0
  87. package/dist/types.d.ts +45 -0
  88. package/dist/types.d.ts.map +1 -0
  89. package/dist/types.js +2 -0
  90. package/dist/types.js.map +1 -0
  91. package/dist/util/fs.d.ts +6 -0
  92. package/dist/util/fs.d.ts.map +1 -0
  93. package/dist/util/fs.js +24 -0
  94. package/dist/util/fs.js.map +1 -0
  95. package/dist/util/paths.d.ts +16 -0
  96. package/dist/util/paths.d.ts.map +1 -0
  97. package/dist/util/paths.js +19 -0
  98. package/dist/util/paths.js.map +1 -0
  99. package/dist/visualize/html.d.ts +13 -0
  100. package/dist/visualize/html.d.ts.map +1 -0
  101. package/dist/visualize/html.js +374 -0
  102. package/dist/visualize/html.js.map +1 -0
  103. package/dist/visualize/stats.d.ts +21 -0
  104. package/dist/visualize/stats.d.ts.map +1 -0
  105. package/dist/visualize/stats.js +45 -0
  106. package/dist/visualize/stats.js.map +1 -0
  107. package/documents.json +64 -0
  108. package/package.json +65 -0
  109. package/scaffold/.ai-spector/.docflow/config/analyze.graphify.json +40 -0
  110. package/scaffold/.ai-spector/.docflow/config/completeness-rules.basic-design.json +18 -0
  111. package/scaffold/.ai-spector/.docflow/config/completeness-rules.detail-design.json +57 -0
  112. package/scaffold/.ai-spector/.docflow/config/completeness-rules.srs.json +72 -0
  113. package/scaffold/.ai-spector/.docflow/config/dag.basic-design.json +38 -0
  114. package/scaffold/.ai-spector/.docflow/config/dag.detail-design.json +64 -0
  115. package/scaffold/.ai-spector/.docflow/config/dag.srs.json +87 -0
  116. package/scaffold/.ai-spector/.docflow/config/data-source.json +5 -0
  117. package/scaffold/.ai-spector/.docflow/config/index.docs.json +22 -0
  118. package/scaffold/.ai-spector/.docflow/config/workflow.dependencies.json +271 -0
  119. package/scaffold/.ai-spector/.docflow/extract/patch.example.json +20 -0
  120. package/scaffold/.ai-spector/.docflow/state.json +11 -0
  121. package/scaffold/.ai-spector/docflow.config.json +7 -0
  122. package/scaffold/.ai-spector/index/README.md +18 -0
  123. package/scaffold/.ai-spector/index/basic-design.md +5 -0
  124. package/scaffold/.ai-spector/index/srs.md +5 -0
  125. package/scaffold/.cursor/commands/_cli-failures.md +110 -0
  126. package/scaffold/.cursor/commands/_graph.md +48 -0
  127. package/scaffold/.cursor/commands/_prerequisites.md +48 -0
  128. package/scaffold/.cursor/commands/_workflow.md +50 -0
  129. package/scaffold/.cursor/commands/analyze.md +92 -0
  130. package/scaffold/.cursor/commands/generate-basic-design.md +26 -0
  131. package/scaffold/.cursor/commands/generate-detail-design.md +19 -0
  132. package/scaffold/.cursor/commands/generate-srs.md +63 -0
  133. package/scaffold/.cursor/commands/graph-impact.md +45 -0
  134. package/scaffold/.cursor/commands/index-docs.md +36 -0
  135. package/scaffold/.cursor/commands/sync-graph.md +30 -0
  136. package/scaffold/.cursor/commands/validate-graph.md +28 -0
  137. package/scaffold/.cursor/commands/visualize-graph.md +24 -0
  138. package/scaffold/.cursor/skills/ai-spector/SKILL.md +39 -0
  139. package/scaffold/docs/data-source/README.md +7 -0
  140. package/schemas/rules.impact.json +17 -0
  141. package/schemas/rules.traceability.json +30 -0
  142. package/schemas/schema.extract-patch.json +19 -0
  143. package/schemas/schema.graph.json +83 -0
  144. package/schemas/schema.knowledge.json +107 -0
  145. package/templates/basic_design/db-design-template.md +177 -0
  146. package/templates/basic_design/detail-api-template.md +278 -0
  147. package/templates/basic_design/detail-screen-template.md +281 -0
  148. package/templates/basic_design/list-api-template.md +130 -0
  149. package/templates/basic_design/list-screen-template.md +242 -0
  150. package/templates/detail_design/common/architecture-overview-template.md +302 -0
  151. package/templates/detail_design/common/deployment-infrastructure-template.md +461 -0
  152. package/templates/detail_design/common/error-handling-patterns-template.md +460 -0
  153. package/templates/detail_design/common/integration-patterns-template.md +410 -0
  154. package/templates/detail_design/common/performance-standards-template.md +406 -0
  155. package/templates/detail_design/common/security-patterns-template.md +395 -0
  156. package/templates/detail_design/feature-detail-design-template.md +773 -0
  157. package/templates/detail_design/feature-list-template.md +39 -0
  158. package/templates/srs/1-introduction.md +58 -0
  159. package/templates/srs/2-overall-description.md +91 -0
  160. package/templates/srs/3-use-case-detail-template.md +142 -0
  161. package/templates/srs/3-use-cases.md +53 -0
  162. package/templates/srs/4-system-feature-detail-template.md +131 -0
  163. package/templates/srs/4-system-features-list-template.md +39 -0
  164. package/templates/srs/5-data-requirements.md +59 -0
  165. package/templates/srs/6-external-interfaces.md +56 -0
  166. package/templates/srs/7-quality-attributes.md +74 -0
  167. package/templates/srs/8-internationalization.md +36 -0
  168. package/templates/srs/9-other-requirements.md +46 -0
package/templates/srs/7-quality-attributes.md ADDED
@@ -0,0 +1,74 @@
1
+ ## 7. Non-Functional Requirements (Quality Attributes)
2
+
3
+ > This section specifies the non-functional requirements that define the quality attributes, constraints, and performance characteristics of the system. These requirements describe how the system should behave rather than what functions it should perform.
4
+
5
+ ### 7.1 Usability
6
+
7
+ > Specify any requirements regarding characteristics that will make the software appear to be "user-friendly."
8
+
9
+ **Requirements:**
10
+ - **Ease of Use:** <Requirement>
11
+ - **Ease of Learning:** <Requirement>
12
+ - **Accessibility:** <Requirement>
13
+ - **Error Handling:** <Requirement>
14
+
15
+ **UI Design Standards:**
16
+ - <Standard 1>
17
+ - <Standard 2>
18
+
19
+ ### 7.2 Performance
20
+
21
+ > State specific performance requirements for various system operations.
22
+
23
+ | Operation | Response Time Requirement |
24
+ |-----------|---------------------------|
25
+ | <Operation 1> | <Time requirement> |
26
+ | <Operation 2> | <Time requirement> |
27
+
28
+ **Throughput Requirements:**
29
+ - <Requirement 1>
30
+ - <Requirement 2>
31
+
32
+ ### 7.3 Security
33
+
34
+ > Specify any requirements regarding security or privacy issues.
35
+
36
+ **Requirements:**
37
+ - **Access Control:** <Requirement>
38
+ - **Authentication:** <Requirement>
39
+ - **Authorization:** <Requirement>
40
+ - **Data Security:** <Requirement>
41
+ - **Privacy:** <Requirement>
42
+
43
+ **Compliance:**
44
+ - <Compliance requirement 1>
45
+ - <Compliance requirement 2>
46
+
47
+ ### 7.4 Safety
48
+
49
+ > Specify requirements that are concerned with possible loss, damage, or harm.
50
+
51
+ **Requirements:**
52
+ - <Requirement 1>
53
+ - <Requirement 2>
54
+
55
+ **Safeguards:**
56
+ - <Safeguard 1>
57
+ - <Safeguard 2>
58
+
59
+ ### 7.5 Others as relevant
60
+
61
+ > Create a separate section for each additional product quality attribute.
62
+
63
+ **Availability:**
64
+ - <Requirement 1>
65
+ - <Requirement 2>
66
+
67
+ **Reliability:**
68
+ - <Requirement 1>
69
+ - <Requirement 2>
70
+
71
+ **Maintainability:**
72
+ - <Requirement 1>
73
+ - <Requirement 2>
74
+
package/templates/srs/8-internationalization.md ADDED
@@ -0,0 +1,36 @@
1
+ ## 8. Internationalization and Localization Requirements
2
+
3
+ > Internationalization and localization requirements ensure that the product will be suitable for use in nations, cultures, and geographic locations other than those in which it was created.
4
+
5
+ **Supported Languages:**
6
+
7
+ - <Language 1>
8
+ - <Language 2>
9
+
10
+ **Supported Locales:**
11
+
12
+ - <Locale 1>
13
+ - <Locale 2>
14
+
15
+ **Formatting Requirements:**
16
+
17
+ - **Currency:**
18
+ - **Date/Time:**
19
+ - **Numbers:**
20
+ - **Addresses:**
21
+
22
+ **Character Sets:**
23
+
24
+ - <Requirement 1>
25
+ - <Requirement 2>
26
+
27
+ **Cultural Considerations:**
28
+
29
+ - <Consideration 1>
30
+ - <Consideration 2>
31
+
32
+ **Regulatory Compliance:**
33
+
34
+ - <Regulation 1>
35
+ - <Regulation 2>
36
+
package/templates/srs/9-other-requirements.md ADDED
@@ -0,0 +1,46 @@
1
+ ## 9. Other Requirements
2
+
3
+ > Examples are: legal, regulatory or financial compliance, and standards requirements; requirements for product installation, configuration, startup, and shutdown; and logging, monitoring and audit trail requirements.
4
+
5
+ ### 9.1 Legal and Regulatory Compliance
6
+
7
+ **Legal Requirements:**
8
+ - <Requirement 1>
9
+ - <Requirement 2>
10
+
11
+ **Regulatory Compliance:**
12
+ - <Compliance requirement 1>
13
+ - <Compliance requirement 2>
14
+
15
+ **Standards Compliance:**
16
+ - <Standard 1>
17
+ - <Standard 2>
18
+
19
+ ### 9.2 Installation and Configuration
20
+
21
+ **Installation Requirements:**
22
+ - <Requirement 1>
23
+ - <Requirement 2>
24
+
25
+ **Configuration Requirements:**
26
+ - <Requirement 1>
27
+ - <Requirement 2>
28
+
29
+ **Startup/Shutdown Requirements:**
30
+ - <Requirement 1>
31
+ - <Requirement 2>
32
+
33
+ ### 9.3 Logging and Monitoring
34
+
35
+ **Logging Requirements:**
36
+ - <Requirement 1>
37
+ - <Requirement 2>
38
+
39
+ **Monitoring Requirements:**
40
+ - <Requirement 1>
41
+ - <Requirement 2>
42
+
43
+ **Audit Trail Requirements:**
44
+ - <Requirement 1>
45
+ - <Requirement 2>
46
+