@zapier/zapier-sdk-cli 0.59.1 → 0.59.3

package/dist/src/utils/cli-options.d.ts

@@ -1,16 +0,0 @@
-interface CliOption {
-    name: string;
-    flag: string;
-    short?: string;
-    description: string;
-}
-export declare enum ReservedCliParameter {
-    Version = "version",
-    Help = "help"
-}
-/** CLI options at the framework level, not defined by any SDK command. */
-export declare const RESERVED_CLI_OPTIONS: readonly Readonly<CliOption>[];
-export declare function getReservedCliOption(name: ReservedCliParameter): Readonly<CliOption>;
-/** CLI options automatically added to every SDK-generated command. */
-export declare const SHARED_COMMAND_CLI_OPTIONS: readonly Readonly<CliOption>[];
-export {};

package/dist/src/utils/cli-options.js

@@ -1,34 +0,0 @@
-export var ReservedCliParameter;
-(function (ReservedCliParameter) {
-    ReservedCliParameter["Version"] = "version";
-    ReservedCliParameter["Help"] = "help";
-})(ReservedCliParameter || (ReservedCliParameter = {}));
-/** CLI options at the framework level, not defined by any SDK command. */
-export const RESERVED_CLI_OPTIONS = [
-    {
-        name: ReservedCliParameter.Version,
-        flag: "--version",
-        short: "-V",
-        description: "Display version number",
-    },
-    {
-        name: ReservedCliParameter.Help,
-        flag: "--help",
-        short: "-h",
-        description: "Display help for command",
-    },
-];
-export function getReservedCliOption(name) {
-    const option = RESERVED_CLI_OPTIONS.find((opt) => opt.name === name);
-    if (!option)
-        throw new Error(`Reserved CLI option not found: ${name}`);
-    return option;
-}
-/** CLI options automatically added to every SDK-generated command. */
-export const SHARED_COMMAND_CLI_OPTIONS = [
-    {
-        name: "json",
-        flag: "--json",
-        description: "Output raw JSON instead of formatted results",
-    },
-];

package/dist/src/utils/cli-renderer.d.ts

@@ -1,53 +0,0 @@
-import type { FunctionRegistryEntry, SdkPage, ZapierSdk } from "@zapier/zapier-sdk";
-export interface JsonErrorEntry {
-    code: string;
-    message: string;
-    reason?: string;
-}
-export interface JsonEnvelope {
-    data: unknown;
-    nextCursor?: string;
-    errors: JsonErrorEntry[];
-}
-type PagedSource = AsyncIterable<SdkPage> | PromiseLike<SdkPage>;
-export interface CliRenderer {
-    renderPaginatedList(source: PagedSource, functionInfo: FunctionRegistryEntry): Promise<void>;
-    renderCollectedList(items: unknown[], options: {
-        maxItems?: number;
-        userSpecifiedMaxItems?: boolean;
-        functionInfo?: FunctionRegistryEntry;
-    }): Promise<void>;
-    renderItem(value: unknown, options?: {
-        outputFile?: unknown;
-        commandName?: string;
-        functionInfo?: FunctionRegistryEntry;
-    }): void;
-    renderResponse(response: Response): Promise<void>;
-    renderError(error: unknown): never;
-}
-/**
- * Per-invocation context the interactive renderer threads into the registry
- * formatter. `sdk` and `params` are passed to `formatter.fetch(...)` so a
- * formatter can enrich items by calling back into the SDK (for example, the
- * table-record formatter resolves field IDs to human-readable names).
- */
-export interface RendererContext {
-    sdk?: ZapierSdk;
-    params?: Record<string, unknown>;
-}
-export declare function buildJsonErrors(error: unknown): JsonErrorEntry[];
-/**
- * Replacer for JSON.stringify that coerces Error instances to a plain
- * object with `{ name, message, stack }`. Without this, `JSON.stringify`
- * renders an Error as `{}` (its useful properties are non-enumerable),
- * which surfaces in any command that returns Error-like values — most
- * notably `drainTriggerInbox` whose `errors[].reason` is typed `unknown`
- * and is usually an Error.
- *
- * Walks recursively because the replacer is invoked for every nested
- * key/value pair, not just the top-level value.
- */
-export declare function jsonReplacer(_key: string, value: unknown): unknown;
-export declare function createJsonRenderer(): CliRenderer;
-export declare function createInteractiveRenderer(context?: RendererContext): CliRenderer;
-export {};

package/dist/src/utils/cli-renderer.js

@@ -1,265 +0,0 @@
-import { ZapierCliMissingParametersError, ZapierCliExitError } from "./errors";
-import { formatErrorMessage, ZapierError } from "@zapier/zapier-sdk";
-import { getApprovalReason } from "./approval-errors";
-import { formatItemsFromSchema, formatJsonOutput } from "./schema-formatter";
-import { toKebabCase } from "./string-utils";
-import chalk from "chalk";
-import inquirer from "inquirer";
-// ============================================================================
-// Shared error formatting
-// ============================================================================
-function formatMissingParamsError(error) {
-    return [
-        "Missing required parameters:",
-        ...error.params.map(({ name, isPositional }) => isPositional
-            ? `  • <${toKebabCase(name)}>`
-            : `  • --${toKebabCase(name)}`),
-    ].join("\n");
-}
-// ============================================================================
-// Shared error serialization (used by JSON renderer)
-// ============================================================================
-export function buildJsonErrors(error) {
-    if (error instanceof ZapierCliMissingParametersError) {
-        return error.params.map(({ name, isPositional }) => ({
-            code: error.code,
-            message: isPositional
-                ? `<${toKebabCase(name)}> is required in non-interactive mode`
-                : `--${toKebabCase(name)} is required in non-interactive mode`,
-        }));
-    }
-    const code = error instanceof ZapierError ? error.code : "UNKNOWN_ERROR";
-    const message = error instanceof Error ? error.message : String(error);
-    const reason = getApprovalReason(error);
-    return [
-        {
-            code,
-            message,
-            ...(reason ? { reason } : {}),
-        },
-    ];
-}
-// ============================================================================
-// HTTP response unwrapping
-// ============================================================================
-async function unwrapHttpResponse(response) {
-    const text = await response.text().catch(() => "[unable to read body]");
-    try {
-        return {
-            statusCode: response.status,
-            headers: Object.fromEntries(response.headers.entries()),
-            body: JSON.parse(text),
-        };
-    }
-    catch {
-        throw new Error(`Failed to parse response as JSON (status: ${response.status}). Body: ${text.slice(0, 500)}`);
-    }
-}
-// ============================================================================
-// JSON renderer
-// ============================================================================
-/**
- * Replacer for JSON.stringify that coerces Error instances to a plain
- * object with `{ name, message, stack }`. Without this, `JSON.stringify`
- * renders an Error as `{}` (its useful properties are non-enumerable),
- * which surfaces in any command that returns Error-like values — most
- * notably `drainTriggerInbox` whose `errors[].reason` is typed `unknown`
- * and is usually an Error.
- *
- * Walks recursively because the replacer is invoked for every nested
- * key/value pair, not just the top-level value.
- */
-export function jsonReplacer(_key, value) {
-    if (value instanceof Error) {
-        return {
-            name: value.name,
-            message: value.message,
-            ...(value.stack ? { stack: value.stack } : {}),
-        };
-    }
-    return value;
-}
-function outputJson(envelope) {
-    console.log(JSON.stringify(envelope, jsonReplacer, 2));
-}
-export function createJsonRenderer() {
-    return {
-        async renderPaginatedList(source, _functionInfo) {
-            let page;
-            if (Symbol.asyncIterator in Object(source)) {
-                const iter = source[Symbol.asyncIterator]();
-                const result = await iter.next();
-                page = result.done ? undefined : result.value;
-            }
-            else {
-                page = await source;
-            }
-            const data = Array.isArray(page?.data) ? page.data : [];
-            outputJson({
-                data,
-                ...(page?.nextCursor && { nextCursor: page.nextCursor }),
-                errors: [],
-            });
-        },
-        async renderCollectedList(items, _options) {
-            outputJson({ data: items, errors: [] });
-        },
-        renderItem(value, options) {
-            if (value === undefined && !options?.outputFile) {
-                return;
-            }
-            outputJson({
-                data: options?.outputFile
-                    ? { outputFile: options.outputFile }
-                    : (value ?? null),
-                errors: [],
-            });
-        },
-        async renderResponse(response) {
-            // Leave envelope as is for backwards compatibility
-            // until we fully deprecate fetch from CLI
-            console.log(JSON.stringify(await unwrapHttpResponse(response), null, 2));
-        },
-        renderError(error) {
-            outputJson({ data: null, errors: buildJsonErrors(error) });
-            throw new ZapierCliExitError(error instanceof Error ? error.message : String(error), 1);
-        },
-    };
-}
-// ============================================================================
-// Interactive renderer
-// ============================================================================
-function getItemName(functionInfo) {
-    if (functionInfo?.itemType)
-        return `${functionInfo.itemType} items`;
-    return "items";
-}
-function getListTitle(functionInfo) {
-    if (functionInfo.itemType)
-        return `Available ${functionInfo.itemType} items`;
-    return "items";
-}
-export function createInteractiveRenderer(context = {}) {
-    async function renderItemsForDisplay(items, functionInfo, startingNumber = 0) {
-        if (functionInfo?.inputSchema) {
-            // `formatter` on the registry entry is typed `unknown` so the registry
-            // layer stays SDK-agnostic; cast back to the CLI-side shape here at the
-            // boundary where we actually use it.
-            await formatItemsFromSchema(functionInfo, items, startingNumber, {
-                formatter: functionInfo.formatter,
-                sdk: context.sdk,
-                params: context.params,
-            });
-        }
-        else {
-            items.forEach((item, index) => {
-                const obj = item;
-                const name = obj?.name || obj?.key || obj?.id || "Item";
-                console.log(`${chalk.gray(`${startingNumber + index + 1}.`)} ${chalk.cyan(String(name))}`);
-                if (obj?.description)
-                    console.log(`   ${chalk.dim(String(obj.description))}`);
-                console.log();
-            });
-        }
-    }
-    return {
-        async renderPaginatedList(source, functionInfo) {
-            const itemName = getItemName(functionInfo);
-            if (!(Symbol.asyncIterator in Object(source))) {
-                const items = source?.data;
-                if (!Array.isArray(items) || items.length === 0) {
-                    console.log(chalk.yellow(`No ${itemName} found.`));
-                    return;
-                }
-                await renderItemsForDisplay(items, functionInfo, 0);
-                console.log(chalk.green(`\n✅ Showing ${items.length} ${itemName}`));
-                return;
-            }
-            let totalShown = 0;
-            let pageCount = 0;
-            console.log(chalk.blue(`📋 ${getListTitle(functionInfo)}\n`));
-            for await (const page of source) {
-                const items = page.data ?? [];
-                pageCount++;
-                if (items.length === 0 && pageCount === 1) {
-                    console.log(chalk.yellow(`No ${itemName} found.`));
-                    return;
-                }
-                if (items.length === 0)
-                    break;
-                if (pageCount > 1) {
-                    console.clear();
-                    console.log(chalk.blue(`📋 ${getListTitle(functionInfo)}\n`));
-                }
-                await renderItemsForDisplay(items, functionInfo, totalShown);
-                totalShown += items.length;
-                console.log(chalk.green(`\n✅ Showing ${totalShown} ${itemName} (page ${pageCount})`));
-                if (page.nextCursor) {
-                    const { continueReading } = await inquirer.prompt([
-                        {
-                            type: "confirm",
-                            name: "continueReading",
-                            message: "Load next page?",
-                            default: true,
-                        },
-                    ]);
-                    if (!continueReading)
-                        break;
-                }
-                else {
-                    break;
-                }
-            }
-            console.log(chalk.gray(`\n📄 Finished browsing ${itemName}`));
-        },
-        async renderCollectedList(items, { maxItems, userSpecifiedMaxItems, functionInfo } = {}) {
-            if (!Array.isArray(items)) {
-                formatJsonOutput(items);
-                return;
-            }
-            const itemName = getItemName(functionInfo);
-            if (items.length === 0) {
-                console.log(chalk.yellow(`No ${itemName} found.`));
-                return;
-            }
-            console.log(chalk.green(`\n✅ Found ${items.length} ${itemName}:\n`));
-            await renderItemsForDisplay(items, functionInfo);
-            if (userSpecifiedMaxItems && maxItems) {
-                console.log(chalk.gray(`\n📄 Showing up to ${maxItems} ${itemName} (--max-items ${maxItems})`));
-            }
-            else {
-                console.log(chalk.gray(`\n📄 All available ${itemName} shown`));
-            }
-        },
-        renderItem(value, options) {
-            if (options?.outputFile) {
-                const label = options.commandName
-                    ? `✅ ${options.commandName} completed successfully!`
-                    : "✅ Done!";
-                console.log(chalk.green(label));
-                console.log(chalk.gray(`Output written to: ${options.outputFile}`));
-            }
-            else {
-                formatJsonOutput(value);
-            }
-        },
-        async renderResponse(response) {
-            formatJsonOutput(await unwrapHttpResponse(response));
-        },
-        renderError(error) {
-            if (error instanceof ZapierCliMissingParametersError) {
-                console.error(chalk.red("❌ " + formatMissingParamsError(error)));
-                console.error("\n" + chalk.dim("Use --help to see available options"));
-                throw new ZapierCliExitError(error.message, 1);
-            }
-            if (error instanceof ZapierError) {
-                const formattedMessage = formatErrorMessage(error);
-                console.error(chalk.red("❌ Error:"), formattedMessage);
-                throw new ZapierCliExitError(formattedMessage, 1);
-            }
-            const msg = error instanceof Error ? error.message : "Unknown error";
-            console.error(chalk.red("❌ Error:"), msg);
-            throw new ZapierCliExitError(msg, 1);
-        },
-    };
-}

package/dist/src/utils/constants.d.ts

@@ -1,3 +0,0 @@
-export { AUTH_MODE_HEADER } from "../login";
-export declare const LOGIN_PORTS: number[];
-export declare const LOGIN_TIMEOUT_MS = 300000;

package/dist/src/utils/constants.js

@@ -1,5 +0,0 @@
-// Import shared OAuth constants from login package
-export { AUTH_MODE_HEADER } from "../login";
-// CLI-specific constants
-export const LOGIN_PORTS = [49505, 50575, 52804, 55981, 61010, 63851];
-export const LOGIN_TIMEOUT_MS = 300000; // 5 minutes

package/dist/src/utils/directory-detection.d.ts

@@ -1,5 +0,0 @@
-/**
- * Detect the best default directory for TypeScript types
- * Looks for src or lib directories, falls back to current directory
- */
-export declare function detectTypesOutputDirectory(): Promise<string>;

package/dist/src/utils/directory-detection.js

@@ -1,21 +0,0 @@
-import { access } from "fs/promises";
-import { join } from "path";
-/**
- * Detect the best default directory for TypeScript types
- * Looks for src or lib directories, falls back to current directory
- */
-export async function detectTypesOutputDirectory() {
-    // Check for common source directories in priority order
-    const candidates = ["src", "lib"];
-    for (const candidate of candidates) {
-        try {
-            await access(candidate);
-            return join(candidate, "zapier", "apps");
-        }
-        catch {
-            // Directory doesn't exist, continue to next candidate
-        }
-    }
-    // Fall back to current directory
-    return "./zapier/apps/";
-}

package/dist/src/utils/errors.d.ts

@@ -1,33 +0,0 @@
-import { ZapierError } from "@zapier/zapier-sdk";
-export declare abstract class ZapierCliError extends ZapierError {
-    abstract readonly exitCode: number;
-}
-export declare class ZapierCliUserCancellationError extends ZapierCliError {
-    readonly name = "ZapierCliUserCancellationError";
-    readonly code = "ZAPIER_CLI_USER_CANCELLATION";
-    readonly exitCode = 0;
-    constructor(message?: string);
-}
-export declare class ZapierCliExitError extends ZapierCliError {
-    readonly name = "ZapierCliExitError";
-    readonly code = "ZAPIER_CLI_EXIT";
-    readonly exitCode: number;
-    constructor(message: string, exitCode?: number);
-}
-export interface MissingParam {
-    name: string;
-    isPositional: boolean;
-}
-export declare class ZapierCliValidationError extends ZapierCliError {
-    readonly name = "ZapierCliValidationError";
-    readonly code = "ZAPIER_CLI_VALIDATION_ERROR";
-    readonly exitCode = 1;
-    constructor(message: string);
-}
-export declare class ZapierCliMissingParametersError extends ZapierCliError {
-    readonly name = "ZapierCliMissingParametersError";
-    readonly code = "ZAPIER_CLI_MISSING_PARAMETERS";
-    readonly exitCode = 1;
-    readonly params: MissingParam[];
-    constructor(params: MissingParam[]);
-}

package/dist/src/utils/errors.js

@@ -1,36 +0,0 @@
-import { ZapierError } from "@zapier/zapier-sdk";
-export class ZapierCliError extends ZapierError {
-}
-export class ZapierCliUserCancellationError extends ZapierCliError {
-    constructor(message = "Operation cancelled by user") {
-        super(message);
-        this.name = "ZapierCliUserCancellationError";
-        this.code = "ZAPIER_CLI_USER_CANCELLATION";
-        this.exitCode = 0;
-    }
-}
-export class ZapierCliExitError extends ZapierCliError {
-    constructor(message, exitCode = 1) {
-        super(message);
-        this.name = "ZapierCliExitError";
-        this.code = "ZAPIER_CLI_EXIT";
-        this.exitCode = exitCode;
-    }
-}
-export class ZapierCliValidationError extends ZapierCliError {
-    constructor(message) {
-        super(message);
-        this.name = "ZapierCliValidationError";
-        this.code = "ZAPIER_CLI_VALIDATION_ERROR";
-        this.exitCode = 1;
-    }
-}
-export class ZapierCliMissingParametersError extends ZapierCliError {
-    constructor(params) {
-        super(`Missing required parameters: ${params.map((p) => p.name).join(", ")}`);
-        this.name = "ZapierCliMissingParametersError";
-        this.code = "ZAPIER_CLI_MISSING_PARAMETERS";
-        this.exitCode = 1;
-        this.params = params;
-    }
-}

package/dist/src/utils/extensions.d.ts

@@ -1,20 +0,0 @@
-import type { Plugin, PluginProvides } from "@zapier/zapier-sdk";
-/**
- * Discovers and dynamically imports SDK extension packages declared via the
- * `ZAPIER_SDK_EXTENSIONS` env var (comma-separated package specifiers).
- * Each spec is `await import()`-ed and its default export is normalized via
- * {@link normalizeExtension}. A failed import or unrecognized export shape
- * triggers a warning and skip — a broken extension never kills the CLI.
- *
- * A richer, declarative discovery path (e.g. `.zapierrc` extensions) is
- * tracked as a follow-up; for now the env var is the only entry point.
- */
-export declare function resolveExtensions(): Promise<Plugin<unknown, PluginProvides>[]>;
-/**
- * Translates a module's default export into a plugin array suitable for
- * `.addPlugin(...)`. Accepts:
- *   - a single Plugin function → `[fn]`
- *   - an array of Plugin functions → returned as-is
- * Returns `null` for unrecognized shapes (caller emits a skip warning).
- */
-export declare function normalizeExtension(exported: unknown): Plugin<unknown, PluginProvides>[] | null;

package/dist/src/utils/extensions.js

@@ -1,66 +0,0 @@
-const ENV_VAR = "ZAPIER_SDK_EXTENSIONS";
-/**
- * Discovers and dynamically imports SDK extension packages declared via the
- * `ZAPIER_SDK_EXTENSIONS` env var (comma-separated package specifiers).
- * Each spec is `await import()`-ed and its default export is normalized via
- * {@link normalizeExtension}. A failed import or unrecognized export shape
- * triggers a warning and skip — a broken extension never kills the CLI.
- *
- * A richer, declarative discovery path (e.g. `.zapierrc` extensions) is
- * tracked as a follow-up; for now the env var is the only entry point.
- */
-export async function resolveExtensions() {
-    const seen = new Set();
-    const specs = readEnvSpecs().filter((spec) => {
-        if (seen.has(spec))
-            return false;
-        seen.add(spec);
-        return true;
-    });
-    const plugins = [];
-    for (const spec of specs) {
-        try {
-            const mod = await import(spec);
-            const exported = mod.default ?? mod;
-            const got = normalizeExtension(exported);
-            if (got) {
-                plugins.push(...got);
-            }
-            else {
-                console.warn(`Extension '${spec}': unrecognized default export shape; skipping.`);
-            }
-        }
-        catch (err) {
-            console.warn(`Extension '${spec}' failed to load: ${err.message}`);
-        }
-    }
-    return plugins;
-}
-/**
- * Translates a module's default export into a plugin array suitable for
- * `.addPlugin(...)`. Accepts:
- *   - a single Plugin function → `[fn]`
- *   - an array of Plugin functions → returned as-is
- * Returns `null` for unrecognized shapes (caller emits a skip warning).
- */
-export function normalizeExtension(exported) {
-    if (typeof exported === "function") {
-        return [exported];
-    }
-    if (Array.isArray(exported)) {
-        if (exported.every((e) => typeof e === "function")) {
-            return exported;
-        }
-        return null;
-    }
-    return null;
-}
-function readEnvSpecs() {
-    const raw = process.env[ENV_VAR];
-    if (!raw)
-        return [];
-    return raw
-        .split(",")
-        .map((s) => s.trim())
-        .filter((s) => s.length > 0);
-}

package/dist/src/utils/getCallablePromise.d.ts

@@ -1,6 +0,0 @@
-declare const getCallablePromise: <T>() => {
-    promise: Promise<T>;
-    resolve: (value: T) => void;
-    reject: (reason: unknown) => void;
-};
-export default getCallablePromise;

package/dist/src/utils/getCallablePromise.js

@@ -1,14 +0,0 @@
-const getCallablePromise = () => {
-    let resolve = () => { };
-    let reject = () => { };
-    const promise = new Promise((_resolve, _reject) => {
-        resolve = _resolve;
-        reject = _reject;
-    });
-    return {
-        promise,
-        resolve,
-        reject,
-    };
-};
-export default getCallablePromise;

package/dist/src/utils/log.d.ts

@@ -1,8 +0,0 @@
-declare const log: {
-    info: (message: string, ...args: unknown[]) => void;
-    error: (message: string, ...args: unknown[]) => void;
-    success: (message: string, ...args: unknown[]) => void;
-    warn: (message: string, ...args: unknown[]) => void;
-    debug: (message: string, ...args: unknown[]) => void;
-};
-export default log;

package/dist/src/utils/log.js

@@ -1,26 +0,0 @@
-import chalk from "chalk";
-// Every method here writes to stderr. The CLI reserves stdout for the
-// program's data payload (command output, JSON, response bodies); status,
-// info, warnings, errors, and debug all belong on stderr so they don't
-// break callers piping CLI output through jq, > redirect, or JSON.parse.
-// In a TTY both streams interleave, so interactive users see no change.
-const log = {
-    info: (message, ...args) => {
-        console.error(chalk.blue("ℹ"), message, ...args);
-    },
-    error: (message, ...args) => {
-        console.error(chalk.red("✖"), message, ...args);
-    },
-    success: (message, ...args) => {
-        console.error(chalk.green("✓"), message, ...args);
-    },
-    warn: (message, ...args) => {
-        console.error(chalk.yellow("⚠"), message, ...args);
-    },
-    debug: (message, ...args) => {
-        if (process.env.DEBUG === "true" || process.argv.includes("--debug")) {
-            console.error(chalk.gray("🐛"), message, ...args);
-        }
-    },
-};
-export default log;

package/dist/src/utils/manifest-helpers.d.ts

@@ -1,10 +0,0 @@
-import type { AppItem, ManifestEntry } from "@zapier/zapier-sdk";
-/**
- * Get the preferred key for a manifest entry
- * Prefers slug over implementation name
- */
-export declare function getManifestKey(app: AppItem): string;
-/**
- * Create a manifest entry from an app
- */
-export declare function createManifestEntry(app: AppItem): ManifestEntry;

package/dist/src/utils/manifest-helpers.js

@@ -1,19 +0,0 @@
-/**
- * Get the preferred key for a manifest entry
- * Prefers slug over implementation name
- */
-export function getManifestKey(app) {
-    return app.slug || app.key;
-}
-/**
- * Create a manifest entry from an app
- */
-export function createManifestEntry(app) {
-    if (!app.version) {
-        throw new Error(`App ${app.key} does not have a version. Implementation ID: ${app.implementation_id}`);
-    }
-    return {
-        implementationName: app.key,
-        version: app.version,
-    };
-}