@cleocode/contracts 2026.4.0 → 2026.4.3

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 (55) hide show
  1. package/dist/adapter.d.ts +60 -0
  2. package/dist/adapter.d.ts.map +1 -1
  3. package/dist/brain.d.ts +19 -0
  4. package/dist/brain.d.ts.map +1 -1
  5. package/dist/capabilities.d.ts +1 -0
  6. package/dist/capabilities.d.ts.map +1 -1
  7. package/dist/conduit.d.ts +5 -0
  8. package/dist/conduit.d.ts.map +1 -1
  9. package/dist/config.d.ts +38 -3
  10. package/dist/config.d.ts.map +1 -1
  11. package/dist/errors.d.ts +30 -0
  12. package/dist/errors.d.ts.map +1 -1
  13. package/dist/errors.js +30 -0
  14. package/dist/errors.js.map +1 -1
  15. package/dist/install.d.ts +1 -1
  16. package/dist/install.d.ts.map +1 -1
  17. package/dist/lafs.d.ts +167 -11
  18. package/dist/lafs.d.ts.map +1 -1
  19. package/dist/lafs.js +57 -3
  20. package/dist/lafs.js.map +1 -1
  21. package/dist/memory.d.ts +77 -0
  22. package/dist/memory.d.ts.map +1 -1
  23. package/dist/operations/issues.d.ts +1 -1
  24. package/dist/operations/issues.d.ts.map +1 -1
  25. package/dist/operations/session.d.ts +1 -1
  26. package/dist/operations/session.js +1 -1
  27. package/dist/operations/tasks.d.ts +1 -1
  28. package/dist/operations/tasks.js +1 -1
  29. package/dist/results.d.ts +89 -0
  30. package/dist/results.d.ts.map +1 -1
  31. package/dist/session.d.ts +78 -0
  32. package/dist/session.d.ts.map +1 -1
  33. package/dist/session.js +5 -0
  34. package/dist/session.js.map +1 -1
  35. package/dist/status-registry.d.ts +1 -1
  36. package/dist/status-registry.js +1 -1
  37. package/dist/task.d.ts +106 -33
  38. package/dist/task.d.ts.map +1 -1
  39. package/package.json +1 -1
  40. package/src/adapter.ts +60 -0
  41. package/src/brain.ts +19 -0
  42. package/src/capabilities.ts +1 -0
  43. package/src/conduit.ts +3 -0
  44. package/src/config.ts +38 -3
  45. package/src/errors.ts +30 -0
  46. package/src/install.ts +1 -1
  47. package/src/lafs.ts +169 -13
  48. package/src/memory.ts +77 -0
  49. package/src/operations/issues.ts +1 -1
  50. package/src/operations/session.ts +1 -1
  51. package/src/operations/tasks.ts +1 -1
  52. package/src/results.ts +89 -0
  53. package/src/session.ts +78 -0
  54. package/src/status-registry.ts +1 -1
  55. package/src/task.ts +106 -33
package/dist/adapter.d.ts CHANGED
@@ -12,25 +12,85 @@ import type { AdapterPathProvider } from './provider-paths.js';
12
12
  import type { AdapterSpawnProvider } from './spawn.js';
13
13
  import type { ExternalTaskProvider } from './task-sync.js';
14
14
  import type { AdapterTransportProvider } from './transport.js';
15
+ /**
16
+ * Core provider adapter interface that every CLEO provider must implement.
17
+ *
18
+ * @remarks
19
+ * Provider adapters bridge CLEO's core engine to specific LLM providers
20
+ * (Claude, GPT, etc.). Each adapter declares its capabilities and exposes
21
+ * optional sub-providers for hooks, spawning, paths, and transport.
22
+ */
15
23
  export interface CLEOProviderAdapter {
24
+ /** Unique identifier for this adapter (e.g. `"claude"`, `"openai"`). */
16
25
  readonly id: string;
26
+ /** Human-readable display name for the adapter. */
17
27
  readonly name: string;
28
+ /** Semantic version of the adapter implementation. */
18
29
  readonly version: string;
30
+ /** Capability flags declaring what this adapter supports. */
19
31
  capabilities: AdapterCapabilities;
32
+ /**
33
+ * Optional hook provider for lifecycle event integration.
34
+ *
35
+ * @defaultValue undefined
36
+ */
20
37
  hooks?: AdapterHookProvider;
38
+ /**
39
+ * Optional spawn provider for launching sub-agents.
40
+ *
41
+ * @defaultValue undefined
42
+ */
21
43
  spawn?: AdapterSpawnProvider;
44
+ /** Installation provider for scaffolding adapter-specific config files. */
22
45
  install: AdapterInstallProvider;
46
+ /**
47
+ * Optional path provider for adapter-specific file locations.
48
+ *
49
+ * @defaultValue undefined
50
+ */
23
51
  paths?: AdapterPathProvider;
52
+ /**
53
+ * Optional context monitor provider for tracking token usage.
54
+ *
55
+ * @defaultValue undefined
56
+ */
24
57
  contextMonitor?: AdapterContextMonitorProvider;
58
+ /**
59
+ * Optional transport provider for inter-agent messaging.
60
+ *
61
+ * @defaultValue undefined
62
+ */
25
63
  transport?: AdapterTransportProvider;
64
+ /**
65
+ * Optional external task sync provider for bidirectional issue tracking.
66
+ *
67
+ * @defaultValue undefined
68
+ */
26
69
  taskSync?: ExternalTaskProvider;
70
+ /** Initialize the adapter for the given project directory. */
27
71
  initialize(projectDir: string): Promise<void>;
72
+ /** Release all resources held by the adapter. */
28
73
  dispose(): Promise<void>;
74
+ /** Return the current health status of the adapter. */
29
75
  healthCheck(): Promise<AdapterHealthStatus>;
30
76
  }
77
+ /**
78
+ * Health check result returned by {@link CLEOProviderAdapter.healthCheck}.
79
+ *
80
+ * @remarks
81
+ * Used by the `cleo doctor` command to verify adapter connectivity and
82
+ * surface provider-specific diagnostic information.
83
+ */
31
84
  export interface AdapterHealthStatus {
85
+ /** Whether the adapter is currently operational. */
32
86
  healthy: boolean;
87
+ /** Name of the provider this status applies to. */
33
88
  provider: string;
89
+ /**
90
+ * Provider-specific diagnostic key-value pairs.
91
+ *
92
+ * @defaultValue undefined
93
+ */
34
94
  details?: Record<string, unknown>;
35
95
  }
36
96
  //# sourceMappingURL=adapter.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,mBAAmB,CAAC;IAClC,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,OAAO,EAAE,sBAAsB,CAAC;IAChC,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,cAAc,CAAC,EAAE,6BAA6B,CAAC;IAC/C,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC"}
1
+ {"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,6DAA6D;IAC7D,YAAY,EAAE,mBAAmB,CAAC;IAClC;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,2EAA2E;IAC3E,OAAO,EAAE,sBAAsB,CAAC;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,8DAA8D;IAC9D,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,iDAAiD;IACjD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,uDAAuD;IACvD,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAC;IACjB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC"}
package/dist/brain.d.ts CHANGED
@@ -8,29 +8,48 @@
8
8
  */
9
9
  /** Compact brain entry reference used in contradiction analysis. */
10
10
  export interface BrainEntryRef {
11
+ /** Brain.db entry identifier. */
11
12
  id: string;
13
+ /** Entry type (e.g. `"observation"`, `"learning"`, `"decision"`). */
12
14
  type: string;
15
+ /** Full text content of the brain entry. */
13
16
  content: string;
17
+ /** ISO 8601 timestamp of when the entry was created. */
14
18
  createdAt: string;
15
19
  }
16
20
  /** Brain entry reference with summary, used in superseded analysis. */
17
21
  export interface BrainEntrySummary {
22
+ /** Brain.db entry identifier. */
18
23
  id: string;
24
+ /** Entry type (e.g. `"observation"`, `"learning"`, `"decision"`). */
19
25
  type: string;
26
+ /** ISO 8601 timestamp of when the entry was created. */
20
27
  createdAt: string;
28
+ /** Truncated summary of the entry content. */
21
29
  summary: string;
22
30
  }
23
31
  /** Contradiction detail between two brain entries. */
24
32
  export interface ContradictionDetail {
33
+ /** First entry in the contradicting pair. */
25
34
  entryA: BrainEntryRef;
35
+ /** Second entry in the contradicting pair. */
26
36
  entryB: BrainEntryRef;
37
+ /**
38
+ * Additional context explaining the scope of the contradiction.
39
+ *
40
+ * @defaultValue undefined
41
+ */
27
42
  context?: string;
43
+ /** Description of how the two entries conflict. */
28
44
  conflictDetails: string;
29
45
  }
30
46
  /** Superseded entry pair showing old and replacement entries. */
31
47
  export interface SupersededEntry {
48
+ /** The older entry that has been superseded. */
32
49
  oldEntry: BrainEntrySummary;
50
+ /** The newer entry that replaces the old one. */
33
51
  replacement: BrainEntrySummary;
52
+ /** Topic or category grouping these entries together. */
34
53
  grouping: string;
35
54
  }
36
55
  //# sourceMappingURL=brain.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"brain.d.ts","sourceRoot":"","sources":["../src/brain.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,oEAAoE;AACpE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,sDAAsD;AACtD,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,iEAAiE;AACjE,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,WAAW,EAAE,iBAAiB,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"brain.d.ts","sourceRoot":"","sources":["../src/brain.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,oEAAoE;AACpE,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,sDAAsD;AACtD,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,MAAM,EAAE,aAAa,CAAC;IACtB,8CAA8C;IAC9C,MAAM,EAAE,aAAa,CAAC;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,iEAAiE;AACjE,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,iDAAiD;IACjD,WAAW,EAAE,iBAAiB,CAAC;IAC/B,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;CAClB"}
@@ -8,6 +8,7 @@ export interface AdapterCapabilities {
8
8
  supportedHookEvents: string[];
9
9
  supportsSpawn: boolean;
10
10
  supportsInstall: boolean;
11
+ /** Always false. CLI is the only dispatch channel. */
11
12
  supportsMcp: boolean;
12
13
  supportsInstructionFiles: boolean;
13
14
  /** Provider-specific instruction file name, e.g. "CLAUDE.md", ".cursorrules" */
@@ -1 +1 @@
1
- {"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,wBAAwB,EAAE,OAAO,CAAC;IAClC,gFAAgF;IAChF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,OAAO,CAAC;IAChC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;CAC3B"}
1
+ {"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,sDAAsD;IACtD,WAAW,EAAE,OAAO,CAAC;IACrB,wBAAwB,EAAE,OAAO,CAAC;IAClC,gFAAgF;IAChF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,OAAO,CAAC;IAChC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;CAC3B"}
package/dist/conduit.d.ts CHANGED
@@ -86,6 +86,11 @@ export interface Conduit {
86
86
  send(to: string, content: string, options?: ConduitSendOptions): Promise<ConduitSendResult>;
87
87
  /** Subscribe to incoming messages. Returns unsubscribe function. */
88
88
  onMessage(handler: (message: ConduitMessage) => void): ConduitUnsubscribe;
89
+ /** One-shot poll for new messages. Returns messages without subscribing. */
90
+ poll(options?: {
91
+ limit?: number;
92
+ since?: string;
93
+ }): Promise<ConduitMessage[]>;
89
94
  /** Send a heartbeat to indicate this agent is alive. */
90
95
  heartbeat(): Promise<void>;
91
96
  /** Check if a specific agent is currently online. */
@@ -1 +1 @@
1
- {"version":3,"file":"conduit.d.ts","sourceRoot":"","sources":["../src/conduit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,mCAAmC;AACnC,MAAM,WAAW,iBAAiB;IAChC,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAM5C,iCAAiC;AACjC,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;AAElG,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,IAAI,EAAE,YAAY,CAAC;IACnB,iBAAiB;IACjB,EAAE,EAAE,YAAY,CAAC;IACjB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,OAAO;IAGtB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE5F,oEAAoE;IACpE,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,kBAAkB,CAAC;IAI1E,wDAAwD;IACxD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C,6FAA6F;IAC7F,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAIjC,wCAAwC;IACxC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,6CAA6C;IAC7C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,IAAI,YAAY,CAAC;IAEzB,6CAA6C;IAC7C,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,GAAG,kBAAkB,CAAC;IAIlF,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAMD,qDAAqD;AACrD,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}
1
+ {"version":3,"file":"conduit.d.ts","sourceRoot":"","sources":["../src/conduit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,mCAAmC;AACnC,MAAM,WAAW,iBAAiB;IAChC,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAM5C,iCAAiC;AACjC,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAC;AAElG,qCAAqC;AACrC,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,IAAI,EAAE,YAAY,CAAC;IACnB,iBAAiB;IACjB,EAAE,EAAE,YAAY,CAAC;IACjB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,OAAO;IAGtB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE5F,oEAAoE;IACpE,SAAS,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,kBAAkB,CAAC;IAE1E,4EAA4E;IAC5E,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAI9E,wDAAwD;IACxD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C,6FAA6F;IAC7F,UAAU,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAIjC,wCAAwC;IACxC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,6CAA6C;IAC7C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,IAAI,YAAY,CAAC;IAEzB,6CAA6C;IAC7C,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,GAAG,kBAAkB,CAAC;IAIlF,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAMD,qDAAqD;AACrD,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}
package/dist/config.d.ts CHANGED
@@ -14,24 +14,35 @@ export type OutputFormat = 'json' | 'text' | 'jsonl' | 'markdown' | 'table';
14
14
  export type DateFormat = 'relative' | 'iso' | 'short' | 'long';
15
15
  /** Output configuration. */
16
16
  export interface OutputConfig {
17
+ /** Default output format for CLI responses. */
17
18
  defaultFormat: OutputFormat;
19
+ /** Whether to use ANSI color codes in terminal output. */
18
20
  showColor: boolean;
21
+ /** Whether to use Unicode symbols (checkmarks, arrows) in output. */
19
22
  showUnicode: boolean;
23
+ /** Whether to display progress bars for long-running operations. */
20
24
  showProgressBars: boolean;
25
+ /** Date display format for timestamps in output. */
21
26
  dateFormat: DateFormat;
22
27
  }
23
28
  /** Backup configuration. */
24
29
  export interface BackupConfig {
30
+ /** Maximum number of operational backups to retain during normal operations. */
25
31
  maxOperationalBackups: number;
32
+ /** Maximum number of safety backups to retain for disaster recovery. */
26
33
  maxSafetyBackups: number;
34
+ /** Whether to compress backup files to reduce disk usage. */
27
35
  compressionEnabled: boolean;
28
36
  }
29
37
  /** Hierarchy enforcement profile preset. */
30
38
  export type EnforcementProfile = 'llm-agent-first' | 'human-cognitive' | 'custom';
31
39
  /** Hierarchy configuration. */
32
40
  export interface HierarchyConfig {
41
+ /** Maximum nesting depth for task hierarchy (epic > task > subtask). */
33
42
  maxDepth: number;
43
+ /** Maximum number of sibling tasks under a single parent. */
34
44
  maxSiblings: number;
45
+ /** Whether deleting a parent cascades to all descendant tasks. */
35
46
  cascadeDelete: boolean;
36
47
  /** Maximum number of active (non-done) siblings. 0 = disabled. */
37
48
  maxActiveSiblings: number;
@@ -42,8 +53,11 @@ export interface HierarchyConfig {
42
53
  }
43
54
  /** Session configuration. */
44
55
  export interface SessionConfig {
56
+ /** Whether to auto-start a session on first mutate operation. */
45
57
  autoStart: boolean;
58
+ /** Whether session end requires at least one note. */
46
59
  requireNotes: boolean;
60
+ /** Whether multiple concurrent sessions are allowed. */
47
61
  multiSession: boolean;
48
62
  }
49
63
  /** Pino log levels. */
@@ -99,6 +113,7 @@ export interface VerificationConfig {
99
113
  export type LifecycleEnforcementMode = 'strict' | 'advisory' | 'off';
100
114
  /** Lifecycle enforcement configuration. */
101
115
  export interface LifecycleConfig {
116
+ /** Enforcement mode controlling how lifecycle rules are applied. */
102
117
  mode: LifecycleEnforcementMode;
103
118
  }
104
119
  /** Sharing mode: whether .cleo/ files are committed to the project git repo. */
@@ -162,7 +177,7 @@ export interface BrainConfig {
162
177
  autoCapture: boolean;
163
178
  /** Whether to capture file change events (default: false). */
164
179
  captureFiles: boolean;
165
- /** Whether to capture MCP tool events (default: false). */
180
+ /** Unused. CLI dispatch only. */
166
181
  captureMcp: boolean;
167
182
  /** Whether to capture active-work dispatch mutations (tasks.add, tasks.update) (default: false). */
168
183
  captureWork: boolean;
@@ -206,26 +221,46 @@ export interface SignalDockConfig {
206
221
  }
207
222
  /** CLEO project configuration (config.json). */
208
223
  export interface CleoConfig {
224
+ /** Configuration schema version string. */
209
225
  version: string;
226
+ /** Output formatting preferences. */
210
227
  output: OutputConfig;
228
+ /** Database backup retention and compression settings. */
211
229
  backup: BackupConfig;
230
+ /** Task hierarchy depth and sibling constraints. */
212
231
  hierarchy: HierarchyConfig;
232
+ /** Session auto-start and multi-session policies. */
213
233
  session: SessionConfig;
234
+ /** Acceptance criteria and session enforcement rules. */
214
235
  enforcement: EnforcementConfig;
236
+ /** Verification gate pipeline settings. */
215
237
  verification: VerificationConfig;
238
+ /** Task lifecycle enforcement mode. */
216
239
  lifecycle: LifecycleConfig;
240
+ /** Log level, rotation, and audit retention settings. */
217
241
  logging: LoggingConfig;
242
+ /** Multi-contributor `.cleo/` state sharing settings. */
218
243
  sharing: SharingConfig;
219
- /** SignalDock inter-agent transport (optional, disabled by default). */
244
+ /**
245
+ * SignalDock inter-agent transport (optional, disabled by default).
246
+ *
247
+ * @defaultValue undefined
248
+ */
220
249
  signaldock?: SignalDockConfig;
221
- /** Brain memory system configuration (optional, uses defaults when absent). */
250
+ /**
251
+ * Brain memory system configuration (optional, uses defaults when absent).
252
+ *
253
+ * @defaultValue undefined
254
+ */
222
255
  brain?: BrainConfig;
223
256
  }
224
257
  /** Configuration resolution priority. */
225
258
  export type ConfigSource = 'cli' | 'env' | 'project' | 'global' | 'default';
226
259
  /** A resolved config value with its source. */
227
260
  export interface ResolvedValue<T> {
261
+ /** The resolved configuration value. */
228
262
  value: T;
263
+ /** Where this value was resolved from in the cascade. */
229
264
  source: ConfigSource;
230
265
  }
231
266
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6BAA6B;AAC7B,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;AAE5E,2BAA2B;AAC3B,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAE/D,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,YAAY,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,QAAQ,CAAC;AAElF,+BAA+B;AAC/B,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,kEAAkE;IAClE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yDAAyD;IACzD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,0EAA0E;IAC1E,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED,6BAA6B;AAC7B,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1F,6BAA6B;AAC7B,MAAM,WAAW,aAAa;IAC5B,oDAAoD;IACpD,KAAK,EAAE,QAAQ,CAAC;IAChB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yFAAyF;IACzF,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,4CAA4C;AAC5C,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,gDAAgD;AAChD,MAAM,WAAW,2BAA2B;IAC1C,wBAAwB;IACxB,IAAI,EAAE,yBAAyB,CAAC;IAChC,uCAAuC;IACvC,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,oCAAoC;AACpC,MAAM,WAAW,wBAAwB;IACvC,2DAA2D;IAC3D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,2CAA2C;AAC3C,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,UAAU,EAAE,2BAA2B,CAAC;IACxC,2BAA2B;IAC3B,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,kCAAkC;AAClC,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAErE,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED,gFAAgF;AAChF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;IAClB,8EAA8E;IAC9E,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,gGAAgG;IAChG,WAAW,EAAE,OAAO,CAAC;IACrB,0FAA0F;IAC1F,YAAY,EAAE,OAAO,CAAC;IACtB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,2FAA2F;IAC3F,WAAW,EAAE,OAAO,CAAC;IACrB,8DAA8D;IAC9D,YAAY,EAAE,OAAO,CAAC;IACtB,2DAA2D;IAC3D,UAAU,EAAE,OAAO,CAAC;IACpB,oGAAoG;IACpG,WAAW,EAAE,OAAO,CAAC;IACrB,mCAAmC;IACnC,SAAS,EAAE,oBAAoB,CAAC;IAChC,2CAA2C;IAC3C,YAAY,EAAE,uBAAuB,CAAC;IACtC,sCAAsC;IACtC,aAAa,EAAE,wBAAwB,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,iCAAiC;AACjC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE/C,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC;IACjB,mGAAmG;IACnG,IAAI,EAAE,cAAc,CAAC;IACrB,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,WAAW,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,WAAW,EAAE,QAAQ,GAAG,cAAc,GAAG,SAAS,CAAC;CACpD;AAED,gDAAgD;AAChD,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,YAAY,EAAE,kBAAkB,CAAC;IACjC,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,wEAAwE;IACxE,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,+EAA+E;IAC/E,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,yCAAyC;AACzC,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE5E,+CAA+C;AAC/C,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,YAAY,CAAC;CACtB"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,6BAA6B;AAC7B,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;AAE5E,2BAA2B;AAC3B,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAE/D,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,aAAa,EAAE,YAAY,CAAC;IAC5B,0DAA0D;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,qEAAqE;IACrE,WAAW,EAAE,OAAO,CAAC;IACrB,oEAAoE;IACpE,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oDAAoD;IACpD,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,4BAA4B;AAC5B,MAAM,WAAW,YAAY;IAC3B,gFAAgF;IAChF,qBAAqB,EAAE,MAAM,CAAC;IAC9B,wEAAwE;IACxE,gBAAgB,EAAE,MAAM,CAAC;IACzB,6DAA6D;IAC7D,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,QAAQ,CAAC;AAElF,+BAA+B;AAC/B,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,aAAa,EAAE,OAAO,CAAC;IACvB,kEAAkE;IAClE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yDAAyD;IACzD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,0EAA0E;IAC1E,kBAAkB,EAAE,kBAAkB,CAAC;CACxC;AAED,6BAA6B;AAC7B,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,YAAY,EAAE,OAAO,CAAC;IACtB,wDAAwD;IACxD,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE1F,6BAA6B;AAC7B,MAAM,WAAW,aAAa;IAC5B,oDAAoD;IACpD,KAAK,EAAE,QAAQ,CAAC;IAChB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yFAAyF;IACzF,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,4CAA4C;AAC5C,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,gDAAgD;AAChD,MAAM,WAAW,2BAA2B;IAC1C,wBAAwB;IACxB,IAAI,EAAE,yBAAyB,CAAC;IAChC,uCAAuC;IACvC,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,oCAAoC;AACpC,MAAM,WAAW,wBAAwB;IACvC,2DAA2D;IAC3D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,2CAA2C;AAC3C,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,UAAU,EAAE,2BAA2B,CAAC;IACxC,2BAA2B;IAC3B,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,kCAAkC;AAClC,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAErE,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED,gFAAgF;AAChF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;AAE7C,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;IAClB,8EAA8E;IAC9E,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACtC,gGAAgG;IAChG,WAAW,EAAE,OAAO,CAAC;IACrB,0FAA0F;IAC1F,YAAY,EAAE,OAAO,CAAC;IACtB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAC;IACjB,oDAAoD;IACpD,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,2FAA2F;IAC3F,WAAW,EAAE,OAAO,CAAC;IACrB,8DAA8D;IAC9D,YAAY,EAAE,OAAO,CAAC;IACtB,iCAAiC;IACjC,UAAU,EAAE,OAAO,CAAC;IACpB,oGAAoG;IACpG,WAAW,EAAE,OAAO,CAAC;IACrB,mCAAmC;IACnC,SAAS,EAAE,oBAAoB,CAAC;IAChC,2CAA2C;IAC3C,YAAY,EAAE,uBAAuB,CAAC;IACtC,sCAAsC;IACtC,aAAa,EAAE,wBAAwB,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,iCAAiC;AACjC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE/C,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC;IACjB,mGAAmG;IACnG,IAAI,EAAE,cAAc,CAAC;IACrB,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,WAAW,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,WAAW,EAAE,QAAQ,GAAG,cAAc,GAAG,SAAS,CAAC;CACpD;AAED,gDAAgD;AAChD,MAAM,WAAW,UAAU;IACzB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,MAAM,EAAE,YAAY,CAAC;IACrB,0DAA0D;IAC1D,MAAM,EAAE,YAAY,CAAC;IACrB,oDAAoD;IACpD,SAAS,EAAE,eAAe,CAAC;IAC3B,qDAAqD;IACrD,OAAO,EAAE,aAAa,CAAC;IACvB,yDAAyD;IACzD,WAAW,EAAE,iBAAiB,CAAC;IAC/B,2CAA2C;IAC3C,YAAY,EAAE,kBAAkB,CAAC;IACjC,uCAAuC;IACvC,SAAS,EAAE,eAAe,CAAC;IAC3B,yDAAyD;IACzD,OAAO,EAAE,aAAa,CAAC;IACvB,yDAAyD;IACzD,OAAO,EAAE,aAAa,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,yCAAyC;AACzC,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE5E,+CAA+C;AAC/C,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,wCAAwC;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,yDAAyD;IACzD,MAAM,EAAE,YAAY,CAAC;CACtB"}
package/dist/errors.d.ts CHANGED
@@ -19,6 +19,11 @@
19
19
  * @param fallbackMessage - Message to use if error provides none
20
20
  * @returns Normalized error with consistent shape
21
21
  *
22
+ * @remarks
23
+ * This function is safe to call on any value thrown by a `catch` clause.
24
+ * It guarantees the returned object is always an `Error` instance with a
25
+ * non-empty `message` property.
26
+ *
22
27
  * @example
23
28
  * ```typescript
24
29
  * try {
@@ -39,6 +44,10 @@ export declare function normalizeError(error: unknown, fallbackMessage?: string)
39
44
  * @param fallback - Fallback message if extraction fails
40
45
  * @returns The error message string
41
46
  *
47
+ * @remarks
48
+ * Inspects the value for an `Error` instance, a plain string, or an object
49
+ * with a `message` property before falling back to the provided default.
50
+ *
42
51
  * @example
43
52
  * ```typescript
44
53
  * const message = getErrorMessage(err, 'Unknown error');
@@ -55,6 +64,11 @@ export declare function getErrorMessage(error: unknown, fallback?: string): stri
55
64
  * @param includeStack - Whether to include stack traces (default: false)
56
65
  * @returns Formatted error string
57
66
  *
67
+ * @remarks
68
+ * When `context` is provided it is prefixed in square brackets (e.g.
69
+ * `[Database] Connection refused`). Stack traces are appended on a new line
70
+ * only when `includeStack` is `true` and the value is an `Error` with a stack.
71
+ *
58
72
  * @example
59
73
  * ```typescript
60
74
  * console.error(formatError(err, 'Database connection'));
@@ -71,6 +85,10 @@ export declare function formatError(error: unknown, context?: string, includeSta
71
85
  * @param codeOrName - The error code or name to match
72
86
  * @returns True if the error matches
73
87
  *
88
+ * @remarks
89
+ * Checks both `Error.name` and a custom `code` property, supporting both
90
+ * standard and LAFS-style error codes (e.g. `"E_NOT_FOUND"`).
91
+ *
74
92
  * @example
75
93
  * ```typescript
76
94
  * if (isErrorType(err, 'E_NOT_FOUND')) {
@@ -87,6 +105,10 @@ export declare function isErrorType(error: unknown, codeOrName: string): boolean
87
105
  * @param error - The error value
88
106
  * @returns Error result object
89
107
  *
108
+ * @remarks
109
+ * Pairs with {@link createSuccessResult} and {@link isErrorResult} to provide
110
+ * a consistent result-or-error pattern without exceptions.
111
+ *
90
112
  * @example
91
113
  * ```typescript
92
114
  * return createErrorResult(err);
@@ -102,6 +124,10 @@ export declare function createErrorResult(error: unknown): {
102
124
  *
103
125
  * @returns Success result object
104
126
  *
127
+ * @remarks
128
+ * Pairs with {@link createErrorResult} and {@link isErrorResult} to provide
129
+ * a consistent result-or-error pattern without exceptions.
130
+ *
105
131
  * @example
106
132
  * ```typescript
107
133
  * return createSuccessResult();
@@ -117,6 +143,10 @@ export declare function createSuccessResult(): {
117
143
  * @param result - The result to check
118
144
  * @returns True if the result is an error result
119
145
  *
146
+ * @remarks
147
+ * Narrows the result type so that `result.error` is guaranteed to be a string
148
+ * after the guard returns `true`.
149
+ *
120
150
  * @example
121
151
  * ```typescript
122
152
  * const result = await someOperation();
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,OAAO,EACd,eAAe,SAAiC,GAC/C,KAAK,CAmBP;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAkB,GAAG,MAAM,CAmBlF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,UAAQ,GAAG,MAAM,CAU1F;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAWvE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAKnF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,IAAI;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAEvD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GAAG,MAAM,IAAI;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAE9C"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,OAAO,EACd,eAAe,SAAiC,GAC/C,KAAK,CAmBP;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAkB,GAAG,MAAM,CAmBlF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,UAAQ,GAAG,MAAM,CAU1F;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAWvE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAKnF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,IAAI;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAEvD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GAAG,MAAM,IAAI;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAE9C"}
package/dist/errors.js CHANGED
@@ -19,6 +19,11 @@
19
19
  * @param fallbackMessage - Message to use if error provides none
20
20
  * @returns Normalized error with consistent shape
21
21
  *
22
+ * @remarks
23
+ * This function is safe to call on any value thrown by a `catch` clause.
24
+ * It guarantees the returned object is always an `Error` instance with a
25
+ * non-empty `message` property.
26
+ *
22
27
  * @example
23
28
  * ```typescript
24
29
  * try {
@@ -53,6 +58,10 @@ export function normalizeError(error, fallbackMessage = 'An unexpected error occ
53
58
  * @param fallback - Fallback message if extraction fails
54
59
  * @returns The error message string
55
60
  *
61
+ * @remarks
62
+ * Inspects the value for an `Error` instance, a plain string, or an object
63
+ * with a `message` property before falling back to the provided default.
64
+ *
56
65
  * @example
57
66
  * ```typescript
58
67
  * const message = getErrorMessage(err, 'Unknown error');
@@ -83,6 +92,11 @@ export function getErrorMessage(error, fallback = 'Unknown error') {
83
92
  * @param includeStack - Whether to include stack traces (default: false)
84
93
  * @returns Formatted error string
85
94
  *
95
+ * @remarks
96
+ * When `context` is provided it is prefixed in square brackets (e.g.
97
+ * `[Database] Connection refused`). Stack traces are appended on a new line
98
+ * only when `includeStack` is `true` and the value is an `Error` with a stack.
99
+ *
86
100
  * @example
87
101
  * ```typescript
88
102
  * console.error(formatError(err, 'Database connection'));
@@ -107,6 +121,10 @@ export function formatError(error, context, includeStack = false) {
107
121
  * @param codeOrName - The error code or name to match
108
122
  * @returns True if the error matches
109
123
  *
124
+ * @remarks
125
+ * Checks both `Error.name` and a custom `code` property, supporting both
126
+ * standard and LAFS-style error codes (e.g. `"E_NOT_FOUND"`).
127
+ *
110
128
  * @example
111
129
  * ```typescript
112
130
  * if (isErrorType(err, 'E_NOT_FOUND')) {
@@ -134,6 +152,10 @@ export function isErrorType(error, codeOrName) {
134
152
  * @param error - The error value
135
153
  * @returns Error result object
136
154
  *
155
+ * @remarks
156
+ * Pairs with {@link createSuccessResult} and {@link isErrorResult} to provide
157
+ * a consistent result-or-error pattern without exceptions.
158
+ *
137
159
  * @example
138
160
  * ```typescript
139
161
  * return createErrorResult(err);
@@ -151,6 +173,10 @@ export function createErrorResult(error) {
151
173
  *
152
174
  * @returns Success result object
153
175
  *
176
+ * @remarks
177
+ * Pairs with {@link createErrorResult} and {@link isErrorResult} to provide
178
+ * a consistent result-or-error pattern without exceptions.
179
+ *
154
180
  * @example
155
181
  * ```typescript
156
182
  * return createSuccessResult();
@@ -166,6 +192,10 @@ export function createSuccessResult() {
166
192
  * @param result - The result to check
167
193
  * @returns True if the result is an error result
168
194
  *
195
+ * @remarks
196
+ * Narrows the result type so that `result.error` is guaranteed to be a string
197
+ * after the guard returns `true`.
198
+ *
169
199
  * @example
170
200
  * ```typescript
171
201
  * const result = await someOperation();
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAc,EACd,eAAe,GAAG,8BAA8B;IAEhD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc,EAAE,QAAQ,GAAG,eAAe;IACxE,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc,EAAE,OAAgB,EAAE,YAAY,GAAG,KAAK;IAChF,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC;IAEnC,IAAI,YAAY,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc,EAAE,UAAkB;IAC5D,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,iCAAiC;QACjC,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO;QACL,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,MAG7B;IACC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;AACzB,CAAC"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAc,EACd,eAAe,GAAG,8BAA8B;IAEhD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc,EAAE,QAAQ,GAAG,eAAe;IACxE,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EACjC,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc,EAAE,OAAgB,EAAE,YAAY,GAAG,KAAK;IAChF,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC;IAEnC,IAAI,YAAY,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc,EAAE,UAAkB;IAC5D,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,iCAAiC;QACjC,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO;QACL,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;KAC9B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAAC,MAG7B;IACC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;AACzB,CAAC"}
package/dist/install.d.ts CHANGED
@@ -14,12 +14,12 @@ export interface AdapterInstallProvider {
14
14
  export interface InstallOptions {
15
15
  projectDir: string;
16
16
  global?: boolean;
17
- mcpServerPath?: string;
18
17
  }
19
18
  export interface InstallResult {
20
19
  success: boolean;
21
20
  installedAt: string;
22
21
  instructionFileUpdated: boolean;
22
+ /** Always false. CLI dispatch only. */
23
23
  mcpRegistered: boolean;
24
24
  details?: Record<string, unknown>;
25
25
  }
@@ -1 +1 @@
1
- {"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACzD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,6FAA6F;IAC7F,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB,EAAE,OAAO,CAAC;IAChC,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC"}
1
+ {"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACzD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,6FAA6F;IAC7F,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB,EAAE,OAAO,CAAC;IAChC,uCAAuC;IACvC,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC"}