@zapier/zapier-sdk 0.37.0 → 0.39.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk
 
+## 0.39.0
+
+### Minor Changes
+
+- a20d36a: Add define primitives (defineTool, defineDurable, defineComponent) via @zapier/zapier-sdk/define entrypoint and app registry via @zapier/zapier-sdk/apps entrypoint.
+
+## 0.38.0
+
+### Minor Changes
+
+- 2906101: Default `listConnections` and `listTables` to only return your own items. Gate shared access and table deletion behind boolean flags: `canIncludeSharedConnections`, `canIncludeSharedTables`, `canDeleteTables`. Set via SDK options, `.zapierrc`, CLI flags (`--can-delete-tables`), or env vars (`ZAPIER_CAN_DELETE_TABLES=true`).
+
 ## 0.37.0
 
 ### Minor Changes

package/README.md

@@ -320,14 +320,17 @@ console.log(emojiData.emoji);
 
 The `createZapierSdk(...)` factory function is the main entry point for the SDK. It provides methods for managing connections, listing apps, running actions, and more.
 
-| Name                     | Type                       | Required | Default | Possible Values | Description                                                                                                                                                                                   |
-| ------------------------ | -------------------------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `credentials`            | `string, object, function` | ❌       | —       | —               | Authentication credentials. Can be a string (token or API key), a client credentials object ({ clientId, clientSecret }), a PKCE object ({ clientId }), or a function returning any of those. |
-| `debug`                  | `boolean`                  | ❌       | —       | —               | Enable debug logging.                                                                                                                                                                         |
-| `baseUrl`                | `string`                   | ❌       | —       | —               | Base URL for Zapier API endpoints.                                                                                                                                                            |
-| `trackingBaseUrl`        | `string`                   | ❌       | —       | —               | Base URL for Zapier tracking endpoints.                                                                                                                                                       |
-| `maxNetworkRetries`      | `number`                   | ❌       | —       | —               | Max retries for rate-limited requests (default: 3).                                                                                                                                           |
-| `maxNetworkRetryDelayMs` | `number`                   | ❌       | —       | —               | Max delay in ms to wait for retry (default: 60000).                                                                                                                                           |
+| Name                          | Type                       | Required | Default | Possible Values | Description                                                                                                                                                                                   |
+| ----------------------------- | -------------------------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `credentials`                 | `string, object, function` | ❌       | —       | —               | Authentication credentials. Can be a string (token or API key), a client credentials object ({ clientId, clientSecret }), a PKCE object ({ clientId }), or a function returning any of those. |
+| `debug`                       | `boolean`                  | ❌       | —       | —               | Enable debug logging.                                                                                                                                                                         |
+| `baseUrl`                     | `string`                   | ❌       | —       | —               | Base URL for Zapier API endpoints.                                                                                                                                                            |
+| `trackingBaseUrl`             | `string`                   | ❌       | —       | —               | Base URL for Zapier tracking endpoints.                                                                                                                                                       |
+| `maxNetworkRetries`           | `number`                   | ❌       | —       | —               | Max retries for rate-limited requests (default: 3).                                                                                                                                           |
+| `maxNetworkRetryDelayMs`      | `number`                   | ❌       | —       | —               | Max delay in ms to wait for retry (default: 60000).                                                                                                                                           |
+| `canIncludeSharedConnections` | `boolean`                  | ❌       | —       | —               | Allow listing shared connections.                                                                                                                                                             |
+| `canIncludeSharedTables`      | `boolean`                  | ❌       | —       | —               | Allow listing shared tables.                                                                                                                                                                  |
+| `canDeleteTables`             | `boolean`                  | ❌       | —       | —               | Allow deleting tables.                                                                                                                                                                        |
 
 ## Named Connections
 
@@ -862,15 +865,16 @@ Find the first connection matching the criteria
 
 **Parameters:**
 
-| Name          | Type      | Required | Default | Possible Values | Description                                                                    |
-| ------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
-| `options`     | `object`  | ✅       | —       | —               |                                                                                |
-| ↳ `search`    | `string`  | ❌       | —       | —               | Search term to filter connections by title                                     |
-| ↳ `title`     | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally) |
-| ↳ `owner`     | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID           |
-| ↳ `appKey`    | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
-| ↳ `accountId` | `string`  | ❌       | —       | —               | Account ID to filter by                                                        |
-| ↳ `isExpired` | `boolean` | ❌       | —       | —               | Filter by expired status                                                       |
+| Name              | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
+| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `options`         | `object`  | ✅       | —       | —               |                                                                                                                                                     |
+| ↳ `search`        | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
+| ↳ `title`         | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
+| ↳ `owner`         | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
+| ↳ `appKey`        | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
+| ↳ `accountId`     | `string`  | ❌       | —       | —               | Account ID to filter by                                                                                                                             |
+| ↳ `includeShared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
+| ↳ `isExpired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
 
 **Returns:** `Promise<ConnectionItem>`
 
@@ -886,15 +890,16 @@ Find a unique connection matching the criteria
 
 **Parameters:**
 
-| Name          | Type      | Required | Default | Possible Values | Description                                                                    |
-| ------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
-| `options`     | `object`  | ✅       | —       | —               |                                                                                |
-| ↳ `search`    | `string`  | ❌       | —       | —               | Search term to filter connections by title                                     |
-| ↳ `title`     | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally) |
-| ↳ `owner`     | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID           |
-| ↳ `appKey`    | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
-| ↳ `accountId` | `string`  | ❌       | —       | —               | Account ID to filter by                                                        |
-| ↳ `isExpired` | `boolean` | ❌       | —       | —               | Filter by expired status                                                       |
+| Name              | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
+| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `options`         | `object`  | ✅       | —       | —               |                                                                                                                                                     |
+| ↳ `search`        | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
+| ↳ `title`         | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
+| ↳ `owner`         | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
+| ↳ `appKey`        | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
+| ↳ `accountId`     | `string`  | ❌       | —       | —               | Account ID to filter by                                                                                                                             |
+| ↳ `includeShared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
+| ↳ `isExpired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
 
 **Returns:** `Promise<ConnectionItem>`
 
@@ -929,19 +934,20 @@ List available connections with optional filtering
 
 **Parameters:**
 
-| Name              | Type      | Required | Default | Possible Values | Description                                                                    |
-| ----------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
-| `options`         | `object`  | ✅       | —       | —               |                                                                                |
-| ↳ `search`        | `string`  | ❌       | —       | —               | Search term to filter connections by title                                     |
-| ↳ `title`         | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally) |
-| ↳ `owner`         | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID           |
-| ↳ `appKey`        | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
-| ↳ `connectionIds` | `array`   | ❌       | —       | —               | List of connection IDs to filter by                                            |
-| ↳ `accountId`     | `string`  | ❌       | —       | —               | Account ID to filter by                                                        |
-| ↳ `isExpired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                       |
-| ↳ `pageSize`      | `number`  | ❌       | —       | —               | Number of connections per page                                                 |
-| ↳ `maxItems`      | `number`  | ❌       | —       | —               | Maximum total items to return across all pages                                 |
-| ↳ `cursor`        | `string`  | ❌       | —       | —               | Cursor to start from                                                           |
+| Name              | Type      | Required | Default | Possible Values | Description                                                                                                                                         |
+| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `options`         | `object`  | ✅       | —       | —               |                                                                                                                                                     |
+| ↳ `search`        | `string`  | ❌       | —       | —               | Search term to filter connections by title                                                                                                          |
+| ↳ `title`         | `string`  | ❌       | —       | —               | Filter connections by exact title match (searches first, then filters locally)                                                                      |
+| ↳ `owner`         | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own connections or a specific user ID                                                                                |
+| ↳ `appKey`        | `string`  | ❌       | —       | —               | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')                                                                          |
+| ↳ `connectionIds` | `array`   | ❌       | —       | —               | List of connection IDs to filter by                                                                                                                 |
+| ↳ `accountId`     | `string`  | ❌       | —       | —               | Account ID to filter by                                                                                                                             |
+| ↳ `includeShared` | `boolean` | ❌       | —       | —               | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
+| ↳ `isExpired`     | `boolean` | ❌       | —       | —               | Filter by expired status                                                                                                                            |
+| ↳ `pageSize`      | `number`  | ❌       | —       | —               | Number of connections per page                                                                                                                      |
+| ↳ `maxItems`      | `number`  | ❌       | —       | —               | Maximum total items to return across all pages                                                                                                      |
+| ↳ `cursor`        | `string`  | ❌       | —       | —               | Cursor to start from                                                                                                                                |
 
 **Returns:** `Promise<PaginatedResult<ConnectionItem>>`
 
@@ -1263,16 +1269,17 @@ List tables available to the authenticated user
 
 **Parameters:**
 
-| Name         | Type     | Required | Default | Possible Values                  | Description                                                                 |
-| ------------ | -------- | -------- | ------- | -------------------------------- | --------------------------------------------------------------------------- |
-| `options`    | `object` | ✅       | —       | —                                |                                                                             |
-| ↳ `tableIds` | `array`  | ❌       | —       | —                                | Filter by specific table IDs                                                |
-| ↳ `kind`     | `string` | ❌       | —       | `table`, `virtual_table`, `both` | Filter by table type                                                        |
-| ↳ `search`   | `string` | ❌       | —       | —                                | Search term to filter tables by name                                        |
-| ↳ `owner`    | `string` | ❌       | —       | —                                | Filter by table owner. Use "me" for the current user, or a numeric user ID. |
-| ↳ `pageSize` | `number` | ❌       | —       | —                                | Number of tables per page                                                   |
-| ↳ `maxItems` | `number` | ❌       | —       | —                                | Maximum total items to return across all pages                              |
-| ↳ `cursor`   | `string` | ❌       | —       | —                                | Cursor to start from                                                        |
+| Name              | Type      | Required | Default | Possible Values                  | Description                                                                                                    |
+| ----------------- | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `options`         | `object`  | ✅       | —       | —                                |                                                                                                                |
+| ↳ `tableIds`      | `array`   | ❌       | —       | —                                | Filter by specific table IDs                                                                                   |
+| ↳ `kind`          | `string`  | ❌       | —       | `table`, `virtual_table`, `both` | Filter by table type                                                                                           |
+| ↳ `search`        | `string`  | ❌       | —       | —                                | Search term to filter tables by name                                                                           |
+| ↳ `owner`         | `string`  | ❌       | —       | —                                | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
+| ↳ `includeShared` | `boolean` | ❌       | —       | —                                | Include tables shared with you. Without this, only your own tables are returned.                               |
+| ↳ `pageSize`      | `number`  | ❌       | —       | —                                | Number of tables per page                                                                                      |
+| ↳ `maxItems`      | `number`  | ❌       | —       | —                                | Maximum total items to return across all pages                                                                 |
+| ↳ `cursor`        | `string`  | ❌       | —       | —                                | Cursor to start from                                                                                           |
 
 **Returns:** `Promise<PaginatedResult<TableItem>>`