@zapier/zapier-sdk 0.59.0 → 0.61.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @zapier/zapier-sdk
 
+## 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
+
+- f12598a: Add the workflow-read experimental plugins: `listWorkflows` and `getWorkflow`. Both are registered only in `@zapier/zapier-sdk/experimental`; the stable subpath does not expose them. `listWorkflows` uses `createPaginatedPluginMethod` (page-iterator + `pageSize`/`cursor`/`maxItems` options) so callers can iterate via `for await (const page of sdk.listWorkflows())` or `toIterable(sdk.listWorkflows())`. The backend does not paginate today; the SDK treats a missing `next_cursor` as the last page, so server-side pagination drops in without an SDK API change. Introduces `packages/zapier-sdk/src/plugins/codeSubstrate/shared.ts` with `codeSubstrateDefaults` (`{ categories: ["code-workflow"], experimental: true }`) that subsequent code-workflow plugins spread into their `createPluginMethod` configs. Also adds `workflowIdResolver` in `src/resolvers/workflowId.ts` (mirrors `tableIdResolver` / `triggerInboxResolver`) so commands that take a workflow id present an interactive picker via `sdk.listWorkflows()` in the CLI. Workflow-write commands (`createWorkflow`, `updateWorkflow`, `enable/disable/deleteWorkflow`) land in a follow-up MR.
+
 ## 0.59.0
 
 ### Minor Changes

package/README.md

@@ -26,6 +26,14 @@
   - [`createClientCredentials`](#createclientcredentials)
   - [`deleteClientCredentials`](#deleteclientcredentials)
   - [`listClientCredentials`](#listclientcredentials)
+- [Code Workflows (Experimental)](#code-workflows-experimental)
+  - [`createWorkflow`](#createworkflow--experimental)
+  - [`deleteWorkflow`](#deleteworkflow--experimental)
+  - [`disableWorkflow`](#disableworkflow--experimental)
+  - [`enableWorkflow`](#enableworkflow--experimental)
+  - [`getWorkflow`](#getworkflow--experimental)
+  - [`listWorkflows`](#listworkflows--experimental)
+  - [`updateWorkflow`](#updateworkflow--experimental)
 - [Connections](#connections)
   - [`findFirstConnection`](#findfirstconnection)
   - [`findUniqueConnection`](#finduniqueconnection)
@@ -85,7 +93,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
@@ -1080,6 +1088,236 @@ for await (const clientCredentials of zapier.listClientCredentials().items()) {
 }
 ```
 
+### Code Workflows (Experimental)
+
+> ℹ️ **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",
+});
+```
+
+#### `getWorkflow` 🧪 _experimental_
+
+Get a durable workflow with its current version details and trigger claim status
+
+**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)                                                                                                          |
+| ​ ↳ `name`                     | `string`  | ✅       | —               | Workflow name                                                                                                               |
+| ​ ↳ `description`              | `string`  | ✅       | —               | Optional 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                                                                             |
+| ​ ↳ `current_version`          | `object`  | ❌       | —               | The currently published version, if any. Absent for workflows with no version published yet.                                |
+| ​   ↳ `id`                     | `string`  | ✅       | —               | Workflow version ID (UUID)                                                                                                  |
+| ​   ↳ `workflow_id`            | `string`  | ✅       | —               | Parent workflow ID                                                                                                          |
+| ​   ↳ `source_files`           | `object`  | ✅       | —               | Source files keyed by filename → contents                                                                                   |
+| ​   ↳ `zapier_durable_version` | `string`  | ✅       | —               | Pinned semver of @zapier/zapier-durable used by this version's runs                                                         |
+| ​   ↳ `dependencies`           | `object`  | ✅       | —               | Additional npm dependencies pinned for this version (or null)                                                               |
+| ​   ↳ `created_by_user_id`     | `string`  | ✅       | —               | ID of the user who published this version                                                                                   |
+| ​   ↳ `created_at`             | `string`  | ✅       | —               | When the version was published (ISO-8601)                                                                                   |
+| ​ ↳ `created_at`               | `string`  | ✅       | —               | When the workflow was created (ISO-8601)                                                                                    |
+| ​ ↳ `updated_at`               | `string`  | ✅       | —               | When the workflow was last modified (ISO-8601)                                                                              |
+
+**Example:**
+
+```typescript
+const { data: workflow } = await zapier.getWorkflow({
+  workflow: "example-workflow",
+});
+```
+
+#### `listWorkflows` 🧪 _experimental_
+
+List all active durable workflows for the authenticated account
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description                                                                                  |
+| -------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------- |
+| `options`      | `object` | ✅       | —       | —               |                                                                                              |
+| ​ ↳ `pageSize` | `number` | ❌       | —       | —               | Number of workflows per page (server-side pagination forthcoming; ignored until then)        |
+| ​ ↳ `maxItems` | `number` | ❌       | —       | —               | Maximum total workflows to return across all pages                                           |
+| ​ ↳ `cursor`   | `string` | ❌       | —       | —               | Cursor to start from for pagination (server-side pagination forthcoming; ignored until then) |
+
+**Returns:** `Promise<PaginatedResult<WorkflowItem>>`
+
+| Name                     | Type       | Required | Possible Values | Description                                                                                                                 |
+| ------------------------ | ---------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `data[]`                 | `object[]` | ✅       | —               |                                                                                                                             |
+| ​ ↳ `id`                 | `string`   | ✅       | —               | Workflow ID (UUID)                                                                                                          |
+| ​ ↳ `name`               | `string`   | ✅       | —               | Workflow name                                                                                                               |
+| ​ ↳ `description`        | `string`   | ✅       | —               | Optional 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                                                                             |
+| ​ ↳ `current_version_id` | `string`   | ✅       | —               | ID of the workflow version that runs handle. Null until a version is published.                                             |
+| ​ ↳ `created_at`         | `string`   | ✅       | —               | When the workflow was created (ISO-8601)                                                                                    |
+| ​ ↳ `updated_at`         | `string`   | ✅       | —               | When the workflow was last modified (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: workflows, nextCursor } = await zapier.listWorkflows();
+
+// Or iterate over all pages
+for await (const page of zapier.listWorkflows()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const workflow of zapier.listWorkflows().items()) {
+  // Do something with each workflow
+}
+```
+
+#### `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`