@zapier/zapier-sdk 0.2.0 → 0.3.0

package/src/sdk.ts

@@ -1,5 +1,6 @@
 import { createZapierApi } from "./api";
 import { BaseSdkOptions } from "./types/domain";
+import { getTokenFromEnvOrConfig } from "./auth";
 // Import function implementations
 import { listApps } from "./functions/listApps";
 import { getApp } from "./functions/getApp";
@@ -7,6 +8,7 @@ import { listActions } from "./functions/listActions";
 import { getAction } from "./functions/getAction";
 import { runAction } from "./functions/runAction";
 import { listAuthentications } from "./functions/listAuthentications";
+import { getAuthentication } from "./functions/getAuthentication";
 import { findFirstAuthentication } from "./functions/findFirstAuthentication";
 import { findUniqueAuthentication } from "./functions/findUniqueAuthentication";
 import { listFields } from "./functions/listFields";
@@ -20,6 +22,7 @@ import { listActionsInfo } from "./functions/listActions/info";
 import { getActionInfo } from "./functions/getAction/info";
 import { runActionInfo } from "./functions/runAction/info";
 import { listAuthenticationsInfo } from "./functions/listAuthentications/info";
+import { getAuthenticationInfo } from "./functions/getAuthentication/info";
 import { findFirstAuthenticationInfo } from "./functions/findFirstAuthentication/info";
 import { findUniqueAuthenticationInfo } from "./functions/findUniqueAuthentication/info";
 import { listFieldsInfo } from "./functions/listFields/info";
@@ -34,6 +37,7 @@ const functionRegistry = [
   getActionInfo,
   runActionInfo,
   listAuthenticationsInfo,
+  getAuthenticationInfo,
   findFirstAuthenticationInfo,
   findUniqueAuthenticationInfo,
   listFieldsInfo,
@@ -49,53 +53,45 @@ import { createAppsPlugin } from "./plugins/apps/index";
 
 // TODO: Add plugin registry back when needed for CLI compatibility
 
-// Base SDK functions interface (functions + registry, no plugins)
-interface BaseZapierSdkWithFunctions {
-  __registry: Array<{
-    name: string;
-    inputSchema: any;
-    implementation: Function;
-  }>;
-  listApps: ZapierSdk["listApps"];
-  getApp: ZapierSdk["getApp"];
-  listActions: ZapierSdk["listActions"];
-  getAction: ZapierSdk["getAction"];
-  runAction: ZapierSdk["runAction"];
-  listAuthentications: ZapierSdk["listAuthentications"];
-  findFirstAuthentication: ZapierSdk["findFirstAuthentication"];
-  findUniqueAuthentication: ZapierSdk["findUniqueAuthentication"];
-  listFields: ZapierSdk["listFields"];
-  generateTypes: ZapierSdk["generateTypes"];
-  bundleCode: ZapierSdk["bundleCode"];
-}
-
 // Full SDK interface with plugins applied
 export type { ZapierSdk } from "./types/sdk";
 
 export interface ZapierSdkOptions extends BaseSdkOptions {}
 
-function createBaseZapierSdk(
-  options: ZapierSdkOptions = {},
-): BaseZapierSdkWithFunctions {
+export function createZapierSdk(options: ZapierSdkOptions = {}): ZapierSdk {
   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
+      ? () => getTokenFromEnvOrConfig({ onEvent, fetch: customFetch })
+      : undefined);
+
   // Create the API client
   const api = createZapierApi({
     baseUrl,
     token,
-    getToken,
+    getToken: resolvedGetToken,
     debug,
     fetch: customFetch,
   });
 
-  // Build SDK directly - TypeScript will enforce correct implementation
-  const sdk: BaseZapierSdkWithFunctions = {
+  // Create plugins directly - TypeScript will enforce correct implementation
+  const appsPlugin = createAppsPlugin({
+    api,
+    token,
+  });
+
+  // Compose final SDK - TypeScript will enforce we have all required properties
+  const fullSdk: ZapierSdk = {
     // Registry for CLI
     __registry: functionRegistry,
 
@@ -107,6 +103,7 @@ function createBaseZapierSdk(
     runAction: (options) => runAction({ ...options, api }),
     listAuthentications: (options = {}) =>
       listAuthentications({ ...options, api }),
+    getAuthentication: (options) => getAuthentication({ ...options, api }),
     findFirstAuthentication: (options = {}) =>
       findFirstAuthentication({ ...options, api }),
     findUniqueAuthentication: (options = {}) =>
@@ -114,42 +111,8 @@ function createBaseZapierSdk(
     listFields: (options) => listFields({ ...options, api }),
     generateTypes: (options) => generateTypes({ ...options, api }),
     bundleCode: (options) => bundleCode(options), // No API config needed
-  };
-
-  return sdk;
-}
-
-export function createZapierSdk(options: ZapierSdkOptions = {}): ZapierSdk {
-  // 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 = createZapierApi({
-    baseUrl,
-    token,
-    getToken,
-    debug,
-    fetch: customFetch,
-  });
-
-  // Create plugins directly - TypeScript will enforce correct implementation
-  const appsPlugin = createAppsPlugin({
-    api,
-    token,
-  });
-
-  // Compose final SDK - TypeScript will enforce we have all required properties
-  const fullSdk: ZapierSdk = {
-    ...baseSdk,
+    // Add plugins
     apps: appsPlugin,
   };
 

package/src/types/domain.ts

@@ -14,6 +14,9 @@ export type {
   AuthenticationsResponse,
 } from "../api/types";
 
+// Import event types
+import type { EventCallback } from "./events";
+
 // SDK Configuration Types
 export interface ActionExecutionOptions {
   inputs?: Record<string, any>;
@@ -27,6 +30,7 @@ export interface AuthObject {
 export interface BaseSdkOptions {
   token?: string;
   getToken?: () => Promise<string | undefined>;
+  onEvent?: EventCallback;
   fetch?: typeof fetch;
   baseUrl?: string;
   debug?: boolean;

package/src/types/events.ts

@@ -0,0 +1,43 @@
+/**
+ * SDK Event System
+ *
+ * This module provides common event type definitions for the SDK's
+ * event system, including authentication, API, and loading events.
+ */
+
+// Generic event system
+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/src/types/properties.ts

@@ -9,7 +9,16 @@ export const AppKeyPropertySchema = withPositional(
 );
 
 export const ActionTypePropertySchema = 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");
 
 export const ActionKeyPropertySchema = z

package/src/types/sdk.ts

@@ -5,6 +5,7 @@ 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";
@@ -22,6 +23,7 @@ export interface ZapierSdkFunctions
     RunActionSdkFunction,
     ListFieldsSdkFunction,
     ListAuthenticationsSdkFunction,
+    GetAuthenticationSdkFunction,
     FindFirstAuthenticationSdkFunction,
     FindUniqueAuthenticationSdkFunction,
     GenerateTypesSdkFunction,

package/dist/utils/getTokenFromConfig.d.ts

@@ -1,7 +0,0 @@
-/**
- * Attempts to read the JWT token from the CLI config file.
- * This is a synchronous function that only returns valid, non-expired tokens.
- * For token refresh logic, the CLI should handle that separately.
- * Returns undefined if config file doesn't exist, token is not available, or token is expired.
- */
-export declare function getTokenFromConfig(): string | undefined;

package/dist/utils/getTokenFromConfig.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTokenFromConfig = getTokenFromConfig;
-/**
- * Attempts to read the JWT token from the CLI config file.
- * This is a synchronous function that only returns valid, non-expired tokens.
- * For token refresh logic, the CLI should handle that separately.
- * Returns undefined if config file doesn't exist, token is not available, or token is expired.
- */
-function getTokenFromConfig() {
-    try {
-        // Dynamically import conf to avoid dependency issues if not installed
-        const Conf = require("conf");
-        const config = new Conf({ projectName: "zapier-sdk-cli" });
-        // Get the stored JWT token
-        const jwt = config.get("login_jwt");
-        const expiresAt = config.get("login_expires_at");
-        // Check if token exists and is not expired (with 30s buffer)
-        if (jwt && expiresAt && expiresAt > Date.now() + 30 * 1000) {
-            return jwt;
-        }
-        // Token is missing or expired - return undefined so SDK will require explicit auth
-        return undefined;
-    }
-    catch {
-        // Config package not available or other error - silently fail
-        return undefined;
-    }
-}

package/src/utils/getTokenFromConfig.ts

@@ -1,28 +0,0 @@
-/**
- * Attempts to read the JWT token from the CLI config file.
- * This is a synchronous function that only returns valid, non-expired tokens.
- * For token refresh logic, the CLI should handle that separately.
- * Returns undefined if config file doesn't exist, token is not available, or token is expired.
- */
-export function getTokenFromConfig(): string | undefined {
-  try {
-    // Dynamically import conf to avoid dependency issues if not installed
-    const Conf = require("conf");
-    const config = new Conf({ projectName: "zapier-sdk-cli" });
-
-    // Get the stored JWT token
-    const jwt = config.get("login_jwt") as string | undefined;
-    const expiresAt = config.get("login_expires_at") as number | undefined;
-
-    // Check if token exists and is not expired (with 30s buffer)
-    if (jwt && expiresAt && expiresAt > Date.now() + 30 * 1000) {
-      return jwt;
-    }
-
-    // Token is missing or expired - return undefined so SDK will require explicit auth
-    return undefined;
-  } catch {
-    // Config package not available or other error - silently fail
-    return undefined;
-  }
-}