@zapier/zapier-sdk-cli 0.19.0 → 0.22.0

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

@@ -1,18 +0,0 @@
-import { createFunction } from "@zapier/zapier-sdk";
-import { logout } from "@zapier/zapier-sdk-cli-login";
-import { LogoutSchema } from "./schemas";
-const logoutWithSdk = createFunction(async function logoutWithSdk(_options) {
-    logout();
-    console.log("✅ Successfully logged out");
-}, LogoutSchema);
-export const logoutPlugin = () => ({
-    logout: logoutWithSdk,
-    context: {
-        meta: {
-            logout: {
-                categories: ["account"],
-                inputSchema: LogoutSchema,
-            },
-        },
-    },
-});

package/dist/src/plugins/logout/schemas.d.ts

@@ -1,3 +0,0 @@
-import { z } from "zod";
-export declare const LogoutSchema: z.ZodObject<{}, z.core.$strip>;
-export type LogoutOptions = z.infer<typeof LogoutSchema>;

package/dist/src/plugins/logout/schemas.js

@@ -1,5 +0,0 @@
-import { z } from "zod";
-// Logout schema (no parameters needed)
-export const LogoutSchema = z
-    .object({})
-    .describe("Log out of your Zapier account");

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

@@ -1,15 +0,0 @@
-import type { Plugin } from "@zapier/zapier-sdk";
-import { McpSchema, type McpOptions } from "./schemas";
-interface McpPluginProvides {
-    mcp: (options: McpOptions) => Promise<void>;
-    context: {
-        meta: {
-            mcp: {
-                inputSchema: typeof McpSchema;
-                categories: string[];
-            };
-        };
-    };
-}
-export declare const mcpPlugin: Plugin<{}, {}, McpPluginProvides>;
-export type { McpPluginProvides };

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

@@ -1,24 +0,0 @@
-import { createFunction } from "@zapier/zapier-sdk";
-import { startMcpServer } from "@zapier/zapier-sdk-mcp";
-import { McpSchema } from "./schemas";
-export const mcpPlugin = ({ context }) => {
-    const mcpWithSdk = createFunction(async function mcpWithSdk(options) {
-        // Pass through the SDK's debug option to the MCP server
-        const mcpOptions = {
-            ...options,
-            debug: context.options.debug,
-        };
-        return await startMcpServer(mcpOptions);
-    }, McpSchema);
-    return {
-        mcp: mcpWithSdk,
-        context: {
-            meta: {
-                mcp: {
-                    categories: ["utility"],
-                    inputSchema: McpSchema,
-                },
-            },
-        },
-    };
-};

package/dist/src/plugins/mcp/schemas.d.ts

@@ -1,5 +0,0 @@
-import { z } from "zod";
-export declare const McpSchema: z.ZodObject<{
-    port: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type McpOptions = z.infer<typeof McpSchema>;

package/dist/src/plugins/mcp/schemas.js

@@ -1,10 +0,0 @@
-import { z } from "zod";
-// MCP server schema
-export const McpSchema = z
-    .object({
-    port: z
-        .string()
-        .optional()
-        .describe("Port to listen on (for future HTTP transport)"),
-})
-    .describe("Start MCP server for Zapier SDK");

package/dist/src/sdk.d.ts

@@ -1,9 +0,0 @@
-import { type ZapierSdkOptions } from "@zapier/zapier-sdk";
-import type { ZapierSdkCli } from "./types/sdk";
-export interface ZapierCliSdkOptions extends ZapierSdkOptions {
-}
-/**
- * Create a Zapier SDK instance configured specifically for the CLI
- * Includes all CLI-specific plugins in addition to the standard SDK functionality
- */
-export declare function createZapierCliSdk(options?: ZapierCliSdkOptions): ZapierSdkCli;

package/dist/src/sdk.js

@@ -1,24 +0,0 @@
-import { createZapierSdkWithoutRegistry, registryPlugin, } from "@zapier/zapier-sdk";
-import { loginPlugin, logoutPlugin, mcpPlugin, bundleCodePlugin, getLoginConfigPathPlugin, addPlugin, generateAppTypesPlugin, buildManifestPlugin, } from "./plugins/index";
-/**
- * Create a Zapier SDK instance configured specifically for the CLI
- * Includes all CLI-specific plugins in addition to the standard SDK functionality
- */
-export function createZapierCliSdk(options = {}) {
-    // Create SDK instance and chain all plugins
-    // Chaining prevents type widening that occurs with let reassignment
-    return (createZapierSdkWithoutRegistry({
-        ...options,
-    })
-        // Add CLI-specific plugins before registry
-        .addPlugin(generateAppTypesPlugin)
-        .addPlugin(buildManifestPlugin)
-        .addPlugin(bundleCodePlugin)
-        .addPlugin(getLoginConfigPathPlugin)
-        .addPlugin(addPlugin)
-        .addPlugin(mcpPlugin)
-        .addPlugin(loginPlugin)
-        .addPlugin(logoutPlugin)
-        // Add registry plugin to finalize SDK
-        .addPlugin(registryPlugin));
-}

package/dist/src/telemetry/builders.d.ts

@@ -1,42 +0,0 @@
-/**
- * CLI-specific event builders
- *
- * Provides builder functions for CLI command telemetry that auto-populate
- * common CLI fields and system information.
- */
-import type { CliCommandExecutedEvent } from "./events";
-export interface CliEventContext {
-    customuser_id?: number | null;
-    account_id?: number | null;
-    identity_id?: number | null;
-    visitor_id?: string | null;
-    correlation_id?: string | null;
-    session_id?: string | null;
-    selected_api?: string | null;
-    app_id?: number | null;
-    app_version_id?: number | null;
-}
-export interface CliCommandExecutedEventData {
-    cli_primary_command: string;
-    success_flag: boolean;
-    execution_duration_ms?: number | null;
-    exit_code?: number | null;
-    error_message?: string | null;
-    command_category?: string | null;
-    requires_auth?: boolean | null;
-    cli_arguments?: (string | null)[] | null;
-    cli_version?: string | null;
-    made_network_requests?: boolean | null;
-    files_modified_count?: number | null;
-    files_created_count?: number | null;
-    files_processed_size_bytes?: number | null;
-    peak_memory_usage_bytes?: number | null;
-    cpu_time_ms?: number | null;
-    subprocess_count?: number | null;
-    package_manager?: string | null;
-}
-export declare function buildCliCommandExecutedEvent({ data, context, cliVersion, }: {
-    data: CliCommandExecutedEventData;
-    context?: CliEventContext;
-    cliVersion?: string;
-}): CliCommandExecutedEvent;

package/dist/src/telemetry/builders.js

@@ -1,55 +0,0 @@
-/**
- * CLI-specific event builders
- *
- * Provides builder functions for CLI command telemetry that auto-populate
- * common CLI fields and system information.
- */
-import { generateEventId, getCurrentTimestamp, getReleaseId, getOsInfo, getPlatformVersions, isCi, getCiPlatform, } from "@zapier/zapier-sdk";
-import cliPackageJson from "../../package.json";
-// Create base event for CLI events
-function createCliBaseEvent(context = {}) {
-    return {
-        event_id: generateEventId(),
-        timestamp_ms: getCurrentTimestamp(),
-        release_id: getReleaseId(),
-        customuser_id: context.customuser_id ?? null,
-        account_id: context.account_id ?? null,
-        identity_id: context.identity_id ?? null,
-        visitor_id: context.visitor_id ?? null,
-        correlation_id: context.correlation_id ?? null,
-    };
-}
-export function buildCliCommandExecutedEvent({ data, context = {}, cliVersion = cliPackageJson.version, }) {
-    const osInfo = getOsInfo();
-    const platformVersions = getPlatformVersions();
-    return {
-        ...createCliBaseEvent(context),
-        system_name: "zapier-sdk-cli",
-        session_id: context.session_id ?? null,
-        cli_version: data.cli_version ?? cliVersion,
-        cli_arguments: data.cli_arguments ?? null,
-        cli_primary_command: data.cli_primary_command,
-        os_platform: osInfo.platform,
-        os_release: osInfo.release,
-        os_architecture: osInfo.architecture,
-        platform_versions: platformVersions,
-        selected_api: context.selected_api ?? null,
-        app_id: context.app_id ?? null,
-        app_version_id: context.app_version_id ?? null,
-        execution_duration_ms: data.execution_duration_ms ?? null,
-        success_flag: data.success_flag,
-        exit_code: data.exit_code ?? (data.success_flag ? 0 : 1),
-        error_message: data.error_message ?? null,
-        command_category: data.command_category ?? null,
-        requires_auth: data.requires_auth ?? null,
-        is_ci_environment: isCi(),
-        ci_platform: getCiPlatform(),
-        package_manager: data.package_manager ?? "pnpm", // Default based on project setup
-        made_network_requests: data.made_network_requests ?? null,
-        files_modified_count: data.files_modified_count ?? null,
-        files_created_count: data.files_created_count ?? null,
-        files_processed_size_bytes: data.files_processed_size_bytes ?? null,
-        cpu_time_ms: data.cpu_time_ms ?? null,
-        subprocess_count: data.subprocess_count ?? null,
-    };
-}

package/dist/src/telemetry/events.d.ts

@@ -1,37 +0,0 @@
-/**
- * CLI-specific telemetry event definitions
- */
-import type { BaseEvent } from "@zapier/zapier-sdk";
-/**
- * Event emitted when a CLI command is executed
- */
-export interface CliCommandExecutedEvent extends BaseEvent {
-    system_name: string;
-    session_id?: string | null;
-    cli_version?: string | null;
-    cli_arguments?: (string | null)[] | null;
-    cli_primary_command?: string | null;
-    os_platform?: string | null;
-    os_release?: string | null;
-    os_architecture?: string | null;
-    platform_versions?: Record<string, string | null> | null;
-    selected_api?: string | null;
-    app_id?: number | null;
-    app_version_id?: number | null;
-    execution_duration_ms?: number | null;
-    success_flag: boolean;
-    exit_code?: number | null;
-    error_message?: string | null;
-    command_category?: string | null;
-    requires_auth?: boolean | null;
-    is_ci_environment?: boolean | null;
-    ci_platform?: string | null;
-    package_manager?: string | null;
-    made_network_requests?: boolean | null;
-    files_modified_count?: number | null;
-    files_created_count?: number | null;
-    files_processed_size_bytes?: number | null;
-    peak_memory_usage_bytes?: number | null;
-    cpu_time_ms?: number | null;
-    subprocess_count?: number | null;
-}

package/dist/src/telemetry/events.js

@@ -1,4 +0,0 @@
-/**
- * CLI-specific telemetry event definitions
- */
-export {};

package/dist/src/types/sdk.d.ts

@@ -1,5 +0,0 @@
-import type { GetSdkType, ZapierSdk } from "@zapier/zapier-sdk";
-import type { BuildManifestPluginProvides } from "../plugins/buildManifest";
-import type { GenerateAppTypesPluginProvides } from "../plugins/generateAppTypes";
-export interface ZapierSdkCli extends GetSdkType<ZapierSdk & BuildManifestPluginProvides & GenerateAppTypesPluginProvides> {
-}

package/dist/src/types/sdk.js

@@ -1 +0,0 @@
-export {};

package/dist/src/utils/api/client.d.ts

@@ -1,15 +0,0 @@
-export interface ApiResponse<T = unknown> {
-    data: T;
-    status: number;
-}
-export declare const createApiClient: () => {
-    post: <T = unknown>(url: string, data: Record<string, string>, options?: {
-        headers?: Record<string, string>;
-    }) => Promise<ApiResponse<T>>;
-};
-declare const api: {
-    post: <T = unknown>(url: string, data: Record<string, string>, options?: {
-        headers?: Record<string, string>;
-    }) => Promise<ApiResponse<T>>;
-};
-export default api;

package/dist/src/utils/api/client.js

@@ -1,27 +0,0 @@
-export const createApiClient = () => {
-    const post = async (url, data, options = {}) => {
-        const { headers = {} } = options;
-        const response = await fetch(url, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/x-www-form-urlencoded",
-                Connection: "close",
-                ...headers,
-            },
-            body: new URLSearchParams(data),
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status} ${response.statusText}`);
-        }
-        const responseData = await response.json();
-        return {
-            data: responseData,
-            status: response.status,
-        };
-    };
-    return {
-        post,
-    };
-};
-const api = createApiClient();
-export default api;

package/dist/src/utils/auth/login.d.ts

@@ -1,7 +0,0 @@
-import { type PkceCredentials } from "@zapier/zapier-sdk-cli-login";
-interface LoginOptions {
-    timeoutMs?: number;
-    credentials?: PkceCredentials;
-}
-declare const login: ({ timeoutMs, credentials, }: LoginOptions) => Promise<string>;
-export default login;

package/dist/src/utils/auth/login.js

@@ -1,154 +0,0 @@
-import open from "open";
-import crypto from "node:crypto";
-import express from "express";
-import pkceChallenge from "pkce-challenge";
-import { AUTH_MODE_HEADER, LOGIN_PORTS, LOGIN_TIMEOUT_MS } from "../constants";
-import { spinPromise } from "../spinner";
-import log from "../log";
-import api from "../api/client";
-import getCallablePromise from "../getCallablePromise";
-import { updateLogin, logout, getPkceLoginConfig, } from "@zapier/zapier-sdk-cli-login";
-import { ZapierCliUserCancellationError } from "../errors";
-const findAvailablePort = () => {
-    return new Promise((resolve, reject) => {
-        let portIndex = 0;
-        const tryPort = (port) => {
-            const server = express().listen(port, () => {
-                server.close();
-                resolve(port);
-            });
-            server.on("error", (err) => {
-                if (err.code === "EADDRINUSE") {
-                    if (portIndex < LOGIN_PORTS.length) {
-                        // Try next predefined port
-                        tryPort(LOGIN_PORTS[portIndex++]);
-                    }
-                    else {
-                        // All configured ports are busy
-                        reject(new Error(`All configured OAuth callback ports are busy: ${LOGIN_PORTS.join(", ")}. Please try again later or close applications using these ports.`));
-                    }
-                }
-                else {
-                    reject(err);
-                }
-            });
-        };
-        if (LOGIN_PORTS.length > 0) {
-            tryPort(LOGIN_PORTS[portIndex++]);
-        }
-        else {
-            reject(new Error("No OAuth callback ports configured"));
-        }
-    });
-};
-const generateRandomString = () => {
-    const array = new Uint32Array(28);
-    crypto.getRandomValues(array);
-    return Array.from(array, (dec) => ("0" + dec.toString(16)).substring(-2)).join("");
-};
-// Ensure offline_access is included in scope for PKCE (needed for refresh tokens)
-function ensureOfflineAccess(scope) {
-    if (scope.includes("offline_access")) {
-        return scope;
-    }
-    return `${scope} offline_access`;
-}
-const login = async ({ timeoutMs = LOGIN_TIMEOUT_MS, credentials, }) => {
-    const { clientId, tokenUrl, authorizeUrl } = getPkceLoginConfig({
-        credentials,
-    });
-    const scope = ensureOfflineAccess(credentials?.scope || "internal credentials");
-    // Force logout
-    logout();
-    // Find an available port
-    const availablePort = await findAvailablePort();
-    const redirectUri = `http://localhost:${availablePort}/oauth`;
-    log.info(`Using port ${availablePort} for OAuth callback`);
-    const { promise: promisedCode, resolve: setCode, reject: rejectCode, } = getCallablePromise();
-    const app = express();
-    app.get("/oauth", (req, res) => {
-        setCode(String(req.query.code));
-        // Set headers to prevent keep-alive
-        res.setHeader("Connection", "close");
-        res.end("You can now close this tab and return to the CLI.");
-    });
-    const server = app.listen(availablePort);
-    // Track connections to force close them if needed
-    const connections = new Set();
-    server.on("connection", (conn) => {
-        connections.add(conn);
-        conn.on("close", () => connections.delete(conn));
-    });
-    // Set up signal handlers for graceful shutdown
-    const cleanup = () => {
-        server.close();
-        log.info("\n❌ Login cancelled by user");
-        rejectCode(new ZapierCliUserCancellationError());
-    };
-    process.on("SIGINT", cleanup);
-    process.on("SIGTERM", cleanup);
-    const { code_verifier: codeVerifier, code_challenge: codeChallenge } = await pkceChallenge();
-    const authUrl = `${authorizeUrl}?${new URLSearchParams({
-        response_type: "code",
-        client_id: clientId,
-        redirect_uri: redirectUri,
-        scope,
-        state: generateRandomString(),
-        code_challenge: codeChallenge,
-        code_challenge_method: "S256",
-    }).toString()}`;
-    log.info("Opening your browser to log in.");
-    log.info("If it doesn't open, visit:", authUrl);
-    open(authUrl);
-    // Track the timeout timer so we can cancel it after login succeeds
-    let timeoutTimer;
-    try {
-        await spinPromise(Promise.race([
-            promisedCode,
-            new Promise((_resolve, reject) => {
-                timeoutTimer = setTimeout(() => {
-                    reject(new Error(`Login timed out after ${Math.round(timeoutMs / 1000)} seconds.`));
-                }, timeoutMs);
-            }),
-        ]), "Waiting for you to login and authorize");
-    }
-    finally {
-        // Clear the timeout timer to prevent it from keeping the process alive
-        if (timeoutTimer) {
-            clearTimeout(timeoutTimer);
-        }
-        // Remove signal handlers
-        process.off("SIGINT", cleanup);
-        process.off("SIGTERM", cleanup);
-        // Close server with timeout and force-close connections if needed
-        await new Promise((resolve) => {
-            const timeout = setTimeout(() => {
-                log.info("Server close timed out, forcing connection shutdown...");
-                // Force close all connections
-                connections.forEach((conn) => conn.destroy());
-                resolve();
-            }, 1000); // 1 second timeout
-            server.close(() => {
-                clearTimeout(timeout);
-                resolve();
-            });
-        });
-    }
-    log.info("Exchanging authorization code for tokens...");
-    const { data } = await api.post(tokenUrl, {
-        grant_type: "authorization_code",
-        code: await promisedCode,
-        redirect_uri: redirectUri,
-        client_id: clientId,
-        code_verifier: codeVerifier,
-    }, {
-        headers: {
-            [AUTH_MODE_HEADER]: "no",
-            "Content-Type": "application/x-www-form-urlencoded",
-        },
-    });
-    updateLogin(data);
-    log.info("Token exchange completed successfully");
-    return data.access_token;
-};
-export default login;

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

@@ -1,14 +0,0 @@
-import { z } from "zod";
-import { type FunctionRegistryEntry } from "@zapier/zapier-sdk";
-export interface CliParameter {
-    name: string;
-    type: "string" | "number" | "boolean" | "array";
-    required: boolean;
-    description?: string;
-    default?: unknown;
-    choices?: string[];
-    hasResolver?: boolean;
-    isPositional?: boolean;
-}
-export declare function analyzeZodSchema(schema: z.ZodSchema, functionInfo?: FunctionRegistryEntry): CliParameter[];
-export declare function convertCliArgsToSdkParams(parameters: CliParameter[], positionalArgs: unknown[], options: Record<string, unknown>): Record<string, unknown>;

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

@@ -1,122 +0,0 @@
-import { z } from "zod";
-import { isPositional } from "@zapier/zapier-sdk";
-// ============================================================================
-// Schema Analysis
-// ============================================================================
-export function analyzeZodSchema(schema, functionInfo) {
-    const parameters = [];
-    if (schema instanceof z.ZodObject) {
-        const shape = schema.shape;
-        for (const [key, fieldSchema] of Object.entries(shape)) {
-            const param = analyzeZodField(key, fieldSchema, functionInfo);
-            if (param) {
-                parameters.push(param);
-            }
-        }
-    }
-    return parameters;
-}
-function analyzeZodField(name, schema, functionInfo) {
-    let baseSchema = schema;
-    let required = true;
-    let defaultValue = undefined;
-    // Unwrap optional and default wrappers
-    if (baseSchema instanceof z.ZodOptional) {
-        required = false;
-        baseSchema = baseSchema._zod.def.innerType;
-    }
-    if (baseSchema instanceof z.ZodDefault) {
-        required = false;
-        defaultValue = baseSchema._zod.def.defaultValue();
-        baseSchema = baseSchema._zod.def.innerType;
-    }
-    // Determine parameter type
-    let paramType = "string";
-    let choices;
-    if (baseSchema instanceof z.ZodString) {
-        paramType = "string";
-    }
-    else if (baseSchema instanceof z.ZodNumber) {
-        paramType = "number";
-    }
-    else if (baseSchema instanceof z.ZodBoolean) {
-        paramType = "boolean";
-    }
-    else if (baseSchema instanceof z.ZodArray) {
-        paramType = "array";
-    }
-    else if (baseSchema instanceof z.ZodEnum) {
-        paramType = "string";
-        choices = baseSchema.options;
-    }
-    else if (baseSchema instanceof z.ZodRecord) {
-        // Handle Record<string, any> as JSON string input
-        paramType = "string";
-    }
-    // Check if this parameter has a resolver
-    let paramHasResolver = false;
-    // Check function-specific resolvers first
-    if (functionInfo?.resolvers?.[name]) {
-        paramHasResolver = true;
-    }
-    // Extract resolver metadata
-    return {
-        name,
-        type: paramType,
-        required,
-        description: schema.description,
-        default: defaultValue,
-        choices,
-        hasResolver: paramHasResolver,
-        isPositional: isPositional(schema),
-    };
-}
-// ============================================================================
-// Parameter Conversion
-// ============================================================================
-export function convertCliArgsToSdkParams(parameters, positionalArgs, options) {
-    const sdkParams = {};
-    // Handle positional arguments (required parameters or optional positional parameters)
-    let argIndex = 0;
-    parameters.forEach((param) => {
-        if ((param.required || param.isPositional) &&
-            argIndex < positionalArgs.length) {
-            // Use the original camelCase parameter name for the SDK
-            sdkParams[param.name] = convertValue(positionalArgs[argIndex], param.type);
-            argIndex++;
-        }
-    });
-    // Handle option flags
-    Object.entries(options).forEach(([key, value]) => {
-        // Convert kebab-case back to camelCase
-        const camelKey = key.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
-        const param = parameters.find((p) => p.name === camelKey);
-        if (param && value !== undefined) {
-            sdkParams[camelKey] = convertValue(value, param.type);
-        }
-    });
-    return sdkParams;
-}
-function convertValue(value, type) {
-    switch (type) {
-        case "number":
-            return Number(value);
-        case "boolean":
-            return Boolean(value);
-        case "array":
-            return Array.isArray(value) ? value : [value];
-        case "string":
-        default:
-            // Handle JSON string for objects
-            if (typeof value === "string" &&
-                (value.startsWith("{") || value.startsWith("["))) {
-                try {
-                    return JSON.parse(value);
-                }
-                catch {
-                    return value;
-                }
-            }
-            return value;
-    }
-}

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

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-import type { ZapierSdk } from "@zapier/zapier-sdk";
-export declare function generateCliCommands(program: Command, sdk: ZapierSdk): void;