@tailor-platform/sdk 1.10.1 → 1.11.1

package/dist/utils/test/index.d.mts

@@ -1,6 +1,6 @@
 /// <reference path="./../../user-defined.d.ts" />
-import { et as TailorDBType, mt as TailorField } from "../../index-CoqePlnt.mjs";
-import { W as WORKFLOW_TEST_ENV_KEY, n as output } from "../../index-BQw6I-mY.mjs";
+import { et as TailorDBType, mt as TailorField } from "../../index-DcOTucF6.mjs";
+import { W as WORKFLOW_TEST_ENV_KEY, n as output } from "../../index-DnoS_Mi4.mjs";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/utils/test/index.d.ts

package/docs/cli/executor.md

@@ -6,7 +6,7 @@ Commands for managing executors and executor jobs.
 
 ## executor
 
-Manage executors and executor jobs.
+Manage executors
 
 **Usage**
 
@@ -18,65 +18,63 @@ tailor-sdk executor [command]
 
 | Command                                 | Description                   |
 | --------------------------------------- | ----------------------------- |
+| [`executor list`](#executor-list)       | List all executors            |
+| [`executor get`](#executor-get)         | Get executor details          |
 | [`executor jobs`](#executor-jobs)       | List or get executor jobs.    |
 | [`executor trigger`](#executor-trigger) | Trigger an executor manually. |
+| [`executor webhook`](#executor-webhook) | Manage executor webhooks      |
 
 <!-- politty:command:executor:end -->
-<!-- politty:command:executor trigger:start -->
 
-### executor trigger
+<!-- politty:command:executor list:start -->
 
-Trigger an executor manually.
+### executor list
+
+List all executors
 
 **Usage**
 
 ```
-tailor-sdk executor trigger [options] <executorName>
+tailor-sdk executor list [options]
 ```
 
-**Arguments**
+**Options**
 
-| Argument       | Description   | Required |
-| -------------- | ------------- | -------- |
-| `executorName` | Executor name | Yes      |
+| Option                          | Alias | Description       | Default |
+| ------------------------------- | ----- | ----------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON    | `false` |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | -       |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile | -       |
 
-**Options**
+<!-- politty:command:executor list:end -->
 
-| Option                          | Alias | Description                                                                        | Default |
-| ------------------------------- | ----- | ---------------------------------------------------------------------------------- | ------- |
-| `--json`                        | `-j`  | Output as JSON                                                                     | `false` |
-| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID                                                                       | -       |
-| `--profile <PROFILE>`           | `-p`  | Workspace profile                                                                  | -       |
-| `--data <DATA>`                 | `-d`  | Request body (JSON string)                                                         | -       |
-| `--header <HEADER>`             | `-H`  | Request header (format: 'Key: Value', can be specified multiple times)             | -       |
-| `--wait`                        | `-W`  | Wait for job completion and downstream execution (workflow/function) if applicable | `false` |
-| `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m')                     | `"3s"`  |
-| `--logs`                        | `-l`  | Display function execution logs after completion (requires --wait)                 | `false` |
+<!-- politty:command:executor get:start -->
 
-<!-- politty:command:executor trigger:end -->
+### executor get
 
-Only executors with `incomingWebhook` or `schedule` trigger types can be triggered manually. Executors with `event` trigger types (such as `recordCreated`, `recordUpdated`, `recordDeleted`) cannot be triggered manually.
+Get executor details
 
-The `--data` and `--header` options are only available for `incomingWebhook` trigger type.
+**Usage**
 
-**Usage Examples:**
+```
+tailor-sdk executor get [options] <name>
+```
 
-```bash
-# Trigger an executor
-tailor-sdk executor trigger my-executor
+**Arguments**
 
-# Trigger with data
-tailor-sdk executor trigger my-executor -d '{"message": "hello"}'
+| Argument | Description   | Required |
+| -------- | ------------- | -------- |
+| `name`   | Executor name | Yes      |
 
-# Trigger with data and headers
-tailor-sdk executor trigger my-executor -d '{"message": "hello"}' -H "X-Custom: value" -H "X-Another: value2"
+**Options**
 
-# Trigger and wait for completion
-tailor-sdk executor trigger my-executor -W
+| Option                          | Alias | Description       | Default |
+| ------------------------------- | ----- | ----------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON    | `false` |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | -       |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile | -       |
 
-# Trigger, wait, and show logs
-tailor-sdk executor trigger my-executor -W -l
-```
+<!-- politty:command:executor get:end -->
 
 <!-- politty:command:executor jobs:start -->
 
@@ -111,34 +109,123 @@ tailor-sdk executor jobs [options] <executorName> [jobId]
 | `--logs`                        | `-l`  | Display function execution logs after completion (requires --wait)                                    | `false` |
 | `--limit <LIMIT>`               | -     | Maximum number of jobs to list (default: 50, max: 1000) (list mode only)                              | -       |
 
+**Examples**
+
+**List jobs for an executor (default: 50 jobs)**
+
+```bash
+$ tailor-sdk executor jobs my-executor
+```
+
+**Limit the number of jobs**
+
+```bash
+$ tailor-sdk executor jobs my-executor --limit 10
+```
+
+**Filter by status**
+
+```bash
+$ tailor-sdk executor jobs my-executor -s RUNNING
+```
+
+**Get job details**
+
+```bash
+$ tailor-sdk executor jobs my-executor <job-id>
+```
+
+**Get job details with attempts**
+
+```bash
+$ tailor-sdk executor jobs my-executor <job-id> --attempts
+```
+
+**Wait for job to complete**
+
+```bash
+$ tailor-sdk executor jobs my-executor <job-id> -W
+```
+
+**Wait for job with logs**
+
+```bash
+$ tailor-sdk executor jobs my-executor <job-id> -W -l
+```
+
 <!-- politty:command:executor jobs:end -->
 
-**Usage Examples:**
+<!-- politty:command:executor trigger:start -->
+
+### executor trigger
+
+Trigger an executor manually.
+
+**Usage**
+
+```
+tailor-sdk executor trigger [options] <executorName>
+```
+
+**Arguments**
+
+| Argument       | Description   | Required |
+| -------------- | ------------- | -------- |
+| `executorName` | Executor name | Yes      |
+
+**Options**
+
+| Option                          | Alias | Description                                                                        | Default |
+| ------------------------------- | ----- | ---------------------------------------------------------------------------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON                                                                     | `false` |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID                                                                       | -       |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile                                                                  | -       |
+| `--data <DATA>`                 | `-d`  | Request body (JSON string)                                                         | -       |
+| `--header <HEADER>`             | `-H`  | Request header (format: 'Key: Value', can be specified multiple times)             | -       |
+| `--wait`                        | `-W`  | Wait for job completion and downstream execution (workflow/function) if applicable | `false` |
+| `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m')                     | `"3s"`  |
+| `--logs`                        | `-l`  | Display function execution logs after completion (requires --wait)                 | `false` |
+
+**Examples**
+
+**Trigger an executor**
+
+```bash
+$ tailor-sdk executor trigger my-executor
+```
+
+**Trigger with data**
 
 ```bash
-# List jobs for an executor (default: 50 jobs)
-tailor-sdk executor jobs my-executor
+$ tailor-sdk executor trigger my-executor -d '{"message": "hello"}'
+```
 
-# Limit the number of jobs
-tailor-sdk executor jobs my-executor --limit 10
+**Trigger with data and headers**
 
-# Filter by status
-tailor-sdk executor jobs my-executor -s RUNNING
+```bash
+$ tailor-sdk executor trigger my-executor -d '{"message": "hello"}' -H "X-Custom: value" -H "X-Another: value2"
+```
 
-# Get job details
-tailor-sdk executor jobs my-executor <job-id>
+**Trigger and wait for completion**
 
-# Get job details with attempts
-tailor-sdk executor jobs my-executor <job-id> --attempts
+```bash
+$ tailor-sdk executor trigger my-executor -W
+```
 
-# Wait for job to complete
-tailor-sdk executor jobs my-executor <job-id> -W
+**Trigger, wait, and show logs**
 
-# Wait for job with logs
-tailor-sdk executor jobs my-executor <job-id> -W -l
+```bash
+$ tailor-sdk executor trigger my-executor -W -l
 ```
 
-## Downstream Execution Tracking
+**Notes**
+
+Only executors with `INCOMING_WEBHOOK` or `SCHEDULE` trigger types can be triggered manually.
+Executors with `EVENT` trigger types (such as `recordCreated`, `recordUpdated`, `recordDeleted`) cannot be triggered manually.
+
+The `--data` and `--header` options are only available for `INCOMING_WEBHOOK` trigger type.
+
+**Downstream Execution Tracking**
 
 When using `--wait`, the CLI tracks not only the executor job but also any downstream executions:
 
@@ -147,3 +234,47 @@ When using `--wait`, the CLI tracks not only the executor job but also any downs
 - **Webhook/GraphQL targets**: Only waits for the executor job itself
 
 The `--logs` option displays logs from the downstream execution when available.
+
+<!-- politty:command:executor trigger:end -->
+
+<!-- politty:command:executor webhook:start -->
+
+### executor webhook
+
+Manage executor webhooks
+
+**Usage**
+
+```
+tailor-sdk executor webhook [command]
+```
+
+**Commands**
+
+| Command                                           | Description                                   |
+| ------------------------------------------------- | --------------------------------------------- |
+| [`executor webhook list`](#executor-webhook-list) | List executors with incoming webhook triggers |
+
+<!-- politty:command:executor webhook:end -->
+
+<!-- politty:command:executor webhook list:start -->
+
+#### executor webhook list
+
+List executors with incoming webhook triggers
+
+**Usage**
+
+```
+tailor-sdk executor webhook list [options]
+```
+
+**Options**
+
+| Option                          | Alias | Description       | Default |
+| ------------------------------- | ----- | ----------------- | ------- |
+| `--json`                        | `-j`  | Output as JSON    | `false` |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | -       |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile | -       |
+
+<!-- politty:command:executor webhook list:end -->

package/docs/services/workflow.md

@@ -56,6 +56,34 @@ export const fetchCustomer = createWorkflowJob({
 });
 ```
 
+## Input and Output Type Constraints
+
+Workflow job inputs and outputs are serialized as JSON when passed between jobs. This imposes type constraints:
+
+**Input types** must be JSON-compatible — only primitives (`string`, `number`, `boolean`, `null`), arrays, and plain objects are allowed. `Date`, `Map`, `Set`, functions, and other non-serializable types cannot be used.
+
+```typescript
+// OK
+export const myJob = createWorkflowJob({
+  name: "my-job",
+  body: async (input: { id: string; count: number; tags: string[] }) => {
+    // ...
+  },
+});
+
+// Compile error — Date is not allowed in input
+export const badJob = createWorkflowJob({
+  name: "bad-job",
+  body: async (input: { createdAt: Date }) => {
+    // ...
+  },
+});
+```
+
+**Output types** are more permissive — `Date` and objects with `toJSON()` are allowed because they are serialized via `JSON.stringify` at runtime (e.g., `Date` becomes a string).
+
+These constraints are enforced at compile time — you will get a type error if you use an unsupported type.
+
 ## Triggering Jobs
 
 Use `.trigger()` to start other jobs from within a job.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/sdk",
-  "version": "1.10.1",
+  "version": "1.11.1",
   "description": "Tailor Platform SDK - The SDK to work with Tailor Platform",
   "license": "MIT",
   "repository": {
@@ -51,6 +51,7 @@
     "confbox": "0.2.2",
     "consola": "3.4.2",
     "date-fns": "4.1.0",
+    "es-toolkit": "^1.44.0",
     "find-up-simple": "1.0.1",
     "inflection": "3.0.2",
     "madge": "8.0.0",