@zapier/zapier-sdk 0.2.0 → 0.3.0

package/dist/functions/runAction/index.js

@@ -14,7 +14,7 @@ const getApp_1 = require("../getApp");
  * @returns Promise<ActionExecutionResult>
  */
 async function runAction(options) {
-    const { appKey, actionType, actionKey, inputs, authenticationId: providedAuthenticationId, token, } = options;
+    const { appKey, actionType, actionKey, inputs, authenticationId: providedAuthenticationId, } = options;
     const api = (0, api_1.getOrCreateApiClient)(options);
     api.requireAuthTo("run actions");
     // Validate that the action exists
@@ -28,17 +28,15 @@ async function runAction(options) {
     if (actionData.type !== actionType) {
         throw new Error(`Action type mismatch: expected ${actionType}, got ${actionData.type}`);
     }
-    // Execute the action using the appropriate API based on action type
+    // Execute the action using the Actions API (supports all action types)
     const startTime = Date.now();
-    const result = await executeActionWithStrategy({
+    const result = await executeAction({
         api,
         appSlug: appKey,
         actionKey: actionKey,
         actionType: actionData.type,
         executionOptions: { inputs: inputs || {} },
-        auth: token
-            ? { token: token, authentication_id: providedAuthenticationId }
-            : undefined,
+        authenticationId: providedAuthenticationId,
         options,
     });
     const executionTime = Date.now() - startTime;
@@ -51,37 +49,8 @@ async function runAction(options) {
         },
     };
 }
-async function executeActionWithStrategy(strategyOptions) {
-    const { api, appSlug, actionKey, actionType, executionOptions, auth, options, } = strategyOptions;
-    // Actions API supports: read, read_bulk, write
-    // Invoke API supports: search, read, write, read_bulk, and more
-    const actionsApiTypes = ["read", "read_bulk", "write"];
-    const useActionsApi = actionsApiTypes.includes(actionType);
-    if (useActionsApi) {
-        return executeActionViaActionsApi({
-            api,
-            appSlug,
-            actionKey,
-            actionType,
-            executionOptions,
-            auth,
-            options,
-        });
-    }
-    else {
-        return executeActionViaInvokeApi({
-            api,
-            appSlug,
-            actionKey,
-            actionType,
-            executionOptions,
-            auth,
-            options,
-        });
-    }
-}
-async function executeActionViaActionsApi(apiOptions) {
-    const { api, appSlug, actionKey, actionType, executionOptions, auth, options, } = apiOptions;
+async function executeAction(actionOptions) {
+    const { api, appSlug, actionKey, actionType, executionOptions, authenticationId, options, } = actionOptions;
     // Use the standalone getApp function
     const appData = await (0, getApp_1.getApp)({
         appKey: appSlug,
@@ -95,13 +64,10 @@ async function executeActionViaActionsApi(apiOptions) {
     if (!selectedApi) {
         throw new Error("No current_implementation_id found for app");
     }
-    if (!auth?.token) {
-        throw new Error("Authentication token is required. Please provide token when creating the SDK.");
-    }
     // Step 1: POST to /actions/v1/runs to start execution
     const runRequest = {
         data: {
-            authentication_id: auth.authentication_id || 1,
+            authentication_id: authenticationId || 1,
             selected_api: selectedApi,
             action_key: actionKey,
             action_type: actionType,
@@ -117,39 +83,4 @@ async function executeActionViaActionsApi(apiOptions) {
         resultExtractor: (result) => result.data,
     });
 }
-async function executeActionViaInvokeApi(apiOptions) {
-    const { api, appSlug, actionKey, actionType, executionOptions, auth, options, } = apiOptions;
-    // Use the standalone getApp function
-    const appData = await (0, getApp_1.getApp)({
-        appKey: appSlug,
-        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");
-    }
-    if (!auth?.token) {
-        throw new Error("Authentication token is required. Please provide token when creating the SDK.");
-    }
-    // Step 1: POST to /invoke/v1/invoke to start execution
-    const invokeRequest = {
-        selected_api: selectedApi,
-        action: actionKey,
-        type_of: actionType,
-        authentication_id: auth.authentication_id || 1,
-        params: executionOptions.inputs || {},
-    };
-    const invokeData = await api.post("/api/invoke/v1/invoke", invokeRequest);
-    const invocationId = invokeData.invocation_id;
-    // Step 2: Poll GET /invoke/v1/invoke/{invocation_id} for results
-    return await api.poll(`/api/invoke/v1/invoke/${invocationId}`, {
-        successStatus: 200,
-        pendingStatus: 202,
-        resultExtractor: (result) => result.results || result,
-    });
-}
 // No registry info here - moved to info.ts for proper tree-shaking

package/dist/functions/runAction/info.d.ts

@@ -3,19 +3,19 @@ export declare const runActionInfo: {
     name: string;
     inputSchema: import("zod").ZodObject<{
         appKey: import("zod").ZodString;
-        actionType: import("zod").ZodEnum<["read", "write", "search", "create", "update", "delete"]>;
+        actionType: import("zod").ZodEnum<["read", "read_bulk", "write", "run", "search", "search_or_write", "search_and_write", "filter"]>;
         actionKey: import("zod").ZodString;
         inputs: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
         authenticationId: import("zod").ZodOptional<import("zod").ZodNumber>;
     }, "strip", import("zod").ZodTypeAny, {
         appKey: string;
-        actionType: "create" | "update" | "search" | "delete" | "read" | "write";
+        actionType: "read" | "read_bulk" | "write" | "run" | "search" | "search_or_write" | "search_and_write" | "filter";
         actionKey: string;
         inputs?: Record<string, any> | undefined;
         authenticationId?: number | undefined;
     }, {
         appKey: string;
-        actionType: "create" | "update" | "search" | "delete" | "read" | "write";
+        actionType: "read" | "read_bulk" | "write" | "run" | "search" | "search_or_write" | "search_and_write" | "filter";
         actionKey: string;
         inputs?: Record<string, any> | undefined;
         authenticationId?: number | undefined;

package/dist/functions/runAction/schemas.d.ts

@@ -2,19 +2,19 @@ import { z } from "zod";
 import type { ActionExecutionResult } from "../../types/domain";
 export declare const RunActionSchema: z.ZodObject<{
     appKey: z.ZodString;
-    actionType: z.ZodEnum<["read", "write", "search", "create", "update", "delete"]>;
+    actionType: z.ZodEnum<["read", "read_bulk", "write", "run", "search", "search_or_write", "search_and_write", "filter"]>;
     actionKey: z.ZodString;
     inputs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     authenticationId: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     appKey: string;
-    actionType: "create" | "update" | "search" | "delete" | "read" | "write";
+    actionType: "read" | "read_bulk" | "write" | "run" | "search" | "search_or_write" | "search_and_write" | "filter";
     actionKey: string;
     inputs?: Record<string, any> | undefined;
     authenticationId?: number | undefined;
 }, {
     appKey: string;
-    actionType: "create" | "update" | "search" | "delete" | "read" | "write";
+    actionType: "read" | "read_bulk" | "write" | "run" | "search" | "search_or_write" | "search_and_write" | "filter";
     actionKey: string;
     inputs?: Record<string, any> | undefined;
     authenticationId?: number | undefined;

package/dist/index.d.ts

@@ -2,8 +2,10 @@ export * from "./types/domain";
 export * from "./types/properties";
 export * from "./plugins/apps";
 export { isPositional } from "./schema-utils";
+export * from "./auth";
 export * from "./resolvers";
 export { listAuthentications } from "./functions/listAuthentications";
+export { getAuthentication } from "./functions/getAuthentication";
 export { findFirstAuthentication } from "./functions/findFirstAuthentication";
 export { findUniqueAuthentication } from "./functions/findUniqueAuthentication";
 export { listApps } from "./functions/listApps";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createZapierSdk = exports.bundleCode = exports.generateTypes = exports.listFields = exports.runAction = exports.getAction = exports.listActions = exports.getApp = exports.listApps = exports.findUniqueAuthentication = exports.findFirstAuthentication = exports.listAuthentications = exports.isPositional = void 0;
+exports.createZapierSdk = exports.bundleCode = exports.generateTypes = exports.listFields = exports.runAction = exports.getAction = exports.listActions = exports.getApp = exports.listApps = exports.findUniqueAuthentication = exports.findFirstAuthentication = exports.getAuthentication = exports.listAuthentications = exports.isPositional = void 0;
 // Export everything from types and plugins
 __exportStar(require("./types/domain"), exports);
 __exportStar(require("./types/properties"), exports);
@@ -22,12 +22,16 @@ __exportStar(require("./plugins/apps"), exports);
 // Export schema utilities for CLI
 var schema_utils_1 = require("./schema-utils");
 Object.defineProperty(exports, "isPositional", { enumerable: true, get: function () { return schema_utils_1.isPositional; } });
+// Export auth utilities for CLI use
+__exportStar(require("./auth"), exports);
 // Export resolvers for CLI use
 __exportStar(require("./resolvers"), exports);
 // Note: SdkSchemas is now available via SDK.__registry
 // Export individual functions for tree-shaking
 var listAuthentications_1 = require("./functions/listAuthentications");
 Object.defineProperty(exports, "listAuthentications", { enumerable: true, get: function () { return listAuthentications_1.listAuthentications; } });
+var getAuthentication_1 = require("./functions/getAuthentication");
+Object.defineProperty(exports, "getAuthentication", { enumerable: true, get: function () { return getAuthentication_1.getAuthentication; } });
 var findFirstAuthentication_1 = require("./functions/findFirstAuthentication");
 Object.defineProperty(exports, "findFirstAuthentication", { enumerable: true, get: function () { return findFirstAuthentication_1.findFirstAuthentication; } });
 var findUniqueAuthentication_1 = require("./functions/findUniqueAuthentication");

package/dist/sdk.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createZapierSdk = createZapierSdk;
 const api_1 = require("./api");
+const auth_1 = require("./auth");
 // Import function implementations
 const listApps_1 = require("./functions/listApps");
 const getApp_1 = require("./functions/getApp");
@@ -9,6 +10,7 @@ const listActions_1 = require("./functions/listActions");
 const getAction_1 = require("./functions/getAction");
 const runAction_1 = require("./functions/runAction");
 const listAuthentications_1 = require("./functions/listAuthentications");
+const getAuthentication_1 = require("./functions/getAuthentication");
 const findFirstAuthentication_1 = require("./functions/findFirstAuthentication");
 const findUniqueAuthentication_1 = require("./functions/findUniqueAuthentication");
 const listFields_1 = require("./functions/listFields");
@@ -21,11 +23,12 @@ const info_3 = require("./functions/listActions/info");
 const info_4 = require("./functions/getAction/info");
 const info_5 = require("./functions/runAction/info");
 const info_6 = require("./functions/listAuthentications/info");
-const info_7 = require("./functions/findFirstAuthentication/info");
-const info_8 = require("./functions/findUniqueAuthentication/info");
-const info_9 = require("./functions/listFields/info");
-const info_10 = require("./functions/generateTypes/info");
-const info_11 = require("./functions/bundleCode/info");
+const info_7 = require("./functions/getAuthentication/info");
+const info_8 = require("./functions/findFirstAuthentication/info");
+const info_9 = require("./functions/findUniqueAuthentication/info");
+const info_10 = require("./functions/listFields/info");
+const info_11 = require("./functions/generateTypes/info");
+const info_12 = require("./functions/bundleCode/info");
 // Function registry as array - uses names from function info objects
 const functionRegistry = [
     info_1.listAppsInfo,
@@ -34,26 +37,37 @@ const functionRegistry = [
     info_4.getActionInfo,
     info_5.runActionInfo,
     info_6.listAuthenticationsInfo,
-    info_7.findFirstAuthenticationInfo,
-    info_8.findUniqueAuthenticationInfo,
-    info_9.listFieldsInfo,
-    info_10.generateTypesInfo,
-    info_11.bundleCodeInfo,
+    info_7.getAuthenticationInfo,
+    info_8.findFirstAuthenticationInfo,
+    info_9.findUniqueAuthenticationInfo,
+    info_10.listFieldsInfo,
+    info_11.generateTypesInfo,
+    info_12.bundleCodeInfo,
 ];
 // Import plugin functions
 const index_1 = require("./plugins/apps/index");
-function createBaseZapierSdk(options = {}) {
-    const { fetch: customFetch = globalThis.fetch, baseUrl = "https://zapier.com", token, getToken, debug = false, } = options;
+function createZapierSdk(options = {}) {
+    const { fetch: customFetch = globalThis.fetch, baseUrl = "https://zapier.com", token, getToken, onEvent, debug = false, } = options;
+    // If no explicit token or getToken provided, try env var then CLI config with event callbacks
+    const resolvedGetToken = getToken ||
+        (!token
+            ? () => (0, auth_1.getTokenFromEnvOrConfig)({ onEvent, fetch: customFetch })
+            : undefined);
     // Create the API client
     const api = (0, api_1.createZapierApi)({
         baseUrl,
         token,
-        getToken,
+        getToken: resolvedGetToken,
         debug,
         fetch: customFetch,
     });
-    // Build SDK directly - TypeScript will enforce correct implementation
-    const sdk = {
+    // Create plugins directly - TypeScript will enforce correct implementation
+    const appsPlugin = (0, index_1.createAppsPlugin)({
+        api,
+        token,
+    });
+    // Compose final SDK - TypeScript will enforce we have all required properties
+    const fullSdk = {
         // Registry for CLI
         __registry: functionRegistry,
         // Function implementations with API config injection
@@ -63,35 +77,13 @@ function createBaseZapierSdk(options = {}) {
         getAction: (options) => (0, getAction_1.getAction)({ ...options, api }),
         runAction: (options) => (0, runAction_1.runAction)({ ...options, api }),
         listAuthentications: (options = {}) => (0, listAuthentications_1.listAuthentications)({ ...options, api }),
+        getAuthentication: (options) => (0, getAuthentication_1.getAuthentication)({ ...options, api }),
         findFirstAuthentication: (options = {}) => (0, findFirstAuthentication_1.findFirstAuthentication)({ ...options, api }),
         findUniqueAuthentication: (options = {}) => (0, findUniqueAuthentication_1.findUniqueAuthentication)({ ...options, api }),
         listFields: (options) => (0, listFields_1.listFields)({ ...options, api }),
         generateTypes: (options) => (0, generateTypes_1.generateTypes)({ ...options, api }),
         bundleCode: (options) => (0, bundleCode_1.bundleCode)(options), // No API config needed
-    };
-    return sdk;
-}
-function createZapierSdk(options = {}) {
-    // Create base SDK
-    const baseSdk = createBaseZapierSdk(options);
-    // Extract options needed for plugins
-    const { fetch: customFetch = globalThis.fetch, baseUrl = "https://zapier.com", token, getToken, debug = false, } = options;
-    // Create the API client for plugins
-    const api = (0, api_1.createZapierApi)({
-        baseUrl,
-        token,
-        getToken,
-        debug,
-        fetch: customFetch,
-    });
-    // Create plugins directly - TypeScript will enforce correct implementation
-    const appsPlugin = (0, index_1.createAppsPlugin)({
-        api,
-        token,
-    });
-    // Compose final SDK - TypeScript will enforce we have all required properties
-    const fullSdk = {
-        ...baseSdk,
+        // Add plugins
         apps: appsPlugin,
     };
     return fullSdk;

package/dist/types/domain.d.ts

@@ -1,4 +1,5 @@
 export type { Integration, Action, Trigger, Field, Choice, ActionExecutionResult, ActionField, ActionFieldChoice, NeedsRequest, NeedsResponse, Authentication, AuthenticationsResponse, } from "../api/types";
+import type { EventCallback } from "./events";
 export interface ActionExecutionOptions {
     inputs?: Record<string, any>;
     authenticationId?: number;
@@ -9,6 +10,7 @@ export interface AuthObject {
 export interface BaseSdkOptions {
     token?: string;
     getToken?: () => Promise<string | undefined>;
+    onEvent?: EventCallback;
     fetch?: typeof fetch;
     baseUrl?: string;
     debug?: boolean;

package/dist/types/events.d.ts

@@ -0,0 +1,37 @@
+/**
+ * SDK Event System
+ *
+ * This module provides common event type definitions for the SDK's
+ * event system, including authentication, API, and loading events.
+ */
+export interface SdkEvent {
+    type: string;
+    payload?: Record<string, any>;
+    timestamp?: number;
+}
+export interface AuthEvent extends SdkEvent {
+    type: "auth_refreshing" | "auth_success" | "auth_error" | "auth_logout";
+    payload?: {
+        message?: string;
+        error?: string;
+        operation?: string;
+    };
+}
+export interface ApiEvent extends SdkEvent {
+    type: "api_request" | "api_response" | "api_error";
+    payload?: {
+        url?: string;
+        method?: string;
+        status?: number;
+        duration?: number;
+        error?: string;
+    };
+}
+export interface LoadingEvent extends SdkEvent {
+    type: "loading_start" | "loading_end";
+    payload?: {
+        operation?: string;
+        resource?: string;
+    };
+}
+export type EventCallback = (event: SdkEvent) => void;

package/dist/types/events.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * SDK Event System
+ *
+ * This module provides common event type definitions for the SDK's
+ * event system, including authentication, API, and loading events.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/properties.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 export declare const AppKeyPropertySchema: z.ZodString;
-export declare const ActionTypePropertySchema: z.ZodEnum<["read", "write", "search", "create", "update", "delete"]>;
+export declare const ActionTypePropertySchema: z.ZodEnum<["read", "read_bulk", "write", "run", "search", "search_or_write", "search_and_write", "filter"]>;
 export declare const ActionKeyPropertySchema: z.ZodString;
 export declare const AuthenticationIdPropertySchema: z.ZodNumber;
 export declare const InputsPropertySchema: z.ZodRecord<z.ZodString, z.ZodAny>;

package/dist/types/properties.js

@@ -7,7 +7,16 @@ const schema_utils_1 = require("../schema-utils");
 // These can be reused in function schemas without duplication
 exports.AppKeyPropertySchema = (0, schema_utils_1.withPositional)(zod_1.z.string().min(1).describe("App slug (e.g., 'slack', 'github')"));
 exports.ActionTypePropertySchema = zod_1.z
-    .enum(["read", "write", "search", "create", "update", "delete"])
+    .enum([
+    "read",
+    "read_bulk",
+    "write",
+    "run",
+    "search",
+    "search_or_write",
+    "search_and_write",
+    "filter",
+])
     .describe("Action type that matches the action's defined type");
 exports.ActionKeyPropertySchema = zod_1.z
     .string()

package/dist/types/sdk.d.ts

@@ -4,13 +4,14 @@ import type { GetAppSdkFunction } from "../functions/getApp/schemas";
 import type { RunActionSdkFunction } from "../functions/runAction/schemas";
 import type { ListFieldsSdkFunction } from "../functions/listFields/schemas";
 import type { ListAuthenticationsSdkFunction } from "../functions/listAuthentications/schemas";
+import type { GetAuthenticationSdkFunction } from "../functions/getAuthentication/schemas";
 import type { FindFirstAuthenticationSdkFunction } from "../functions/findFirstAuthentication/schemas";
 import type { FindUniqueAuthenticationSdkFunction } from "../functions/findUniqueAuthentication/schemas";
 import type { GenerateTypesSdkFunction } from "../functions/generateTypes/schemas";
 import type { ListAppsSdkFunction } from "../functions/listApps/schemas";
 import type { BundleCodeSdkFunction } from "../functions/bundleCode/schemas";
 import type { AppsPluginSdkExtension } from "../plugins/apps/types";
-export interface ZapierSdkFunctions extends ListActionsSdkFunction, GetActionSdkFunction, GetAppSdkFunction, RunActionSdkFunction, ListFieldsSdkFunction, ListAuthenticationsSdkFunction, FindFirstAuthenticationSdkFunction, FindUniqueAuthenticationSdkFunction, GenerateTypesSdkFunction, ListAppsSdkFunction, BundleCodeSdkFunction {
+export interface ZapierSdkFunctions extends ListActionsSdkFunction, GetActionSdkFunction, GetAppSdkFunction, RunActionSdkFunction, ListFieldsSdkFunction, ListAuthenticationsSdkFunction, GetAuthenticationSdkFunction, FindFirstAuthenticationSdkFunction, FindUniqueAuthenticationSdkFunction, GenerateTypesSdkFunction, ListAppsSdkFunction, BundleCodeSdkFunction {
 }
 export interface ZapierSdkPlugins extends AppsPluginSdkExtension {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Complete Zapier SDK - combines all Zapier SDK packages",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,10 +18,13 @@
     "access": "restricted"
   },
   "dependencies": {
+    "conf": "^14.0.0",
     "esbuild": "^0.25.5",
+    "jsonwebtoken": "^9.0.2",
     "zod": "^3.25.67"
   },
   "devDependencies": {
+    "@types/jsonwebtoken": "^9.0.10",
     "@types/node": "^24.0.1",
     "typescript": "^5.8.3"
   },

package/src/api/client.ts

@@ -14,6 +14,7 @@ import type {
 import { getAuthorizationHeader } from "./auth";
 import { createDebugLogger, createDebugFetch } from "./debug";
 import { pollUntilComplete } from "./polling";
+import { getTokenFromEnv } from "../auth";
 
 export function createZapierApi(options: ApiClientOptions): ApiClient {
   const {
@@ -59,7 +60,7 @@ export function createZapierApi(options: ApiClientOptions): ApiClient {
       }
 
       if (!resolvedToken) {
-        resolvedToken = process.env.ZAPIER_TOKEN;
+        resolvedToken = getTokenFromEnv();
       }
 
       if (resolvedToken) {
@@ -163,7 +164,7 @@ export function createZapierApi(options: ApiClientOptions): ApiClient {
 
     requireAuthTo(operation: string): void {
       // Check if any authentication method is available
-      if (!token && !getToken && !process.env.ZAPIER_TOKEN) {
+      if (!token && !getToken && !getTokenFromEnv()) {
         throw new Error(
           `Authentication token is required to ${operation}. Please provide token in options or set ZAPIER_TOKEN environment variable.`,
         );

package/src/api/types.ts

@@ -67,7 +67,15 @@ export interface Action {
   name: string;
   description: string;
   appKey: string;
-  type: "create" | "update" | "search" | "delete" | "read";
+  type:
+    | "read"
+    | "read_bulk"
+    | "write"
+    | "run"
+    | "search"
+    | "search_or_write"
+    | "search_and_write"
+    | "filter";
   inputFields: Field[];
   outputFields: Field[];
 }