@zapier/zapier-sdk 0.8.3 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @zapier/zapier-sdk
 
+## 0.10.0
+
+### Minor Changes
+
+- 3184903: No more global resolver registry, each plugin function has its own resolvers. Plugin function meta also stores output schema and some function type info to avoid some special case code for handling lists, documenting functions, etc. findFirstAuthentication throws an error to make all item functions consistent. Various other schema and output cleanup.
+
+## 0.9.1
+
+### Patch Changes
+
+- 3cfed98: Reducing any usages
+
+## 0.9.0
+
+### Minor Changes
+
+- 5ccaec6: AST-based type gen instead of string-based. Added `add` function for locking app versions and generating types. Removed `lockVersion` and `generateTypes functions. Manifest matching on slug or implementation name.
+
 ## 0.8.3
 
 ### Patch Changes

package/README.md

@@ -25,8 +25,6 @@
   - [`listAuthentications`](#listauthentications)
 - [HTTP Requests](#http-requests)
   - [`request`](#request)
-- [Utilities](#utilities)
-  - [`lockVersion`](#lockversion)
 
 ## Installation
 
@@ -68,7 +66,7 @@ Get current user's profile information
 
 **Parameters:** None
 
-**Returns:** `Promise<UserProfile>`
+**Returns:** `Promise<ProfileItem>`
 
 **Example:**
 
@@ -172,7 +170,7 @@ Get the input fields required for a specific action
 | `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of input fields per page                       |
 | `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages        |
 
-**Returns:** `Promise<PaginatedResult<ActionField>>`
+**Returns:** `Promise<PaginatedResult<InputFieldItem>>`
 
 **Example:**
 
@@ -200,7 +198,7 @@ Execute an action with the given inputs
 | `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of results per page                         |
 | `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages     |
 
-**Returns:** `Promise<ActionExecutionResult>`
+**Returns:** `Promise<PaginatedResult<ActionResultItem>>`
 
 **Example:**
 
@@ -271,7 +269,7 @@ Find the first authentication matching the criteria
 | `accountId` | `string` | ❌       | —       | —               | Filter by account ID                                    |
 | `owner`     | `string` | ❌       | —       | —               | Filter by owner                                         |
 
-**Returns:** `Promise<Authentication | null>`
+**Returns:** `Promise<AuthenticationItem>`
 
 **Example:**
 
@@ -293,7 +291,7 @@ Find a unique authentication matching the criteria
 | `accountId` | `string` | ❌       | —       | —               | Filter by account ID                                    |
 | `owner`     | `string` | ❌       | —       | —               | Filter by owner                                         |
 
-**Returns:** `Promise<Authentication | null>`
+**Returns:** `Promise<AuthenticationItem>`
 
 **Example:**
 
@@ -311,7 +309,7 @@ Get a specific authentication by ID
 | ------------------ | -------- | -------- | ------- | --------------- | ----------------------------- |
 | `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve |
 
-**Returns:** `Promise<Authentication>`
+**Returns:** `Promise<AuthenticationItem>`
 
 **Example:**
 
@@ -327,17 +325,18 @@ 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              |
-| `accountId` | `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           |
+| Name                | Type     | Required | Default | Possible Values | Description                                              |
+| ------------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
+| `appKey`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
+| `authenticationIds` | `array`  | ❌       | —       | —               | List of authentication IDs to filter by                  |
+| `search`            | `string` | ❌       | —       | —               | Search term to filter authentications by title           |
+| `title`             | `string` | ❌       | —       | —               | Filter authentications by exact title match              |
+| `accountId`         | `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>>`
+**Returns:** `Promise<PaginatedResult<AuthenticationItem>>`
 
 **Example:**
 
@@ -374,26 +373,4 @@ const result = await sdk.request({
 });
 ```
 
-### Utilities
-
-#### `lockVersion`
-
-Execute lockVersion
-
-**Parameters:**
-
-| Name     | Type     | Required | Default | Possible Values | Description                                              |
-| -------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
-| `appKey` | `string` | ✅       | —       | —               | The app key to lock version for (e.g., 'slack', 'gmail') |
-
-**Returns:** `Promise<any>`
-
-**Example:**
-
-```typescript
-const result = await sdk.lockVersion({
-  appKey: "example-key",
-});
-```
-
 <!-- End Generated API Reference -->

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

@@ -1 +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;AA6bjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAqB3D,CAAC"}
+{"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;AAycjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAqB3D,CAAC"}

package/dist/api/client.js

@@ -167,6 +167,20 @@ class ZapierApiClient {
                 if (this.isApiErrorArray(data.errors)) {
                     return data.errors[0].detail || data.errors[0].title;
                 }
+                else if (data.errors.length > 0) {
+                    // Handle simple string errors array
+                    const firstError = data.errors[0];
+                    if (typeof firstError === "string") {
+                        return firstError;
+                    }
+                    // For non-string errors, stringify them
+                    try {
+                        return JSON.stringify(firstError);
+                    }
+                    catch {
+                        return String(firstError);
+                    }
+                }
             }
         }
         return undefined;

package/dist/api/debug.d.ts

@@ -6,6 +6,7 @@
  */
 import type { DebugLogger } from "./types";
 export declare function createDebugLogger(enabled: boolean): DebugLogger;
+export declare function censorHeaders(headers?: HeadersInit): Record<string, string> | undefined;
 export declare function createDebugFetch(options: {
     originalFetch: typeof globalThis.fetch;
     debugLog: DebugLogger;

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

@@ -1 +1 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/api/debug.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAQ/D;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,aAAa,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IACvC,QAAQ,EAAE,WAAW,CAAC;CACvB,IAEe,OAAO,WAAW,GAAG,GAAG,EAAE,UAAU,WAAW,uBA0C9D"}
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/api/debug.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAQ/D;AAED,wBAAgB,aAAa,CAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAwCpC;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IACxC,aAAa,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IACvC,QAAQ,EAAE,WAAW,CAAC;CACvB,IAEe,OAAO,WAAW,GAAG,GAAG,EAAE,UAAU,WAAW,uBA0C9D"}

package/dist/api/debug.js

@@ -12,6 +12,47 @@ export function createDebugLogger(enabled) {
         console.log(`[Zapier SDK] ${message}`, data || "");
     };
 }
+export function censorHeaders(headers) {
+    if (!headers)
+        return headers;
+    const headersObj = new Headers(headers);
+    const authKeys = ["authorization", "x-api-key"];
+    for (const [key, value] of headersObj.entries()) {
+        if (authKeys.some((authKey) => key.toLowerCase() === authKey)) {
+            // Find space after prefix (like "Bearer ")
+            const spaceIndex = value.indexOf(" ");
+            if (spaceIndex > 0 && spaceIndex < value.length - 1) {
+                const prefix = value.substring(0, spaceIndex + 1); // Include the space
+                const token = value.substring(spaceIndex + 1);
+                if (token.length > 12) {
+                    // Show first 4 and last 4 chars, truncate middle
+                    const start = token.substring(0, 4);
+                    const end = token.substring(token.length - 4);
+                    headersObj.set(key, `${prefix}${start}...${end}`);
+                }
+                else {
+                    // Short token, use first character + three dots
+                    const firstChar = token.charAt(0);
+                    headersObj.set(key, `${prefix}${firstChar}...`);
+                }
+            }
+            else {
+                // No prefix found, truncate the whole value
+                if (value.length > 12) {
+                    const start = value.substring(0, 4);
+                    const end = value.substring(value.length - 4);
+                    headersObj.set(key, `${start}...${end}`);
+                }
+                else {
+                    // Short token, use first character + three dots
+                    const firstChar = value.charAt(0);
+                    headersObj.set(key, `${firstChar}...`);
+                }
+            }
+        }
+    }
+    return Object.fromEntries(headersObj);
+}
 export function createDebugFetch(options) {
     const { originalFetch, debugLog } = options;
     return async (input, options) => {
@@ -20,7 +61,7 @@ export function createDebugFetch(options) {
         const url = typeof input === "string" ? input : input.toString();
         const method = options?.method || "GET";
         debugLog(`→ ${method} ${url}`, {
-            headers: options?.headers,
+            headers: censorHeaders(options?.headers),
             body: options?.body && typeof options.body === "string"
                 ? (() => {
                     try {

package/dist/api/debug.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=debug.test.d.ts.map

package/dist/api/debug.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.test.d.ts","sourceRoot":"","sources":["../../src/api/debug.test.ts"],"names":[],"mappings":""}

package/dist/api/debug.test.js

@@ -0,0 +1,59 @@
+import { describe, it, expect } from "vitest";
+import { censorHeaders } from "./debug";
+describe("censorHeaders", () => {
+    it("should return undefined for undefined headers", () => {
+        expect(censorHeaders(undefined)).toBeUndefined();
+    });
+    it("should return headers unchanged for non-auth headers", () => {
+        const headers = {
+            "Content-Type": "application/json",
+            "User-Agent": "test",
+        };
+        const result = censorHeaders(headers);
+        // Headers API normalizes header names to lowercase
+        expect(result["content-type"]).toBe("application/json");
+        expect(result["user-agent"]).toBe("test");
+    });
+    it("should censor authorization header with Bearer prefix - long token", () => {
+        const headers = { authorization: "Bearer abcdef1234567890xyz" };
+        const result = censorHeaders(headers);
+        expect(result.authorization).toBe("Bearer abcd...0xyz");
+    });
+    it("should censor authorization header with Bearer prefix - short token", () => {
+        const headers = { authorization: "Bearer short123" };
+        const result = censorHeaders(headers);
+        expect(result.authorization).toBe("Bearer s...");
+    });
+    it("should censor x-api-key header - long token", () => {
+        const headers = { "x-api-key": "sk-1234567890abcdefghij" };
+        const result = censorHeaders(headers);
+        expect(result["x-api-key"]).toBe("sk-1...ghij");
+    });
+    it("should censor x-api-key header - short token", () => {
+        const headers = { "x-api-key": "short" };
+        const result = censorHeaders(headers);
+        expect(result["x-api-key"]).toBe("s...");
+    });
+    it("should handle Headers object input", () => {
+        const headers = new Headers();
+        headers.set("authorization", "Bearer verylongtoken123456789");
+        const result = censorHeaders(headers);
+        expect(result.authorization).toBe("Bearer very...6789");
+    });
+    it("should handle mixed case authorization headers", () => {
+        const headers = { Authorization: "Bearer mixedcasetoken123" };
+        const result = censorHeaders(headers);
+        expect(result.authorization).toBe("Bearer mixe...n123");
+    });
+    it("should preserve non-auth headers while censoring auth headers", () => {
+        const headers = {
+            "Content-Type": "application/json",
+            authorization: "Bearer shouldbecensored123456789",
+            "User-Agent": "test-agent",
+        };
+        const result = censorHeaders(headers);
+        expect(result["content-type"]).toBe("application/json");
+        expect(result["user-agent"]).toBe("test-agent");
+        expect(result.authorization).toBe("Bearer shou...6789");
+    });
+});