@manehorizons/cadence-types 1.9.0 → 1.10.0

package/dist/host.d.ts

@@ -1,10 +1,87 @@
-import type { AbstractEvent } from './events.js';
-export interface HostCapabilities {
-    hooks: AbstractEvent[];
-    slashCommands: boolean;
-    skillSystem: 'native' | 'prompted' | 'none';
-    blockingHooks: AbstractEvent[];
-    subagentSpawn: 'native' | 'shell-out' | 'none';
-    streamingOutput: boolean;
+import { z } from 'zod';
+import { type AbstractEvent } from './events.js';
+/**
+ * Capability descriptor a host adapter declares about its environment. The
+ * core uses it to decide which abstract events the host can deliver and which
+ * of them can block. Zod schema kept in parity with {@link AbstractEventZ}; the
+ * `HostCapabilities` type is derived from it so the schema is the single
+ * source of truth.
+ */
+export declare const HostCapabilitiesZ: z.ZodObject<{
+    hooks: z.ZodArray<z.ZodEnum<{
+        "session-start": "session-start";
+        "user-prompt": "user-prompt";
+        "pre-tool-edit": "pre-tool-edit";
+        "post-tool-edit": "post-tool-edit";
+        "session-stop": "session-stop";
+        "subagent-result": "subagent-result";
+        "skill-invoke": "skill-invoke";
+    }>>;
+    slashCommands: z.ZodBoolean;
+    skillSystem: z.ZodEnum<{
+        none: "none";
+        native: "native";
+        prompted: "prompted";
+    }>;
+    blockingHooks: z.ZodArray<z.ZodEnum<{
+        "session-start": "session-start";
+        "user-prompt": "user-prompt";
+        "pre-tool-edit": "pre-tool-edit";
+        "post-tool-edit": "post-tool-edit";
+        "session-stop": "session-stop";
+        "subagent-result": "subagent-result";
+        "skill-invoke": "skill-invoke";
+    }>>;
+    subagentSpawn: z.ZodEnum<{
+        none: "none";
+        native: "native";
+        "shell-out": "shell-out";
+    }>;
+    streamingOutput: z.ZodBoolean;
+}, z.core.$strip>;
+export type HostCapabilities = z.infer<typeof HostCapabilitiesZ>;
+/**
+ * Version of the host-adapter contract (capabilities + event map + payload
+ * extraction + install surface). Integer, breaking-only — bumped when an
+ * existing adapter would need code changes to keep conforming.
+ */
+export declare const ADAPTER_CONTRACT_VERSION = 1;
+/**
+ * Normalized payload the core dispatcher consumes, extracted by an adapter
+ * from a host's raw event. `files` for edit-tool events; `skill` for
+ * skill-invoke events. Host-facing adapters own the extraction; this is the
+ * core-facing shape they must produce.
+ */
+export interface ExtractedPayload {
+    files?: string[];
+    skill?: string;
+}
+/**
+ * The host-adapter contract. An adapter package translates a host's lifecycle
+ * into the abstract events the core already speaks, declares its capabilities,
+ * extracts payloads, and installs itself into the host.
+ *
+ * Only the core-facing surface is pinned here. Install option shapes are
+ * intrinsically host-specific, so they are left as type parameters rather than
+ * coupled to any one host. Runtime plumbing a host needs internally (request
+ * routing, locating its own install) is a documented responsibility, not part
+ * of this type — see the "write your own adapter" guide.
+ *
+ * @typeParam HookOpts - host-specific options for {@link HostAdapter.installHooks}
+ * @typeParam CommandOpts - host-specific options for {@link HostAdapter.installCommands}
+ */
+export interface HostAdapter<HookOpts = unknown, CommandOpts = unknown> {
+    /** Contract version this adapter targets; must equal {@link ADAPTER_CONTRACT_VERSION}. */
+    readonly contractVersion: number;
+    /** What the host environment can do. */
+    readonly capabilities: HostCapabilities;
+    /** Map a host lifecycle event name to its abstract event, or null if unmapped. */
+    mapEvent(hostEvent: string, toolName?: string): AbstractEvent | null;
+    /** Extract the normalized payload from a host's raw event. */
+    extractPayload(raw: unknown): ExtractedPayload | undefined;
+    /** Wire the host's lifecycle hooks to the cadence shim, under project `root`. */
+    installHooks(root: string, options?: HookOpts): Promise<unknown> | unknown;
+    /** Install the host's slash-command (or equivalent) surface, under project `root`. */
+    installCommands(root: string, options?: CommandOpts): Promise<unknown> | unknown;
 }
 //# sourceMappingURL=host.d.ts.map

package/dist/host.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;IAC5C,aAAa,EAAE,aAAa,EAAE,CAAC;IAC/B,aAAa,EAAE,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAC;IAC/C,eAAe,EAAE,OAAO,CAAC;CAC1B"}
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAkB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjE;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO5B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,WAAW,CAAC,QAAQ,GAAG,OAAO,EAAE,WAAW,GAAG,OAAO;IACpE,0FAA0F;IAC1F,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,gBAAgB,CAAC;IACxC,kFAAkF;IAClF,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC;IACrE,8DAA8D;IAC9D,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC3D,iFAAiF;IACjF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IAC3E,sFAAsF;IACtF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CAClF"}

package/dist/host.js

@@ -1,2 +1,24 @@
-export {};
+import { z } from 'zod';
+import { AbstractEventZ } from './events.js';
+/**
+ * Capability descriptor a host adapter declares about its environment. The
+ * core uses it to decide which abstract events the host can deliver and which
+ * of them can block. Zod schema kept in parity with {@link AbstractEventZ}; the
+ * `HostCapabilities` type is derived from it so the schema is the single
+ * source of truth.
+ */
+export const HostCapabilitiesZ = z.object({
+    hooks: z.array(AbstractEventZ),
+    slashCommands: z.boolean(),
+    skillSystem: z.enum(['native', 'prompted', 'none']),
+    blockingHooks: z.array(AbstractEventZ),
+    subagentSpawn: z.enum(['native', 'shell-out', 'none']),
+    streamingOutput: z.boolean(),
+});
+/**
+ * Version of the host-adapter contract (capabilities + event map + payload
+ * extraction + install surface). Integer, breaking-only — bumped when an
+ * existing adapter would need code changes to keep conforming.
+ */
+export const ADAPTER_CONTRACT_VERSION = 1;
 //# sourceMappingURL=host.js.map

package/dist/host.js.map

@@ -1 +1 @@
-{"version":3,"file":"host.js","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":""}
+{"version":3,"file":"host.js","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAsB,MAAM,aAAa,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC9B,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IACnD,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IACtC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IACtD,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;CAC7B,CAAC,CAAC;AAIH;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manehorizons/cadence-types",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "engines": {
     "node": ">=20"
   },