@zapier/zapier-sdk 0.4.1 → 0.5.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @zapier/zapier-sdk
+
+## 0.5.1
+
+### Patch Changes
+
+- c662f79: Add proper README with dynamically-listed methods
+
+## 0.5.0
+
+### Minor Changes
+
+- 741c385: All functions are now plugins, so _everything_ is a plugin.

package/README.md

@@ -0,0 +1,343 @@
+# @zapier/zapier-sdk
+
+<!-- Generated API Reference -->
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Available Functions](#available-functions)
+- [Actions](#actions)
+  - [`listActions`](#listactions)
+  - [`getAction`](#getaction)
+  - [`listInputFields`](#listinputfields)
+  - [`runAction`](#runaction)
+- [Apps](#apps)
+  - [`listApps`](#listapps)
+  - [`getApp`](#getapp)
+- [Authentication](#authentication)
+  - [`listAuthentications`](#listauthentications)
+  - [`getAuthentication`](#getauthentication)
+  - [`findFirstAuthentication`](#findfirstauthentication)
+  - [`findUniqueAuthentication`](#finduniqueauthentication)
+- [HTTP Requests](#http-requests)
+  - [`request`](#request)
+- [User & Profile](#user--profile)
+  - [`getProfile`](#getprofile)
+
+## Installation
+
+```bash
+npm install @zapier/zapier-sdk
+```
+
+## Quick Start
+
+```typescript
+import { createZapierSdk } from "@zapier/zapier-sdk";
+
+const sdk = createZapierSdk({
+  token: "your_zapier_token_here", // or use ZAPIER_TOKEN env var
+});
+
+// List all available apps
+const apps = await sdk.listApps();
+
+// Get information about a specific app
+const slackApp = await sdk.getApp({ appKey: "slack" });
+
+// Run an action
+const result = await sdk.runAction({
+  appKey: "slack",
+  actionType: "write",
+  actionKey: "send_message",
+  inputs: { channel: "#general", message: "Hello World!" },
+});
+```
+
+## Available Functions
+
+### Actions
+
+#### `listActions`
+
+List all actions for a specific app
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                      |
+| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key of actions to list (e.g., 'SlackCLIAPI') |
+| `actionType` | `string` | ❌       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type                           |
+| `pageSize`   | `number` | ❌       | —       | —                                                                                              | Number of actions per page                       |
+| `maxItems`   | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages   |
+
+**Returns:** `Promise<PaginatedResult<ActionItem>>`
+
+**Example:**
+
+```typescript
+const result = await sdk.listActions({
+  appKey: "example-key",
+});
+```
+
+#### `getAction`
+
+Get detailed information about a specific action
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                        |
+| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI')                      |
+| `actionType` | `string` | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
+| `actionKey`  | `string` | ✅       | —       | —                                                                                              | Action key to execute                              |
+
+**Returns:** `Promise<ActionItem>`
+
+**Example:**
+
+```typescript
+const result = await sdk.getAction({
+  appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
+});
+```
+
+#### `listInputFields`
+
+Get the input fields required for a specific action
+
+**Parameters:**
+
+| Name               | Type     | Required | Default | Possible Values                                                                                | Description                                           |
+| ------------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
+| `appKey`           | `string` | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI')                         |
+| `actionType`       | `string` | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type    |
+| `actionKey`        | `string` | ✅       | —       | —                                                                                              | Action key to execute                                 |
+| `authenticationId` | `string` | ❌       | —       | —                                                                                              | Authentication ID to use for this action              |
+| `inputs`           | `object` | ❌       | —       | —                                                                                              | Current input values that may affect available fields |
+| `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of input fields per page                       |
+| `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages        |
+
+**Returns:** `Promise<PaginatedResult<ActionField>>`
+
+**Example:**
+
+```typescript
+const result = await sdk.listInputFields({
+  appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
+});
+```
+
+#### `runAction`
+
+Execute an action with the given inputs
+
+**Parameters:**
+
+| Name               | Type     | Required | Default | Possible Values                                                                                | Description                                        |
+| ------------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| `appKey`           | `string` | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI')                      |
+| `actionType`       | `string` | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
+| `actionKey`        | `string` | ✅       | —       | —                                                                                              | Action key to execute                              |
+| `authenticationId` | `string` | ❌       | —       | —                                                                                              | Authentication ID to use for this action           |
+| `inputs`           | `object` | ❌       | —       | —                                                                                              | Input parameters for the action                    |
+| `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of results per page                         |
+| `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages     |
+
+**Returns:** `Promise<ActionExecutionResult>`
+
+**Example:**
+
+```typescript
+const result = await sdk.runAction({
+  appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
+});
+```
+
+### Apps
+
+#### `listApps`
+
+List all available apps with optional filtering
+
+**Parameters:**
+
+| Name       | Type     | Required | Default | Possible Values | Description                                                         |
+| ---------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
+| `appKeys`  | `array`  | ❌       | —       | —               | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
+| `search`   | `string` | ❌       | —       | —               | Search for apps by name                                             |
+| `pageSize` | `number` | ❌       | —       | —               | Number of apps per page                                             |
+| `maxItems` | `number` | ❌       | —       | —               | Maximum total items to return across all pages                      |
+
+**Returns:** `Promise<PaginatedResult<AppItem>>`
+
+**Example:**
+
+```typescript
+const result = await sdk.listApps();
+```
+
+#### `getApp`
+
+Get detailed information about a specific app
+
+**Parameters:**
+
+| Name     | Type     | Required | Default | Possible Values | Description                                   |
+| -------- | -------- | -------- | ------- | --------------- | --------------------------------------------- |
+| `appKey` | `string` | ✅       | —       | —               | App key of app to fetch (e.g., 'SlackCLIAPI') |
+
+**Returns:** `Promise<AppItem>`
+
+**Example:**
+
+```typescript
+const result = await sdk.getApp({
+  appKey: "example-key",
+});
+```
+
+### Authentication
+
+#### `listAuthentications`
+
+List available authentications with optional filtering
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values | Description                                              |
+| ------------ | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
+| `appKey`     | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
+| `search`     | `string` | ❌       | —       | —               | Search term to filter authentications by title           |
+| `title`      | `string` | ❌       | —       | —               | Filter authentications by exact title match              |
+| `account_id` | `string` | ❌       | —       | —               | Filter by account ID                                     |
+| `owner`      | `string` | ❌       | —       | —               | Filter by owner                                          |
+| `pageSize`   | `number` | ❌       | —       | —               | Number of authentications per page                       |
+| `maxItems`   | `number` | ❌       | —       | —               | Maximum total items to return across all pages           |
+
+**Returns:** `Promise<PaginatedResult<Authentication>>`
+
+**Example:**
+
+```typescript
+const result = await sdk.listAuthentications();
+```
+
+#### `getAuthentication`
+
+Get a specific authentication by ID
+
+**Parameters:**
+
+| Name               | Type     | Required | Default | Possible Values | Description                   |
+| ------------------ | -------- | -------- | ------- | --------------- | ----------------------------- |
+| `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve |
+
+**Returns:** `Promise<Authentication>`
+
+**Example:**
+
+```typescript
+const result = await sdk.getAuthentication({
+  authenticationId: 12345,
+});
+```
+
+#### `findFirstAuthentication`
+
+Find the first authentication matching the criteria
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values | Description                                             |
+| ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------- |
+| `appKey`     | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI') |
+| `search`     | `string` | ❌       | —       | —               | Search term to filter authentications by title          |
+| `title`      | `string` | ❌       | —       | —               | Filter authentications by exact title match             |
+| `account_id` | `string` | ❌       | —       | —               | Filter by account ID                                    |
+| `owner`      | `string` | ❌       | —       | —               | Filter by owner                                         |
+
+**Returns:** `Promise<Authentication | null>`
+
+**Example:**
+
+```typescript
+const result = await sdk.findFirstAuthentication();
+```
+
+#### `findUniqueAuthentication`
+
+Find a unique authentication matching the criteria
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values | Description                                             |
+| ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------- |
+| `appKey`     | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI') |
+| `search`     | `string` | ❌       | —       | —               | Search term to filter authentications by title          |
+| `title`      | `string` | ❌       | —       | —               | Filter authentications by exact title match             |
+| `account_id` | `string` | ❌       | —       | —               | Filter by account ID                                    |
+| `owner`      | `string` | ❌       | —       | —               | Filter by owner                                         |
+
+**Returns:** `Promise<Authentication | null>`
+
+**Example:**
+
+```typescript
+const result = await sdk.findUniqueAuthentication();
+```
+
+### HTTP Requests
+
+#### `request`
+
+Make authenticated HTTP requests through Zapier's Relay service
+
+**Parameters:**
+
+| Name                     | Type     | Required | Default | Possible Values                                            | Description                                                          |
+| ------------------------ | -------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
+| `url`                    | `string` | ✅       | —       | —                                                          | The URL to request (will be proxied through Relay)                   |
+| `method`                 | `string` | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method                                                          |
+| `body`                   | `string` | ❌       | —       | —                                                          | Request body as a string                                             |
+| `authenticationId`       | `number` | ❌       | —       | —                                                          | Zapier authentication ID to use for the request                      |
+| `callbackUrl`            | `string` | ❌       | —       | —                                                          | URL to send async response to (makes request async)                  |
+| `authenticationTemplate` | `string` | ❌       | —       | —                                                          | Optional JSON string authentication template to bypass Notary lookup |
+| `headers`                | `string` | ❌       | —       | —                                                          | Request headers                                                      |
+| `relayBaseUrl`           | `string` | ❌       | —       | —                                                          | Base URL for Relay service                                           |
+
+**Returns:** `Promise<Response>`
+
+**Example:**
+
+```typescript
+const result = await sdk.request({
+  url: "https://example.com",
+});
+```
+
+### User & Profile
+
+#### `getProfile`
+
+Get current user's profile information
+
+**Parameters:** None
+
+**Returns:** `Promise<UserProfile>`
+
+**Example:**
+
+```typescript
+const result = await sdk.getProfile();
+```
+
+<!-- End Generated API Reference -->

package/dist/api/auth.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Authentication Utilities
+ *
+ * This module provides utilities for handling authentication tokens,
+ * including JWT detection and authorization header generation.
+ */
+export declare function isJwt(token: string): boolean;
+export declare function getAuthorizationHeader(token: string): string;
+//# sourceMappingURL=auth.d.ts.map

package/dist/api/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/api/auth.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAW5C;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAO5D"}

package/dist/api/auth.js

@@ -0,0 +1,25 @@
+/**
+ * Authentication Utilities
+ *
+ * This module provides utilities for handling authentication tokens,
+ * including JWT detection and authorization header generation.
+ */
+export function isJwt(token) {
+    // JWT tokens have exactly 3 parts separated by dots
+    const parts = token.split(".");
+    if (parts.length !== 3) {
+        return false;
+    }
+    // Each part should be base64url encoded (no padding)
+    // Basic validation - each part should be non-empty and contain valid base64url characters
+    const base64UrlPattern = /^[A-Za-z0-9_-]+$/;
+    return parts.every((part) => part.length > 0 && base64UrlPattern.test(part));
+}
+export function getAuthorizationHeader(token) {
+    // Check if token is a JWT (has 3 parts separated by dots)
+    if (isJwt(token)) {
+        return `JWT ${token}`;
+    }
+    // Default to Bearer for other token types
+    return `Bearer ${token}`;
+}

package/dist/api/client.d.ts

@@ -0,0 +1,9 @@
+/**
+ * API Client Implementation
+ *
+ * This module contains the core API client implementation, including
+ * HTTP method handlers, response processing, and client factory functions.
+ */
+import type { ApiClient, ApiClientOptions } from "./types";
+export declare const createZapierApi: (options: ApiClientOptions) => ApiClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/api/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AA4bjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAqB3D,CAAC"}