@zapier/zapier-sdk 0.18.4 → 0.19.0

package/dist/plugins/listApps/index.js

@@ -1,67 +0,0 @@
-import { createPaginatedFunction } from "../../utils/function-utils";
-import { ListAppsSchema, } from "./schemas";
-import { AppItemSchema } from "../../schemas/App";
-import { createTelemetryCallback } from "../../utils/telemetry-utils";
-import { stripPageSuffix } from "../../utils/string-utils";
-export const listAppsPlugin = ({ context }) => {
-    async function listAppsPage(options) {
-        const { api, resolveAppKeys } = context;
-        const appKeys = options.appKeys ?? [];
-        const appLocators = await resolveAppKeys({
-            appKeys: [...appKeys],
-        });
-        const implementationNameToLocator = {};
-        for (const locator of appLocators) {
-            implementationNameToLocator[locator.implementationName] = [
-                ...(implementationNameToLocator[locator.implementationName] ?? []),
-                locator,
-            ];
-        }
-        const duplicatedLookupAppKeys = Object.keys(implementationNameToLocator)
-            .filter((key) => implementationNameToLocator[key].length > 1)
-            .map((key) => implementationNameToLocator[key])
-            .flat()
-            .map((locator) => locator.lookupAppKey);
-        if (duplicatedLookupAppKeys.length > 0) {
-            throw new Error(`Duplicate lookup app keys found: ${duplicatedLookupAppKeys.join(", ")}`);
-        }
-        // Step 2: Early return if user provided appKeys but they resolved to nothing AND no search
-        // This prevents the handler from returning all apps when the user explicitly filtered
-        // If search is provided, let the handler augment with search results
-        if (appKeys.length > 0 && appLocators.length === 0 && !options.search) {
-            return {
-                data: [],
-                links: { next: null },
-                meta: { count: 0, limit: 0, offset: 0 },
-            };
-        }
-        const implementationIds = appLocators.map((locator) => {
-            const version = locator.version || "latest";
-            return `${locator.implementationName}@${version}`;
-        });
-        return await api.get("/api/v0/apps", {
-            searchParams: {
-                appKeys: implementationIds.join(","),
-                ...(options.search && { search: options.search }),
-                pageSize: options.pageSize.toString(),
-                ...(options.cursor && { offset: options.cursor }),
-            },
-        });
-    }
-    const methodName = stripPageSuffix(listAppsPage.name);
-    const listAppsDefinition = createPaginatedFunction(listAppsPage, ListAppsSchema, createTelemetryCallback(context.eventEmission.emitMethodCalled, methodName), methodName);
-    return {
-        listApps: listAppsDefinition,
-        context: {
-            meta: {
-                listApps: {
-                    categories: ["app"],
-                    type: "list",
-                    itemType: "App",
-                    inputSchema: ListAppsSchema,
-                    outputSchema: AppItemSchema,
-                },
-            },
-        },
-    };
-};

package/dist/plugins/listApps/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/plugins/listApps/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../../src/plugins/listApps/index.test.ts"],"names":[],"mappings":""}

package/dist/plugins/listApps/index.test.js

@@ -1,121 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { ZapierValidationError } from "../../types/errors";
-import { listAppsPlugin } from "./index";
-import { createSdk } from "../../sdk";
-import { eventEmissionPlugin } from "../eventEmission";
-// Mock transport for testing - prevents real HTTP telemetry requests
-const mockTransport = {
-    emit: vi.fn().mockResolvedValue(undefined),
-    close: vi.fn().mockResolvedValue(undefined),
-};
-vi.mock("../eventEmission/transport", () => ({
-    createTransport: vi.fn(() => mockTransport),
-}));
-// Mock CLI login package - prevents real token resolution requests
-vi.mock("@zapier/zapier-sdk-cli-login", () => ({
-    getToken: vi.fn().mockResolvedValue(undefined),
-}));
-const mockResolveAppKeys = vi
-    .fn()
-    .mockImplementation(async ({ appKeys }) => {
-    return appKeys.map((appKey) => ({
-        lookupAppKey: appKey,
-        implementationName: appKey,
-        slug: appKey.toLowerCase(),
-        version: undefined,
-    }));
-});
-describe("listApps plugin", () => {
-    let mockApiClient;
-    beforeEach(() => {
-        vi.clearAllMocks();
-        mockApiClient = {
-            get: vi.fn().mockResolvedValue({
-                data: [
-                    {
-                        title: "Slack",
-                        key: "SlackCLIAPI",
-                        implementation_id: "SlackCLIAPI@1.0.0",
-                        version: "1.0.0",
-                        slug: "slack",
-                        description: "Team communication",
-                        primary_color: "#4A154B",
-                    },
-                    {
-                        title: "Google Sheets",
-                        key: "GoogleSheetsCLIAPI",
-                        implementation_id: "GoogleSheetsCLIAPI@1.0.0",
-                        version: "1.0.0",
-                        slug: "google-sheets",
-                        description: "Online spreadsheets",
-                        primary_color: "#34A853",
-                    },
-                ],
-                links: { next: null },
-                meta: { count: 2, limit: 100, offset: 0 },
-            }),
-        };
-    });
-    const apiPlugin = () => ({
-        context: {
-            api: mockApiClient,
-        },
-    });
-    function createTestSdk() {
-        return createSdk()
-            .addPlugin(() => ({
-            context: {
-                options: {},
-            },
-        }))
-            .addPlugin(apiPlugin)
-            .addPlugin(eventEmissionPlugin)
-            .addPlugin(() => ({
-            context: {
-                resolveAppKeys: mockResolveAppKeys,
-            },
-        }))
-            .addPlugin(listAppsPlugin);
-    }
-    describe("basic functionality", () => {
-        it("should provide listApps method that returns apps", async () => {
-            const sdk = createTestSdk();
-            const result = await sdk.listApps({ pageSize: 2 });
-            // Just verify the structure - handler tests verify correct data
-            expect(result.data.length).toBeGreaterThan(0);
-            expect(result.data[0]).toHaveProperty("title");
-            expect(result.data[0]).toHaveProperty("key");
-            expect(result.data[0]).toHaveProperty("implementation_id");
-            expect(result.data[0]).toHaveProperty("version");
-        });
-    });
-    describe("plugin integration", () => {
-        it("should provide metadata in context for CLI introspection", () => {
-            const sdk = createTestSdk();
-            const context = sdk.getContext();
-            expect(context.meta.listApps).toBeDefined();
-            expect(context.meta.listApps.inputSchema).toBeDefined();
-        });
-        it("should integrate with resolveAppKeys", async () => {
-            const sdk = createTestSdk();
-            await sdk.listApps({ appKeys: ["SlackCLIAPI"] });
-            // Verify resolveAppKeys was called with the provided appKeys
-            expect(mockResolveAppKeys).toHaveBeenCalledWith(expect.objectContaining({
-                appKeys: ["SlackCLIAPI"],
-            }));
-        });
-    });
-    describe("validation", () => {
-        it("should throw validation error for invalid input", () => {
-            const sdk = createTestSdk();
-            // Invalid pageSize
-            expect(() => {
-                sdk.listApps({ pageSize: 0 });
-            }).toThrow(ZapierValidationError);
-            // Invalid appKeys type
-            expect(() => {
-                sdk.listApps({ appKeys: 123 });
-            }).toThrow(ZapierValidationError);
-        });
-    });
-});

package/dist/plugins/listApps/schemas.d.ts

@@ -1,47 +0,0 @@
-/**
- * Plugin schemas for listApps
- *
- * Imports base query schema from @zapier/zapier-sdk-core (sdkapi) and extends
- * with SDK-specific options.
- *
- * Note: The sdkapi endpoint uses ListAppsQuerySchema (HTTP query params),
- * but the SDK exposes ListAppsSchema (user-friendly options):
- * - ListAppsOptions accepts `appKeys` as array, `cursor`, `maxItems`
- * - ListAppsQuery accepts `appKeys` as comma-separated string, `offset`
- * - The plugin transforms between these formats
- */
-import { z } from "zod";
-import type { PaginatedSdkFunction } from "../../types/functions";
-import type { ZapierApiError, ZapierValidationError } from "../../types/errors";
-import { AppItemSchema as AppItemSchemaBase, ListAppsResponseSchema as ListAppsResponseSchemaBase, type AppItem, type ListAppsResponse } from "@zapier/zapier-sdk-core/v0/schemas/apps";
-export { AppItemSchemaBase as AppItemSchema };
-export { ListAppsResponseSchemaBase as ListAppsResponseSchema };
-export type { AppItem, ListAppsResponse };
-/**
- * SDK user-facing options for listApps
- *
- * Extends ListAppsQuerySchema from zapier-sdk-core with SDK-specific options:
- * - appKeys: array (not comma-separated string)
- * - cursor: pagination cursor (not offset)
- * - maxItems: SDK-specific pagination limit
- */
-export declare const ListAppsSchema: z.ZodObject<{
-    search: z.ZodOptional<z.ZodString>;
-    appKeys: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    pageSize: z.ZodOptional<z.ZodNumber>;
-    maxItems: z.ZodOptional<z.ZodNumber>;
-    cursor: z.ZodOptional<z.ZodString>;
-    _telemetry: z.ZodOptional<z.ZodObject<{
-        isNested: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export type ListAppsOptions = z.infer<typeof ListAppsSchema>;
-export interface ListAppsPage {
-    data: AppItem[];
-    nextCursor?: string;
-}
-export type ListAppsError = ZapierApiError | ZapierValidationError;
-export interface ListAppsSdkFunction {
-    listApps: PaginatedSdkFunction<ListAppsOptions | undefined, AppItem>;
-}
-//# sourceMappingURL=schemas.d.ts.map

package/dist/plugins/listApps/schemas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/plugins/listApps/schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAIhF,OAAO,EACL,aAAa,IAAI,iBAAiB,EAClC,sBAAsB,IAAI,0BAA0B,EAEpD,KAAK,OAAO,EACZ,KAAK,gBAAgB,EACtB,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,iBAAiB,IAAI,aAAa,EAAE,CAAC;AAC9C,OAAO,EAAE,0BAA0B,IAAI,sBAAsB,EAAE,CAAC;AAChE,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAE1C;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;;;;;;;;iBAuBmC,CAAC;AAE/D,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAG7D,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG,qBAAqB,CAAC;AAGnE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,oBAAoB,CAAC,eAAe,GAAG,SAAS,EAAE,OAAO,CAAC,CAAC;CACtE"}

package/dist/plugins/listApps/schemas.js

@@ -1,49 +0,0 @@
-/**
- * Plugin schemas for listApps
- *
- * Imports base query schema from @zapier/zapier-sdk-core (sdkapi) and extends
- * with SDK-specific options.
- *
- * Note: The sdkapi endpoint uses ListAppsQuerySchema (HTTP query params),
- * but the SDK exposes ListAppsSchema (user-friendly options):
- * - ListAppsOptions accepts `appKeys` as array, `cursor`, `maxItems`
- * - ListAppsQuery accepts `appKeys` as comma-separated string, `offset`
- * - The plugin transforms between these formats
- */
-import { z } from "zod";
-import { TelemetryMarkerSchema } from "../../utils/function-utils";
-// Import schemas and types from @zapier/zapier-sdk-core (sdkapi)
-import { AppItemSchema as AppItemSchemaBase, ListAppsResponseSchema as ListAppsResponseSchemaBase, ListAppsQuerySchema as ListAppsQueryBase, } from "@zapier/zapier-sdk-core/v0/schemas/apps";
-// Re-export for consumers
-export { AppItemSchemaBase as AppItemSchema };
-export { ListAppsResponseSchemaBase as ListAppsResponseSchema };
-/**
- * SDK user-facing options for listApps
- *
- * Extends ListAppsQuerySchema from zapier-sdk-core with SDK-specific options:
- * - appKeys: array (not comma-separated string)
- * - cursor: pagination cursor (not offset)
- * - maxItems: SDK-specific pagination limit
- */
-export const ListAppsSchema = ListAppsQueryBase.omit({
-    offset: true,
-})
-    .extend({
-    // Override appKeys to be an array instead of comma-separated string
-    appKeys: z
-        .array(z.string())
-        .optional()
-        .describe("Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github')"),
-    // Override pageSize to make optional (base has default value)
-    pageSize: z.number().min(1).optional().describe("Number of apps per page"),
-    // SDK specific property for pagination/iterator helpers
-    maxItems: z
-        .number()
-        .min(1)
-        .optional()
-        .describe("Maximum total items to return across all pages"),
-    // SDK specific property for pagination/iterator helpers
-    cursor: z.string().optional().describe("Cursor to start from"),
-})
-    .merge(TelemetryMarkerSchema)
-    .describe("List all available apps with optional filtering");

package/dist/plugins/listAuthentications/index.d.ts

@@ -1,24 +0,0 @@
-import type { Plugin, GetSdkType } from "../../types/plugin";
-import type { ApiClient } from "../../api";
-import type { AuthenticationItem } from "@zapier/zapier-sdk-core/v0/schemas/authentications";
-import { ListAuthenticationsQuerySchema, type ListAuthenticationsOptions, type ListAuthenticationsPage } from "./schemas";
-import type { GetVersionedImplementationId } from "../manifest/schemas";
-import type { ManifestPluginProvides } from "../manifest";
-import type { EventEmissionContext } from "../eventEmission";
-export interface ListAuthenticationsPluginProvides {
-    listAuthentications: (options?: ListAuthenticationsOptions) => Promise<ListAuthenticationsPage> & AsyncIterable<ListAuthenticationsPage> & {
-        items(): AsyncIterable<AuthenticationItem>;
-    };
-    context: {
-        meta: {
-            listAuthentications: {
-                inputSchema: typeof ListAuthenticationsQuerySchema;
-            };
-        };
-    };
-}
-export declare const listAuthenticationsPlugin: Plugin<GetSdkType<ManifestPluginProvides>, {
-    api: ApiClient;
-    getVersionedImplementationId: GetVersionedImplementationId;
-} & EventEmissionContext, ListAuthenticationsPluginProvides>;
-//# sourceMappingURL=index.d.ts.map

package/dist/plugins/listAuthentications/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/listAuthentications/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC;AAC7F,OAAO,EACL,8BAA8B,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC7B,MAAM,WAAW,CAAC;AAInB,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAG1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAK7D,MAAM,WAAW,iCAAiC;IAChD,mBAAmB,EAAE,CACnB,OAAO,CAAC,EAAE,0BAA0B,KACjC,OAAO,CAAC,uBAAuB,CAAC,GACnC,aAAa,CAAC,uBAAuB,CAAC,GAAG;QACvC,KAAK,IAAI,aAAa,CAAC,kBAAkB,CAAC,CAAC;KAC5C,CAAC;IACJ,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,mBAAmB,EAAE;gBACnB,WAAW,EAAE,OAAO,8BAA8B,CAAC;aACpD,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAC5C,UAAU,CAAC,sBAAsB,CAAC,EAClC;IACE,GAAG,EAAE,SAAS,CAAC;IACf,4BAA4B,EAAE,4BAA4B,CAAC;CAC5D,GAAG,oBAAoB,EACxB,iCAAiC,CAiGlC,CAAC"}

package/dist/plugins/listAuthentications/index.js

@@ -1,77 +0,0 @@
-import { ListAuthenticationsQuerySchema, } from "./schemas";
-import { splitVersionedKey } from "../../utils/domain-utils";
-import { createPaginatedFunction } from "../../utils/function-utils";
-import { appKeyResolver } from "../../resolvers";
-import { AuthenticationItemSchema } from "../../schemas/Auth";
-import { createTelemetryCallback } from "../../utils/telemetry-utils";
-import { stripPageSuffix } from "../../utils/string-utils";
-import { ZapierAuthenticationError } from "../../types/errors";
-export const listAuthenticationsPlugin = ({ context }) => {
-    async function listAuthenticationsPage(options) {
-        const { api, getVersionedImplementationId } = context;
-        const searchParams = {
-            pageSize: options.pageSize.toString(),
-        };
-        // Resolve appKey to implementationId if provided
-        if (options.appKey) {
-            const implementationId = await getVersionedImplementationId(options.appKey);
-            if (implementationId) {
-                // Extract versionless app key to pass to handler
-                const [versionlessSelectedApi] = splitVersionedKey(implementationId);
-                searchParams.appKey = versionlessSelectedApi;
-            }
-        }
-        // Pass other filter options as searchParams
-        if (options.authenticationIds && options.authenticationIds.length > 0) {
-            searchParams.authenticationIds = options.authenticationIds.join(",");
-        }
-        if (options.search) {
-            searchParams.search = options.search;
-        }
-        if (options.title) {
-            searchParams.title = options.title;
-        }
-        if (options.accountId) {
-            searchParams.accountId = options.accountId;
-        }
-        if (options.owner) {
-            searchParams.owner = options.owner;
-        }
-        if (options.cursor) {
-            searchParams.offset = options.cursor;
-        }
-        const response = await api.get("/api/v0/authentications", {
-            searchParams,
-            customErrorHandler: ({ status }) => {
-                if (status === 401) {
-                    return new ZapierAuthenticationError(`Authentication failed. Your token may not have permission to access authentications or may be expired. (HTTP ${status})`, { statusCode: status });
-                }
-                if (status === 403) {
-                    return new ZapierAuthenticationError(`Access forbidden. Your token may not have the required scopes to list authentications. (HTTP ${status})`, { statusCode: status });
-                }
-                return undefined;
-            },
-            authRequired: true,
-        });
-        return response;
-    }
-    const methodName = stripPageSuffix(listAuthenticationsPage.name);
-    const listAuthenticationsDefinition = createPaginatedFunction(listAuthenticationsPage, ListAuthenticationsQuerySchema, createTelemetryCallback(context.eventEmission.emitMethodCalled, methodName), methodName);
-    return {
-        listAuthentications: listAuthenticationsDefinition,
-        context: {
-            meta: {
-                listAuthentications: {
-                    categories: ["authentication"],
-                    type: "list",
-                    itemType: "Authentication",
-                    inputSchema: ListAuthenticationsQuerySchema,
-                    outputSchema: AuthenticationItemSchema,
-                    resolvers: {
-                        appKey: appKeyResolver,
-                    },
-                },
-            },
-        },
-    };
-};

package/dist/plugins/listAuthentications/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/plugins/listAuthentications/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../../src/plugins/listAuthentications/index.test.ts"],"names":[],"mappings":""}