@zapier/zapier-sdk 0.0.2 → 0.0.3

package/dist/functions/getAction.d.ts

@@ -0,0 +1,16 @@
+import type { Action, FunctionConfig } from "../types";
+export interface GetActionOptions extends FunctionConfig {
+    app: string;
+    action: string;
+    type: string;
+}
+/**
+ * Get a specific action by app, action key, and type
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - App key, action key, type, and API configuration options
+ * @returns Promise<Action>
+ */
+export declare function getAction(options: GetActionOptions): Promise<Action>;

package/dist/functions/getAction.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAction = getAction;
+const listActions_1 = require("./listActions");
+/**
+ * Get a specific action by app, action key, and type
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - App key, action key, type, and API configuration options
+ * @returns Promise<Action>
+ */
+async function getAction(options) {
+    const { app, action: actionKey, type } = options;
+    const actions = await (0, listActions_1.listActions)({
+        ...options,
+        appKey: app,
+    });
+    const action = actions.find((a) => a.key === actionKey && a.type === type);
+    if (!action) {
+        throw new Error(`Action not found: ${actionKey} with type ${type}`);
+    }
+    return action;
+}

package/dist/functions/getApp.d.ts

@@ -0,0 +1,14 @@
+import type { Integration, FunctionConfig } from "../types";
+export interface GetAppOptions extends FunctionConfig {
+    key: string;
+}
+/**
+ * Get a specific app by key
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - App key and API configuration options
+ * @returns Promise<Integration>
+ */
+export declare function getApp(options: GetAppOptions): Promise<Integration>;

package/dist/functions/getApp.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApp = getApp;
+const api_1 = require("../api");
+/**
+ * Get a specific app by key
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - App key and API configuration options
+ * @returns Promise<Integration>
+ */
+async function getApp(options) {
+    const api = (0, api_1.getOrCreateApiClient)(options);
+    const { key } = options;
+    const app = await api.get(`/api/v4/apps/${key}/`, {
+        customErrorHandler: (response) => {
+            if (response.status === 404) {
+                const AppNotFoundError = class extends Error {
+                    constructor(appKey) {
+                        super(`App not found: ${appKey}`);
+                        this.name = "AppNotFoundError";
+                    }
+                };
+                return new AppNotFoundError(key);
+            }
+            return undefined;
+        },
+    });
+    return {
+        key: app.slug,
+        name: app.name,
+        description: app.description,
+        version: "1.0.0",
+        category: app.category?.name,
+        actions: [],
+        triggers: [],
+        current_implementation_id: app.current_implementation_id,
+    };
+}

package/dist/functions/listActions.d.ts

@@ -0,0 +1,15 @@
+import type { Action, FunctionConfig } from "../types";
+export interface ListActionsOptions extends FunctionConfig {
+    appKey?: string;
+    type?: string;
+}
+/**
+ * List available actions with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering and API configuration options
+ * @returns Promise<Action[]> with pagination metadata
+ */
+export declare function listActions(options?: ListActionsOptions): Promise<Action[]>;

package/dist/functions/listActions.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listActions = listActions;
+const api_1 = require("../api");
+const getApp_1 = require("./getApp");
+/**
+ * List available actions with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering and API configuration options
+ * @returns Promise<Action[]> with pagination metadata
+ */
+async function listActions(options = {}) {
+    const api = (0, api_1.getOrCreateApiClient)(options);
+    // If filtering by appKey, use optimized approach with selected_apis parameter
+    if (options.appKey) {
+        try {
+            // Use the standalone getApp function
+            const appData = await (0, getApp_1.getApp)({
+                key: options.appKey,
+                api,
+                token: options.token,
+                baseUrl: options.baseUrl,
+                debug: options.debug,
+                fetch: options.fetch,
+            });
+            // Extract implementation name from current_implementation_id (e.g., "SlackCLIAPI@1.20.0" -> "SlackCLIAPI")
+            const implementationId = appData.current_implementation_id?.split("@")[0];
+            if (!implementationId) {
+                throw new Error("No current_implementation_id found for app");
+            }
+            const searchParams = {
+                global: "true",
+                public_only: "true",
+                selected_apis: implementationId,
+            };
+            const data = await api.get("/api/v4/implementations/", {
+                searchParams,
+            });
+            const actions = [];
+            // Transform implementations to actions
+            for (const implementation of data.results || []) {
+                if (implementation.actions) {
+                    for (const action of implementation.actions) {
+                        const transformedAction = {
+                            key: action.key,
+                            name: action.name || action.label,
+                            description: action.description || "",
+                            appKey: implementation.slug || "",
+                            type: action.type || action.type_of || "read",
+                            inputFields: [], // Would need additional API call for detailed fields
+                            outputFields: [],
+                        };
+                        // Apply type filter if provided
+                        if (options?.type && transformedAction.type !== options.type) {
+                            continue;
+                        }
+                        actions.push(transformedAction);
+                    }
+                }
+            }
+            // Add pagination metadata for app-specific queries
+            if (actions.length > 0) {
+                actions.__pagination = {
+                    count: data.count,
+                    hasNext: !!data.next,
+                    hasPrevious: !!data.previous,
+                    nextUrl: data.next,
+                    previousUrl: data.previous,
+                };
+            }
+            return actions;
+        }
+        catch (error) {
+            // If it's an AppNotFoundError, don't try fallback - just re-throw
+            if (error instanceof Error && error.name === "AppNotFoundError") {
+                throw error;
+            }
+            // Fallback to original approach if optimized approach fails
+            console.warn("Optimized app lookup failed, falling back to full scan:", error);
+        }
+    }
+    // Original approach for general queries or when optimization fails
+    const searchParams = {
+        global: "true",
+        public_only: "true",
+    };
+    const data = await api.get("/api/v4/implementations/", { searchParams });
+    const actions = [];
+    // Transform implementations to actions
+    for (const implementation of data.results || []) {
+        if (implementation.actions) {
+            for (const action of implementation.actions) {
+                const transformedAction = {
+                    key: action.key,
+                    name: action.name || action.label,
+                    description: action.description || "",
+                    appKey: implementation.slug || "",
+                    type: action.type || action.type_of || "read",
+                    inputFields: [], // Would need additional API call for detailed fields
+                    outputFields: [],
+                };
+                // Apply filters
+                if (options?.appKey && transformedAction.appKey !== options.appKey) {
+                    continue;
+                }
+                if (options?.type && transformedAction.type !== options.type) {
+                    continue;
+                }
+                actions.push(transformedAction);
+            }
+        }
+    }
+    // Add pagination metadata for general queries
+    if (actions.length > 0) {
+        actions.__pagination = {
+            count: data.count,
+            hasNext: !!data.next,
+            hasPrevious: !!data.previous,
+            nextUrl: data.next,
+            previousUrl: data.previous,
+        };
+    }
+    return actions;
+}

package/dist/functions/listApps.d.ts

@@ -0,0 +1,16 @@
+import type { Integration, FunctionConfig } from "../types";
+export interface ListAppsOptions extends FunctionConfig {
+    category?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * List available apps with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering, pagination, and API configuration options
+ * @returns Promise<Integration[]> with pagination metadata
+ */
+export declare function listApps(options?: ListAppsOptions): Promise<Integration[]>;

package/dist/functions/listApps.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listApps = listApps;
+const api_1 = require("../api");
+/**
+ * List available apps with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering, pagination, and API configuration options
+ * @returns Promise<Integration[]> with pagination metadata
+ */
+async function listApps(options = {}) {
+    const api = (0, api_1.getOrCreateApiClient)(options);
+    // Build search parameters
+    const searchParams = {};
+    if (options.category) {
+        searchParams.category = options.category;
+    }
+    if (options.limit) {
+        searchParams.limit = options.limit.toString();
+    }
+    if (options.offset) {
+        searchParams.offset = options.offset.toString();
+    }
+    const data = await api.get("/api/v4/apps/", { searchParams });
+    // Transform API response to our Integration interface
+    const apps = data.results?.map((app) => ({
+        key: app.slug,
+        name: app.name,
+        description: app.description,
+        version: "1.0.0", // API doesn't provide version
+        category: app.category?.name,
+        actions: [], // Will be populated separately
+        triggers: [],
+        current_implementation_id: app.current_implementation_id,
+    })) || [];
+    // Add pagination metadata to the response
+    if (apps.length > 0) {
+        apps.__pagination = {
+            count: data.count,
+            hasNext: !!data.next,
+            hasPrevious: !!data.previous,
+            nextUrl: data.next,
+            previousUrl: data.previous,
+        };
+    }
+    return apps;
+}

package/dist/functions/listAuths.d.ts

@@ -0,0 +1,18 @@
+import type { Authentication, FunctionConfig } from "../types";
+export interface ListAuthsOptions extends FunctionConfig {
+    appKey?: string;
+    account_id?: string;
+    owner?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * List available authentications with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering, pagination, and API configuration options
+ * @returns Promise<Authentication[]> with pagination metadata
+ */
+export declare function listAuths(options?: ListAuthsOptions): Promise<Authentication[]>;

package/dist/functions/listAuths.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listAuths = listAuths;
+const api_1 = require("../api");
+const getApp_1 = require("./getApp");
+/**
+ * List available authentications with optional filtering
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Filtering, pagination, and API configuration options
+ * @returns Promise<Authentication[]> with pagination metadata
+ */
+async function listAuths(options = {}) {
+    const { token } = options;
+    if (!token && !process.env.ZAPIER_TOKEN) {
+        throw new Error("Authentication token is required to list authentications. Please provide token in options or set ZAPIER_TOKEN environment variable.");
+    }
+    const api = (0, api_1.getOrCreateApiClient)(options);
+    // Local function to handle the actual API fetching
+    const listAuthsInternal = async (options = {}) => {
+        // Build search parameters
+        const searchParams = {};
+        // Handle appKey filtering by getting the selected_api first
+        if (options.appKey) {
+            try {
+                // Use the standalone getApp function
+                const app = await (0, getApp_1.getApp)({
+                    key: options.appKey,
+                    api,
+                    token: options.token,
+                    baseUrl: options.baseUrl,
+                    debug: options.debug,
+                    fetch: options.fetch,
+                });
+                const selectedApi = app.current_implementation_id;
+                if (selectedApi) {
+                    // Use versionless_selected_api to find auths across all app versions
+                    // Extract the base name without the version (e.g., "SlackCLIAPI" from "SlackCLIAPI@1.21.1")
+                    const versionlessApi = selectedApi.split("@")[0];
+                    searchParams.versionless_selected_api = versionlessApi;
+                }
+            }
+            catch (error) {
+                // If it's an AppNotFoundError, re-throw it
+                if (error instanceof Error && error.name === "AppNotFoundError") {
+                    throw error;
+                }
+                // For other errors, continue without app filtering
+                console.warn(`Warning: Could not filter by app ${options.appKey}:`, error instanceof Error ? error.message : "Unknown error");
+            }
+        }
+        // Add other query parameters if provided
+        if (options.account_id) {
+            searchParams.account_id = options.account_id;
+        }
+        if (options.owner) {
+            searchParams.owner = options.owner;
+        }
+        if (options.limit) {
+            searchParams.limit = options.limit.toString();
+        }
+        if (options.offset) {
+            searchParams.offset = options.offset.toString();
+        }
+        const data = await api.get("/api/v4/authentications/", {
+            searchParams,
+            customErrorHandler: (response) => {
+                if (response.status === 401) {
+                    return new Error(`Authentication failed. Your token may not have permission to access authentications or may be expired. (HTTP ${response.status})`);
+                }
+                if (response.status === 403) {
+                    return new Error(`Access forbidden. Your token may not have the required scopes to list authentications. (HTTP ${response.status})`);
+                }
+                return undefined;
+            },
+        });
+        // Transform API response
+        const auths = data.results || [];
+        // Add pagination metadata to the response
+        if (auths.length > 0) {
+            auths.__pagination = {
+                count: data.count,
+                hasNext: !!data.next,
+                hasPrevious: !!data.previous,
+                nextUrl: data.next,
+                previousUrl: data.previous,
+            };
+        }
+        return auths;
+    };
+    // If a limit is provided and no specific owner filter, prioritize owned auths
+    if (options.limit && options.owner === undefined) {
+        // First get owned auths
+        const ownedAuths = await listAuthsInternal({
+            ...options,
+            owner: "me",
+        });
+        // If we have enough owned auths, just slice and return
+        if (ownedAuths.length >= options.limit) {
+            return ownedAuths.slice(0, options.limit);
+        }
+        // Get all auths up to the original limit to fill remaining slots
+        const allAuths = await listAuthsInternal({
+            ...options,
+            owner: undefined,
+        });
+        // Filter out auths the user already owns to avoid duplicates
+        const ownedAuthIds = new Set(ownedAuths.map((auth) => auth.id));
+        const additionalAuths = allAuths.filter((auth) => !ownedAuthIds.has(auth.id));
+        // Combine and slice to the requested limit
+        const combined = [...ownedAuths, ...additionalAuths];
+        return combined.slice(0, options.limit);
+    }
+    // Standard implementation for non-prioritized requests
+    return listAuthsInternal(options);
+}

package/dist/functions/listFields.d.ts

@@ -0,0 +1,18 @@
+import type { ActionField, FunctionConfig } from "../types";
+export interface ListFieldsOptions extends FunctionConfig {
+    app: string;
+    action: string;
+    type: string;
+    authId?: number;
+    params?: Record<string, any>;
+}
+/**
+ * List available fields for an action
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Action details, auth ID, params, and API configuration options
+ * @returns Promise<ActionField[]>
+ */
+export declare function listFields(options: ListFieldsOptions): Promise<ActionField[]>;

package/dist/functions/listFields.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFields = listFields;
+const api_1 = require("../api");
+const getApp_1 = require("./getApp");
+/**
+ * List available fields for an action
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Action details, auth ID, params, and API configuration options
+ * @returns Promise<ActionField[]>
+ */
+async function listFields(options) {
+    const api = (0, api_1.getOrCreateApiClient)(options);
+    // Map consistent parameter names to internal API names
+    const { app, action, type, authId, params } = options;
+    const appKey = app;
+    const actionKey = action;
+    const actionType = type;
+    // Use the standalone getApp function
+    const appData = await (0, getApp_1.getApp)({
+        key: appKey,
+        api,
+        token: options.token,
+        baseUrl: options.baseUrl,
+        debug: options.debug,
+        fetch: options.fetch,
+    });
+    const selectedApi = appData.current_implementation_id;
+    if (!selectedApi) {
+        throw new Error("No current_implementation_id found for app");
+    }
+    // Build needs request
+    const needsRequest = {
+        selected_api: selectedApi,
+        action: actionKey,
+        type_of: actionType,
+        authentication_id: authId,
+        params: params || {},
+    };
+    const needsData = await api.post("/api/v4/implementations/needs/", needsRequest);
+    if (!needsData.success) {
+        throw new Error(`Failed to get action fields: ${needsData.errors?.join(", ") || "Unknown error"}`);
+    }
+    // Transform API response to our ActionField interface
+    return (needsData.needs || []).map((need) => ({
+        key: need.key,
+        label: need.label,
+        required: need.required || false,
+        type: need.type,
+        helpText: need.help_text,
+        helpTextHtml: need.help_text_html,
+        choices: need.choices?.map((choice) => ({
+            value: choice.value,
+            label: choice.label,
+        })),
+        default: need.default,
+        placeholder: need.placeholder,
+        computed: need.computed,
+        customField: need.custom_field,
+        dependsOn: need.depends_on,
+        format: need.format,
+        inputFormat: need.input_format,
+    }));
+}

package/dist/functions/runAction.d.ts

@@ -0,0 +1,18 @@
+import type { ActionExecutionResult, FunctionConfig } from "../types";
+export interface RunActionOptions extends FunctionConfig {
+    app: string;
+    type: string;
+    action: string;
+    inputs?: Record<string, any>;
+    authId?: number;
+}
+/**
+ * Execute an action
+ *
+ * This function can be used standalone without instantiating a full SDK,
+ * which enables better tree-shaking in applications that only need this functionality.
+ *
+ * @param options - Action execution parameters and API configuration options
+ * @returns Promise<ActionExecutionResult>
+ */
+export declare function runAction(options: RunActionOptions): Promise<ActionExecutionResult>;