@studio-foundation/contracts 0.13.0 → 0.14.0

package/README.md

@@ -67,7 +67,7 @@ Nothing imports upward. If you find yourself adding a dep here, you're solving t
 | `tool-plugin.ts` | `ToolPluginDef`, `ToolCommandDef`, `ShellExecute`, `BuiltinExecute`, `ParameterDef` |
 | `runner-events.ts` | `RunnerCallbacks`, `ToolCallStartEvent`, `ToolCallCompleteEvent`, `AgentThinkingEvent`, `AgentProgressEvent`, `AgentTokenEvent` |
 | `spawner.ts` | `RunSpawner`, `SpawnConfig`, `SpawnResult` |
-| `integration-plugin.ts` | `IntegrationPluginDef` |
+| `trigger.ts` | `TriggerDef` |
 
 ## Key types
 

package/dist/index.d.ts

@@ -10,5 +10,5 @@ export * from './context-pack.js';
 export * from './tool-plugin.js';
 export * from './runner-events.js';
 export * from './spawner.js';
-export * from './integration-plugin.js';
+export * from './trigger.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -12,5 +12,5 @@ export * from './context-pack.js';
 export * from './tool-plugin.js';
 export * from './runner-events.js';
 export * from './spawner.js';
-export * from './integration-plugin.js';
+export * from './trigger.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,oDAAoD;AAEpD,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,oDAAoD;AAEpD,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/trigger.d.ts

@@ -0,0 +1,38 @@
+export interface TriggerDef {
+    name: string;
+    version: number;
+    description?: string;
+    /** Pipeline to launch when the webhook matches. */
+    pipeline: string;
+    /** Omitted entirely, every signed-or-not delivery matches — same as an empty block. */
+    webhook?: {
+        hmac?: {
+            /** Request header carrying the hex signature, e.g. 'x-hub-signature-256'. */
+            header: string;
+            /** Shared secret; `${VAR}` is resolved from the environment at load. */
+            secret: string;
+        };
+        /** Conditions over `payload.<path>`, same syntax as a stage `when:`. All must hold. */
+        when?: string[];
+    };
+    /** Pipeline input, with `{{payload.<path>}}` references. */
+    input?: Record<string, unknown>;
+    /** Run metadata, with `{{payload.<path>}}` references. */
+    meta?: Record<string, unknown>;
+    /** What to show in the trigger log, with `{{payload.<path>}}` references. */
+    log?: {
+        external_id?: string;
+        external_label?: string;
+        external_url?: string;
+    };
+    /**
+     * Command run when a triggered run does not succeed. Values reach it through
+     * the environment (`STUDIO_RUN_ID`, `STUDIO_META`, …), never interpolated into
+     * the command string — the payload that produced them is untrusted.
+     */
+    on_failure?: {
+        command: string;
+        timeout_ms?: number;
+    };
+}
+//# sourceMappingURL=trigger.d.ts.map

package/dist/trigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../src/trigger.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,uFAAuF;IACvF,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE;YACL,6EAA6E;YAC7E,MAAM,EAAE,MAAM,CAAC;YACf,wEAAwE;YACxE,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,uFAAuF;QACvF,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,6EAA6E;IAC7E,GAAG,CAAC,EAAE;QACJ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF;;;;OAIG;IACH,UAAU,CAAC,EAAE;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH"}

package/dist/trigger.js

@@ -0,0 +1,6 @@
+// A `.trigger.yaml` — an inbound webhook that launches a pipeline run.
+//
+// Triggers cover the one thing tools and MCP servers cannot: an external system
+// pushing to Studio. Everything a trigger does *outbound* belongs in a tool.
+export {};
+//# sourceMappingURL=trigger.js.map

package/dist/trigger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trigger.js","sourceRoot":"","sources":["../src/trigger.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,EAAE;AACF,gFAAgF;AAChF,6EAA6E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studio-foundation/contracts",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Shared TypeScript types and interfaces for Studio packages",
   "type": "module",
   "main": "./dist/index.js",

package/dist/integration-plugin.d.ts

@@ -1,35 +0,0 @@
-export interface IntegrationPluginDef {
-    name: string;
-    version: number;
-    description?: string;
-    config?: {
-        required?: string[];
-        optional?: Record<string, unknown>;
-    };
-    events?: {
-        consumes?: string[];
-        emits?: string[];
-    };
-    test?: {
-        type: 'http';
-        endpoint: string;
-        method?: 'GET' | 'POST';
-        /** e.g. "bearer:${LINEAR_API_KEY}" — resolved before use */
-        auth?: string;
-        body?: string;
-        expect?: {
-            status?: number;
-        };
-    };
-    webhook?: {
-        hmac?: {
-            header: string;
-            secret_env: string;
-        };
-        handler: string;
-    };
-    on_failure?: {
-        handler: string;
-    };
-}
-//# sourceMappingURL=integration-plugin.d.ts.map

package/dist/integration-plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"integration-plugin.d.ts","sourceRoot":"","sources":["../src/integration-plugin.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC;IACF,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IACF,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACxB,4DAA4D;QAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KAC9B,CAAC;IACF,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE;YACL,MAAM,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,UAAU,CAAC,EAAE;QACX,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH"}

package/dist/integration-plugin.js

@@ -1,3 +0,0 @@
-// contracts/src/integration-plugin.ts
-export {};
-//# sourceMappingURL=integration-plugin.js.map

package/dist/integration-plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"integration-plugin.js","sourceRoot":"","sources":["../src/integration-plugin.ts"],"names":[],"mappings":"AAAA,sCAAsC"}