@zapier/zapier-sdk 0.108.1 → 0.109.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +21 -21
  3. package/dist/{chunk-S7XDZGKJ.mjs → chunk-6TOSNLPZ.mjs} +290 -234
  4. package/dist/{chunk-OS45HFVJ.cjs → chunk-NTUEFDSW.cjs} +289 -233
  5. package/dist/experimental.cjs +384 -382
  6. package/dist/experimental.d.mts +3 -3
  7. package/dist/experimental.d.ts +3 -3
  8. package/dist/experimental.mjs +8 -6
  9. package/dist/{index-BUYztqGh.d.mts → index-Cum18GPG.d.mts} +34 -35
  10. package/dist/{index-BUYztqGh.d.ts → index-Cum18GPG.d.ts} +34 -35
  11. package/dist/index.cjs +279 -279
  12. package/dist/index.d.mts +1 -1
  13. package/dist/index.d.ts +1 -1
  14. package/dist/index.mjs +1 -1
  15. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.109.1
4
+
5
+ ### Patch Changes
6
+
7
+ - c970d16: Corrected the draft `slug` descriptions: slugs are no longer unique among a workflow's open drafts, and the `listWorkflowDrafts` `slug` filter can return more than one draft. Documentation only — no behaviour change. These descriptions surface as MCP tool schemas, so agents were previously told the filter returns at most one match.
8
+
9
+ ## 0.109.0
10
+
11
+ ### Minor Changes
12
+
13
+ - f56765a: Deprecated `createZapierApi` and `getOrCreateApiClient` in favor of building an SDK with `createSdk` and accessing `apiPluginRef` with `resolvePlugin`. Both functions continue to work with a once-per-process warning.
14
+
15
+ ### Patch Changes
16
+
17
+ - f56765a: `createZapierSdk({ cache })` now uses the caller-supplied cache for client-credentials access tokens instead of silently falling back to the default cache (the CLI's filesystem and keychain cache when installed, otherwise in-memory).
18
+
3
19
  ## 0.108.1
4
20
 
5
21
  ### Patch Changes
package/README.md CHANGED
@@ -1288,11 +1288,11 @@ Fork a new draft from the workflow's current live version (or a blank stub befor
1288
1288
 
1289
1289
  **Parameters:**
1290
1290
 
1291
- | Name | Type | Required | Default | Possible Values | Description |
1292
- | -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------- |
1293
- | `options` | `object` | ✅ | — | — | |
1294
- | ​ ↳ `workflow` | `string` | ✅ | — | — | Durable workflow ID |
1295
- | ​ ↳ `slug` | `string` | ❌ | — | — | Optional slug for URL routing. When omitted, the server generates one. |
1291
+ | Name | Type | Required | Default | Possible Values | Description |
1292
+ | -------------- | -------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1293
+ | `options` | `object` | ✅ | — | — | |
1294
+ | ​ ↳ `workflow` | `string` | ✅ | — | — | Durable workflow ID |
1295
+ | ​ ↳ `slug` | `string` | ❌ | — | — | Optional display name for the draft. When omitted, the server generates one. Need not be unique among the workflow's open drafts. |
1296
1296
 
1297
1297
  **Returns:** `Promise<WorkflowDraftItem>`
1298
1298
 
@@ -1301,7 +1301,7 @@ Fork a new draft from the workflow's current live version (or a blank stub befor
1301
1301
  | `data` | `object` | ✅ | — | |
1302
1302
  | ​ ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
1303
1303
  | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1304
- | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
1304
+ | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
1305
1305
  | ​ ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
1306
1306
  | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1307
1307
  | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |
@@ -1424,7 +1424,7 @@ Discard an open workflow draft (soft delete). The draft's unpublished edits stop
1424
1424
  | `data` | `object` | ✅ | — | |
1425
1425
  | ​ ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
1426
1426
  | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1427
- | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
1427
+ | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
1428
1428
  | ​ ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
1429
1429
  | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1430
1430
  | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |
@@ -1710,7 +1710,7 @@ Get full details of a workflow draft including source files
1710
1710
  | `data` | `object` | ✅ | — | |
1711
1711
  | ​ ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
1712
1712
  | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1713
- | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
1713
+ | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
1714
1714
  | ​ ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
1715
1715
  | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1716
1716
  | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |
@@ -1853,7 +1853,7 @@ Convert an existing Zap into a durable workflow. Transforms the Zap's latest pub
1853
1853
  | ​ ↳ `draft` | `object` | ✅ | — | The open draft holding the transformed source. |
1854
1854
  | ​   ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
1855
1855
  | ​   ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1856
- | ​   ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
1856
+ | ​   ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
1857
1857
  | ​   ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
1858
1858
  | ​   ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1859
1859
  | ​   ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |
@@ -1937,15 +1937,15 @@ List drafts for a workflow, most recently edited first (open drafts by default)
1937
1937
 
1938
1938
  **Parameters:**
1939
1939
 
1940
- | Name | Type | Required | Default | Possible Values | Description |
1941
- | -------------- | -------- | -------- | ------- | ------------------- | ----------------------------------------------------- |
1942
- | `options` | `object` | ✅ | — | — | |
1943
- | ​ ↳ `workflow` | `string` | ✅ | — | — | Durable workflow ID |
1944
- | ​ ↳ `status` | `string` | ❌ | — | `open`, `discarded` | Filter by draft status (server default: open) |
1945
- | ​ ↳ `slug` | `string` | ❌ | — | — | Filter by exact slug match; returns at most one draft |
1946
- | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of drafts per page (max 100) |
1947
- | ​ ↳ `cursor` | `string` | ❌ | — | — | Pagination cursor |
1948
- | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total drafts to return across all pages |
1940
+ | Name | Type | Required | Default | Possible Values | Description |
1941
+ | -------------- | -------- | -------- | ------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1942
+ | `options` | `object` | ✅ | — | — | |
1943
+ | ​ ↳ `workflow` | `string` | ✅ | — | — | Durable workflow ID |
1944
+ | ​ ↳ `status` | `string` | ❌ | — | `open`, `discarded` | Filter by draft status (server default: open) |
1945
+ | ​ ↳ `slug` | `string` | ❌ | — | — | Filter by exact slug match. Slugs are not unique, so this returns every draft with this slug matching the selected status, ordered by most recent activity and paginated |
1946
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of drafts per page (max 100) |
1947
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Pagination cursor |
1948
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total drafts to return across all pages |
1949
1949
 
1950
1950
  **Returns:** `Promise<PaginatedResult<WorkflowDraftItem>>`
1951
1951
 
@@ -1954,7 +1954,7 @@ List drafts for a workflow, most recently edited first (open drafts by default)
1954
1954
  | `data[]` | `object[]` | ✅ | — | |
1955
1955
  | ​ ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
1956
1956
  | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1957
- | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
1957
+ | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
1958
1958
  | ​ ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
1959
1959
  | ​ ↳ `status` | `string` | ✅ | `open`, `discarded` | Lifecycle status of a workflow draft. |
1960
1960
  | ​ ↳ `last_edited_by_user_id` | `string` | ✅ | — | ID of the user who last saved this draft (or null) |
@@ -2184,7 +2184,7 @@ Publish an open draft as a new immutable workflow version. Advances the workflow
2184
2184
  | ​ ↳ `draft` | `object` | ✅ | — | The consumed draft: status is 'discarded' and discarded_at is set. base_version_id still records the version the draft was forked from. |
2185
2185
  | ​   ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
2186
2186
  | ​   ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
2187
- | ​   ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
2187
+ | ​   ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
2188
2188
  | ​   ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
2189
2189
  | ​   ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
2190
2190
  | ​   ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |
@@ -2467,7 +2467,7 @@ Update (autosave) an open workflow draft
2467
2467
  | `data` | `object` | ✅ | — | |
2468
2468
  | ​ ↳ `id` | `string` | ✅ | — | Workflow draft ID (UUID) |
2469
2469
  | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
2470
- | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly identifier for URL routing; unique among open drafts per workflow |
2470
+ | ​ ↳ `slug` | `string` | ✅ | — | Human-friendly display name, not an identifier: two open drafts of a workflow may share one |
2471
2471
  | ​ ↳ `base_version_id` | `string` | ✅ | — | The version this draft was forked from (the live version at draft creation), or null when the workflow had no published version yet |
2472
2472
  | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
2473
2473
  | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this draft |