@zapier/zapier-sdk 0.98.1 → 0.100.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @zapier/zapier-sdk
 
+## 0.100.0
+
+### Minor Changes
+
+- 22a885c: Added `validateWorkflow` (experimental) to check durable workflow source without publishing it. Pass `sourceFiles` (absolute logical path → TypeScript source) and an optional `entrypointFile`, which defaults to `/workflow.ts`. The response carries an `issues` array that is empty when the source is valid; each issue has a `kind`, a `message`, a `severity` (`error`, `warning`, `info`, or `hint`), an optional `suggestion`, and usually the `source` location it points at. New `kind` values are added over time, so treat an unfamiliar one as a diagnostic rather than an error.
+
+## 0.99.0
+
+### Minor Changes
+
+- 9cde1f6: Item and list methods accept `skipOutputDataValidation: true` alongside their
+  input, bypassing output validation for that one call. Most methods here opt out
+  of validation at authoring time, where a caller's flag does nothing, so it
+  applies to `createActionRun` and `getActionRun`. Both build their response field
+  by field, so nothing is stripped either way, and the visible difference is a
+  `meta.outputDataValidation` sidecar on a call that passes it.
+
+  `ResponseMeta` gains `outputDataValidation`, a union discriminated on `skipped`,
+  which supersedes the deprecated `outputValidation`. That field is still written,
+  with the same `{ droppedPaths }` shape.
+
+  `defineOverride` is re-exported, so a head can patch how a surface presents an
+  SDK method without importing kitcore. `defineMethodOverride` is deprecated in
+  its favour and still works.
+
 ## 0.98.1
 
 ### Patch Changes

package/README.md

@@ -53,6 +53,7 @@
   - [`triggerWorkflow`](#triggerworkflow--experimental)
   - [`updateWorkflow`](#updateworkflow--experimental)
   - [`updateWorkflowDraft`](#updateworkflowdraft--experimental)
+  - [`validateWorkflow`](#validateworkflow--experimental)
 - [Connections](#connections)
   - [`createConnection`](#createconnection)
   - [`findFirstConnection`](#findfirstconnection)
@@ -2213,6 +2214,48 @@ const { data: workflowDraft } = await zapier.updateWorkflowDraft({
 });
 ```
 
+#### `validateWorkflow` 🧪 _experimental_
+
+Validate durable workflow source without publishing it. Returns source diagnostics; issue kinds are extensible and may be unfamiliar to the client.
+
+**Parameters:**
+
+| Name                 | Type     | Required | Default | Possible Values | Description                                                                       |
+| -------------------- | -------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------- |
+| `options`            | `object` | ✅       | —       | —               |                                                                                   |
+| ​ ↳ `sourceFiles`    | `object` | ✅       | —       | —               | Exact TypeScript sources keyed by absolute logical path.                          |
+| ​ ↳ `entrypointFile` | `string` | ❌       | —       | —               | Absolute logical path of the entry file in sourceFiles. Defaults to /workflow.ts. |
+
+**Returns:** `Promise<WorkflowValidationItem>`
+
+| Name                   | Type       | Required | Possible Values                    | Description                                                                         |
+| ---------------------- | ---------- | -------- | ---------------------------------- | ----------------------------------------------------------------------------------- |
+| `data`                 | `object`   | ✅       | —                                  |                                                                                     |
+| ​ ↳ `issues[]`         | `object[]` | ✅       | —                                  | Source diagnostics, or an empty array when validation passes.                       |
+| ​   ↳ `kind`           | `string`   | ✅       | —                                  | Extensible diagnostic category; clients must accept unfamiliar values.              |
+| ​   ↳ `message`        | `string`   | ✅       | —                                  | Safe human-readable explanation.                                                    |
+| ​   ↳ `severity`       | `string`   | ✅       | `error`, `warning`, `info`, `hint` | Diagnostic severity.                                                                |
+| ​   ↳ `suggestion`     | `string`   | ❌       | —                                  | Actionable fix hint.                                                                |
+| ​   ↳ `source`         | `object`   | ❌       | —                                  | Affected source location.                                                           |
+| ​     ↳ `file_id`      | `string`   | ✅       | —                                  | Source file containing the diagnostic.                                              |
+| ​     ↳ `start_line`   | `number`   | ✅       | —                                  | Inclusive 1-based start line.                                                       |
+| ​     ↳ `start_column` | `number`   | ✅       | —                                  | Inclusive 1-based start column.                                                     |
+| ​     ↳ `end_line`     | `number`   | ✅       | —                                  | Inclusive 1-based end line.                                                         |
+| ​     ↳ `end_column`   | `number`   | ✅       | —                                  | Inclusive 1-based end column.                                                       |
+| ​   ↳ `source_excerpt` | `string`   | ❌       | —                                  | Source text the diagnostic was raised against, truncated to 240 characters.         |
+| ​   ↳ `syntax_kind`    | `string`   | ❌       | —                                  | TypeScript AST node kind the diagnostic was raised against (e.g. `CallExpression`). |
+
+**Example:**
+
+```typescript
+const { data: workflowValidation } = await zapier.validateWorkflow({
+  sourceFiles: {
+    "/workflow.ts":
+      'import { defineDurable } from "@zapier/zapier-durable"; export default defineDurable("hello-world", async (ctx, input) => { return ctx.step("greet", async () => "Hello, world!"); });',
+  },
+});
+```
+
 ### Connections
 
 #### `createConnection`