micro-contracts 0.18.10 → 0.18.12

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 (202) hide show
  1. package/README.md +7 -14
  2. package/cli-contract.yaml +15 -27
  3. package/dist/agents/context-builder.d.ts +5 -0
  4. package/dist/agents/context-builder.d.ts.map +1 -0
  5. package/dist/agents/context-builder.js +239 -0
  6. package/dist/agents/context-builder.js.map +1 -0
  7. package/dist/agents/formatter.d.ts +9 -0
  8. package/dist/agents/formatter.d.ts.map +1 -0
  9. package/dist/agents/formatter.js +124 -0
  10. package/dist/agents/formatter.js.map +1 -0
  11. package/dist/agents/index.d.ts +6 -0
  12. package/dist/agents/index.d.ts.map +1 -0
  13. package/dist/agents/index.js +4 -0
  14. package/dist/agents/index.js.map +1 -0
  15. package/dist/agents/orchestrator.d.ts +5 -0
  16. package/dist/agents/orchestrator.d.ts.map +1 -0
  17. package/dist/agents/orchestrator.js +46 -0
  18. package/dist/agents/orchestrator.js.map +1 -0
  19. package/dist/agents/types.d.ts +29 -0
  20. package/dist/agents/types.d.ts.map +1 -0
  21. package/dist/agents/types.js +7 -0
  22. package/dist/agents/types.js.map +1 -0
  23. package/dist/cli/templates.d.ts +15 -0
  24. package/dist/cli/templates.d.ts.map +1 -0
  25. package/dist/cli/templates.js +445 -0
  26. package/dist/cli/templates.js.map +1 -0
  27. package/dist/cli.d.ts +3 -0
  28. package/dist/cli.d.ts.map +1 -0
  29. package/dist/cli.js +1201 -0
  30. package/dist/cli.js.map +1 -0
  31. package/dist/commands/audit-guardrails.d.ts +15 -0
  32. package/dist/commands/audit-guardrails.d.ts.map +1 -0
  33. package/dist/commands/audit-guardrails.js +33 -0
  34. package/dist/commands/audit-guardrails.js.map +1 -0
  35. package/dist/commands/audit-openapi.d.ts +15 -0
  36. package/dist/commands/audit-openapi.d.ts.map +1 -0
  37. package/dist/commands/audit-openapi.js +33 -0
  38. package/dist/commands/audit-openapi.js.map +1 -0
  39. package/dist/commands/insights.d.ts +8 -0
  40. package/dist/commands/insights.d.ts.map +1 -0
  41. package/dist/commands/insights.js +13 -0
  42. package/dist/commands/insights.js.map +1 -0
  43. package/dist/commands/propose-overlays.d.ts +15 -0
  44. package/dist/commands/propose-overlays.d.ts.map +1 -0
  45. package/dist/commands/propose-overlays.js +33 -0
  46. package/dist/commands/propose-overlays.js.map +1 -0
  47. package/dist/commands/review-published.d.ts +15 -0
  48. package/dist/commands/review-published.d.ts.map +1 -0
  49. package/dist/commands/review-published.js +33 -0
  50. package/dist/commands/review-published.js.map +1 -0
  51. package/dist/external/insight-provider.d.ts.map +1 -0
  52. package/dist/external/insight-provider.js.map +1 -0
  53. package/dist/generated/commands.d.ts +2 -0
  54. package/dist/generated/commands.d.ts.map +1 -0
  55. package/dist/generated/commands.js +2 -0
  56. package/dist/generated/commands.js.map +1 -0
  57. package/dist/generated/contract.d.ts +3 -0
  58. package/dist/generated/contract.d.ts.map +1 -0
  59. package/dist/generated/contract.js +5 -0
  60. package/dist/generated/contract.js.map +1 -0
  61. package/dist/generated/dsl/agents.d.ts +34 -0
  62. package/dist/generated/dsl/agents.d.ts.map +1 -0
  63. package/dist/generated/dsl/agents.js +98 -0
  64. package/dist/generated/dsl/agents.js.map +1 -0
  65. package/dist/generated/dsl/dsl-data.d.ts +7 -0
  66. package/dist/generated/dsl/dsl-data.d.ts.map +1 -0
  67. package/dist/generated/dsl/dsl-data.js +1041 -0
  68. package/dist/generated/dsl/dsl-data.js.map +1 -0
  69. package/dist/generated/dsl/handoffs.d.ts +457 -0
  70. package/dist/generated/dsl/handoffs.d.ts.map +1 -0
  71. package/dist/generated/dsl/handoffs.js +205 -0
  72. package/dist/generated/dsl/handoffs.js.map +1 -0
  73. package/dist/generated/dsl/index.d.ts +14 -0
  74. package/dist/generated/dsl/index.d.ts.map +1 -0
  75. package/dist/generated/dsl/index.js +11 -0
  76. package/dist/generated/dsl/index.js.map +1 -0
  77. package/dist/generated/dsl/tasks.d.ts +28 -0
  78. package/dist/generated/dsl/tasks.d.ts.map +1 -0
  79. package/dist/generated/dsl/tasks.js +137 -0
  80. package/dist/generated/dsl/tasks.js.map +1 -0
  81. package/dist/generated/dsl/workflows.d.ts +34 -0
  82. package/dist/generated/dsl/workflows.d.ts.map +1 -0
  83. package/dist/generated/dsl/workflows.js +84 -0
  84. package/dist/generated/dsl/workflows.js.map +1 -0
  85. package/dist/generated/index.d.ts +8 -0
  86. package/dist/generated/index.d.ts.map +1 -0
  87. package/dist/generated/index.js +8 -0
  88. package/dist/generated/index.js.map +1 -0
  89. package/dist/generated/policy-runtime.d.ts +114 -0
  90. package/dist/generated/policy-runtime.d.ts.map +1 -0
  91. package/dist/generated/policy-runtime.js +195 -0
  92. package/dist/generated/policy-runtime.js.map +1 -0
  93. package/dist/generated/policy.d.ts +658 -0
  94. package/dist/generated/policy.d.ts.map +1 -0
  95. package/dist/generated/policy.js +844 -0
  96. package/dist/generated/policy.js.map +1 -0
  97. package/dist/generated/program.d.ts +120 -0
  98. package/dist/generated/program.d.ts.map +1 -0
  99. package/dist/generated/program.js +370 -0
  100. package/dist/generated/program.js.map +1 -0
  101. package/dist/generated/schemas.d.ts +779 -0
  102. package/dist/generated/schemas.d.ts.map +1 -0
  103. package/dist/generated/schemas.js +1006 -0
  104. package/dist/generated/schemas.js.map +1 -0
  105. package/dist/generated/types.d.ts +786 -0
  106. package/dist/generated/types.d.ts.map +1 -0
  107. package/dist/generated/types.js +3 -0
  108. package/dist/generated/types.js.map +1 -0
  109. package/dist/generator/dependencyGenerator.d.ts +16 -0
  110. package/dist/generator/dependencyGenerator.d.ts.map +1 -0
  111. package/dist/generator/dependencyGenerator.js +25 -0
  112. package/dist/generator/dependencyGenerator.js.map +1 -0
  113. package/dist/generator/index.d.ts +47 -0
  114. package/dist/generator/index.d.ts.map +1 -0
  115. package/dist/generator/index.js +707 -0
  116. package/dist/generator/index.js.map +1 -0
  117. package/dist/generator/inputHash.d.ts +23 -0
  118. package/dist/generator/inputHash.d.ts.map +1 -0
  119. package/dist/generator/inputHash.js +138 -0
  120. package/dist/generator/inputHash.js.map +1 -0
  121. package/dist/generator/linter.d.ts +26 -0
  122. package/dist/generator/linter.d.ts.map +1 -0
  123. package/dist/generator/linter.js +441 -0
  124. package/dist/generator/linter.js.map +1 -0
  125. package/dist/generator/overlayProcessor.d.ts +71 -0
  126. package/dist/generator/overlayProcessor.d.ts.map +1 -0
  127. package/dist/generator/overlayProcessor.js +500 -0
  128. package/dist/generator/overlayProcessor.js.map +1 -0
  129. package/dist/generator/schemaGenerator.d.ts +10 -0
  130. package/dist/generator/schemaGenerator.d.ts.map +1 -0
  131. package/dist/generator/schemaGenerator.js +296 -0
  132. package/dist/generator/schemaGenerator.js.map +1 -0
  133. package/dist/generator/serviceGenerator.d.ts +20 -0
  134. package/dist/generator/serviceGenerator.d.ts.map +1 -0
  135. package/dist/generator/serviceGenerator.js +293 -0
  136. package/dist/generator/serviceGenerator.js.map +1 -0
  137. package/dist/generator/templateProcessor.d.ts +208 -0
  138. package/dist/generator/templateProcessor.d.ts.map +1 -0
  139. package/dist/generator/templateProcessor.js +604 -0
  140. package/dist/generator/templateProcessor.js.map +1 -0
  141. package/dist/generator/typeGenerator.d.ts +22 -0
  142. package/dist/generator/typeGenerator.d.ts.map +1 -0
  143. package/dist/generator/typeGenerator.js +439 -0
  144. package/dist/generator/typeGenerator.js.map +1 -0
  145. package/dist/generator/typeGenerator.test.d.ts +2 -0
  146. package/dist/generator/typeGenerator.test.d.ts.map +1 -0
  147. package/dist/generator/typeGenerator.test.js +155 -0
  148. package/dist/generator/typeGenerator.test.js.map +1 -0
  149. package/dist/glob.d.ts +22 -0
  150. package/dist/glob.d.ts.map +1 -0
  151. package/dist/glob.js +103 -0
  152. package/dist/glob.js.map +1 -0
  153. package/dist/guardrails/allowlist.d.ts +30 -0
  154. package/dist/guardrails/allowlist.d.ts.map +1 -0
  155. package/dist/guardrails/allowlist.js +174 -0
  156. package/dist/guardrails/allowlist.js.map +1 -0
  157. package/dist/guardrails/config.d.ts +40 -0
  158. package/dist/guardrails/config.d.ts.map +1 -0
  159. package/dist/guardrails/config.js +177 -0
  160. package/dist/guardrails/config.js.map +1 -0
  161. package/dist/guardrails/drift.d.ts +19 -0
  162. package/dist/guardrails/drift.d.ts.map +1 -0
  163. package/dist/guardrails/drift.js +115 -0
  164. package/dist/guardrails/drift.js.map +1 -0
  165. package/dist/guardrails/index.d.ts +18 -0
  166. package/dist/guardrails/index.d.ts.map +1 -0
  167. package/dist/guardrails/index.js +21 -0
  168. package/dist/guardrails/index.js.map +1 -0
  169. package/dist/guardrails/lint.d.ts +16 -0
  170. package/dist/guardrails/lint.d.ts.map +1 -0
  171. package/dist/guardrails/lint.js +172 -0
  172. package/dist/guardrails/lint.js.map +1 -0
  173. package/dist/guardrails/manifest.d.ts +63 -0
  174. package/dist/guardrails/manifest.d.ts.map +1 -0
  175. package/dist/guardrails/manifest.js +310 -0
  176. package/dist/guardrails/manifest.js.map +1 -0
  177. package/dist/guardrails/runner.d.ts +53 -0
  178. package/dist/guardrails/runner.d.ts.map +1 -0
  179. package/dist/guardrails/runner.js +387 -0
  180. package/dist/guardrails/runner.js.map +1 -0
  181. package/dist/guardrails/types.d.ts +196 -0
  182. package/dist/guardrails/types.d.ts.map +1 -0
  183. package/dist/guardrails/types.js +8 -0
  184. package/dist/guardrails/types.js.map +1 -0
  185. package/dist/index.d.ts +21 -4
  186. package/dist/index.d.ts.map +1 -0
  187. package/dist/index.js +21 -4
  188. package/dist/index.js.map +1 -0
  189. package/dist/micro-contracts.bundle.mjs +349 -374
  190. package/dist/micro-contracts.bundle.mjs.map +3 -3
  191. package/dist/types.d.ts +502 -0
  192. package/dist/types.d.ts.map +1 -0
  193. package/dist/types.js +409 -0
  194. package/dist/types.js.map +1 -0
  195. package/dist/version.d.ts +10 -0
  196. package/dist/version.d.ts.map +1 -0
  197. package/dist/version.js +31 -0
  198. package/dist/version.js.map +1 -0
  199. package/docs/cli-reference.md +13 -15
  200. package/docs/development-guardrails.md +3 -3
  201. package/docs/screen-spec.md +3 -3
  202. package/package.json +13 -12
@@ -0,0 +1,4 @@
1
+ export { runAgentTask, EXIT_RUNTIME_MISSING, EXIT_ADAPTER_ERROR } from "./orchestrator.js";
2
+ export { computeExitCode, formatResultText, formatResultJson, formatResultYaml, formatResult, writeOutput } from "./formatter.js";
3
+ export { TASK_IDS } from "./types.js";
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/agents/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElI,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
@@ -0,0 +1,5 @@
1
+ import type { AuditConfig, AuditOptions, AuditRunResult, TaskId } from "./types.js";
2
+ export declare const EXIT_RUNTIME_MISSING = 11;
3
+ export declare const EXIT_ADAPTER_ERROR = 12;
4
+ export declare function runAgentTask(userRequest: string, taskId: TaskId, auditConfig: AuditConfig, options: AuditOptions): Promise<AuditRunResult>;
5
+ //# sourceMappingURL=orchestrator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"orchestrator.d.ts","sourceRoot":"","sources":["../../src/agents/orchestrator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpF,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,cAAc,CAAC,CA+CzB"}
@@ -0,0 +1,46 @@
1
+ import { resolvedDsl } from "../generated/dsl/dsl-data.js";
2
+ export const EXIT_RUNTIME_MISSING = 11;
3
+ export const EXIT_ADAPTER_ERROR = 12;
4
+ export async function runAgentTask(userRequest, taskId, auditConfig, options) {
5
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
6
+ let executeTask;
7
+ try {
8
+ const runtime = await import("agent-contracts-runtime");
9
+ executeTask = runtime.executeTask;
10
+ }
11
+ catch {
12
+ throw Object.assign(new Error("agent-contracts-runtime is not installed. " +
13
+ "Install it to use this command, or use --show-prompt to inspect the prompt.\n" +
14
+ " npm install agent-contracts-runtime"), { exitCode: EXIT_RUNTIME_MISSING });
15
+ }
16
+ let result;
17
+ try {
18
+ result = await executeTask(taskId, {
19
+ request: userRequest,
20
+ adapter: auditConfig.adapter ?? "mock",
21
+ model: auditConfig.model,
22
+ dsl: resolvedDsl,
23
+ logFile: options.logFile,
24
+ maxFollowUps: 3,
25
+ maxRetries: 1,
26
+ });
27
+ }
28
+ catch (err) {
29
+ throw Object.assign(err, { exitCode: EXIT_ADAPTER_ERROR });
30
+ }
31
+ const outcome = result.outcome;
32
+ return {
33
+ taskId,
34
+ data: outcome.status === "success" ? (outcome.data ?? null) : null,
35
+ raw: outcome.raw ?? "",
36
+ prompt: userRequest,
37
+ status: outcome.status,
38
+ errorMessage: outcome.status === "error" ? outcome.message :
39
+ outcome.status === "escalation" ? outcome.reason :
40
+ outcome.status === "validation_error" ? outcome.errors?.message :
41
+ undefined,
42
+ followUpsUsed: result.follow_ups_used,
43
+ retriesUsed: result.retries_used,
44
+ };
45
+ }
46
+ //# sourceMappingURL=orchestrator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"orchestrator.js","sourceRoot":"","sources":["../../src/agents/orchestrator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAG3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAErC,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,WAAmB,EACnB,MAAc,EACd,WAAwB,EACxB,OAAqB;IAErB,8DAA8D;IAC9D,IAAI,WAA2D,CAAC;IAChE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC;QACxD,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,MAAM,CAAC,MAAM,CACjB,IAAI,KAAK,CACP,4CAA4C;YAC1C,+EAA+E;YAC/E,uCAAuC,CAC1C,EACD,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CACnC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE;YACjC,OAAO,EAAE,WAAW;YACpB,OAAO,EAAE,WAAW,CAAC,OAAO,IAAI,MAAM;YACtC,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,GAAG,EAAE,WAAW;YAChB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,CAAC;SACd,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,MAAM,CAAC,MAAM,CAAC,GAAY,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,OAAO;QACL,MAAM;QACN,IAAI,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;QAClE,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE;QACtB,MAAM,EAAE,WAAW;QACnB,MAAM,EAAE,OAAO,CAAC,MAAkC;QAClD,YAAY,EACV,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClD,OAAO,CAAC,MAAM,KAAK,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACjE,SAAS;QACX,aAAa,EAAE,MAAM,CAAC,eAAe;QACrC,WAAW,EAAE,MAAM,CAAC,YAAY;KACjC,CAAC;AACJ,CAAC"}
@@ -0,0 +1,29 @@
1
+ import type { OpenapiAuditResult } from "../generated/dsl/handoffs.js";
2
+ import { taskRegistry } from "../generated/dsl/tasks.js";
3
+ export type TaskId = keyof typeof taskRegistry;
4
+ export declare const TASK_IDS: {
5
+ readonly auditOpenapi: "audit-openapi-design";
6
+ readonly reviewPublished: "audit-published-api";
7
+ readonly proposeOverlays: "propose-overlay-candidates";
8
+ readonly auditGuardrails: "audit-guardrails-coverage";
9
+ };
10
+ export interface AuditConfig {
11
+ adapter?: string;
12
+ model?: string;
13
+ temperature?: number;
14
+ }
15
+ export interface AuditOptions {
16
+ failOn?: "warning" | "error" | "critical";
17
+ logFile?: string;
18
+ }
19
+ export interface AuditRunResult {
20
+ taskId: TaskId;
21
+ data: OpenapiAuditResult | null;
22
+ raw: string;
23
+ prompt: string;
24
+ status: "success" | "error" | "escalation" | "validation_error";
25
+ errorMessage?: string;
26
+ followUpsUsed: number;
27
+ retriesUsed: number;
28
+ }
29
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/agents/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,MAAM,MAAM,GAAG,MAAM,OAAO,YAAY,CAAC;AAE/C,eAAO,MAAM,QAAQ;;;;;CAKsB,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,kBAAkB,CAAC;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB"}
@@ -0,0 +1,7 @@
1
+ export const TASK_IDS = {
2
+ auditOpenapi: "audit-openapi-design",
3
+ reviewPublished: "audit-published-api",
4
+ proposeOverlays: "propose-overlay-candidates",
5
+ auditGuardrails: "audit-guardrails-coverage",
6
+ };
7
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/agents/types.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,YAAY,EAAE,sBAAsB;IACpC,eAAe,EAAE,qBAAqB;IACtC,eAAe,EAAE,4BAA4B;IAC7C,eAAe,EAAE,2BAA2B;CACH,CAAC"}
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Starter Templates for micro-contracts init command
3
+ *
4
+ * These templates are created in spec/default/templates/ and can be customized.
5
+ * Keep in sync with examples/spec/default/templates/
6
+ */
7
+ /**
8
+ * Get all starter templates
9
+ */
10
+ export declare function getStarterTemplates(): Record<string, string>;
11
+ /**
12
+ * Get screen spec starter templates
13
+ */
14
+ export declare function getScreenStarterTemplates(): Record<string, string>;
15
+ //# sourceMappingURL=templates.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/cli/templates.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA2aH;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ5D;AAED;;GAEG;AACH,wBAAgB,yBAAyB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKlE"}
@@ -0,0 +1,445 @@
1
+ /**
2
+ * Starter Templates for micro-contracts init command
3
+ *
4
+ * These templates are created in spec/default/templates/ and can be customized.
5
+ * Keep in sync with examples/spec/default/templates/
6
+ */
7
+ const STARTER_FASTIFY_ROUTES_TEMPLATE = `/**
8
+ * Auto-generated Fastify routes
9
+ * Generated from: {{spec.info.title}} v{{spec.info.version}}
10
+ * DO NOT EDIT MANUALLY
11
+ */
12
+
13
+ import type { FastifyInstance, FastifyRequest, FastifyReply } from 'fastify';
14
+ import { allSchemas } from '{{contractPackage}}/schemas/index.js';
15
+ import * as types from '{{contractPackage}}/schemas/types.js';
16
+ {{#if extensionInfo.length}}
17
+ import { runOverlays, toHttpRequest, sendError } from './overlayAdapter.generated.js';
18
+ {{/if}}
19
+
20
+ export async function registerRoutes(fastify: FastifyInstance): Promise<void> {
21
+ for (const schema of allSchemas) {
22
+ fastify.addSchema(schema);
23
+ }
24
+
25
+ const { {{#each services}}{{key}}{{#unless @last}}, {{/unless}}{{/each}} } = {{servicesPath}};
26
+ {{#if extensionInfo.length}}
27
+ const handlers = fastify.overlayHandlers;
28
+ {{/if}}
29
+
30
+ {{#each routes}}
31
+ // {{uppercase method}} {{path}}{{#if isPublished}} [PUBLISHED]{{/if}}
32
+ fastify.{{method}}('{{fastifyPath}}', {
33
+ schema: {
34
+ {{#if paramsType}}
35
+ params: { $ref: '{{typeNameBase}}Params#' },
36
+ {{/if}}
37
+ {{#if requestBody}}
38
+ body: { $ref: '{{requestBody.schemaName}}#' },
39
+ {{/if}}
40
+ {{#if responses.length}}
41
+ response: { {{#each responses}}{{#if schemaName}}{{statusCode}}: { $ref: '{{schemaName}}#' }{{#unless @last}}, {{/unless}}{{/if}}{{/each}} },
42
+ {{/if}}
43
+ },
44
+ }, async (req: FastifyRequest, reply: FastifyReply) => {
45
+ {{#if extensions.length}}
46
+ const result = await runOverlays('{{operationId}}', handlers, toHttpRequest(req));
47
+ if (!result.success) return sendError(reply, result.error);
48
+ {{/if}}
49
+ // Build input object (always required, even if empty)
50
+ const input: types.{{inputType}} = {
51
+ {{#if pathParams.length}}
52
+ ...(req.params as types.{{typeNameBase}}Params),
53
+ {{/if}}
54
+ {{#if queryParams.length}}
55
+ ...(req.query as types.{{typeNameBase}}Params),
56
+ {{/if}}
57
+ {{#if requestBody}}
58
+ data: req.body as types.{{requestBody.schemaName}},
59
+ {{/if}}
60
+ };
61
+ return {{serviceKey}}.{{serviceMethod}}(input);
62
+ });
63
+
64
+ {{/each}}
65
+ }
66
+ `;
67
+ const STARTER_FETCH_CLIENT_TEMPLATE = `/**
68
+ * Auto-generated HTTP Client from OpenAPI specification
69
+ * Generated from: {{title}} v{{version}}
70
+ *
71
+ * DO NOT EDIT MANUALLY
72
+ *
73
+ * Client API matches Service API signature (single input object).
74
+ * Internally maps input to HTTP request (path params, query params, body).
75
+ */
76
+
77
+ import type {
78
+ {{#each serviceTypes}}
79
+ {{this}},
80
+ {{/each}}
81
+ } from '{{contractPackage}}/services';
82
+ import type {
83
+ {{#each schemaTypes}}
84
+ {{this}},
85
+ {{/each}}
86
+ } from '{{contractPackage}}/schemas';
87
+ import { ApiError } from '{{contractPackage}}/errors';
88
+
89
+ // BASE_URL derived from OpenAPI servers[0].url: {{baseUrl}}
90
+ // Can be overridden via environment variable (Vite: VITE_API_BASE_URL)
91
+ const BASE_URL = (typeof import.meta !== 'undefined' && import.meta.env?.VITE_API_BASE_URL) || '{{baseUrl}}';
92
+
93
+ /**
94
+ * Handle HTTP response with typed error handling
95
+ */
96
+ async function handleResponse<T>(res: Response): Promise<T> {
97
+ if (!res.ok) {
98
+ const problem = await res.json() as ProblemDetails;
99
+ throw new ApiError(
100
+ res.status,
101
+ problem,
102
+ res.headers.get('x-request-id') ?? undefined
103
+ );
104
+ }
105
+ // Handle 204 No Content and empty responses
106
+ if (res.status === 204 || res.headers.get('content-length') === '0') {
107
+ return undefined as T;
108
+ }
109
+ return res.json();
110
+ }
111
+
112
+ {{#each services}}
113
+ // ==========================================================================
114
+ // {{name}} API Client
115
+ // ==========================================================================
116
+ export const {{key}}Api: {{name}}ServiceApi = {
117
+ {{#each ../routes}}
118
+ {{#if (eq service ../name)}}
119
+ /**
120
+ * {{httpMethod}} {{path}}
121
+ {{#if summary}}* {{summary}}{{/if}}
122
+ {{#if isPublished}}* @published{{/if}}
123
+ */
124
+ async {{serviceMethod}}(input: {{inputType}}): Promise<{{responseType}}> {
125
+ {{#if queryParams.length}}
126
+ const searchParams = new URLSearchParams();
127
+ {{#each queryParams}}
128
+ if (input.{{name}} !== undefined) searchParams.set('{{name}}', String(input.{{name}}));
129
+ {{/each}}
130
+ {{/if}}
131
+ {{#if pathParams.length}}
132
+ const url = \`\${BASE_URL}{{clientUrlPatternInput}}\`{{#if queryParams.length}} + (searchParams.toString() ? '?' + searchParams : ''){{/if}};
133
+ {{else}}
134
+ const url = \`\${BASE_URL}{{path}}\`{{#if queryParams.length}} + (searchParams.toString() ? '?' + searchParams : ''){{/if}};
135
+ {{/if}}
136
+ {{#if (eq httpMethod "GET")}}
137
+ const res = await fetch(url);
138
+ {{else if requestType}}
139
+ const res = await fetch(url, {
140
+ method: '{{httpMethod}}',
141
+ headers: { 'Content-Type': 'application/json' },
142
+ body: JSON.stringify(input.data),
143
+ });
144
+ {{else}}
145
+ const res = await fetch(url, { method: '{{httpMethod}}' });
146
+ {{/if}}
147
+ {{#if (eq responseType "void")}}
148
+ await handleResponse<void>(res);
149
+ {{else}}
150
+ return handleResponse<{{responseType}}>(res);
151
+ {{/if}}
152
+ },
153
+
154
+ {{/if}}
155
+ {{/each}}
156
+ };
157
+
158
+ {{/each}}
159
+ `;
160
+ const STARTER_SERVICE_STUBS_TEMPLATE = `{{!-- Service implementation stubs template --}}
161
+ {{!-- Generates skeleton implementations for service methods --}}
162
+ // Auto-generated service stubs - Edit to implement business logic
163
+ import type { {{#each services}}{{this}}ServiceApi{{#unless @last}}, {{/unless}}{{/each}} } from '{{config.contractPackage}}/services';
164
+ import type * as types from '{{config.contractPackage}}/schemas/types';
165
+
166
+ {{#each services}}
167
+ /**
168
+ * {{this}} Service Implementation
169
+ *
170
+ * Implement the methods below with your business logic.
171
+ * Generated methods receive HTTP-agnostic input objects.
172
+ */
173
+ export class {{this}}Service implements {{this}}ServiceApi {
174
+ {{#each ../operations}}
175
+ {{#if (eq service ../this)}}
176
+ /**
177
+ * {{summary}}
178
+ * {{method}} {{path}}
179
+ */
180
+ async {{serviceMethod}}({{#if inputType}}input: types.{{inputType}}{{/if}}): Promise<types.{{responseType}}> {
181
+ // TODO: Implement {{serviceMethod}}
182
+ throw new Error('Not implemented: {{serviceMethod}}');
183
+ }
184
+
185
+ {{/if}}
186
+ {{/each}}
187
+ }
188
+
189
+ {{/each}}
190
+ `;
191
+ const STARTER_OVERLAY_ADAPTER_TEMPLATE = `/**
192
+ * Auto-generated Overlay Adapter
193
+ * Generated from: {{spec.info.title}} v{{spec.info.version}}
194
+ * DO NOT EDIT MANUALLY
195
+ */
196
+
197
+ import type { FastifyReply } from 'fastify';
198
+ import type { OverlayResult, OverlayRegistry } from '{{contractPackage}}/overlays/index.js';
199
+ import type { ProblemDetails } from '{{contractPackage}}/schemas/types.js';
200
+
201
+ // ==========================================================================
202
+ // Types
203
+ // ==========================================================================
204
+
205
+ /** HTTP request abstraction */
206
+ export interface HttpRequest {
207
+ headers: Record<string, string | string[] | undefined>;
208
+ params: Record<string, string>;
209
+ query: Record<string, unknown>;
210
+ body: unknown;
211
+ }
212
+
213
+ /** Parameter extractor function */
214
+ type ParamExtractor = (req: HttpRequest) => Record<string, unknown>;
215
+
216
+ // ==========================================================================
217
+ // Parameter Extractors (one per overlay, shared across endpoints)
218
+ // ==========================================================================
219
+
220
+ const getHeader = (req: HttpRequest, name: string): string | undefined =>
221
+ req.headers[name.toLowerCase()] as string | undefined;
222
+
223
+ const getQuery = (req: HttpRequest, name: string): unknown => req.query[name];
224
+
225
+ const getParam = (req: HttpRequest, name: string): string | undefined => req.params[name];
226
+
227
+ /** Overlay parameter extractors - each overlay defined once */
228
+ const extractors: Record<string, ParamExtractor> = {
229
+ {{#each uniqueOverlays}}
230
+ '{{name}}': (req) => ({
231
+ {{#each params}}
232
+ '{{name}}': {{#if (eq location "headers")}}getHeader(req, '{{name}}'){{else if (eq location "query")}}getQuery(req, '{{name}}'){{else}}getParam(req, '{{name}}'){{/if}},
233
+ {{/each}}
234
+ }),
235
+ {{/each}}
236
+ };
237
+
238
+ // ==========================================================================
239
+ // Endpoint → Overlay Mapping
240
+ // ==========================================================================
241
+
242
+ /** Which overlays apply to each endpoint */
243
+ export const endpointOverlays: Record<string, string[]> = {
244
+ {{#each routes}}
245
+ {{#if extensions.length}}
246
+ '{{operationId}}': [{{#each extensions}}'{{value}}'{{#unless @last}}, {{/unless}}{{/each}}],
247
+ {{/if}}
248
+ {{/each}}
249
+ };
250
+
251
+ // ==========================================================================
252
+ // Overlay Execution
253
+ // ==========================================================================
254
+
255
+ /**
256
+ * Execute overlays for an endpoint
257
+ */
258
+ export async function runOverlays(
259
+ operationId: string,
260
+ handlers: OverlayRegistry,
261
+ req: HttpRequest
262
+ ): Promise<{ success: true; context: Record<string, unknown> } | { success: false; error: ProblemDetails }> {
263
+ const overlayNames = endpointOverlays[operationId] || [];
264
+ const context: Record<string, unknown> = {};
265
+
266
+ for (const name of overlayNames) {
267
+ const extract = extractors[name];
268
+ const handler = handlers[name as keyof OverlayRegistry];
269
+
270
+ if (!extract || !handler) continue;
271
+
272
+ const input = extract(req);
273
+ const result = await (handler as (input: Record<string, unknown>) => Promise<OverlayResult<unknown>>)(input);
274
+
275
+ if (!result.success) {
276
+ return {
277
+ success: false,
278
+ error: {
279
+ type: \`/errors/\${result.error?.code?.toLowerCase() ?? 'error'}\`,
280
+ title: result.error?.message ?? 'Error',
281
+ status: result.error?.status ?? 500,
282
+ },
283
+ };
284
+ }
285
+
286
+ if (result.context) {
287
+ Object.assign(context, result.context);
288
+ }
289
+ }
290
+
291
+ return { success: true, context };
292
+ }
293
+
294
+ /**
295
+ * Build HttpRequest from Fastify request
296
+ */
297
+ export function toHttpRequest(req: { headers: unknown; params: unknown; query: unknown; body: unknown }): HttpRequest {
298
+ return {
299
+ headers: req.headers as Record<string, string | string[] | undefined>,
300
+ params: req.params as Record<string, string>,
301
+ query: req.query as Record<string, unknown>,
302
+ body: req.body,
303
+ };
304
+ }
305
+
306
+ /**
307
+ * Send error response
308
+ */
309
+ export function sendError(reply: FastifyReply, error: ProblemDetails): void {
310
+ reply.status(error.status).send(error);
311
+ }
312
+ `;
313
+ const STARTER_OVERLAY_STUBS_TEMPLATE = `{{!-- Extension implementation stubs template --}}
314
+ {{!-- Generates skeleton implementations for overlay handlers --}}
315
+ // Auto-generated extension stubs - Edit to implement overlay logic
316
+ import type {
317
+ OverlayResult,
318
+ {{#each extensionTypes}}
319
+ {{this}}OverlayInput,
320
+ {{this}}Overlay,
321
+ {{/each}}
322
+ OverlayRegistry,
323
+ } from '{{config.contractPackage}}/overlays';
324
+
325
+ {{#each extensions}}
326
+ /**
327
+ * {{name}} overlay handler
328
+ *
329
+ * Called when an endpoint has x-middleware: [{{name}}]
330
+ * Returns OverlayResult with success/error status
331
+ */
332
+ export async function {{camelCase name}}(
333
+ input: {{pascalCase name}}OverlayInput
334
+ ): Promise<OverlayResult> {
335
+ // TODO: Implement {{name}} logic
336
+ {{#if injectedParameters}}
337
+ // Input parameters:
338
+ {{#each injectedParameters}}
339
+ // - {{name}}: {{schema.type}}{{#if required}} (required){{/if}}
340
+ {{/each}}
341
+ {{/if}}
342
+
343
+ // Example implementation:
344
+ // if (!validateSomething(input)) {
345
+ // return {
346
+ // success: false,
347
+ // error: { status: 4xx, message: 'Error message', code: 'ERROR_CODE' },
348
+ // };
349
+ // }
350
+
351
+ return { success: true, context: { /* optional context for service */ } };
352
+ }
353
+
354
+ {{/each}}
355
+ /**
356
+ * Registry of all overlay handlers
357
+ * Register this with your server framework
358
+ */
359
+ export const overlayHandlers: OverlayRegistry = {
360
+ {{#each extensions}}
361
+ {{camelCase name}}: {{camelCase name}},
362
+ {{/each}}
363
+ };
364
+ `;
365
+ // =============================================================================
366
+ // Screen Spec Templates
367
+ // =============================================================================
368
+ const STARTER_SCREEN_NAVIGATION_TEMPLATE = `/**
369
+ * Auto-generated screen navigation map from OpenAPI screen specification
370
+ * Generated from: {{title}} v{{version}}
371
+ * DO NOT EDIT MANUALLY
372
+ */
373
+
374
+ const _OP_ROUTES = {
375
+ {{#each screens}}
376
+ {{operationId}}: '{{route}}',
377
+ {{/each}}
378
+ } as const;
379
+
380
+ export const SCREENS = {
381
+ {{#each screens}}
382
+ {{screenConst}}: { id: '{{screenId}}' as const, route: _OP_ROUTES.{{operationId}}, supportsBack: {{supportsBack}} } as const,
383
+ {{/each}}
384
+ } as const;
385
+
386
+ {{#each screens}}
387
+ {{#if links.length}}
388
+ export const {{screenConst}}_PAGE_LINKS = {
389
+ {{#each links}}
390
+ {{name}}: _OP_ROUTES.{{targetOperationId}},
391
+ {{/each}}
392
+ } as const;
393
+
394
+ {{/if}}
395
+ {{/each}}
396
+ `;
397
+ const STARTER_SCREEN_EVENTS_TEMPLATE = `/**
398
+ * Auto-generated analytics event hooks from OpenAPI screen specification
399
+ * Generated from: {{title}} v{{version}}
400
+ * DO NOT EDIT MANUALLY
401
+ */
402
+
403
+ import { trackEvent } from '@/lib/analytics';
404
+
405
+ {{#each screens}}
406
+ {{#if events.length}}
407
+ export function use{{screenName}}Events() {
408
+ return {
409
+ {{#each events}}
410
+ {{#if this.params}}
411
+ {{this.method}}: ({{#each this.params}}{{@key}}: {{#if (eq this 'integer')}}number{{else}}{{this}}{{/if}}{{#unless @last}}, {{/unless}}{{/each}}) =>
412
+ trackEvent('{{this.name}}', '{{this.type}}', { {{#each this.params}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}} }),
413
+ {{else}}
414
+ {{this.method}}: () =>
415
+ trackEvent('{{this.name}}', '{{this.type}}', {}),
416
+ {{/if}}
417
+ {{/each}}
418
+ };
419
+ }
420
+
421
+ {{/if}}
422
+ {{/each}}
423
+ `;
424
+ /**
425
+ * Get all starter templates
426
+ */
427
+ export function getStarterTemplates() {
428
+ return {
429
+ 'fastify-routes.hbs': STARTER_FASTIFY_ROUTES_TEMPLATE,
430
+ 'fetch-client.hbs': STARTER_FETCH_CLIENT_TEMPLATE,
431
+ 'service-stubs.hbs': STARTER_SERVICE_STUBS_TEMPLATE,
432
+ 'overlay-adapter.hbs': STARTER_OVERLAY_ADAPTER_TEMPLATE,
433
+ 'overlay-stubs.hbs': STARTER_OVERLAY_STUBS_TEMPLATE,
434
+ };
435
+ }
436
+ /**
437
+ * Get screen spec starter templates
438
+ */
439
+ export function getScreenStarterTemplates() {
440
+ return {
441
+ 'screen-navigation.hbs': STARTER_SCREEN_NAVIGATION_TEMPLATE,
442
+ 'screen-events.hbs': STARTER_SCREEN_EVENTS_TEMPLATE,
443
+ };
444
+ }
445
+ //# sourceMappingURL=templates.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/cli/templates.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,+BAA+B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2DvC,CAAC;AAEF,MAAM,6BAA6B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4FrC,CAAC;AAEF,MAAM,8BAA8B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BtC,CAAC;AAEF,MAAM,gCAAgC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyHxC,CAAC;AAEF,MAAM,8BAA8B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmDtC,CAAC;AAEF,gFAAgF;AAChF,wBAAwB;AACxB,gFAAgF;AAEhF,MAAM,kCAAkC,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B1C,CAAC;AAEF,MAAM,8BAA8B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BtC,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO;QACL,oBAAoB,EAAE,+BAA+B;QACrD,kBAAkB,EAAE,6BAA6B;QACjD,mBAAmB,EAAE,8BAA8B;QACnD,qBAAqB,EAAE,gCAAgC;QACvD,mBAAmB,EAAE,8BAA8B;KACpD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB;IACvC,OAAO;QACL,uBAAuB,EAAE,kCAAkC;QAC3D,mBAAmB,EAAE,8BAA8B;KACpD,CAAC;AACJ,CAAC"}
package/dist/cli.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=cli.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}