@tailor-platform/sdk 1.4.2 → 1.6.0

package/docs/services/auth.md

@@ -32,6 +32,10 @@ const auth = defineAuth("my-auth", {
     usernameField: "email",
     attributes: { role: true },
   },
+  // Optional when you don't define userProfile:
+  // machineUserAttributes: {
+  //   role: t.string(),
+  // },
   machineUsers: {
     "admin-machine-user": {
       attributes: { role: "ADMIN" },
@@ -84,6 +88,36 @@ export const user = db.type("User", {
 
 **attributes**: Specifies which fields from the TailorDB type are used as user attributes. Set to `true` to enable a field. Enabled attributes must be assigned values in all machine user definitions.
 
+## Machine User Attributes (without userProfile)
+
+When you want to use machine users without defining a `userProfile`, define `machineUserAttributes` instead. These attributes are used for:
+
+- type-safe `machineUsers[*].attributes`
+- `context.user.attributes` typing (via `user-defined.d.ts`)
+
+```typescript
+import { defineAuth, t } from "@tailor-platform/sdk";
+
+export const auth = defineAuth("my-auth", {
+  machineUserAttributes: {
+    role: t.string(),
+    isActive: t.bool(),
+    tags: t.string({ array: true }),
+  },
+  machineUsers: {
+    "admin-machine-user": {
+      attributes: { role: "ADMIN", isActive: true, tags: ["root"] },
+    },
+  },
+});
+```
+
+To update types in `user-defined.d.ts`, run:
+
+```bash
+tailor-sdk generate
+```
+
 ## Machine Users
 
 Service accounts for automated access without user interaction:
@@ -99,7 +133,7 @@ machineUsers: {
 },
 ```
 
-**attributes**: Values for attributes enabled in `userProfile.attributes`. All fields marked as `true` in `userProfile.attributes` must be set here. These values are accessible via `user.attributes`:
+**attributes**: Values for attributes enabled in `userProfile.attributes` (or all fields defined in `machineUserAttributes` when `userProfile` is omitted). All enabled fields must be set here. These values are accessible via `user.attributes`:
 
 ```typescript
 // In a resolver

package/docs/testing.md

@@ -171,6 +171,87 @@ describe("decrementUserAge resolver", () => {
 - Mock high-level operations instead of low-level SQL queries
 - **Best for:** Complex business logic with multiple database operations
 
+## Workflow Tests
+
+Test workflows locally without deploying to Tailor Platform.
+
+### Job Unit Tests
+
+Test individual job logic by calling `.body()` directly:
+
+```typescript
+import workflow, { addNumbers, calculate } from "./workflows/calculation";
+
+describe("workflow jobs", () => {
+  test("addNumbers.body() adds two numbers", () => {
+    const result = addNumbers.body({ a: 2, b: 3 }, { env: {} });
+    expect(result).toBe(5);
+  });
+});
+```
+
+### Mocking Dependent Jobs
+
+For jobs that trigger other jobs, mock the dependencies using `vi.spyOn()`:
+
+```typescript
+import { afterEach, vi } from "vitest";
+import workflow, { addNumbers, calculate, multiplyNumbers } from "./workflows/calculation";
+
+describe("workflow with dependencies", () => {
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  test("calculate.body() with mocked dependent jobs", async () => {
+    // Mock the trigger methods for dependent jobs
+    vi.spyOn(addNumbers, "trigger").mockResolvedValue(5);
+    vi.spyOn(multiplyNumbers, "trigger").mockResolvedValue(10);
+
+    const result = await calculate.body({ a: 2, b: 3 }, { env: {} });
+
+    expect(addNumbers.trigger).toHaveBeenCalledWith({ a: 2, b: 3 });
+    expect(result).toBe(10);
+  });
+});
+```
+
+**Note:** To execute dependent jobs without mocking, and they require `env`, use `vi.stubEnv(WORKFLOW_TEST_ENV_KEY, ...)` and call `.trigger()` directly as shown in the integration test section below.
+
+### Integration Tests with `.trigger()`
+
+Test the full workflow execution using `workflow.mainJob.trigger()`:
+
+```typescript
+import { WORKFLOW_TEST_ENV_KEY } from "@tailor-platform/sdk/test";
+import { afterEach, vi } from "vitest";
+import workflow from "./workflows/calculation";
+
+describe("workflow integration", () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+
+  test("workflow.mainJob.trigger() executes all jobs", async () => {
+    // Set environment variables for the workflow
+    vi.stubEnv(WORKFLOW_TEST_ENV_KEY, JSON.stringify({ NODE_ENV: "test" }));
+
+    // No mocking - all jobs execute their actual body functions
+    const result = await workflow.mainJob.trigger({ a: 3, b: 4 });
+
+    expect(result).toBe(21); // (3 + 4) * 3 = 21
+  });
+});
+```
+
+**Key points:**
+
+- Use `.body()` for unit testing individual job logic
+- Use `vi.spyOn(job, "trigger").mockResolvedValue(...)` to mock dependent jobs when they don't need `env`
+- If dependent jobs require `env`, use `vi.stubEnv(WORKFLOW_TEST_ENV_KEY, ...)` and call `.trigger()` instead of mocking
+- Use `workflow.mainJob.trigger()` to execute the full workflow chain and get the result
+- **Best for:** Testing workflow orchestration and job dependencies
+
 ## End-to-End (E2E) Tests
 
 E2E tests verify your application works correctly when deployed to Tailor Platform. They test the full stack including GraphQL API, database operations, and authentication.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/sdk",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "description": "Tailor Platform SDK - The SDK to work with Tailor Platform",
   "license": "MIT",
   "repository": {
@@ -74,6 +74,7 @@
   },
   "devDependencies": {
     "@eslint/js": "9.39.2",
+    "@tailor-platform/function-kysely-tailordb": "0.1.3",
     "@tailor-platform/function-types": "0.8.0",
     "@toiroakr/lines-db": "0.6.1",
     "@types/madge": "5.0.3",
@@ -86,6 +87,7 @@
     "eslint-plugin-jsdoc": "62.1.0",
     "eslint-plugin-oxlint": "1.39.0",
     "globals": "17.0.0",
+    "kysely": "0.28.2",
     "oxlint": "1.39.0",
     "oxlint-tsgolint": "0.11.1",
     "sonda": "0.10.1",
@@ -96,12 +98,20 @@
   },
   "peerDependencies": {
     "@liam-hq/cli": "*",
+    "@tailor-platform/function-kysely-tailordb": "*",
+    "kysely": "*",
     "serve": "*"
   },
   "peerDependenciesMeta": {
     "@liam-hq/cli": {
       "optional": true
     },
+    "@tailor-platform/function-kysely-tailordb": {
+      "optional": true
+    },
+    "kysely": {
+      "optional": true
+    },
     "serve": {
       "optional": true
     }