@zapier/zapier-sdk 0.121.0 → 0.122.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.122.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 4f890ed: `listActionInputFields` and `listTriggerInputFields` now avoid a redundant app lookup when called with an app slug, reducing network requests and latency.
8
+
9
+ ## 0.122.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 246ba1d: Updated `zod` from 4.3.6 to 4.6.7. Importing `@zapier/zapier-sdk` now uses about 60% less memory (heap after import drops from 35.6 MB to 14.7 MB). The main bundle grows by about 31 KB gzipped, because zod 4.6.7 is larger than 4.3.6.
14
+
15
+ Projects that pass their own zod schemas to the SDK, or reuse its exported schemas, should be on zod 4.6.7 too so the types match. Those schemas follow zod 4.6: ISO timestamps need seconds, and string length limits count characters rather than UTF-16 units. The SDK's own inputs have no ISO timestamp checks, and their string limits are all maximums, so these rules do not make the SDK reject input it accepted before.
16
+
17
+ ### Patch Changes
18
+
19
+ - 246ba1d: Response fields with no fixed shape are now typed and documented as optional. On beta methods: `input` and `output` on `getDurableRun` and `listDurableRuns` (and `input` on a `getDurableRun` execution); `input`, `output` and `error` on `getWorkflowRun`, `getTriggerRun`, `runWorkflow` and `runWorkflowDraft`; `input` and `error` on `listWorkflowRuns`. On the experimental `createForm`: `document`, `consumer_auth` and `callback_url`. These methods already accepted a response without them, so behavior is unchanged.
20
+ - Updated dependencies [246ba1d]
21
+ - @zapier/kitcore@0.22.1
22
+
3
23
  ## 0.121.0
4
24
 
5
25
  ### Minor Changes
package/README.md CHANGED
@@ -1709,10 +1709,10 @@ Create a Zapier Form from a title and optional fields. Forms publish by default
1709
1709
  | ​ ↳ `owner_id` | `string` | ✅ | — | |
1710
1710
  | ​ ↳ `created_at` | `string` | ✅ | — | |
1711
1711
  | ​ ↳ `updated_at` | `string` | ✅ | — | |
1712
- | ​ ↳ `document` | `unknown` | ✅ | — | |
1712
+ | ​ ↳ `document` | `unknown` | ❌ | — | |
1713
1713
  | ​ ↳ `last_published_at` | `string` | ✅ | — | |
1714
- | ​ ↳ `consumer_auth` | `unknown` | ✅ | — | |
1715
- | ​ ↳ `callback_url` | `unknown` | ✅ | — | |
1714
+ | ​ ↳ `consumer_auth` | `unknown` | ❌ | — | |
1715
+ | ​ ↳ `callback_url` | `unknown` | ❌ | — | |
1716
1716
 
1717
1717
  **Example:**
1718
1718
 
@@ -1978,8 +1978,8 @@ Get the full state of a run-once durable run, including its operations journal
1978
1978
  | `data` | `object` | ✅ | — | |
1979
1979
  | ​ ↳ `id` | `string` | ✅ | — | Run ID (UUID) |
1980
1980
  | ​ ↳ `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
1981
- | ​ ↳ `input` | `unknown` | ✅ | — | Input data passed to the run |
1982
- | ​ ↳ `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
1981
+ | ​ ↳ `input` | `unknown` | ❌ | — | Input data passed to the run |
1982
+ | ​ ↳ `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
1983
1983
  | ​ ↳ `error` | `object` | ✅ | — | Structured error details when the run failed (null otherwise) |
1984
1984
  | ​ ↳ `execution` | `object` | ✅ | — | Linked execution, including the operations journal. Null while the run is still in `initialized` state. |
1985
1985
  | ​ ↳ `is_private` | `boolean` | ❌ | — | When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false. |
@@ -2015,9 +2015,9 @@ Get the workflow run associated with a deployed workflow's trigger. Useful immed
2015
2015
  | ​ ↳ `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2016
2016
  | ​ ↳ `workflow_version_id` | `string` | ✅ | — | Workflow version the run is bound to |
2017
2017
  | ​ ↳ `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2018
- | ​ ↳ `input` | `unknown` | ✅ | — | Input passed to the run |
2019
- | ​ ↳ `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2020
- | ​ ↳ `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2018
+ | ​ ↳ `input` | `unknown` | ❌ | — | Input passed to the run |
2019
+ | ​ ↳ `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2020
+ | ​ ↳ `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2021
2021
  | ​ ↳ `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2022
2022
  | ​ ↳ `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2023
2023
 
@@ -2156,9 +2156,9 @@ Get the current state of a workflow run — a live run of a published workflow v
2156
2156
  | `workflow_id` | `string` | ✅ | — | The workflow this run belongs to |
2157
2157
  | `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2158
2158
  | `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2159
- | `input` | `unknown` | ✅ | — | Input passed to the run |
2160
- | `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2161
- | `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2159
+ | `input` | `unknown` | ❌ | — | Input passed to the run |
2160
+ | `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2161
+ | `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2162
2162
  | `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2163
2163
  | `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2164
2164
  | `kind` | `string` | ✅ | `live` | A run of a published workflow version. |
@@ -2173,9 +2173,9 @@ Get the current state of a workflow run — a live run of a published workflow v
2173
2173
  | `workflow_id` | `string` | ✅ | — | The workflow this run belongs to |
2174
2174
  | `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2175
2175
  | `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2176
- | `input` | `unknown` | ✅ | — | Input passed to the run |
2177
- | `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2178
- | `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2176
+ | `input` | `unknown` | ❌ | — | Input passed to the run |
2177
+ | `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2178
+ | `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2179
2179
  | `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2180
2180
  | `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2181
2181
  | `kind` | `string` | ✅ | `draft` | A run launched from a workflow draft via `runWorkflowDraft`. |
@@ -2323,8 +2323,8 @@ List run-once durable runs for the authenticated account, newest first
2323
2323
  | `data[]` | `object[]` | ✅ | — | |
2324
2324
  | ​ ↳ `id` | `string` | ✅ | — | Run ID (UUID) |
2325
2325
  | ​ ↳ `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2326
- | ​ ↳ `input` | `unknown` | ✅ | — | Input data passed to the run |
2327
- | ​ ↳ `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2326
+ | ​ ↳ `input` | `unknown` | ❌ | — | Input data passed to the run |
2327
+ | ​ ↳ `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2328
2328
  | ​ ↳ `error` | `object` | ✅ | — | Structured error details when the run failed (null otherwise) |
2329
2329
  | ​ ↳ `execution_id` | `string` | ✅ | — | Linked execution ID. Null until the run leaves the `initialized` state. |
2330
2330
  | ​ ↳ `is_private` | `boolean` | ❌ | — | When true, the run is visible only to the creating user; when false, it is visible across the account. Deprecated: may be removed from the API in a future release. There is no replacement field; do not rely on it. An absent or null value means unknown, not false. |
@@ -2436,8 +2436,8 @@ List workflow runs for a specific workflow, newest first. Live runs (of publishe
2436
2436
  | `id` | `string` | ✅ | — | Workflow run ID (UUIDv7). Unique across live and draft runs. |
2437
2437
  | `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2438
2438
  | `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2439
- | `input` | `unknown` | ✅ | — | Input passed to the run |
2440
- | `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2439
+ | `input` | `unknown` | ❌ | — | Input passed to the run |
2440
+ | `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2441
2441
  | `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2442
2442
  | `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2443
2443
  | `kind` | `string` | ✅ | `live` | A run of a published workflow version. |
@@ -2451,8 +2451,8 @@ List workflow runs for a specific workflow, newest first. Live runs (of publishe
2451
2451
  | `id` | `string` | ✅ | — | Workflow run ID (UUIDv7). Unique across live and draft runs. |
2452
2452
  | `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2453
2453
  | `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2454
- | `input` | `unknown` | ✅ | — | Input passed to the run |
2455
- | `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2454
+ | `input` | `unknown` | ❌ | — | Input passed to the run |
2455
+ | `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2456
2456
  | `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2457
2457
  | `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2458
2458
  | `kind` | `string` | ✅ | `draft` | A run launched from a workflow draft via `runWorkflowDraft`. |
@@ -2772,9 +2772,9 @@ Run a published workflow and wait for its result: fires the workflow's trigger a
2772
2772
  | ​ ↳ `durable_run_id` | `string` | ✅ | — | Linked code-substrate-runner run ID. Null until the durable run is created. |
2773
2773
  | ​ ↳ `workflow_version_id` | `string` | ✅ | — | Workflow version the run is bound to |
2774
2774
  | ​ ↳ `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2775
- | ​ ↳ `input` | `unknown` | ✅ | — | Input passed to the run |
2776
- | ​ ↳ `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2777
- | ​ ↳ `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2775
+ | ​ ↳ `input` | `unknown` | ❌ | — | Input passed to the run |
2776
+ | ​ ↳ `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2777
+ | ​ ↳ `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2778
2778
  | ​ ↳ `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2779
2779
  | ​ ↳ `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2780
2780
  | ​ ↳ `trigger_id` | `string` | ✅ | — | Trigger ID of the run (UUID) |
@@ -2814,9 +2814,9 @@ Launch a draft test run: execute the draft's current source without publishing i
2814
2814
  | ​ ↳ `workflow_draft_id` | `string` | ✅ | — | The draft this run was launched from. Becomes null once that draft is deleted — the run outlives its draft. |
2815
2815
  | ​ ↳ `draft_revision` | `number` | ✅ | — | The draft's revision at the moment this run was created. |
2816
2816
  | ​ ↳ `status` | `string` | ✅ | `initialized`, `started`, `finished`, `failed`, `cancelled` | Workflow run lifecycle status. `finished` / `failed` / `cancelled` are terminal. |
2817
- | ​ ↳ `input` | `unknown` | ✅ | — | Input passed to the run |
2818
- | ​ ↳ `output` | `unknown` | ✅ | — | Return value, present when status is `finished` |
2819
- | ​ ↳ `error` | `unknown` | ✅ | — | Error payload when status is `failed` (null otherwise) |
2817
+ | ​ ↳ `input` | `unknown` | ❌ | — | Input passed to the run |
2818
+ | ​ ↳ `output` | `unknown` | ❌ | — | Return value, present when status is `finished` |
2819
+ | ​ ↳ `error` | `unknown` | ❌ | — | Error payload when status is `failed` (null otherwise) |
2820
2820
  | ​ ↳ `created_at` | `string` | ✅ | — | When the run was created (ISO-8601) |
2821
2821
  | ​ ↳ `updated_at` | `string` | ✅ | — | When the run was last updated (ISO-8601) |
2822
2822