@zapier/zapier-sdk 0.0.1 → 0.0.2

package/src/sdk.ts

@@ -1,26 +1,26 @@
-import { createActionsSDK, ActionsSDK } from "../../actions-sdk/dist";
-import { BaseSDKOptions } from "../../shared-sdk/dist";
+import { createActionsSdk, ActionsSdk } from "./actions-sdk";
+import { BaseSdkOptions } from "./types";
 
-export interface ZapierSDK extends ActionsSDK {
+export interface ZapierSdk extends ActionsSdk {
   // Future SDK namespaces will be added here
-  // workflows: WorkflowsSDK
-  // interfaces: InterfacesSDK
-  // tables: TablesSDK
+  // workflows: WorkflowsSdk
+  // interfaces: InterfacesSdk
+  // tables: TablesSdk
 }
 
-export interface ZapierSDKOptions extends BaseSDKOptions {}
+export interface ZapierSdkOptions extends BaseSdkOptions {}
 
-export function createZapierSDK(options: ZapierSDKOptions = {}): ZapierSDK {
+export function createZapierSdk(options: ZapierSdkOptions = {}): ZapierSdk {
   // Create individual SDKs
-  const actionsSDK = createActionsSDK(options);
+  const actionsSdk = createActionsSdk(options);
 
   // For now, we just return the actions SDK
   // Later we'll combine multiple SDKs here
   return {
-    ...actionsSDK,
+    ...actionsSdk,
     // Future SDKs will be spread here:
-    // ...workflowsSDK,
-    // ...interfacesSDK,
-    // ...tablesSDK,
+    // ...workflowsSdk,
+    // ...interfacesSdk,
+    // ...tablesSdk,
   };
 }

package/src/types.ts

@@ -0,0 +1,244 @@
+export interface Integration {
+  key: string;
+  name: string;
+  description: string;
+  version: string;
+  category?: string;
+  actions: Action[];
+  triggers: Trigger[];
+  current_implementation_id?: string;
+}
+
+export interface Action {
+  key: string;
+  name: string;
+  description: string;
+  appKey: string;
+  type: "create" | "update" | "search" | "delete" | "read";
+  inputFields: Field[];
+  outputFields: Field[];
+}
+
+export interface Trigger {
+  key: string;
+  name: string;
+  description: string;
+  appKey: string;
+  type: "instant" | "polling" | "webhook";
+  outputFields: Field[];
+}
+
+export interface Field {
+  key: string;
+  label: string;
+  type:
+    | "string"
+    | "number"
+    | "boolean"
+    | "datetime"
+    | "file"
+    | "object"
+    | "array";
+  required: boolean;
+  description?: string;
+  choices?: Choice[];
+}
+
+export interface Choice {
+  value: string | number;
+  label: string;
+}
+
+export interface ListOptions {
+  category?: string;
+  appKey?: string;
+  type?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface ActionExecutionOptions {
+  inputs?: Record<string, any>;
+  authId?: number;
+}
+
+export interface ActionExecutionResult {
+  success: boolean;
+  data?: any;
+  error?: string;
+  metadata?: {
+    executionTime?: number;
+    requestId?: string;
+  };
+}
+
+export interface ActionField {
+  key: string;
+  label?: string;
+  required: boolean;
+  type?: string;
+  helpText?: string;
+  helpTextHtml?: string;
+  choices?: ActionFieldChoice[];
+  default?: string;
+  placeholder?: string;
+  computed?: boolean;
+  customField?: boolean;
+  dependsOn?: string[];
+  format?: string;
+  inputFormat?: string[];
+}
+
+export interface ActionFieldChoice {
+  value: string | number;
+  label: string;
+}
+
+export interface NeedsRequest {
+  selected_api: string;
+  action: string;
+  type_of: string;
+  authentication_id?: number;
+  params?: Record<string, any>;
+}
+
+export interface NeedsResponse {
+  success: boolean;
+  needs?: ActionField[];
+  errors?: string[];
+}
+
+// Future extensibility types
+export interface Workflow {
+  id: string;
+  name: string;
+  description: string;
+  steps: WorkflowStep[];
+}
+
+export interface WorkflowStep {
+  id: string;
+  type: "trigger" | "action";
+  appKey: string;
+  actionKey?: string;
+  triggerKey?: string;
+}
+
+export interface Interface {
+  key: string;
+  name: string;
+  fields: Field[];
+}
+
+export interface Table {
+  key: string;
+  name: string;
+  columns: TableColumn[];
+}
+
+export interface TableColumn {
+  key: string;
+  name: string;
+  type: string;
+}
+
+export interface Authentication {
+  id: number;
+  date: string;
+  lastchanged?: string;
+  account_id: number;
+  customuser_id?: number;
+  selected_api: string;
+  destination_selected_api?: string | null;
+  is_invite_only: boolean;
+  is_private: boolean;
+  shared_with_all: boolean;
+  is_stale?: string;
+  is_shared?: string;
+  marked_stale_at?: string | null;
+  label?: string | null;
+  identifier?: string | null;
+  title?: string | null;
+  url?: string;
+  groups?: string;
+  members?: string;
+  permissions?: Record<string, boolean>;
+}
+
+export interface AuthenticationsResponse {
+  count: number;
+  next?: string | null;
+  previous?: string | null;
+  results: Authentication[];
+}
+
+export interface AuthenticationListOptions {
+  account_id?: string;
+  owner?: string;
+  appKey?: string;
+  limit?: number;
+  offset?: number;
+}
+
+// Custom error classes for better error handling
+export class ZapierSdkError extends Error {
+  constructor(
+    message: string,
+    public code?: string,
+  ) {
+    super(message);
+    this.name = "ZapierSdkError";
+  }
+}
+
+export class AppNotFoundError extends ZapierSdkError {
+  constructor(appKey: string) {
+    super(`App "${appKey}" not found`);
+    this.name = "AppNotFoundError";
+    this.code = "APP_NOT_FOUND";
+  }
+}
+
+export class ActionNotFoundError extends ZapierSdkError {
+  constructor(appKey: string, actionKey: string) {
+    super(`Action "${actionKey}" not found in app "${appKey}"`);
+    this.name = "ActionNotFoundError";
+    this.code = "ACTION_NOT_FOUND";
+  }
+}
+
+export class AuthenticationError extends ZapierSdkError {
+  constructor(message: string) {
+    super(message);
+    this.name = "AuthenticationError";
+    this.code = "AUTHENTICATION_ERROR";
+  }
+}
+
+// Auth configuration types
+export interface AuthObject {
+  id: number;
+}
+
+// Common SDK interfaces
+export interface BaseSdkOptions {
+  token?: string;
+  authentications?: {
+    [appKey: string]: AuthObject[];
+  };
+  fetch?: typeof fetch;
+  baseUrl?: string;
+  debug?: boolean;
+}
+
+export interface CombinedSdk {
+  [namespace: string]: any;
+}
+
+// Factory function type for creating individual SDKs
+export type SdkFactory<T = any> = (options: BaseSdkOptions) => T;
+
+// Utility function to combine multiple SDKs
+export function combineSdks(sdks: Record<string, any>): CombinedSdk {
+  return { ...sdks };
+}