@zapier/zapier-sdk-cli 0.43.0 → 0.43.1

package/dist/package.json

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

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

@@ -1,15 +1,254 @@
-import type { Plugin, ListActionsPluginProvides, ListAppsPluginProvides, ListInputFieldsPluginProvides, ListConnectionsPluginProvides } from "@zapier/zapier-sdk";
-import { AddSchema, type AddOptions } from "./schemas";
-import { type GenerateAppTypesPluginProvides } from "../generateAppTypes";
-import { type BuildManifestPluginProvides } from "../buildManifest";
-export interface AddPluginProvides {
-    add: (options: AddOptions) => Promise<void>;
+export declare const addPlugin: (sdk: {
+    listApps: (options?: ({
+        search?: string | undefined;
+        apps?: string[] | undefined;
+        appKeys?: string[] | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => import("@zapier/zapier-sdk").PaginatedSdkResult<{
+        slug: string;
+        title: string;
+        key: string;
+        implementation_id: string;
+        description?: string | undefined;
+        is_hidden?: boolean | undefined;
+        auth_type?: string | undefined;
+        actions?: {
+            read?: number | undefined;
+            read_bulk?: number | undefined;
+            write?: number | undefined;
+            search?: number | undefined;
+            search_or_write?: number | undefined;
+            search_and_write?: number | undefined;
+            filter?: number | undefined;
+        } | undefined;
+        is_deprecated?: boolean | undefined;
+        is_beta?: boolean | undefined;
+        is_premium?: boolean | undefined;
+        age_in_days?: number | undefined;
+        banner?: string | undefined;
+        categories?: {
+            id: number;
+            name: string;
+            slug: string;
+        }[] | undefined;
+        images?: {
+            url_16x16?: string | undefined;
+            url_32x32?: string | undefined;
+            url_64x64?: string | undefined;
+            url_128x128?: string | undefined;
+        } | undefined;
+        popularity?: number | undefined;
+        has_filters?: boolean | undefined;
+        has_reads?: boolean | undefined;
+        has_searches?: boolean | undefined;
+        has_searches_or_writes?: boolean | undefined;
+        has_upfront_fields?: boolean | undefined;
+        has_writes?: boolean | undefined;
+        is_built_in?: boolean | undefined;
+        is_featured?: boolean | undefined;
+        is_invite?: boolean | undefined;
+        is_public?: boolean | undefined;
+        is_upcoming?: boolean | undefined;
+        visibility?: string | undefined;
+        primary_color?: string | undefined;
+        secondary_color?: string | undefined;
+        classification?: string | undefined;
+        api_docs_url?: string | undefined;
+        image?: string | undefined;
+        version?: string | undefined;
+    }>;
+} & {
     context: {
         meta: {
-            add: {
-                inputSchema: typeof AddSchema;
-            };
+            listApps: import("@zapier/zapier-sdk").PluginMeta;
         };
     };
-}
-export declare const addPlugin: Plugin<ListAppsPluginProvides & ListActionsPluginProvides & ListInputFieldsPluginProvides & ListConnectionsPluginProvides & BuildManifestPluginProvides & GenerateAppTypesPluginProvides, AddPluginProvides>;
+} & {
+    listActions: (options?: (({
+        app: string;
+        actionType?: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write" | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } | {
+        appKey: string;
+        actionType?: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write" | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    }) & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => import("@zapier/zapier-sdk").PaginatedSdkResult<{
+        description: string;
+        key: string;
+        app_key: string;
+        action_type: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        title: string;
+        type: "action";
+        id?: string | undefined;
+        is_important?: boolean | undefined;
+        is_hidden?: boolean | undefined;
+        app_version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listActions: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+} & {
+    listInputFields: (options?: (({
+        app: string;
+        actionType: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        action: string;
+        connection?: string | number | undefined;
+        connectionId?: string | number | null | undefined;
+        authenticationId?: string | number | null | undefined;
+        inputs?: Record<string, unknown> | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } | {
+        appKey: string;
+        actionType: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        actionKey: string;
+        connection?: string | number | undefined;
+        connectionId?: string | number | null | undefined;
+        authenticationId?: string | number | null | undefined;
+        inputs?: Record<string, unknown> | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    }) & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => import("@zapier/zapier-sdk").PaginatedSdkResult<{
+        key: string;
+        type: "input_field";
+        default_value: string;
+        depends_on: string[];
+        description: string;
+        invalidates_input_fields: boolean;
+        is_required: boolean;
+        placeholder: string;
+        title: string;
+        value_type: string;
+        format?: string | undefined;
+        items?: {
+            type: string;
+        } | undefined;
+    } | {
+        key: string;
+        type: "info_field";
+        description: string;
+        title?: string | undefined;
+    } | import("@zapier/zapier-sdk").FieldsetItem>;
+} & {
+    context: {
+        meta: {
+            listInputFields: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+} & {
+    listConnections: (options?: ({
+        title?: string | undefined;
+        search?: string | undefined;
+        owner?: string | undefined;
+        app?: string | undefined;
+        appKey?: string | undefined;
+        connections?: string[] | undefined;
+        connectionIds?: string[] | undefined;
+        authenticationIds?: string[] | undefined;
+        account?: string | undefined;
+        accountId?: string | undefined;
+        includeShared?: boolean | undefined;
+        isExpired?: boolean | undefined;
+        expired?: boolean | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => import("@zapier/zapier-sdk").PaginatedSdkResult<{
+        date: string;
+        is_invite_only: boolean;
+        is_private: boolean;
+        shared_with_all: boolean;
+        id: string;
+        account_id: string;
+        title?: string | null | undefined;
+        lastchanged?: string | undefined;
+        destination_selected_api?: string | null | undefined;
+        is_stale?: string | undefined;
+        is_shared?: string | undefined;
+        marked_stale_at?: string | null | undefined;
+        label?: string | null | undefined;
+        identifier?: string | null | undefined;
+        url?: string | undefined;
+        groups?: Record<string, unknown>[] | undefined;
+        members?: string | undefined;
+        permissions?: Record<string, boolean> | undefined;
+        public_id?: string | undefined;
+        account_public_id?: string | undefined;
+        customuser_public_id?: string | undefined;
+        implementation_id?: string | undefined;
+        profile_id?: string | undefined;
+        is_expired?: string | undefined;
+        expired_at?: string | null | undefined;
+        app_key?: string | undefined;
+        app_version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listConnections: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+} & {
+    buildManifest: (options?: import("../buildManifest/schemas").BuildManifestOptions | undefined) => Promise<import("../buildManifest/schemas").BuildManifestResult>;
+} & {
+    context: {
+        meta: {
+            buildManifest: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+} & {
+    generateAppTypes: (options?: import("../generateAppTypes/schemas").GenerateAppTypesOptions | undefined) => Promise<import("../generateAppTypes/schemas").GenerateAppTypesResult>;
+} & {
+    context: {
+        meta: {
+            generateAppTypes: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+} & {
+    context: import("@zapier/zapier-sdk").EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, import("@zapier/zapier-sdk").PluginMeta>;
+    };
+}) => {
+    add: (options?: {
+        apps: string[];
+        connections?: string[] | undefined;
+        configPath?: string | undefined;
+        typesOutput?: string | undefined;
+    } | undefined) => Promise<void>;
+} & {
+    context: {
+        meta: {
+            add: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+};
+export type AddPluginProvides = ReturnType<typeof addPlugin>;

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

@@ -1,9 +1,12 @@
-import { createFunction } from "@zapier/zapier-sdk";
+import { createPluginMethod, definePlugin } from "@zapier/zapier-sdk";
 import { AddSchema } from "./schemas";
 import { detectTypesOutputDirectory } from "../../utils/directory-detection";
 import { resolve } from "path";
-export const addPlugin = (sdk) => {
-    const add = createFunction(async function add(options) {
+export const addPlugin = definePlugin((sdk) => createPluginMethod(sdk, {
+    name: "add",
+    categories: ["utility"],
+    inputSchema: AddSchema,
+    handler: async ({ sdk, options }) => {
         const { apps: appKeys, connections: connectionIds, configPath, typesOutput = await detectTypesOutputDirectory(), } = options;
         const resolvedTypesOutput = resolve(typesOutput);
         console.log(`📦 Adding ${appKeys.length} app(s)...`);
@@ -88,16 +91,5 @@ export const addPlugin = (sdk) => {
         if (successfulApps.length > 0) {
             console.log(`✅ Added ${successfulApps.length} app(s) to manifest`);
         }
-    }, AddSchema);
-    return {
-        add,
-        context: {
-            meta: {
-                add: {
-                    categories: ["utility"],
-                    inputSchema: AddSchema,
-                },
-            },
-        },
-    };
-};
+    },
+}));

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

@@ -1,13 +1,120 @@
-import type { Plugin, ListAppsPluginProvides, ManifestPluginProvides } from "@zapier/zapier-sdk";
-import { BuildManifestSchema, type BuildManifestOptions, type BuildManifestResult } from "./schemas";
-export interface BuildManifestPluginProvides {
-    buildManifest: (options: BuildManifestOptions) => Promise<BuildManifestResult>;
+import type { Manifest } from "@zapier/zapier-sdk";
+import { type BuildManifestOptions, type BuildManifestResult } from "./schemas";
+export declare const buildManifestPlugin: (sdk: {
+    listApps: (options?: ({
+        search?: string | undefined;
+        apps?: string[] | undefined;
+        appKeys?: string[] | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => import("@zapier/zapier-sdk").PaginatedSdkResult<{
+        slug: string;
+        title: string;
+        key: string;
+        implementation_id: string;
+        description?: string | undefined;
+        is_hidden?: boolean | undefined;
+        auth_type?: string | undefined;
+        actions?: {
+            read?: number | undefined;
+            read_bulk?: number | undefined;
+            write?: number | undefined;
+            search?: number | undefined;
+            search_or_write?: number | undefined;
+            search_and_write?: number | undefined;
+            filter?: number | undefined;
+        } | undefined;
+        is_deprecated?: boolean | undefined;
+        is_beta?: boolean | undefined;
+        is_premium?: boolean | undefined;
+        age_in_days?: number | undefined;
+        banner?: string | undefined;
+        categories?: {
+            id: number;
+            name: string;
+            slug: string;
+        }[] | undefined;
+        images?: {
+            url_16x16?: string | undefined;
+            url_32x32?: string | undefined;
+            url_64x64?: string | undefined;
+            url_128x128?: string | undefined;
+        } | undefined;
+        popularity?: number | undefined;
+        has_filters?: boolean | undefined;
+        has_reads?: boolean | undefined;
+        has_searches?: boolean | undefined;
+        has_searches_or_writes?: boolean | undefined;
+        has_upfront_fields?: boolean | undefined;
+        has_writes?: boolean | undefined;
+        is_built_in?: boolean | undefined;
+        is_featured?: boolean | undefined;
+        is_invite?: boolean | undefined;
+        is_public?: boolean | undefined;
+        is_upcoming?: boolean | undefined;
+        visibility?: string | undefined;
+        primary_color?: string | undefined;
+        secondary_color?: string | undefined;
+        classification?: string | undefined;
+        api_docs_url?: string | undefined;
+        image?: string | undefined;
+        version?: string | undefined;
+    }>;
+} & {
     context: {
         meta: {
-            buildManifest: {
-                inputSchema: typeof BuildManifestSchema;
-            };
+            listApps: import("@zapier/zapier-sdk").PluginMeta;
         };
     };
-}
-export declare const buildManifestPlugin: Plugin<ListAppsPluginProvides & ManifestPluginProvides, BuildManifestPluginProvides>;
+} & {
+    context: {
+        getResolvedManifest: () => Promise<Manifest | null>;
+        getVersionedImplementationId: (appKey: string) => Promise<string | null>;
+        resolveAppKeys: ({ appKeys }: {
+            appKeys: string[];
+        }) => Promise<import("@zapier/zapier-sdk").ResolvedAppLocator[]>;
+        updateManifestEntry: (options: import("@zapier/zapier-sdk").UpdateManifestEntryOptions) => Promise<import("@zapier/zapier-sdk").UpdateManifestEntryResult>;
+        addActionEntry: (options: import("@zapier/zapier-sdk").AddActionEntryOptions) => Promise<import("@zapier/zapier-sdk").AddActionEntryResult>;
+        findActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: Manifest;
+        }) => import("@zapier/zapier-sdk").ActionEntry | null;
+        listActionEntries: ({ configPath, }?: {
+            configPath?: string;
+        }) => Promise<Array<[string, import("@zapier/zapier-sdk").ActionEntry]>>;
+        deleteActionEntry: ({ name, configPath, skipWrite, }: {
+            name: string;
+            configPath?: string;
+            skipWrite?: boolean;
+        }) => Promise<Manifest>;
+        hasActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: Manifest;
+        }) => boolean;
+        findManifestEntry: typeof import("@zapier/zapier-sdk").findManifestEntry;
+        readManifestFromFile: typeof import("@zapier/zapier-sdk").readManifestFromFile;
+        getManifestConnections: () => Promise<Record<string, {
+            connectionId: string | number;
+        }> | null>;
+    };
+} & {
+    context: import("@zapier/zapier-sdk").EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, import("@zapier/zapier-sdk").PluginMeta>;
+    };
+}) => {
+    buildManifest: (options?: BuildManifestOptions | undefined) => Promise<BuildManifestResult>;
+} & {
+    context: {
+        meta: {
+            buildManifest: import("@zapier/zapier-sdk").PluginMeta;
+        };
+    };
+};
+export type BuildManifestPluginProvides = ReturnType<typeof buildManifestPlugin>;

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

@@ -1,8 +1,15 @@
-import { createFunction, ZapierValidationError, ZapierUnknownError, } from "@zapier/zapier-sdk";
+import { createPluginMethod, definePlugin, ZapierValidationError, ZapierUnknownError, } from "@zapier/zapier-sdk";
 import { BuildManifestSchema, } from "./schemas";
 import { createManifestEntry } from "../../utils/manifest-helpers";
-export const buildManifestPlugin = (sdk) => {
-    const buildManifest = createFunction(async function buildManifest(options) {
+export const buildManifestPlugin = definePlugin((sdk) => createPluginMethod(sdk, {
+    name: "buildManifest",
+    categories: ["utility"],
+    // Cast: BuildManifestSchema validates JSON-serializable fields only.
+    // BuildManifestOptions adds an `onProgress` callback that rides through
+    // `createFunction`'s passthrough spread at runtime; this widens TInput
+    // so the handler can read it.
+    inputSchema: BuildManifestSchema,
+    handler: async ({ sdk, options }) => {
         const { apps: appKeys, skipWrite = false, configPath, onProgress, } = options;
         onProgress?.({ type: "apps_lookup_start", count: appKeys.length });
         const appsIterable = sdk.listApps({ apps: appKeys }).items();
@@ -16,7 +23,6 @@ export const buildManifestPlugin = (sdk) => {
             return {};
         }
         let updatedManifest;
-        // Process each app
         for (const app of apps) {
             onProgress?.({
                 type: "app_processing_start",
@@ -55,26 +61,11 @@ export const buildManifestPlugin = (sdk) => {
                     error: errorMessage,
                 });
                 if (error instanceof ZapierValidationError) {
-                    throw error; // Preserve the specific error type
-                }
-                else {
-                    throw new ZapierUnknownError(errorMessage, {
-                        cause: error, // Works for both Error and non-Error
-                    });
+                    throw error;
                 }
+                throw new ZapierUnknownError(errorMessage, { cause: error });
             }
         }
         return { manifest: updatedManifest };
-    }, BuildManifestSchema);
-    return {
-        buildManifest,
-        context: {
-            meta: {
-                buildManifest: {
-                    categories: ["utility"],
-                    inputSchema: BuildManifestSchema,
-                },
-            },
-        },
-    };
-};
+    },
+}));

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

@@ -1,14 +1,23 @@
-import type { Plugin } from "@zapier/zapier-sdk";
-import { BundleCodeSchema, type BundleCodeOptions } from "./schemas";
-export interface BundleCodePluginProvides {
-    bundleCode: (options: BundleCodeOptions) => Promise<string>;
+export declare const bundleCodePlugin: (sdk: {
+    context: import("@zapier/zapier-sdk").EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, import("@zapier/zapier-sdk").PluginMeta>;
+    };
+}) => {
+    bundleCode: (options?: {
+        input: string;
+        output?: string | undefined;
+        string?: boolean | undefined;
+        minify?: boolean | undefined;
+        target?: string | undefined;
+        cjs?: boolean | undefined;
+    } | undefined) => Promise<string>;
+} & {
     context: {
         meta: {
-            bundleCode: {
-                inputSchema: typeof BundleCodeSchema;
-            };
+            bundleCode: import("@zapier/zapier-sdk").PluginMeta;
         };
     };
-}
-export declare const bundleCodePlugin: Plugin<{}, // requires no existing SDK methods
-BundleCodePluginProvides>;
+};
+export type BundleCodePluginProvides = ReturnType<typeof bundleCodePlugin>;

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

@@ -1,24 +1,14 @@
 import { BundleCodeSchema } from "./schemas";
-import { createFunction } from "@zapier/zapier-sdk";
+import { createPluginMethod, definePlugin, } from "@zapier/zapier-sdk";
 import { buildSync } from "esbuild";
 import * as fs from "fs";
 import * as path from "path";
-export const bundleCodePlugin = () => {
-    const bundleCodeWithSdk = createFunction(async function bundleCodeWithSdk(options) {
-        return await bundleCode(options);
-    }, BundleCodeSchema);
-    return {
-        bundleCode: bundleCodeWithSdk,
-        context: {
-            meta: {
-                bundleCode: {
-                    categories: ["utility", "deprecated"],
-                    inputSchema: BundleCodeSchema,
-                },
-            },
-        },
-    };
-};
+export const bundleCodePlugin = definePlugin((sdk) => createPluginMethod(sdk, {
+    name: "bundleCode",
+    categories: ["utility", "deprecated"],
+    inputSchema: BundleCodeSchema,
+    handler: async ({ options }) => bundleCode(options),
+}));
 class ZapierBundleError extends Error {
     constructor(message, details, originalError) {
         super(message);

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

@@ -1,24 +1,26 @@
-import type { FunctionDeprecation, Plugin } from "@zapier/zapier-sdk";
+import type { FunctionDeprecation, PluginMeta } from "@zapier/zapier-sdk";
 interface FetchMeta {
     categories?: string[];
     deprecation?: FunctionDeprecation;
 }
-interface CliOverridesProvides {
-    context: {
-        meta: {
-            fetch?: FetchMeta;
-        };
-    };
-}
 /**
  * CLI-specific metadata overrides.
  * Adds "deprecated" category to fetch so it's hidden from CLI help.
  */
-export declare const cliOverridesPlugin: Plugin<{
+export declare const cliOverridesPlugin: (sdk: {
     context: {
         meta: {
             fetch?: FetchMeta;
         };
     };
-}, CliOverridesProvides>;
+} & {
+    context: {
+        meta: Record<string, PluginMeta>;
+    };
+}) => {
+    context: {
+        meta: Record<string, PluginMeta>;
+    };
+};
+export type CliOverridesProvides = ReturnType<typeof cliOverridesPlugin>;
 export {};

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

@@ -1,25 +1,21 @@
+import { definePlugin } from "@zapier/zapier-sdk";
 /**
  * CLI-specific metadata overrides.
  * Adds "deprecated" category to fetch so it's hidden from CLI help.
  */
-export const cliOverridesPlugin = (sdk) => {
-    if (!sdk.context.meta.fetch) {
-        return { context: { meta: {} } };
-    }
-    return {
-        context: {
-            meta: {
-                fetch: {
-                    ...sdk.context.meta.fetch,
-                    categories: [
-                        ...(sdk.context.meta.fetch.categories || []),
-                        "deprecated",
-                    ],
-                    deprecation: {
-                        message: "This command is deprecated and will be removed soon. Use `curl` instead. Learn more: https://docs.zapier.com/sdk/cli-reference#curl",
-                    },
-                },
+export const cliOverridesPlugin = definePlugin((sdk) => {
+    const meta = {};
+    if (sdk.context.meta.fetch) {
+        meta.fetch = {
+            ...sdk.context.meta.fetch,
+            categories: [
+                ...(sdk.context.meta.fetch.categories || []),
+                "deprecated",
+            ],
+            deprecation: {
+                message: "This command is deprecated and will be removed soon. Use `curl` instead. Learn more: https://docs.zapier.com/sdk/cli-reference#curl",
             },
-        },
-    };
-};
+        };
+    }
+    return { context: { meta } };
+});