@zapier/zapier-sdk-cli 0.53.1 → 0.54.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @zapier/zapier-sdk-cli
 
+## 0.54.0
+
+### Minor Changes
+
+- 9f1e934: Switched `watchTriggerInbox` from backoff polling to a Server-Sent Events subscription, so it now wakes on near-real-time inbox notifications instead of repeatedly polling for new messages.
+  - The `maxDrainIntervalSeconds` option now controls a periodic safety drain that backstops the SSE stream — guaranteeing forward progress if events are missed or the connection drops — and its default changed from 60 to 300 seconds.
+  - Real-time wake-up health is now reported on stderr: a warning when wake-ups pause and the watch falls back to the safety drain, plus transient reconnect notices in debug mode. stdout (including `--json` NDJSON output) is unaffected.
+  - Added a `fetchStream` method to the API client, along with an exported `SseMessage` type, for opening Server-Sent Events connections through the standard request pipeline (auth, base URL, 429 retry, approval, and concurrency).
+
+### Patch Changes
+
+- Updated dependencies [9f1e934]
+  - @zapier/zapier-sdk@0.69.0
+  - @zapier/zapier-sdk-mcp@0.13.24
+
 ## 0.53.1
 
 ### Patch Changes

package/README.md

@@ -1465,7 +1465,7 @@ npx zapier-sdk update-trigger-inbox <inbox> [--notification-url]
 
 #### `watch-trigger-inbox` 🧪 _experimental_
 
-Continuously consume a trigger inbox: drain currently-available messages via onMessage, then poll with backoff for new arrivals, until aborted. Resolves cleanly on signal abort or ZapierAbortDrainSignal from a handler; rejects on fatal SDK errors or fail-fast handler errors.
+Continuously consume a trigger inbox: drain currently-available messages via onMessage, then subscribe to SSE notifications for new arrivals until aborted. A periodic safety drain runs every maxDrainIntervalSeconds (default: 300) to guarantee forward progress if SSE events are missed. Resolves cleanly on signal abort or ZapierAbortDrainSignal from a handler; rejects on fatal SDK errors or fail-fast handler errors. Real-time wake-up health is reported on stderr: a warning when wake-ups pause and the watch falls back to the safety drain, plus (with debug) transient reconnect notices. stdout (including --json NDJSON) is unaffected.
 
 **Options:**
 
@@ -1477,7 +1477,7 @@ Continuously consume a trigger inbox: drain currently-available messages via onM
 | `--lease-seconds`              | `number`  | ❌       | —       | —               | Seconds until the lease expires; messages return to available if not acked. API default is 300 (5 minutes).                                                                                                                                                                                       |
 | `--release-on-error`           | `boolean` | ❌       | —       | —               | If true, errors release the message when the drain finishes. If false (default), errors leave it leased until the lease timeout. `ZapierReleaseTriggerMessageSignal` always releases regardless.                                                                                                  |
 | `--continue-on-error`          | `boolean` | ❌       | —       | —               | If false (default, fail-fast), the first handler error rejects and stops the drain. If true, handler errors are observed via `onError` and the drain continues. SDK-level errors (lease / ack / release) reject regardless.                                                                       |
-| `--max-drain-interval-seconds` | `number`  | ❌       | —       | —               | Maximum seconds between empty-inbox poll attempts (default: 60). Caps the back-off cadence.                                                                                                                                                                                                       |
+| `--max-drain-interval-seconds` | `number`  | ❌       | —       | —               | Maximum seconds between safety drain attempts (default: 300). The watcher subscribes to SSE notifications for near-real-time wake-ups; this interval is the backstop that guarantees forward progress if SSE events are missed or the connection drops undetected.                                |
 | `--exec`                       | `string`  | ❌       | —       | —               | Run a binary per message with no shell interpretation. Message JSON is piped to stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Pass extra argv after `--` (e.g. `--exec ./handler -- --verbose`). Mutually exclusive with --exec-shell and --json.   |
 | `--exec-shell`                 | `string`  | ❌       | —       | —               | Run a shell command per message. Message JSON is piped to the subprocess on stdin; exit code 0 acks, non-zero records the error per the same rules as a thrown handler. Interpreted by the platform's default shell (sh on POSIX, cmd.exe on Windows). Mutually exclusive with --exec and --json. |
 | `--json`                       | `boolean` | ❌       | —       | —               | Stream each message as JSON to stdout (one record per line, NDJSON), acking as each write completes. Use for piping to other tools. Mutually exclusive with --exec / --exec-shell and the interactive default.                                                                                    |

package/dist/cli.cjs

@@ -1573,7 +1573,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -7040,6 +7040,8 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -7138,6 +7140,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -7150,7 +7153,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/sdk.ts
 zapierSdk.injectCliLogin(login_exports);

package/dist/cli.mjs

@@ -1531,7 +1531,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -6998,6 +6998,8 @@ var watchTriggerInboxCliPlugin = definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -7096,6 +7098,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -7108,7 +7111,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/sdk.ts
 injectCliLogin(login_exports);

package/dist/experimental.cjs

@@ -4393,6 +4393,8 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -4491,6 +4493,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -4503,7 +4506,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/experimental.ts
 experimental.injectCliLogin(login_exports);

package/dist/experimental.mjs

@@ -4357,6 +4357,8 @@ var watchTriggerInboxCliPlugin = definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -4455,6 +4457,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -4467,7 +4470,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/experimental.ts
 injectCliLogin(login_exports);

package/dist/index.cjs

@@ -4392,6 +4392,8 @@ zapierSdk.definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -4490,6 +4492,7 @@ zapierSdk.definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -4502,7 +4505,7 @@ zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/sdk.ts
 zapierSdk.injectCliLogin(login_exports);
@@ -4530,7 +4533,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default2 = {
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/index.mjs

@@ -4356,6 +4356,8 @@ definePlugin(
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    const baseDescription = typeof existingMeta.description === "string" ? existingMeta.description : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema ? baseInputSchema.extend({
       exec: ExecCliProperty2,
       execShell: ExecShellCliProperty2,
@@ -4454,6 +4456,7 @@ definePlugin(
         meta: {
           watchTriggerInbox: {
             ...existingMeta,
+            description: cliDescription,
             inputSchema: extendedInputSchema,
             packages: void 0
           }
@@ -4466,7 +4469,7 @@ definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/sdk.ts
 injectCliLogin(login_exports);
@@ -4494,7 +4497,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default2 = {
-  version: "0.53.1"};
+  version: "0.54.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zapier/zapier-sdk-cli",
-    "version": "0.53.1",
+    "version": "0.54.0",
     "description": "Command line interface for Zapier SDK",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",

package/dist/src/plugins/signup/test-harness.js

@@ -50,6 +50,7 @@ function createSignupTestApi() {
         delete: emptyApiResult,
         poll: emptyApiResult,
         fetch: () => Promise.resolve(new Response()),
+        fetchStream: async function* () { },
     };
 }
 export function buildSignupTestContext(vi, mockEmit = () => undefined) {

package/dist/src/plugins/watchTriggerInbox/index.d.ts

@@ -32,6 +32,7 @@ export declare const watchTriggerInboxCliPlugin: (sdk: SdkWithWatchTriggerInbox
     context: {
         meta: {
             watchTriggerInbox: {
+                description: string;
                 inputSchema: z.ZodObject<{
                     exec: z.ZodOptional<z.ZodString>;
                     execShell: z.ZodOptional<z.ZodString>;

package/dist/src/plugins/watchTriggerInbox/index.js

@@ -30,6 +30,14 @@ export const watchTriggerInboxCliPlugin = definePlugin((sdk) => {
     const original = sdk.watchTriggerInbox;
     const existingMeta = sdk.context.meta.watchTriggerInbox;
     const baseInputSchema = existingMeta.inputSchema;
+    // The SDK already documents that real-time health is reported on stderr;
+    // append only the CLI-specific clarification that stdout stays clean for
+    // piping. This flows into the CLI README via the doc generator's per-command
+    // `description` rendering.
+    const baseDescription = typeof existingMeta.description === "string"
+        ? existingMeta.description
+        : "";
+    const cliDescription = `${baseDescription} stdout (including --json NDJSON) is unaffected.`;
     const extendedInputSchema = baseInputSchema
         ? baseInputSchema.extend({
             exec: ExecCliProperty,
@@ -148,6 +156,7 @@ export const watchTriggerInboxCliPlugin = definePlugin((sdk) => {
             meta: {
                 watchTriggerInbox: {
                     ...existingMeta,
+                    description: cliDescription,
                     inputSchema: extendedInputSchema,
                     packages: undefined,
                 },