@zapier/zapier-sdk 0.60.0 → 0.62.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @zapier/zapier-sdk
 
+## 0.62.0
+
+### Minor Changes
+
+- eb9b408: Add the durable-run-read experimental code-substrate plugins: `listDurableRuns` and `getDurableRun`. Both are registered only in `@zapier/zapier-sdk/experimental`; the stable subpath does not expose them. `listDurableRuns` is paginated (cursor + pageSize) per the sdkdurableapi `/api/v0/runs` contract; `getDurableRun` returns the full run state with nested execution and operations journal. Handlers pass API responses through verbatim (no client-side `.parse()` re-emission) so callers see any richer fields the server adds later without an SDK release. Also adds `durableRunIdResolver` in `src/resolvers/durableRunId.ts` so commands that take a run id present an interactive picker via `sdk.listDurableRuns()` in the CLI (uses `toIterable` to pull across pages). Input field naming follows the in-tree convention (`run` rather than the fork's `runId`); input is validated as a UUID at the boundary so non-UUID strings fail with a clear schema error instead of an opaque 500 from the backend's `::uuid` cast.
+
+## 0.61.0
+
+### Minor Changes
+
+- 4827ffe: Add the workflow-write experimental code-substrate plugins: `createWorkflow`, `updateWorkflow`, `enableWorkflow`, `disableWorkflow`, `deleteWorkflow`. All five are registered only in `@zapier/zapier-sdk/experimental`; the stable subpath does not expose them. The four ID-based ops (update, enable, disable, delete) reuse `workflowIdResolver` so callers get an interactive picker via `sdk.listWorkflows()`. `deleteWorkflow` is marked `confirm: "delete"` for an explicit confirmation prompt before the destructive call. Input field naming follows the in-tree convention (`workflow` rather than the fork's `workflowId`, matching `tableIdResolver`'s shape) and is validated as a UUID at the input boundary so non-UUID strings fail with a clear schema error instead of an opaque 500 from the backend's `::uuid` cast. Response shapes match what the durableworkflowzaps handlers actually emit — no fabricated `is_private` / `created_by_user_id` / `triggers` fields. Handlers pass API responses through verbatim (no client-side `.parse()` re-emission) so callers see any richer fields the server adds later without an SDK release.
+
+### Patch Changes
+
+- 104daa3: Fix login/logout reliability bugs.
+
+  **Bug fixes:**
+  - `logout` now warns and still clears local keychain/registry state when the server returns 401 during revocation (404 is still silently swallowed; 401 is surfaced as a console warning so users know to verify or revoke the credential manually if needed)
+  - Re-login no longer fails with "already exists" when a locally-orphaned registry entry has the same name as the desired new credential
+  - `logout` no longer prompts for confirmation before deleting credentials; it always proceeds immediately, which also fixes hangs in non-TTY/CI environments
+
+  **Deprecations:**
+  - `--skip-prompts` on `login` and `init` is deprecated in favour of `--non-interactive`. The old flag continues to work with a deprecation warning.
+
 ## 0.60.0
 
 ### Minor Changes

package/README.md

@@ -27,8 +27,15 @@
   - [`deleteClientCredentials`](#deleteclientcredentials)
   - [`listClientCredentials`](#listclientcredentials)
 - [Code Workflows (Experimental)](#code-workflows-experimental)
+  - [`createWorkflow`](#createworkflow--experimental)
+  - [`deleteWorkflow`](#deleteworkflow--experimental)
+  - [`disableWorkflow`](#disableworkflow--experimental)
+  - [`enableWorkflow`](#enableworkflow--experimental)
+  - [`getDurableRun`](#getdurablerun--experimental)
   - [`getWorkflow`](#getworkflow--experimental)
+  - [`listDurableRuns`](#listdurableruns--experimental)
   - [`listWorkflows`](#listworkflows--experimental)
+  - [`updateWorkflow`](#updateworkflow--experimental)
 - [Connections](#connections)
   - [`findFirstConnection`](#findfirstconnection)
   - [`findUniqueConnection`](#finduniqueconnection)
@@ -88,7 +95,7 @@ The following will create a new project from scratch, set up the SDK and the SDK
 npx @zapier/zapier-sdk-cli init my-zapier-app
 
 # Or skip the interactive prompts and accept all defaults.
-npx @zapier/zapier-sdk-cli init my-zapier-app --skip-prompts
+npx @zapier/zapier-sdk-cli init my-zapier-app --non-interactive
 ```
 
 ## Installation
@@ -1087,6 +1094,147 @@ for await (const clientCredentials of zapier.listClientCredentials().items()) {
 
 > ℹ️ **Experimental.** Import from `"@zapier/zapier-sdk/experimental"` to use these methods. Methods and behavior may change.
 
+#### `createWorkflow` 🧪 _experimental_
+
+Create a durable workflow container. Starts disabled with no version; publish a version to add code.
+
+**Parameters:**
+
+| Name              | Type     | Required | Default | Possible Values | Description                           |
+| ----------------- | -------- | -------- | ------- | --------------- | ------------------------------------- |
+| `options`         | `object` | ✅       | —       | —               |                                       |
+| ​ ↳ `name`        | `string` | ✅       | —       | —               | Workflow name                         |
+| ​ ↳ `description` | `string` | ❌       | —       | —               | Optional description for the workflow |
+
+**Returns:** `Promise<WorkflowItem>`
+
+| Name              | Type      | Required | Possible Values | Description                                                                                                                 |
+| ----------------- | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `data`            | `object`  | ✅       | —               |                                                                                                                             |
+| ​ ↳ `id`          | `string`  | ✅       | —               | Workflow ID (UUID)                                                                                                          |
+| ​ ↳ `name`        | `string`  | ✅       | —               | Workflow name                                                                                                               |
+| ​ ↳ `description` | `string`  | ✅       | —               | Workflow description (null if unset)                                                                                        |
+| ​ ↳ `trigger_url` | `string`  | ✅       | —               | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
+| ​ ↳ `enabled`     | `boolean` | ✅       | —               | Whether the workflow currently accepts triggers. Always false on a new workflow until enabled.                              |
+| ​ ↳ `created_at`  | `string`  | ✅       | —               | When the workflow was created (ISO-8601)                                                                                    |
+
+**Example:**
+
+```typescript
+const result = await zapier.createWorkflow({
+  name: "example-name",
+});
+```
+
+#### `deleteWorkflow` 🧪 _experimental_
+
+Delete a durable workflow. Throws `ZapierNotFoundError` if the workflow doesn't exist; callers wanting idempotency should catch that themselves.
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description         |
+| -------------- | -------- | -------- | ------- | --------------- | ------------------- |
+| `options`      | `object` | ✅       | —       | —               |                     |
+| ​ ↳ `workflow` | `string` | ✅       | —       | —               | Durable workflow ID |
+
+**Returns:** `Promise<{ success: boolean }>`
+
+**Example:**
+
+```typescript
+const result = await zapier.deleteWorkflow({
+  workflow: "example-workflow",
+});
+```
+
+#### `disableWorkflow` 🧪 _experimental_
+
+Disable a durable workflow so it stops accepting triggers
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description         |
+| -------------- | -------- | -------- | ------- | --------------- | ------------------- |
+| `options`      | `object` | ✅       | —       | —               |                     |
+| ​ ↳ `workflow` | `string` | ✅       | —       | —               | Durable workflow ID |
+
+**Returns:** `Promise<WorkflowItem>`
+
+| Name          | Type      | Required | Possible Values | Description                                                                                                                                   |
+| ------------- | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `data`        | `object`  | ✅       | —               |                                                                                                                                               |
+| ​ ↳ `id`      | `string`  | ✅       | —               | Workflow ID (UUID)                                                                                                                            |
+| ​ ↳ `enabled` | `boolean` | ✅       | —               | Workflow's enabled state after the operation. Typically false; mirrors the row's true state in case a concurrent enable raced with this call. |
+
+**Example:**
+
+```typescript
+const result = await zapier.disableWorkflow({
+  workflow: "example-workflow",
+});
+```
+
+#### `enableWorkflow` 🧪 _experimental_
+
+Enable a durable workflow so it accepts triggers
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description         |
+| -------------- | -------- | -------- | ------- | --------------- | ------------------- |
+| `options`      | `object` | ✅       | —       | —               |                     |
+| ​ ↳ `workflow` | `string` | ✅       | —       | —               | Durable workflow ID |
+
+**Returns:** `Promise<WorkflowItem>`
+
+| Name          | Type      | Required | Possible Values | Description                                                |
+| ------------- | --------- | -------- | --------------- | ---------------------------------------------------------- |
+| `data`        | `object`  | ✅       | —               |                                                            |
+| ​ ↳ `id`      | `string`  | ✅       | —               | Workflow ID (UUID)                                         |
+| ​ ↳ `enabled` | `boolean` | ✅       | —               | Workflow's enabled state after the operation (always true) |
+
+**Example:**
+
+```typescript
+const result = await zapier.enableWorkflow({
+  workflow: "example-workflow",
+});
+```
+
+#### `getDurableRun` 🧪 _experimental_
+
+Get the full state of a run-once durable run, including its operations journal
+
+**Parameters:**
+
+| Name      | Type     | Required | Default | Possible Values | Description    |
+| --------- | -------- | -------- | ------- | --------------- | -------------- |
+| `options` | `object` | ✅       | —       | —               |                |
+| ​ ↳ `run` | `string` | ✅       | —       | —               | Durable run ID |
+
+**Returns:** `Promise<DurableRunItem>`
+
+| Name             | Type      | Required | Possible Values                                             | Description                                                                                             |
+| ---------------- | --------- | -------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `data`           | `object`  | ✅       | —                                                           |                                                                                                         |
+| ​ ↳ `id`         | `string`  | ✅       | —                                                           | Run ID (UUID)                                                                                           |
+| ​ ↳ `status`     | `string`  | ✅       | `initialized`, `started`, `finished`, `failed`, `cancelled` | Run lifecycle status. `finished` / `failed` / `cancelled` are terminal.                                 |
+| ​ ↳ `input`      | `string`  | ✅       | —                                                           | Input data passed to the run                                                                            |
+| ​ ↳ `output`     | `string`  | ✅       | —                                                           | Return value, present when status is `finished`                                                         |
+| ​ ↳ `error`      | `object`  | ✅       | —                                                           | Structured error details when the run failed (null otherwise)                                           |
+| ​ ↳ `execution`  | `object`  | ✅       | —                                                           | Linked execution, including the operations journal. Null while the run is still in `initialized` state. |
+| ​ ↳ `is_private` | `boolean` | ✅       | —                                                           | When true, the run is visible only to the creating user; otherwise visible across the account.          |
+| ​ ↳ `created_at` | `string`  | ✅       | —                                                           | When the run was created (ISO-8601)                                                                     |
+| ​ ↳ `updated_at` | `string`  | ✅       | —                                                           | When the run was last updated (ISO-8601)                                                                |
+
+**Example:**
+
+```typescript
+const { data: durableRun } = await zapier.getDurableRun({
+  run: "example-run",
+});
+```
+
 #### `getWorkflow` 🧪 _experimental_
 
 Get a durable workflow with its current version details and trigger claim status
@@ -1127,6 +1275,52 @@ const { data: workflow } = await zapier.getWorkflow({
 });
 ```
 
+#### `listDurableRuns` 🧪 _experimental_
+
+List run-once durable runs for the authenticated account, newest first
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description                                    |
+| -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
+| `options`      | `object` | ✅       | —       | —               |                                                |
+| ​ ↳ `pageSize` | `number` | ❌       | —       | —               | Number of runs per page (max 100)              |
+| ​ ↳ `cursor`   | `string` | ❌       | —       | —               | Pagination cursor                              |
+| ​ ↳ `maxItems` | `number` | ❌       | —       | —               | Maximum total items to return across all pages |
+
+**Returns:** `Promise<PaginatedResult<DurableRunItem>>`
+
+| Name               | Type       | Required | Possible Values                                             | Description                                                                                    |
+| ------------------ | ---------- | -------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `data[]`           | `object[]` | ✅       | —                                                           |                                                                                                |
+| ​ ↳ `id`           | `string`   | ✅       | —                                                           | Run ID (UUID)                                                                                  |
+| ​ ↳ `status`       | `string`   | ✅       | `initialized`, `started`, `finished`, `failed`, `cancelled` | Run lifecycle status. `finished` / `failed` / `cancelled` are terminal.                        |
+| ​ ↳ `input`        | `string`   | ✅       | —                                                           | Input data passed to the run                                                                   |
+| ​ ↳ `output`       | `string`   | ✅       | —                                                           | Return value, present when status is `finished`                                                |
+| ​ ↳ `error`        | `object`   | ✅       | —                                                           | Structured error details when the run failed (null otherwise)                                  |
+| ​ ↳ `execution_id` | `string`   | ✅       | —                                                           | Linked execution ID. Null until the run leaves the `initialized` state.                        |
+| ​ ↳ `is_private`   | `boolean`  | ✅       | —                                                           | When true, the run is visible only to the creating user; otherwise visible across the account. |
+| ​ ↳ `created_at`   | `string`   | ✅       | —                                                           | When the run was created (ISO-8601)                                                            |
+| ​ ↳ `updated_at`   | `string`   | ✅       | —                                                           | When the run was last updated (ISO-8601)                                                       |
+| `nextCursor`       | `string`   | ❌       | —                                                           | Cursor for the next page; omitted when there are no more pages                                 |
+
+**Example:**
+
+```typescript
+// Get first page and a cursor for the second page
+const { data: durableRuns, nextCursor } = await zapier.listDurableRuns();
+
+// Or iterate over all pages
+for await (const page of zapier.listDurableRuns()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const durableRun of zapier.listDurableRuns().items()) {
+  // Do something with each durableRun
+}
+```
+
 #### `listWorkflows` 🧪 _experimental_
 
 List all active durable workflows for the authenticated account
@@ -1172,6 +1366,40 @@ for await (const workflow of zapier.listWorkflows().items()) {
 }
 ```
 
+#### `updateWorkflow` 🧪 _experimental_
+
+Update a durable workflow's name and/or description
+
+**Parameters:**
+
+| Name              | Type     | Required | Default | Possible Values | Description                                           |
+| ----------------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------- |
+| `options`         | `object` | ✅       | —       | —               |                                                       |
+| ​ ↳ `workflow`    | `string` | ✅       | —       | —               | Durable workflow ID                                   |
+| ​ ↳ `name`        | `string` | ❌       | —       | —               | New name for the workflow                             |
+| ​ ↳ `description` | `string` | ❌       | —       | —               | New description for the workflow (pass null to clear) |
+
+**Returns:** `Promise<WorkflowItem>`
+
+| Name              | Type      | Required | Possible Values | Description                                                                                                                 |
+| ----------------- | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `data`            | `object`  | ✅       | —               |                                                                                                                             |
+| ​ ↳ `id`          | `string`  | ✅       | —               | Workflow ID (UUID)                                                                                                          |
+| ​ ↳ `name`        | `string`  | ✅       | —               | Workflow name (post-update)                                                                                                 |
+| ​ ↳ `description` | `string`  | ✅       | —               | Workflow description, post-update (null if unset)                                                                           |
+| ​ ↳ `trigger_url` | `string`  | ✅       | —               | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
+| ​ ↳ `enabled`     | `boolean` | ✅       | —               | Whether the workflow currently accepts triggers                                                                             |
+| ​ ↳ `created_at`  | `string`  | ✅       | —               | When the workflow was created (ISO-8601)                                                                                    |
+| ​ ↳ `updated_at`  | `string`  | ✅       | —               | When this update was applied (ISO-8601)                                                                                     |
+
+**Example:**
+
+```typescript
+const result = await zapier.updateWorkflow({
+  workflow: "example-workflow",
+});
+```
+
 ### Connections
 
 #### `findFirstConnection`