@zapier/zapier-sdk-cli 0.59.1 → 0.59.3

package/dist/package.json

@@ -1,121 +0,0 @@
-{
-    "name": "@zapier/zapier-sdk-cli",
-    "version": "0.59.1",
-    "description": "Command line interface for Zapier SDK",
-    "main": "dist/index.cjs",
-    "module": "dist/index.mjs",
-    "types": "dist/index.d.ts",
-    "exports": {
-        ".": {
-            "source": "./src/index.ts",
-            "require": {
-                "types": "./dist/index.d.ts",
-                "default": "./dist/index.cjs"
-            },
-            "import": {
-                "types": "./dist/index.d.mts",
-                "default": "./dist/index.mjs"
-            }
-        },
-        "./login": {
-            "source": "./src/login.ts",
-            "require": {
-                "types": "./dist/login.d.ts",
-                "default": "./dist/login.cjs"
-            },
-            "import": {
-                "types": "./dist/login.d.mts",
-                "default": "./dist/login.mjs"
-            }
-        },
-        "./experimental": {
-            "source": "./src/experimental.ts",
-            "require": {
-                "types": "./dist/experimental.d.ts",
-                "default": "./dist/experimental.cjs"
-            },
-            "import": {
-                "types": "./dist/experimental.d.mts",
-                "default": "./dist/experimental.mjs"
-            }
-        }
-    },
-    "bin": {
-        "zapier-sdk": "./bin/zapier-sdk.mjs",
-        "zapier-sdk-cli": "./bin/zapier-sdk.mjs",
-        "zapier-sdk-experimental": "./bin/zapier-sdk-experimental.mjs"
-    },
-    "scripts": {
-        "test": "vitest",
-        "build": "tsup",
-        "clean": "rm -rf dist",
-        "rebuild": "pnpm clean && pnpm build",
-        "dev": "tsx src/cli.ts",
-        "typecheck": "tsc --project tsconfig.build.json --noEmit",
-        "prepublishOnly": "node ../../scripts/check-version.js"
-    },
-    "keywords": [
-        "zapier",
-        "cli",
-        "sdk"
-    ],
-    "author": "",
-    "license": "SEE LICENSE IN LICENSE",
-    "files": [
-        "dist",
-        "bin",
-        "templates",
-        "README.md",
-        "CHANGELOG.md",
-        "AGENTS.md",
-        "CLAUDE.md"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://gitlab.com/zapier/zapier-sdk/zapier-sdk.git",
-        "directory": "packages/zapier-sdk-cli"
-    },
-    "homepage": "https://docs.zapier.com/sdk/using-the-cli",
-    "publishConfig": {
-        "access": "public"
-    },
-    "dependencies": {
-        "@inquirer/search": "^3.2.2",
-        "@zapier/policy-schema": "0.15.0",
-        "@zapier/zapier-sdk": "workspace:*",
-        "@zapier/zapier-sdk-mcp": "workspace:*",
-        "chalk": "^5.3.0",
-        "cli-table3": "^0.6.5",
-        "commander": "^12.0.0",
-        "conf": "^14.0.0",
-        "cross-keychain": "^1.1.0",
-        "esbuild": "^0.25.5",
-        "express": "^5.1.0",
-        "handlebars": "^4.7.8",
-        "ink": "7.0.5",
-        "inquirer": "^12.6.3",
-        "is-installed-globally": "^1.0.0",
-        "jsonwebtoken": "^9.0.2",
-        "open": "^10.2.0",
-        "ora": "^8.2.0",
-        "package-json": "^10.0.1",
-        "pkce-challenge": "^5.0.0",
-        "proper-lockfile": "^4.1.2",
-        "react": "19.2.6",
-        "semver": "^7.7.3",
-        "typescript": "^5.8.3",
-        "wrap-ansi": "^10.0.0",
-        "zod": "4.3.6"
-    },
-    "devDependencies": {
-        "@types/express": "^5.0.3",
-        "@types/inquirer": "^9.0.8",
-        "@types/jsonwebtoken": "^9.0.10",
-        "@types/node": "^24.0.1",
-        "@types/proper-lockfile": "^4.1.4",
-        "@types/react": "19.2.15",
-        "@types/semver": "^7.7.1",
-        "tsup": "^8.5.0",
-        "vitest": "^4.1.4"
-    }
-}

package/dist/src/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/src/cli.js

@@ -1,219 +0,0 @@
-#!/usr/bin/env node
-import { Command, CommanderError } from "commander";
-import { generateCliCommands } from "./utils/cli-generator";
-import { createZapierCliSdk as createStableCliSdk } from "./sdk";
-import { createZapierCliSdk as createExperimentalCliSdk } from "./experimental";
-import { resolveExtensions } from "./utils/extensions";
-import packageJson from "../package.json" with { type: "json" };
-import { ZapierCliError } from "./utils/errors";
-import { checkAndNotifyUpdates } from "./utils/version-checker";
-import { BaseSdkOptionsSchema } from "@zapier/zapier-sdk";
-import { z } from "zod";
-import { ReservedCliParameter, getReservedCliOption, } from "./utils/cli-options";
-import { createApprovalProgressRenderer } from "./utils/approval-progress";
-const EXIT_GRACE_PERIOD_MS = 500;
-const program = new Command();
-const versionOption = getReservedCliOption(ReservedCliParameter.Version);
-const helpOption = getReservedCliOption(ReservedCliParameter.Help);
-program
-    .name("zapier-sdk")
-    .description("CLI for Zapier SDK")
-    .version(packageJson.version, `${versionOption.short}, ${versionOption.flag}`, versionOption.description)
-    .option("--debug", "Enable debug logging")
-    .option("--base-url <url>", "Base URL for Zapier API endpoints")
-    .option("--credentials <token>", "Authentication token")
-    .option("--credentials-client-id <id>", "OAuth client ID for authentication")
-    .option("--credentials-client-secret <secret>", "OAuth client secret for authentication")
-    .option("--credentials-base-url <url>", "Base URL for authentication endpoints")
-    .option("--tracking-base-url <url>", "Base URL for Zapier tracking endpoints")
-    .option("--max-network-retries <count>", "Max retries for rate-limited requests (default: 3)")
-    .option("--max-network-retry-delay-ms <ms>", "Max delay in ms to wait for rate limit retry (default: 60000)")
-    .option("--max-concurrent-requests <count>", "Max concurrent in-flight HTTP requests (default: 200). Pass 'Infinity' to disable.")
-    // Registered so Commander accepts --experimental without rejecting it as
-    // unknown. The actual factory selection happens before Commander parses,
-    // by peeking at argv directly. Equivalent to using the
-    // `zapier-sdk-experimental` bin or setting `ZAPIER_EXPERIMENTAL=1`.
-    .option("--experimental", "Use the experimental SDK / CLI surface");
-// Dynamically register boolean flags from BaseSdkOptionsSchema
-const booleanFlags = [];
-for (const [key, fieldSchema] of Object.entries(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-BaseSdkOptionsSchema.shape)) {
-    let inner = fieldSchema;
-    if (inner instanceof z.ZodOptional) {
-        inner = inner._zod.def.innerType;
-    }
-    if (inner instanceof z.ZodBoolean && key !== "debug") {
-        const kebab = key.replace(/([A-Z])/g, "-$1").toLowerCase();
-        const description = fieldSchema.description ?? inner.description ?? "";
-        booleanFlags.push({ camelName: key, kebabFlag: `--${kebab}` });
-        program.option(`--${kebab}`, description);
-    }
-}
-program.helpOption(`${helpOption.short}, ${helpOption.flag}`, helpOption.description);
-// Check for debug flag early (support both flag and env var)
-const isDebugMode = process.env.DEBUG === "true" || process.argv.includes("--debug");
-// Helper to get flag value from argv. Handles both Commander forms:
-// `--flag value` (returns the next argv entry) and `--flag=value` (returns
-// the part after the equals). Returns undefined only when the flag is
-// genuinely absent — an explicit empty string still returns "".
-function getFlagValue(flagName) {
-    const prefix = `${flagName}=`;
-    for (let i = 0; i < process.argv.length; i++) {
-        const arg = process.argv[i];
-        if (arg === flagName)
-            return process.argv[i + 1];
-        if (arg.startsWith(prefix))
-            return arg.slice(prefix.length);
-    }
-    return undefined;
-}
-// Extract options from process.argv for early SDK creation
-// We need to create the SDK before parsing to generate commands from schemas
-const baseUrl = getFlagValue("--base-url");
-const credentialsToken = getFlagValue("--credentials");
-const credentialsClientId = getFlagValue("--credentials-client-id");
-const credentialsClientSecret = getFlagValue("--credentials-client-secret");
-const credentialsBaseUrl = getFlagValue("--credentials-base-url");
-const trackingBaseUrl = getFlagValue("--tracking-base-url");
-const maxNetworkRetriesStr = getFlagValue("--max-network-retries");
-const maxNetworkRetries = maxNetworkRetriesStr
-    ? parseInt(maxNetworkRetriesStr, 10)
-    : undefined;
-const maxNetworkRetryDelayMsStr = getFlagValue("--max-network-retry-delay-ms");
-const maxNetworkRetryDelayMs = maxNetworkRetryDelayMsStr
-    ? parseInt(maxNetworkRetryDelayMsStr, 10)
-    : undefined;
-const maxConcurrentRequestsStr = getFlagValue("--max-concurrent-requests");
-// "Infinity" is the explicit disable sentinel. parseInt of an all-digit
-// overflow value (e.g. "9".repeat(309)) also returns ±Infinity, which
-// would otherwise look like the sentinel and silently disable throttling
-// — coerce non-finite parseInt results to NaN so the SDK boundary's
-// fall-back-to-default branch handles them.
-let maxConcurrentRequests;
-if (maxConcurrentRequestsStr === undefined) {
-    maxConcurrentRequests = undefined;
-}
-else if (maxConcurrentRequestsStr === "Infinity") {
-    maxConcurrentRequests = Infinity;
-}
-else {
-    const parsed = parseInt(maxConcurrentRequestsStr, 10);
-    maxConcurrentRequests = Number.isFinite(parsed) ? parsed : NaN;
-}
-// Build credentials object from flags
-function buildCredentialsFromFlags() {
-    // If a direct token is provided, use it
-    if (credentialsToken) {
-        return credentialsToken;
-    }
-    // If client ID is provided, build a credentials object
-    if (credentialsClientId) {
-        if (credentialsClientSecret) {
-            // Client credentials flow
-            return {
-                type: "client_credentials",
-                clientId: credentialsClientId,
-                clientSecret: credentialsClientSecret,
-                ...(credentialsBaseUrl && { baseUrl: credentialsBaseUrl }),
-            };
-        }
-        else {
-            // PKCE flow (no secret)
-            return {
-                type: "pkce",
-                clientId: credentialsClientId,
-                ...(credentialsBaseUrl && { baseUrl: credentialsBaseUrl }),
-            };
-        }
-    }
-    // No credentials from flags - will fall back to env vars or stored login
-    return undefined;
-}
-const credentials = buildCredentialsFromFlags();
-// Extract boolean flags from argv
-const flagOverrides = {};
-for (const { camelName, kebabFlag } of booleanFlags) {
-    if (process.argv.includes(kebabFlag)) {
-        flagOverrides[camelName] = true;
-    }
-}
-// Pick which CLI SDK factory to use BEFORE Commander parses anything,
-// because the registry of available commands differs by factory:
-// experimental commands literally don't exist in the stable factory's
-// registry. Two equivalent triggers, either of which selects experimental:
-//
-//  - `--experimental` appears in argv (passed by the user, or pushed by
-//    the `zapier-sdk-experimental` bin shim)
-//  - `ZAPIER_EXPERIMENTAL=1` is set in the environment
-//
-// The bin shim works by pushing `--experimental` onto argv before
-// importing this file, so this single argv check covers both `zapier-sdk
-// --experimental` and the dedicated `zapier-sdk-experimental` bin.
-const useExperimental = process.argv.includes("--experimental") ||
-    process.env.ZAPIER_EXPERIMENTAL === "1" ||
-    process.env.ZAPIER_EXPERIMENTAL === "true";
-const createZapierCliSdk = useExperimental
-    ? createExperimentalCliSdk
-    : createStableCliSdk;
-const approvalProgress = createApprovalProgressRenderer({
-    enabled: process.stderr.isTTY === true,
-});
-// Override Commander's default exit behavior to handle our custom errors
-program.exitOverride();
-(async () => {
-    let exitCode = 0;
-    // Resolve extension packages declared via the ZAPIER_SDK_EXTENSIONS env
-    // var. Pre-resolving here keeps createZapierCliSdk synchronous for
-    // programmatic callers.
-    const extensions = await resolveExtensions();
-    // Create CLI SDK instance with all plugins and URL options
-    const sdk = createZapierCliSdk({
-        debug: isDebugMode,
-        credentials,
-        baseUrl,
-        trackingBaseUrl,
-        maxNetworkRetries,
-        maxNetworkRetryDelayMs,
-        maxConcurrentRequests,
-        onEvent: approvalProgress.onEvent,
-        ...flagOverrides,
-        extensions,
-    });
-    // Generate CLI commands from SDK schemas (including CLI plugins and extensions)
-    generateCliCommands(program, sdk);
-    // Start version checking non-blocking
-    const versionCheckPromise = checkAndNotifyUpdates({
-        packageName: packageJson.name,
-        currentVersion: packageJson.version,
-    });
-    try {
-        await program.parseAsync();
-    }
-    catch (error) {
-        if (error instanceof ZapierCliError) {
-            exitCode = error.exitCode;
-        }
-        else if (error instanceof CommanderError) {
-            exitCode = error.exitCode;
-        }
-        else {
-            // For any other unexpected errors, exit with code 1
-            console.error("Unexpected error:", error);
-            exitCode = 1;
-        }
-    }
-    // Wait for version checking to complete
-    await versionCheckPromise;
-    // Flush the exit telemetry event before we force-terminate. The async
-    // transport needs an explicit await because process.on("exit") only
-    // allows synchronous work.
-    await sdk.context.eventEmission.close(exitCode);
-    // Force exit after a short grace period. We can't rely on process.exitCode
-    // alone because background handles (stdin, pending file closes) keep the
-    // event loop alive indefinitely. The unref'd timer won't prevent natural
-    // exit, but guarantees the process terminates if the loop doesn't drain.
-    const exitTimeout = setTimeout(() => process.exit(exitCode), EXIT_GRACE_PERIOD_MS);
-    exitTimeout.unref();
-    process.exitCode = exitCode;
-})();

package/dist/src/experimental.d.ts

@@ -1,33 +0,0 @@
-/**
- * Experimental CLI SDK factory.
- *
- * Mirror of `./sdk.ts`, but built on top of
- * `@zapier/zapier-sdk/experimental` so the underlying SDK has every
- * `meta.experimental: true` plugin registered. The CLI's runtime
- * entry point (`cli.ts`) chooses between this and the stable factory
- * based on three equivalent triggers detected before Commander parses:
- * the `zapier-sdk-experimental` bin name (via `argv[1]`), the
- * `--experimental` flag, or the `ZAPIER_EXPERIMENTAL=1` env var.
- *
- * Plugin chain matches `./sdk.ts` literally, with future CLI-only
- * experimental plugins inserted at appropriate positions. Both
- * factories are kept in sync by shape tests.
- */
-import { type Plugin, type PluginProvides, type ZapierSdkOptions } from "@zapier/zapier-sdk/experimental";
-import type { ZapierSdkCli } from "./types/sdk";
-export interface ZapierCliSdkOptions extends ZapierSdkOptions {
-    /**
-     * Extra plugins discovered from `@zapier/zapier-sdk` extension packages.
-     * Pre-resolved by `cli.ts` (`utils/extensions.ts`) so this factory stays
-     * synchronous. Each plugin is layered onto the chain after all built-in
-     * CLI plugins, so its functions appear in `getRegistry({ package: "cli" })`
-     * automatically.
-     */
-    extensions?: Plugin<unknown, PluginProvides>[];
-}
-/**
- * Create a Zapier CLI SDK with experimental plugins registered. The
- * returned shape is a superset of the stable CLI SDK — same plugins
- * plus any marked experimental.
- */
-export declare function createZapierCliSdk(options?: ZapierCliSdkOptions): ZapierSdkCli;

package/dist/src/experimental.js

@@ -1,86 +0,0 @@
-/**
- * Experimental CLI SDK factory.
- *
- * Mirror of `./sdk.ts`, but built on top of
- * `@zapier/zapier-sdk/experimental` so the underlying SDK has every
- * `meta.experimental: true` plugin registered. The CLI's runtime
- * entry point (`cli.ts`) chooses between this and the stable factory
- * based on three equivalent triggers detected before Commander parses:
- * the `zapier-sdk-experimental` bin name (via `argv[1]`), the
- * `--experimental` flag, or the `ZAPIER_EXPERIMENTAL=1` env var.
- *
- * Plugin chain matches `./sdk.ts` literally, with future CLI-only
- * experimental plugins inserted at appropriate positions. Both
- * factories are kept in sync by shape tests.
- */
-import * as cliLogin from "./login";
-import { addPlugin, createZapierSdkStack, injectCliLogin, } from "@zapier/zapier-sdk/experimental";
-import { loginPlugin, signupPlugin, logoutPlugin, mcpPlugin, bundleCodePlugin, getLoginConfigPathPlugin, addAppsPlugin, generateAppTypesPlugin, buildManifestPlugin, feedbackPlugin, curlPlugin, cliOverridesPlugin, initPlugin, drainTriggerInboxCliPlugin, watchTriggerInboxCliPlugin, } from "./plugins/index";
-import packageJson from "../package.json" with { type: "json" };
-injectCliLogin(cliLogin);
-/**
- * Create a Zapier CLI SDK with experimental plugins registered. The
- * returned shape is a superset of the stable CLI SDK — same plugins
- * plus any marked experimental.
- */
-export function createZapierCliSdk(options = {}) {
-    const { extensions = [], ...sdkOptions } = options;
-    // Stash the resolved extensions on context so `mcpPlugin` can forward
-    // them to `startMcpServer`. Without this, MCP would build a vanilla SDK
-    // with no extensions and the CLI/MCP surfaces would diverge.
-    const extensionsContextPlugin = () => ({
-        context: { extensions },
-    });
-    // Tell the MCP plugin the CLI is in experimental mode so `mcp`
-    // launches a server built against `@zapier/zapier-sdk/experimental`.
-    // Without this, `zapier-sdk-experimental mcp` would silently expose
-    // only the stable surface — the README claim wouldn't match reality.
-    const experimentalContextPlugin = () => ({
-        context: { experimental: true },
-    });
-    const sdk = createZapierSdkStack({
-        ...sdkOptions,
-        eventEmission: { ...sdkOptions.eventEmission, callContext: "cli" },
-        callerPackage: { name: packageJson.name, version: packageJson.version },
-    })
-        .use(extensionsContextPlugin)
-        .use(experimentalContextPlugin)
-        .use(generateAppTypesPlugin)
-        .use(buildManifestPlugin)
-        .use(bundleCodePlugin)
-        .use(getLoginConfigPathPlugin)
-        .use(addAppsPlugin)
-        .use(feedbackPlugin)
-        .use(curlPlugin)
-        .use(initPlugin)
-        // Trigger inbox commands: the SDK's `drainTriggerInbox` and
-        // `watchTriggerInbox` are eager, callback-driven methods. Both CLI
-        // plugins override them to layer presentation flags (`--json`,
-        // interactive prompt, `--exec-shell` wrapping) around the same
-        // `onMessage` callback. `override: true` is the documented opt-in
-        // for intentional same-name replacement.
-        .use(drainTriggerInboxCliPlugin, { override: true })
-        .use(watchTriggerInboxCliPlugin, { override: true })
-        .use(mcpPlugin)
-        .use(loginPlugin)
-        .use(signupPlugin)
-        .use(logoutPlugin)
-        // cliOverridesPlugin patches existing meta entries (e.g. flags `fetch`
-        // as deprecated) without re-registering the method. `.use` throws on
-        // meta-key collisions by default, so the intent has to be explicit.
-        .use(cliOverridesPlugin, { override: true })
-        .toSdk();
-    // Construct extensions defensively. See `./sdk.ts` for the rationale;
-    // `addPlugin` mutates the sdk in place, atomically (validate-then-
-    // apply), so a failed extension leaves the sdk in its prior state
-    // and skipping is safe.
-    for (const ext of extensions) {
-        try {
-            addPlugin(sdk, ext);
-        }
-        catch (err) {
-            console.warn(`Extension plugin failed to construct: ${err.message}; skipping.`);
-        }
-    }
-    return sdk;
-}

package/dist/src/generators/ast-generator.d.ts

@@ -1,41 +0,0 @@
-import type { ListActionsPluginProvides, ListActionInputFieldsPluginProvides, ManifestPluginProvides, AppItem } from "@zapier/zapier-sdk";
-interface GenerateTypesOptions {
-    app: AppItem;
-    connectionId?: string | number;
-}
-/**
- * AST-based TypeScript type generator using the TypeScript Compiler API
- */
-export declare class AstTypeGenerator {
-    private readonly factory;
-    private readonly printer;
-    /**
-     * Generate TypeScript types using AST for a specific app
-     */
-    generateTypes(options: GenerateTypesOptions & {
-        sdk: ListActionsPluginProvides & ListActionInputFieldsPluginProvides & ManifestPluginProvides;
-    }): Promise<string>;
-    private createSourceFile;
-    private createImportStatement;
-    private createTypeImportStatement;
-    private groupActionsByType;
-    private createInputInterface;
-    private createActionInterface;
-    private createAppProxyInterface;
-    private createFetchMethodProperty;
-    private createAppFactoryInterface;
-    private createAppWithFactoryType;
-    private createModuleAugmentation;
-    private mapFieldTypeToTypeNode;
-    private capitalize;
-    private sanitizeActionName;
-    private sanitizeFieldName;
-    private escapeComment;
-    private createPropertyName;
-    private isValidIdentifier;
-    private getPreferredProgrammaticKey;
-    private getPreferredAppName;
-    private sanitizeToIdentifier;
-    private getAllKeys;
-}
-export {};