@zapier/zapier-sdk-cli 0.49.1 → 0.50.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @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

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;
@@ -585,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
@@ -774,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
         );
@@ -1555,7 +1572,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.49.1"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -6586,7 +6603,7 @@ var watchTriggerInboxCliPlugin = zapierSdk.definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.1"};
+  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;
@@ -543,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
@@ -732,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
         );
@@ -1513,7 +1530,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
 
 // package.json
 var package_default = {
-  version: "0.49.1"};
+  version: "0.50.0"};
 
 // src/telemetry/builders.ts
 function createCliBaseEvent(context = {}) {
@@ -6544,7 +6561,7 @@ var watchTriggerInboxCliPlugin = definePlugin(
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@zapier/zapier-sdk-cli",
-  version: "0.49.1"};
+  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.1"};
+  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.1"};
+  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.1"};
+  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.1"};
+  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.1"};
+  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.1"};
+  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.1",
+    "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;
@@ -513,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,
@@ -730,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