@zapier/zapier-sdk 0.13.6 → 0.13.8

package/src/types/errors.ts

@@ -1,278 +0,0 @@
-/**
- * Standard error format returned by the Zapier API
- */
-export interface ApiError {
-  status: number;
-  code: string;
-  title: string;
-  detail: string;
-  source?: unknown;
-  meta?: unknown;
-}
-
-/**
- * Base options for all error constructors
- */
-export interface ErrorOptions {
-  statusCode?: number;
-  errors?: ApiError[];
-  cause?: unknown;
-  response?: unknown;
-}
-
-/**
- * Base class for all Zapier SDK errors
- * Use instanceof ZapierError to check if an error is from the SDK
- */
-export abstract class ZapierError extends Error {
-  abstract readonly name: string;
-  public statusCode?: number;
-  public errors?: ApiError[];
-  public cause?: unknown;
-  public response?: unknown;
-
-  constructor(message: string, options: ErrorOptions = {}) {
-    super(message);
-    this.statusCode = options.statusCode;
-    this.errors = options.errors;
-    this.cause = options.cause;
-    this.response = options.response;
-    // Maintain proper prototype chain for instanceof checks
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-}
-
-/**
- * Error thrown when API requests fail
- */
-export class ZapierApiError extends ZapierError {
-  readonly name = "ZapierApiError";
-
-  constructor(message: string, options: ErrorOptions = {}) {
-    super(message, options);
-  }
-}
-
-/**
- * Error thrown when an app is not found
- */
-export class ZapierAppNotFoundError extends ZapierError {
-  readonly name = "ZapierAppNotFoundError";
-  public appKey?: string;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { appKey?: string } = {},
-  ) {
-    super(message, options);
-    this.appKey = options.appKey;
-  }
-}
-
-/**
- * Error thrown when validation fails (e.g., invalid parameters)
- */
-export class ZapierValidationError extends ZapierError {
-  readonly name = "ZapierValidationError";
-  public details?: unknown;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { details?: unknown } = {},
-  ) {
-    super(message, options);
-    this.details = options.details;
-  }
-}
-
-/**
- * Error for unrecognized/unknown errors that get wrapped by safe functions
- */
-export class ZapierUnknownError extends ZapierError {
-  readonly name = "ZapierUnknownError";
-
-  constructor(message: string, options: ErrorOptions = {}) {
-    super(message, options);
-  }
-}
-
-/**
- * Error thrown for authentication and authorization failures (401/403)
- */
-export class ZapierAuthenticationError extends ZapierError {
-  readonly name = "ZapierAuthenticationError";
-
-  constructor(message: string, options: ErrorOptions = {}) {
-    super(message, options);
-  }
-}
-
-/**
- * Error thrown when a requested resource is not found
- */
-export class ZapierResourceNotFoundError extends ZapierError {
-  readonly name = "ZapierResourceNotFoundError";
-  public resourceType?: string;
-  public resourceId?: string;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { resourceType?: string; resourceId?: string } = {},
-  ) {
-    super(message, options);
-    this.resourceType = options.resourceType;
-    this.resourceId = options.resourceId;
-  }
-}
-
-/**
- * Error thrown when required app or implementation configuration is missing
- */
-export class ZapierConfigurationError extends ZapierError {
-  readonly name = "ZapierConfigurationError";
-  public configType?: string;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { configType?: string } = {},
-  ) {
-    super(message, options);
-    this.configType = options.configType;
-  }
-}
-
-/**
- * Error thrown when code bundling or compilation fails
- */
-export class ZapierBundleError extends ZapierError {
-  readonly name = "ZapierBundleError";
-  public buildErrors?: string[];
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { buildErrors?: string[] } = {},
-  ) {
-    super(message, options);
-    this.buildErrors = options.buildErrors;
-  }
-}
-
-/**
- * Error thrown when operations timeout or exceed retry limits
- */
-export class ZapierTimeoutError extends ZapierError {
-  readonly name = "ZapierTimeoutError";
-  public attempts?: number;
-  public maxAttempts?: number;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { attempts?: number; maxAttempts?: number } = {},
-  ) {
-    super(message, options);
-    this.attempts = options.attempts;
-    this.maxAttempts = options.maxAttempts;
-  }
-}
-
-/**
- * Error thrown when action execution fails due to errors returned from the third-party service
- * This happens when the Actions API returns a 200 status but includes errors in the response
- */
-export class ZapierActionError extends ZapierError {
-  readonly name = "ZapierActionError";
-  public appKey?: string;
-  public actionKey?: string;
-
-  constructor(
-    message: string,
-    options: ErrorOptions & { appKey?: string; actionKey?: string } = {},
-  ) {
-    super(message, options);
-    this.appKey = options.appKey;
-    this.actionKey = options.actionKey;
-  }
-
-  // Legacy accessor for backward compatibility
-  get actionErrors() {
-    return this.errors;
-  }
-}
-
-/**
- * Error thrown when a resource is not found (404)
- */
-export class ZapierNotFoundError extends ZapierError {
-  readonly name = "ZapierNotFoundError";
-
-  constructor(message: string, options: ErrorOptions = {}) {
-    super(message, options);
-  }
-}
-
-/**
- * Utility function to format error messages for display
- */
-export function formatErrorMessage(error: ZapierError): string {
-  let message = error.message;
-
-  // Add additional context from errors array if available
-  if (error.errors && error.errors.length > 0) {
-    const additionalErrors = error.errors.slice(1); // Skip first error (already in message)
-    if (additionalErrors.length > 0) {
-      const errorDetails = additionalErrors
-        .map((err) => `  • ${err.detail || err.title || err.code}`)
-        .join("\n");
-      message += "\n\nAdditional errors:\n" + errorDetails;
-    }
-  }
-
-  // Add error-specific context
-  if (error instanceof ZapierAppNotFoundError && error.appKey) {
-    message += `\nApp key: ${error.appKey}`;
-  }
-
-  if (error instanceof ZapierActionError && (error.appKey || error.actionKey)) {
-    const context = [];
-    if (error.appKey) context.push(`App: ${error.appKey}`);
-    if (error.actionKey) context.push(`Action: ${error.actionKey}`);
-    message += `\n${context.join(", ")}`;
-  }
-
-  if (
-    error instanceof ZapierResourceNotFoundError &&
-    (error.resourceType || error.resourceId)
-  ) {
-    const context = [];
-    if (error.resourceType) context.push(`Type: ${error.resourceType}`);
-    if (error.resourceId) context.push(`ID: ${error.resourceId}`);
-    message += `\n${context.join(", ")}`;
-  }
-
-  if (
-    error instanceof ZapierTimeoutError &&
-    (error.attempts || error.maxAttempts)
-  ) {
-    const context = [];
-    if (error.attempts) context.push(`Attempts: ${error.attempts}`);
-    if (error.maxAttempts) context.push(`Max attempts: ${error.maxAttempts}`);
-    message += `\n${context.join(", ")}`;
-  }
-
-  if (
-    error instanceof ZapierBundleError &&
-    error.buildErrors &&
-    error.buildErrors.length > 0
-  ) {
-    message +=
-      "\n\nBuild errors:\n" +
-      error.buildErrors.map((err) => `  • ${err}`).join("\n");
-  }
-
-  // Add status code if available and not already obvious from the message
-  if (error.statusCode && !message.includes(`${error.statusCode}`)) {
-    message += `\nHTTP Status: ${error.statusCode}`;
-  }
-
-  return message;
-}

package/src/types/events.ts

@@ -1,43 +0,0 @@
-/**
- * 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, unknown>;
-  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/functions.ts

@@ -1,28 +0,0 @@
-import type { ApiClient } from "../api/types";
-/**
- * Function-related types and interfaces
- */
-
-// Common options shared across all function types
-export interface FunctionOptions {
-  /** Base URL for Zapier API */
-  baseUrl?: string;
-  /** Authentication token */
-  token?: string;
-  /** Function to dynamically resolve authentication token */
-  getToken?: () => Promise<string | undefined>;
-  /** Optional pre-instantiated API client */
-  api?: ApiClient;
-  /** Enable debug logging */
-  debug?: boolean;
-  /** Custom fetch implementation */
-  fetch?: typeof globalThis.fetch;
-}
-
-// Generic type helper for paginated SDK functions
-export type PaginatedSdkFunction<TOptions, TItem> = (
-  options: TOptions,
-) => Promise<{ data: TItem[] }> &
-  AsyncIterable<{ data: TItem[]; nextCursor?: string }> & {
-    items(): AsyncIterable<TItem>;
-  };

package/src/types/optional-zapier-sdk-cli-login.d.ts

@@ -1,37 +0,0 @@
-// packages/zapier-sdk/types/cli-login-shim.d.ts
-declare module '@zapier/zapier-sdk-cli-login' {
-  export interface AuthOptions {
-    onEvent?: (event: {
-      type: string;
-      payload: Record<string, any>;
-      timestamp: number;
-    }) => void;
-    fetch?: typeof globalThis.fetch;
-  }
-
-  export interface LoginData {
-    access_token: string;
-    refresh_token: string;
-    expires_in: number;
-  }
-
-  // Minimal API — include only what your SDK actually uses.
-  // (Keeping a few extra exports here is harmless and future-proofs a bit.)
-  export function getToken(
-    options?: AuthOptions
-  ): Promise<string | undefined>;
-
-  export function getValidJwt(
-    options?: AuthOptions
-  ): Promise<string | undefined>;
-
-  export function getLoggedInUser(
-    options?: AuthOptions
-  ): Promise<{ accountId: number; customUserId: number; email: string }>;
-
-  export function logout(options?: Pick<AuthOptions, 'onEvent'>): void;
-
-  export function updateLogin(loginData: LoginData): void;
-
-  export function getConfigPath(): string;
-}

package/src/types/plugin.ts

@@ -1,125 +0,0 @@
-/**
- * ------------------------------
- * Plugin Type System with Explicit Context Dependencies
- * ------------------------------
- *
- * This system makes context dependencies explicit to restore TypeScript's
- * ability to catch missing context at compile time.
- */
-
-import type { z } from "zod";
-import type { BaseSdkOptions } from "./sdk";
-
-export interface PluginDependencies<TSdk = {}, TContext = {}> {
-  sdk: TSdk;
-  context: TContext;
-}
-
-// Plugin provides = sdk properties + optional context
-export interface PluginProvides extends Record<string, any> {
-  context?: Record<string, any>;
-}
-
-export interface PluginMeta {
-  categories: string[];
-  type?: "list" | "item";
-  itemType?: string;
-  returnType?: string;
-  inputSchema: z.ZodSchema;
-  outputSchema?: z.ZodSchema;
-  resolvers?: Record<string, any>;
-  [key: string]: any;
-}
-
-// Utility type to extract SDK properties (everything except 'context')
-export type ExtractSdkProperties<T extends Record<string, any>> = Omit<
-  T,
-  "context"
->;
-
-// Utility type to extract context properties from plugin
-export type ExtractContextProperties<T extends PluginProvides> = T["context"];
-
-// Helper type to create SDK type with properly typed getContext method
-export type GetSdkType<TPluginProvides extends PluginProvides> =
-  ExtractSdkProperties<TPluginProvides> & {
-    getContext(): NonNullable<ExtractContextProperties<TPluginProvides>>;
-  };
-
-export type GetContextType<TPluginProvides extends PluginProvides> =
-  NonNullable<ExtractContextProperties<TPluginProvides>>;
-
-// Helper type for standard plugin options with SDK dependency and meta context
-export type PluginOptions<TSdk = {}, TContext = {}> = {
-  sdk: TSdk;
-  context: TContext & { meta: Record<string, any> };
-};
-
-/**
- * Plugin interface — now has 3 type params:
- *
- *   TRequiresContext = what this plugin *needs* in context
- *   TProvides = what this plugin *returns* (sdk + context)
- *   TSdk = current sdk shape when plugin runs
- */
-export interface Plugin<
-  TSdk = {},
-  TRequiresContext = {},
-  TProvides extends PluginProvides = PluginProvides,
-> {
-  (params: {
-    sdk: TSdk;
-    context: TRequiresContext & {
-      meta: Record<string, PluginMeta>;
-      options: BaseSdkOptions;
-    };
-  }): TProvides;
-}
-
-// Helper type to get missing keys from required context
-type MissingContextKeys<TRequired, TCurrent> =
-  TRequired extends Record<string, any>
-    ? TCurrent extends Record<string, any>
-      ? {
-          [K in keyof TRequired]: K extends keyof TCurrent ? never : K;
-        }[keyof TRequired]
-      : keyof TRequired
-    : never;
-
-// Helper type to create detailed error message
-type ContextError<TRequired, TCurrent> =
-  MissingContextKeys<TRequired, TCurrent> extends never
-    ? never
-    : MissingContextKeys<TRequired, TCurrent> extends infer Missing
-      ? Missing extends string
-        ? `❌ Missing required context: { ${Missing}: any }`
-        : Missing extends number
-          ? `❌ Missing required context: { ${Missing}: any }`
-          : `❌ Missing required context properties. Required: ${keyof TRequired extends string ? keyof TRequired : "unknown"}, Available: ${keyof TCurrent extends string ? keyof TCurrent : "unknown"}`
-      : "❌ Context requirement not satisfied";
-
-/**
- * SDK interface — result of createSdk()
- *
- * addPlugin now enforces that TRequiresContext is assignable to TCurrentContext.
- * If not, TypeScript will emit a detailed error showing missing properties.
- */
-export type Sdk<
-  TCurrentSdk = {},
-  TCurrentContext = { meta: Record<string, PluginMeta> },
-> = TCurrentSdk & {
-  addPlugin<TRequiresContext, TProvides extends PluginProvides>(
-    plugin: Plugin<
-      TCurrentSdk & { getContext(): TCurrentContext },
-      TRequiresContext,
-      TProvides
-    >,
-    options?: any,
-  ): TCurrentContext extends TRequiresContext
-    ? Sdk<
-        TCurrentSdk & ExtractSdkProperties<TProvides>,
-        TCurrentContext & NonNullable<ExtractContextProperties<TProvides>>
-      >
-    : ContextError<TRequiresContext, TCurrentContext>;
-  getContext(): TCurrentContext;
-};

package/src/types/properties.ts

@@ -1,80 +0,0 @@
-import { z } from "zod";
-import { withPositional } from "../utils/schema-utils";
-import { MAX_PAGE_LIMIT } from "../constants";
-
-// Shared property definitions for common parameters across functions
-// These can be reused in function schemas without duplication
-
-export const AppKeyPropertySchema = withPositional(
-  z
-    .string()
-    .min(1)
-    .describe("App key (e.g., 'SlackCLIAPI' or slug like 'github')"),
-);
-
-export const ActionTypePropertySchema = z
-  .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
-  .string()
-  .min(1)
-  .describe("Action key to execute");
-
-export const AuthenticationIdPropertySchema = z
-  .number()
-  .int()
-  .describe("Authentication ID to use for this action");
-
-export const InputsPropertySchema = z
-  .record(z.unknown())
-  .describe("Input parameters for the action");
-
-export const LimitPropertySchema = z
-  .number()
-  .int()
-  .min(1)
-  .max(MAX_PAGE_LIMIT)
-  .default(50)
-  .describe("Maximum number of items to return");
-
-export const OffsetPropertySchema = z
-  .number()
-  .int()
-  .min(0)
-  .default(0)
-  .describe("Number of items to skip for pagination");
-
-export const OutputPropertySchema = z.string().describe("Output file path");
-
-export const DebugPropertySchema = z
-  .boolean()
-  .default(false)
-  .describe("Enable debug logging");
-
-export const ParamsPropertySchema = z
-  .record(z.unknown())
-  .describe("Additional parameters");
-
-// Inferred TypeScript types for the properties
-export type AppKeyProperty = z.infer<typeof AppKeyPropertySchema>;
-export type ActionTypeProperty = z.infer<typeof ActionTypePropertySchema>;
-export type ActionKeyProperty = z.infer<typeof ActionKeyPropertySchema>;
-export type AuthenticationIdProperty = z.infer<
-  typeof AuthenticationIdPropertySchema
->;
-export type InputsProperty = z.infer<typeof InputsPropertySchema>;
-export type LimitProperty = z.infer<typeof LimitPropertySchema>;
-export type OffsetProperty = z.infer<typeof OffsetPropertySchema>;
-export type OutputProperty = z.infer<typeof OutputPropertySchema>;
-export type DebugProperty = z.infer<typeof DebugPropertySchema>;
-export type ParamsProperty = z.infer<typeof ParamsPropertySchema>;

package/src/types/sdk.ts

@@ -1,111 +0,0 @@
-/**
- * SDK-related types and interfaces
- */
-
-import type { EventCallback } from "./events";
-import type { EventEmissionConfig } from "../plugins/eventEmission";
-import type { Manifest } from "../plugins/manifest";
-
-// SDK Configuration Types
-export interface BaseSdkOptions {
-  token?: string;
-  getToken?: () => Promise<string | undefined>;
-  onEvent?: EventCallback;
-  fetch?: typeof fetch;
-  baseUrl?: string;
-  debug?: boolean;
-  manifestPath?: string;
-  manifest?: Manifest;
-  eventEmission?: EventEmissionConfig;
-}
-
-// SDK interface composed from individual function interfaces
-import type { ListInputFieldsSdkFunction } from "../plugins/listInputFields/schemas";
-import type { GetAuthenticationSdkFunction } from "../plugins/getAuthentication/schemas";
-import type { FindFirstAuthenticationSdkFunction } from "../plugins/findFirstAuthentication/schemas";
-import type { FindUniqueAuthenticationSdkFunction } from "../plugins/findUniqueAuthentication/schemas";
-import type { RelayRequestSdkFunction } from "../plugins/request/schemas";
-
-import type { z } from "zod";
-import type { RegistryPluginProvides } from "../plugins/registry";
-import type { GetProfilePluginProvides } from "../plugins/getProfile";
-import type { EventEmissionProvides } from "../plugins/eventEmission";
-import type { ApiPluginProvides } from "../plugins/api";
-import type { AppsPluginProvides, ZapierSdkApps } from "../plugins/apps";
-import type { ActionProxy } from "../plugins/apps/schemas";
-import type { FetchPluginProvides } from "../plugins/fetch";
-import type { ListAppsPluginProvides } from "../plugins/listApps";
-import type { GetAppPluginProvides } from "../plugins/getApp";
-import type { ListActionsPluginProvides } from "../plugins/listActions";
-import type { GetActionPluginProvides } from "../plugins/getAction";
-import type { RunActionPluginProvides } from "../plugins/runAction";
-import type { ListAuthenticationsPluginProvides } from "../plugins/listAuthentications";
-import type { GetAuthenticationPluginProvides } from "../plugins/getAuthentication";
-import type { FindFirstAuthenticationPluginProvides } from "../plugins/findFirstAuthentication";
-import type { FindUniqueAuthenticationPluginProvides } from "../plugins/findUniqueAuthentication";
-import type { ListInputFieldsPluginProvides } from "../plugins/listInputFields";
-import type { ListInputFieldChoicesPluginProvides } from "../plugins/listInputFieldChoices";
-import type { RequestPluginProvides } from "../plugins/request";
-import type { GetSdkType } from "./plugin";
-import type { ManifestPluginProvides } from "../plugins/manifest";
-
-// Plugin interfaces
-// Note: Plugin extension types removed - now using new plugin system
-
-// Registry entry interface with proper types
-export interface FunctionRegistryEntry {
-  name: string;
-  type?: "list" | "item";
-  itemType?: string;
-  returnType?: string;
-  inputSchema?: z.ZodSchema;
-  inputParameters?: Array<{ name: string; schema: z.ZodSchema }>;
-  outputSchema?: z.ZodSchema;
-  categories: string[];
-  resolvers?: Record<string, any>;
-  packages?: string[];
-}
-
-// Compose SDK functions from individual function interfaces
-export interface ZapierSdkFunctions
-  extends ListInputFieldsSdkFunction,
-    GetAuthenticationSdkFunction,
-    FindFirstAuthenticationSdkFunction,
-    FindUniqueAuthenticationSdkFunction,
-    RelayRequestSdkFunction {
-  // All functions now properly typed!
-}
-
-// Note: ZapierSdkPlugins removed - plugins are now handled by the plugin builder system
-
-// Note: BaseZapierSdk removed - all functions now provided by individual plugins
-// The registry is provided by RegistryPlugin
-
-// Note: ZapierSdk type removed - use ReturnType<typeof createZapierSdk> instead
-// This ensures the type matches exactly what the builder produces
-
-export interface ZapierSdk
-  extends GetSdkType<
-    RegistryPluginProvides &
-      FetchPluginProvides &
-      AppsPluginProvides &
-      ListAppsPluginProvides &
-      ManifestPluginProvides &
-      GetAppPluginProvides &
-      ListActionsPluginProvides &
-      GetActionPluginProvides &
-      RunActionPluginProvides &
-      ListAuthenticationsPluginProvides &
-      GetAuthenticationPluginProvides &
-      FindFirstAuthenticationPluginProvides &
-      FindUniqueAuthenticationPluginProvides &
-      ListInputFieldsPluginProvides &
-      ListInputFieldChoicesPluginProvides &
-      RequestPluginProvides &
-      GetProfilePluginProvides &
-      EventEmissionProvides &
-      ApiPluginProvides
-  > {
-  // Override apps property to intersect ActionProxy with our typed apps
-  apps: ActionProxy & ZapierSdkApps;
-}