@zapier/zapier-sdk-cli 0.49.0 → 0.50.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @zapier/zapier-sdk-cli
 
+## 0.50.0
+
+### Minor Changes
+
+- ce779d1: Add `hint?: string | string[]` to `PromptConfig.choices`. The CLI renders it after the choice's `name` as dimmed parens; an unset `hint` with a primitive `value` auto-renders the value.
+
+  All built-in resolvers migrate to the new shape, so existing dropdowns get small visual cleanups (dim parens, no `ID:` prefix, dash converted to parens, em-dash in `tableRecordId` gone).
+
+  Plugin authors who embed the value in `name` (e.g. `"Foo (${id})"`) should drop the embedded parens; the auto-default appends a second otherwise.
+
+### Patch Changes
+
+- Updated dependencies [ce779d1]
+  - @zapier/zapier-sdk@0.55.0
+  - @zapier/zapier-sdk-mcp@0.13.7
+
+## 0.49.1
+
+### Patch Changes
+
+- 22a1727: Add optional `name` parameter to `createTriggerInbox` method
+- Updated dependencies [22a1727]
+  - @zapier/zapier-sdk-mcp@0.13.6
+  - @zapier/zapier-sdk@0.54.1
+
 ## 0.49.0
 
 ### Minor Changes

package/README.md

@@ -797,22 +797,23 @@ npx zapier-sdk ack-trigger-inbox-messages <inbox> <lease> [--messages]
 
 #### `create-trigger-inbox` 🧪 _experimental_
 
-Create a new trigger inbox subscription with an auto-generated name. Always creates; use ensureTriggerInbox for get-or-create on a stable name.
+Create a new trigger inbox subscription. Always creates a new inbox; use ensureTriggerInbox for get-or-create on a stable name.
 
 **Options:**
 
-| Option               | Type             | Required | Default | Possible Values | Description                                                                                                  |
-| -------------------- | ---------------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
-| `<app>`              | `string`         | ✅       | —       | —               | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
-| `<action>`           | `string`         | ✅       | —       | —               | Action key (e.g., 'send_message' or 'find_row')                                                              |
-| `--connection`       | `string, number` | ❌       | —       | —               | Connection alias or connection ID. Optional for triggers that don't require auth.                            |
-| `--inputs`           | `object`         | ❌       | —       | —               | Input parameters for the trigger subscription                                                                |
-| `--notification-url` | `string`         | ❌       | —       | —               | Webhook URL to POST to when new messages arrive                                                              |
+| Option               | Type             | Required | Default | Possible Values | Description                                                                                                                      |
+| -------------------- | ---------------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `<app>`              | `string`         | ✅       | —       | —               | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3')                     |
+| `<action>`           | `string`         | ✅       | —       | —               | Action key (e.g., 'send_message' or 'find_row')                                                                                  |
+| `--name`             | `string`         | ❌       | —       | —               | Optional inbox name. Auto-generated when omitted. Throws a conflict error if the name is already in use by another subscription. |
+| `--connection`       | `string, number` | ❌       | —       | —               | Connection alias or connection ID. Optional for triggers that don't require auth.                                                |
+| `--inputs`           | `object`         | ❌       | —       | —               | Input parameters for the trigger subscription                                                                                    |
+| `--notification-url` | `string`         | ❌       | —       | —               | Webhook URL to POST to when new messages arrive                                                                                  |
 
 **Usage:**
 
 ```bash
-npx zapier-sdk create-trigger-inbox <app> <action> [--connection] [--inputs] [--notification-url]
+npx zapier-sdk create-trigger-inbox <app> <action> [--name] [--connection] [--inputs] [--notification-url]
 ```
 
 #### `delete-trigger-inbox` 🧪 _experimental_

package/dist/cli.cjs

@@ -178,6 +178,20 @@ function coerceToSchemaType(value, schema) {
   }
   return value;
 }
+function renderChoiceLabel(choice) {
+  let effectiveHint = choice.hint;
+  if (effectiveHint === void 0 && (typeof choice.value === "string" || typeof choice.value === "number")) {
+    effectiveHint = String(choice.value);
+  }
+  if (!effectiveHint || Array.isArray(effectiveHint) && effectiveHint.length === 0) {
+    return choice;
+  }
+  const hintText = Array.isArray(effectiveHint) ? effectiveHint.join(", ") : effectiveHint;
+  if (hintText === choice.name) {
+    return choice;
+  }
+  return { ...choice, name: `${choice.name} ${chalk__default.default.dim(`(${hintText})`)}` };
+}
 var SchemaParameterResolver = class {
   constructor() {
     this.debug = false;
@@ -213,14 +227,8 @@ var SchemaParameterResolver = class {
         const hasValue = this.getNestedValue(providedParams, param.path) !== void 0;
         return !hasValue;
       });
-      const required = missingResolvable.filter((param) => {
-        if (param.isRequired) return true;
-        if (param.name === "inputs") return interactiveMode;
-        return false;
-      });
-      const optional = missingResolvable.filter(
-        (param) => !required.includes(param)
-      );
+      const required = missingResolvable.filter((param) => param.isRequired);
+      const optional = missingResolvable.filter((param) => !param.isRequired);
       if (parseResult.success && required.length === 0 && optional.length === 0) {
         return parseResult.data;
       }
@@ -591,7 +599,7 @@ var SchemaParameterResolver = class {
       }
       const { items } = await this.unpackFetchResult(fetchResult, promptLabel);
       const choicesConfig = resolver.prompt(items, searchParams);
-      const dataChoices = choicesConfig.choices ?? [];
+      const dataChoices = (choicesConfig.choices ?? []).map(renderChoiceLabel);
       const capabilityHintMessages = await this.computeCapabilityHints(
         resolver,
         context
@@ -780,6 +788,9 @@ var SchemaParameterResolver = class {
           context.resolvedParams
         );
         promptConfig.name = promptName;
+        if (promptConfig.choices) {
+          promptConfig.choices = promptConfig.choices.map(renderChoiceLabel);
+        }
         const hasSelectableChoice = promptConfig.choices?.some(
           (c) => !c.disabled
         );
@@ -1561,7 +1572,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -6592,7 +6603,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/sdk.ts
 zapierSdk.injectCliLogin(login_exports);

package/dist/cli.mjs

@@ -136,6 +136,20 @@ function coerceToSchemaType(value, schema) {
   }
   return value;
 }
+function renderChoiceLabel(choice) {
+  let effectiveHint = choice.hint;
+  if (effectiveHint === void 0 && (typeof choice.value === "string" || typeof choice.value === "number")) {
+    effectiveHint = String(choice.value);
+  }
+  if (!effectiveHint || Array.isArray(effectiveHint) && effectiveHint.length === 0) {
+    return choice;
+  }
+  const hintText = Array.isArray(effectiveHint) ? effectiveHint.join(", ") : effectiveHint;
+  if (hintText === choice.name) {
+    return choice;
+  }
+  return { ...choice, name: `${choice.name} ${chalk.dim(`(${hintText})`)}` };
+}
 var SchemaParameterResolver = class {
   constructor() {
     this.debug = false;
@@ -171,14 +185,8 @@ var SchemaParameterResolver = class {
         const hasValue = this.getNestedValue(providedParams, param.path) !== void 0;
         return !hasValue;
       });
-      const required = missingResolvable.filter((param) => {
-        if (param.isRequired) return true;
-        if (param.name === "inputs") return interactiveMode;
-        return false;
-      });
-      const optional = missingResolvable.filter(
-        (param) => !required.includes(param)
-      );
+      const required = missingResolvable.filter((param) => param.isRequired);
+      const optional = missingResolvable.filter((param) => !param.isRequired);
       if (parseResult.success && required.length === 0 && optional.length === 0) {
         return parseResult.data;
       }
@@ -549,7 +557,7 @@ var SchemaParameterResolver = class {
       }
       const { items } = await this.unpackFetchResult(fetchResult, promptLabel);
       const choicesConfig = resolver.prompt(items, searchParams);
-      const dataChoices = choicesConfig.choices ?? [];
+      const dataChoices = (choicesConfig.choices ?? []).map(renderChoiceLabel);
       const capabilityHintMessages = await this.computeCapabilityHints(
         resolver,
         context
@@ -738,6 +746,9 @@ var SchemaParameterResolver = class {
           context.resolvedParams
         );
         promptConfig.name = promptName;
+        if (promptConfig.choices) {
+          promptConfig.choices = promptConfig.choices.map(renderChoiceLabel);
+        }
         const hasSelectableChoice = promptConfig.choices?.some(
           (c) => !c.disabled
         );
@@ -1519,7 +1530,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -6550,7 +6561,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/sdk.ts
 injectCliLogin(login_exports);

package/dist/experimental.cjs

@@ -3963,7 +3963,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/experimental.ts
 experimental.injectCliLogin(login_exports);

package/dist/experimental.mjs

@@ -3927,7 +3927,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/experimental.ts
 injectCliLogin(login_exports);

package/dist/index.cjs

@@ -3962,7 +3962,7 @@ zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/sdk.ts
 zapierSdk.injectCliLogin(login_exports);
@@ -3990,7 +3990,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default2 = {
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/index.mjs

@@ -3926,7 +3926,7 @@ definePlugin(
 // package.json with { type: 'json' }
 var package_default = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/sdk.ts
 injectCliLogin(login_exports);
@@ -3954,7 +3954,7 @@ function createZapierCliSdk(options = {}) {
 
 // package.json
 var package_default2 = {
-  version: "0.49.0"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {

package/dist/package.json

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

package/dist/src/utils/parameter-resolver.d.ts

@@ -1,5 +1,26 @@
 import { z } from "zod";
 import { type ZapierSdk } from "@zapier/zapier-sdk";
+/**
+ * Append a choice's `hint` to its name as dimmed parens, returning a new
+ * choice object. An array hint is joined with ", ". Used by every prompt
+ * backend that renders resolver-supplied choices so the dim styling lives
+ * in one place.
+ *
+ * Default-when-unset: if `hint` is not provided and the choice's `value`
+ * is a primitive (string or number), the value is auto-rendered as the
+ * hint. So a resolver returning `{ name: "Slack", value: "SlackCLIAPI" }`
+ * with no `hint` renders as `Slack (SlackCLIAPI)`. To opt out of the
+ * auto-default, set `hint: ""` or `hint: []` explicitly.
+ *
+ * Skip-when-equal: a hint that matches the rendered name verbatim is
+ * suppressed so primitive-enum resolvers (where `name === String(value)`)
+ * don't render "read (read)". Case differences still render both.
+ */
+export declare function renderChoiceLabel<T extends {
+    name: string;
+    value: unknown;
+    hint?: string | string[];
+}>(choice: T): T;
 export declare class SchemaParameterResolver {
     private debug;
     private spinner;

package/dist/src/utils/parameter-resolver.js

@@ -87,6 +87,40 @@ function coerceToSchemaType(value, schema) {
 // ============================================================================
 // Schema Parameter Resolver
 // ============================================================================
+/**
+ * Append a choice's `hint` to its name as dimmed parens, returning a new
+ * choice object. An array hint is joined with ", ". Used by every prompt
+ * backend that renders resolver-supplied choices so the dim styling lives
+ * in one place.
+ *
+ * Default-when-unset: if `hint` is not provided and the choice's `value`
+ * is a primitive (string or number), the value is auto-rendered as the
+ * hint. So a resolver returning `{ name: "Slack", value: "SlackCLIAPI" }`
+ * with no `hint` renders as `Slack (SlackCLIAPI)`. To opt out of the
+ * auto-default, set `hint: ""` or `hint: []` explicitly.
+ *
+ * Skip-when-equal: a hint that matches the rendered name verbatim is
+ * suppressed so primitive-enum resolvers (where `name === String(value)`)
+ * don't render "read (read)". Case differences still render both.
+ */
+export function renderChoiceLabel(choice) {
+    let effectiveHint = choice.hint;
+    if (effectiveHint === undefined &&
+        (typeof choice.value === "string" || typeof choice.value === "number")) {
+        effectiveHint = String(choice.value);
+    }
+    if (!effectiveHint ||
+        (Array.isArray(effectiveHint) && effectiveHint.length === 0)) {
+        return choice;
+    }
+    const hintText = Array.isArray(effectiveHint)
+        ? effectiveHint.join(", ")
+        : effectiveHint;
+    if (hintText === choice.name) {
+        return choice;
+    }
+    return { ...choice, name: `${choice.name} ${chalk.dim(`(${hintText})`)}` };
+}
 export class SchemaParameterResolver {
     constructor() {
         this.debug = false;
@@ -123,16 +157,12 @@ export class SchemaParameterResolver {
                 const hasValue = this.getNestedValue(providedParams, param.path) !== undefined;
                 return !hasValue;
             });
-            // Split missing resolvable params into required vs optional.
-            // "inputs" is treated as required in interactive mode.
-            const required = missingResolvable.filter((param) => {
-                if (param.isRequired)
-                    return true;
-                if (param.name === "inputs")
-                    return interactiveMode;
-                return false;
-            });
-            const optional = missingResolvable.filter((param) => !required.includes(param));
+            // Split missing resolvable params into required vs optional based on
+            // schema. Optional params still get prompted in interactive mode, but
+            // in a second pass after the schema-required ones (and their resolver
+            // dependencies) are settled.
+            const required = missingResolvable.filter((param) => param.isRequired);
+            const optional = missingResolvable.filter((param) => !param.isRequired);
             if (parseResult.success &&
                 required.length === 0 &&
                 optional.length === 0) {
@@ -517,7 +547,7 @@ export class SchemaParameterResolver {
             }
             const { items } = await this.unpackFetchResult(fetchResult, promptLabel);
             const choicesConfig = resolver.prompt(items, searchParams);
-            const dataChoices = choicesConfig.choices ?? [];
+            const dataChoices = (choicesConfig.choices ?? []).map(renderChoiceLabel);
             const capabilityHintMessages = await this.computeCapabilityHints(resolver, context);
             const selected = await search({
                 message: choicesConfig.message,
@@ -734,6 +764,12 @@ export class SchemaParameterResolver {
             while (true) {
                 const promptConfig = dynamicResolver.prompt(items, context.resolvedParams);
                 promptConfig.name = promptName;
+                // Fold any per-choice `hint` into the rendered name once, here, so
+                // both the search-backed list path and the checkbox path below
+                // pick up the dim styling without each having to know about hints.
+                if (promptConfig.choices) {
+                    promptConfig.choices = promptConfig.choices.map(renderChoiceLabel);
+                }
                 // Friendlier than inquirer's default "No selectable choices. All
                 // choices are disabled." when the resolver returns no items (or
                 // filters everything out in `prompt`). Use ZapierCliValidationError