@tailor-platform/create-sdk 1.20.0 → 1.21.0

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # @tailor-platform/create-sdk
 
+## 1.21.0
+
 ## 1.20.0
 
 ## 1.19.0

package/dist/index.js

@@ -18,8 +18,13 @@ const availableTemplates = async () => {
 const templateHints = {
 	"hello-world": "Initial project to get started with Tailor Platform SDK",
 	"inventory-management": "Simple inventory management system",
-	testing: "Testing guide for Tailor Platform SDK",
-	"multi-application": "Multi-application setup with shared databases"
+	"multi-application": "Multi-application setup with shared databases",
+	tailordb: "Comprehensive TailorDB type definitions with all features",
+	resolver: "Resolver patterns with testing (simple, DB, env, user)",
+	workflow: "Workflow patterns with job chaining and testing",
+	executor: "Executor trigger types (record, resolver, schedule, webhook)",
+	"static-web-site": "Static website with auth and IdP integration",
+	generators: "Built-in generators: kysely, enums, files, seed"
 };
 const validateName = (name) => {
 	if (name.length < 3 || name.length > 30) return "Project name must be between 3 and 30 characters long.";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/create-sdk",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "A CLI tool to quickly create a new Tailor Platform SDK project",
   "license": "MIT",
   "repository": {

package/templates/executor/README.md

@@ -0,0 +1,32 @@
+# Executor Template
+
+Demonstrates all executor trigger types with supporting infrastructure.
+
+## Trigger Types
+
+- `recordCreatedTrigger` - React to new record creation (with condition)
+- `recordUpdatedTrigger` - React to record updates
+- `resolverExecutedTrigger` - React to resolver execution
+- `scheduleTrigger` - CRON-based scheduled execution
+- `incomingWebhookTrigger` - React to external webhook calls
+
+## Operation Kinds
+
+- `function` - Custom function body
+- `graphql` - Execute GraphQL mutations
+- `webhook` - Send HTTP requests
+- `workflow` - Trigger a workflow
+
+## Getting Started
+
+```bash
+pnpm install
+pnpm generate
+pnpm deploy
+```
+
+## Testing
+
+```bash
+pnpm test
+```

package/templates/{testing → executor}/eslint.config.js

@@ -4,10 +4,7 @@ import { defineConfig, globalIgnores } from "eslint/config";
 import oxlint from "eslint-plugin-oxlint";
 
 export default defineConfig([
-  // Ignore sdk's output directory.
   globalIgnores([".tailor-sdk/", "src/generated/"]),
-  // Use recommended rules.
-  // https://typescript-eslint.io/users/configs#projects-with-type-checking
   eslint.configs.recommended,
   tseslint.configs.recommendedTypeChecked,
   tseslint.configs.stylisticTypeChecked,
@@ -19,8 +16,6 @@ export default defineConfig([
       },
     },
   },
-  // Disable type-checked linting for root config files.
-  // https://typescript-eslint.io/troubleshooting/typed-linting/#how-do-i-disable-type-checked-linting-for-a-file
   {
     files: ["eslint.config.js"],
     extends: [tseslint.configs.disableTypeChecked],

package/templates/executor/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "executor",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "generate": "tailor-sdk generate",
+    "deploy": "tailor-sdk apply",
+    "test": "vitest --project unit",
+    "test:unit": "vitest --project unit",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
+    "lint": "oxlint --type-aware . && eslint --cache .",
+    "lint:fix": "oxlint --type-aware --fix . && eslint --cache --fix .",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.39.2",
+    "@tailor-platform/function-types": "0.8.0",
+    "@tailor-platform/sdk": "1.21.0",
+    "@types/node": "24.10.9",
+    "eslint": "9.39.2",
+    "eslint-plugin-oxlint": "1.39.0",
+    "oxfmt": "0.24.0",
+    "oxlint": "1.39.0",
+    "oxlint-tsgolint": "0.11.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.53.0",
+    "vitest": "4.0.17"
+  }
+}

package/templates/executor/src/db/auditLog.ts

@@ -0,0 +1,24 @@
+import { db } from "@tailor-platform/sdk";
+
+export const auditLog = db
+  .type("AuditLog", "Records system events for auditing", {
+    action: db.string(),
+    entityType: db.string(),
+    entityId: db.uuid(),
+    message: db.string(),
+    ...db.fields.timestamps(),
+  })
+  .indexes({ fields: ["entityType", "entityId"], unique: false })
+  .permission({
+    create: [[{ user: "_loggedIn" }, "=", true]],
+    read: [[{ user: "_loggedIn" }, "=", true]],
+    update: [[{ user: "_loggedIn" }, "=", true]],
+    delete: [[{ user: "_loggedIn" }, "=", true]],
+  })
+  .gqlPermission([
+    {
+      conditions: [[{ user: "_loggedIn" }, "=", true]],
+      actions: "all",
+      permit: true,
+    },
+  ]);

package/templates/executor/src/db/notification.ts

@@ -0,0 +1,27 @@
+import { db } from "@tailor-platform/sdk";
+import { user } from "./user";
+
+export const notification = db
+  .type("Notification", {
+    userId: db.uuid().relation({
+      type: "n-1",
+      toward: { type: user },
+    }),
+    title: db.string(),
+    body: db.string(),
+    isRead: db.bool(),
+    ...db.fields.timestamps(),
+  })
+  .permission({
+    create: [[{ user: "_loggedIn" }, "=", true]],
+    read: [[{ user: "_loggedIn" }, "=", true]],
+    update: [[{ user: "_loggedIn" }, "=", true]],
+    delete: [[{ user: "_loggedIn" }, "=", true]],
+  })
+  .gqlPermission([
+    {
+      conditions: [[{ user: "_loggedIn" }, "=", true]],
+      actions: "all",
+      permit: true,
+    },
+  ]);

package/templates/executor/src/db/user.ts

@@ -0,0 +1,22 @@
+import { db } from "@tailor-platform/sdk";
+
+export const user = db
+  .type("User", {
+    name: db.string(),
+    email: db.string().unique(),
+    role: db.enum(["ADMIN", "MEMBER"]),
+    ...db.fields.timestamps(),
+  })
+  .permission({
+    create: [[{ user: "_loggedIn" }, "=", true]],
+    read: [[{ user: "_loggedIn" }, "=", true]],
+    update: [[{ user: "_loggedIn" }, "=", true]],
+    delete: [[{ user: "_loggedIn" }, "=", true]],
+  })
+  .gqlPermission([
+    {
+      conditions: [[{ user: "_loggedIn" }, "=", true]],
+      actions: "all",
+      permit: true,
+    },
+  ]);

package/templates/executor/src/executor/dailyCleanup.ts

@@ -0,0 +1,16 @@
+import { createExecutor, scheduleTrigger } from "@tailor-platform/sdk";
+import cleanupWorkflow from "../workflow/cleanup";
+
+export default createExecutor({
+  name: "daily-cleanup",
+  description: "Runs cleanup workflow daily at midnight",
+  trigger: scheduleTrigger({
+    cron: "0 0 * * *",
+    timezone: "UTC",
+  }),
+  operation: {
+    kind: "workflow",
+    workflow: cleanupWorkflow,
+    args: () => ({ daysOld: 30 }),
+  },
+});

package/templates/executor/src/executor/externalWebhook.ts

@@ -0,0 +1,18 @@
+import { createExecutor, incomingWebhookTrigger } from "@tailor-platform/sdk";
+
+export default createExecutor({
+  name: "external-webhook",
+  description: "Handles incoming webhook events",
+  trigger: incomingWebhookTrigger<{
+    body: { event: string; payload: Record<string, unknown> };
+    headers: Record<string, string>;
+  }>(),
+  operation: {
+    kind: "function",
+    body: (args) => {
+      console.log("Webhook event:", args.body.event);
+      console.log("Payload:", args.body.payload);
+      console.log("Headers:", args.headers);
+    },
+  },
+});

package/templates/executor/src/executor/onDataProcessed.ts

@@ -0,0 +1,26 @@
+import { createExecutor, resolverExecutedTrigger } from "@tailor-platform/sdk";
+import processData from "../resolver/processData";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-data-processed",
+  description: "Creates an audit log when data is processed",
+  trigger: resolverExecutedTrigger({
+    resolver: processData,
+    condition: ({ result }) => {
+      if (!result) return false;
+      return result.processed;
+    },
+  }),
+  operation: {
+    kind: "function",
+    body: async () => {
+      await createAuditLog({
+        action: "DATA_PROCESSED",
+        entityType: "Resolver",
+        entityId: "00000000-0000-0000-0000-000000000000",
+        message: "Data processing completed",
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onIdpUserCreated.ts

@@ -0,0 +1,19 @@
+import { createExecutor, idpUserCreatedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-idp-user-created",
+  description: "Creates an audit log when an IdP user registers",
+  trigger: idpUserCreatedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "IDP_USER_CREATED",
+        entityType: "IdpUser",
+        entityId: args.userId,
+        message: `IdP user registered in namespace: ${args.namespaceName}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onIdpUserDeleted.ts

@@ -0,0 +1,19 @@
+import { createExecutor, idpUserDeletedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-idp-user-deleted",
+  description: "Creates an audit log when an IdP user is deleted",
+  trigger: idpUserDeletedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "IDP_USER_DELETED",
+        entityType: "IdpUser",
+        entityId: args.userId,
+        message: `IdP user deleted from namespace: ${args.namespaceName}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onIdpUserUpdated.ts

@@ -0,0 +1,19 @@
+import { createExecutor, idpUserUpdatedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-idp-user-updated",
+  description: "Creates an audit log when an IdP user profile is updated",
+  trigger: idpUserUpdatedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "IDP_USER_UPDATED",
+        entityType: "IdpUser",
+        entityId: args.userId,
+        message: `IdP user updated in namespace: ${args.namespaceName}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onTokenIssued.ts

@@ -0,0 +1,19 @@
+import { createExecutor, authAccessTokenIssuedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-token-issued",
+  description: "Creates an audit log when an access token is issued",
+  trigger: authAccessTokenIssuedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "TOKEN_ISSUED",
+        entityType: "AuthToken",
+        entityId: args.userId,
+        message: `Access token issued for user: ${args.userId}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onTokenRefreshed.ts

@@ -0,0 +1,19 @@
+import { createExecutor, authAccessTokenRefreshedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-token-refreshed",
+  description: "Creates an audit log when an access token is refreshed",
+  trigger: authAccessTokenRefreshedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "TOKEN_REFRESHED",
+        entityType: "AuthToken",
+        entityId: args.userId,
+        message: `Access token refreshed for user: ${args.userId}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onTokenRevoked.ts

@@ -0,0 +1,19 @@
+import { createExecutor, authAccessTokenRevokedTrigger } from "@tailor-platform/sdk";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-token-revoked",
+  description: "Creates an audit log when an access token is revoked",
+  trigger: authAccessTokenRevokedTrigger(),
+  operation: {
+    kind: "function",
+    body: async (args) => {
+      await createAuditLog({
+        action: "TOKEN_REVOKED",
+        entityType: "AuthToken",
+        entityId: args.userId,
+        message: `Access token revoked for user: ${args.userId}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onUserCreated.ts

@@ -0,0 +1,23 @@
+import { createExecutor, recordCreatedTrigger, t } from "@tailor-platform/sdk";
+import { user } from "../db/user";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-user-created",
+  description: "Creates an audit log when a new admin user is created",
+  trigger: recordCreatedTrigger({
+    type: user,
+    condition: ({ newRecord }) => newRecord.role === "ADMIN",
+  }),
+  operation: {
+    kind: "function",
+    body: async (args: { newRecord: t.infer<typeof user> }) => {
+      await createAuditLog({
+        action: "USER_CREATED",
+        entityType: "User",
+        entityId: args.newRecord.id,
+        message: `Admin user created: ${args.newRecord.name} (${args.newRecord.email})`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onUserDeleted.ts

@@ -0,0 +1,22 @@
+import { createExecutor, recordDeletedTrigger, t } from "@tailor-platform/sdk";
+import { user } from "../db/user";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-user-deleted",
+  description: "Creates an audit log when a user is deleted",
+  trigger: recordDeletedTrigger({
+    type: user,
+  }),
+  operation: {
+    kind: "function",
+    body: async (args: { oldRecord: t.infer<typeof user> }) => {
+      await createAuditLog({
+        action: "USER_DELETED",
+        entityType: "User",
+        entityId: args.oldRecord.id,
+        message: `User deleted: ${args.oldRecord.name} (${args.oldRecord.email})`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/onUserUpdated.ts

@@ -0,0 +1,22 @@
+import { createExecutor, recordUpdatedTrigger, t } from "@tailor-platform/sdk";
+import { user } from "../db/user";
+import { createAuditLog } from "./shared";
+
+export default createExecutor({
+  name: "on-user-updated",
+  description: "Creates an audit log when a user is updated",
+  trigger: recordUpdatedTrigger({
+    type: user,
+  }),
+  operation: {
+    kind: "function",
+    body: async (args: { newRecord: t.infer<typeof user>; oldRecord: t.infer<typeof user> }) => {
+      await createAuditLog({
+        action: "USER_UPDATED",
+        entityType: "User",
+        entityId: args.newRecord.id,
+        message: `User updated: ${args.oldRecord.name} -> ${args.newRecord.name}`,
+      });
+    },
+  },
+});

package/templates/executor/src/executor/shared.test.ts

@@ -0,0 +1,36 @@
+import { afterAll, afterEach, beforeAll, describe, expect, test, vi } from "vitest";
+import { createAuditLog } from "./shared";
+
+describe("createAuditLog", () => {
+  const mockQueryObject = vi.fn();
+  beforeAll(() => {
+    vi.stubGlobal("tailordb", {
+      Client: vi.fn(
+        class {
+          connect = vi.fn();
+          end = vi.fn();
+          queryObject = mockQueryObject;
+        },
+      ),
+    });
+  });
+  afterAll(() => {
+    vi.unstubAllGlobals();
+  });
+  afterEach(() => {
+    mockQueryObject.mockReset();
+  });
+
+  test("inserts audit log record", async () => {
+    mockQueryObject.mockResolvedValueOnce({});
+
+    await createAuditLog({
+      action: "USER_CREATED",
+      entityType: "User",
+      entityId: "test-id",
+      message: "Test audit log",
+    });
+
+    expect(mockQueryObject).toHaveBeenCalledTimes(1);
+  });
+});

package/templates/executor/src/executor/shared.ts

@@ -0,0 +1,13 @@
+import { getDB } from "../generated/db";
+
+interface AuditLogInput {
+  action: string;
+  entityType: string;
+  entityId: string;
+  message: string;
+}
+
+export async function createAuditLog(input: AuditLogInput): Promise<void> {
+  const db = getDB("main-db");
+  await db.insertInto("AuditLog").values(input).execute();
+}

package/templates/executor/src/generated/db.ts

@@ -0,0 +1,59 @@
+import {
+  createGetDB,
+  type Generated,
+  type Timestamp,
+  type NamespaceDB,
+  type NamespaceInsertable,
+  type NamespaceSelectable,
+  type NamespaceTable,
+  type NamespaceTableName,
+  type NamespaceTransaction,
+  type NamespaceUpdateable,
+} from "@tailor-platform/sdk/kysely";
+
+export interface Namespace {
+  "main-db": {
+    AuditLog: {
+      id: Generated<string>;
+      action: string;
+      entityType: string;
+      entityId: string;
+      message: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Notification: {
+      id: Generated<string>;
+      userId: string;
+      title: string;
+      body: string;
+      isRead: boolean;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    User: {
+      id: Generated<string>;
+      name: string;
+      email: string;
+      role: "ADMIN" | "MEMBER";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+  }
+}
+
+export const getDB = createGetDB<Namespace>();
+
+export type DB<N extends keyof Namespace = keyof Namespace> = NamespaceDB<Namespace, N>;
+
+export type Transaction<K extends keyof Namespace | DB = keyof Namespace> =
+  NamespaceTransaction<Namespace, K>;
+
+type TableName = NamespaceTableName<Namespace>;
+export type Table<T extends TableName> = NamespaceTable<Namespace, T>;
+
+export type Insertable<T extends TableName> = NamespaceInsertable<Namespace, T>;
+export type Selectable<T extends TableName> = NamespaceSelectable<Namespace, T>;
+export type Updateable<T extends TableName> = NamespaceUpdateable<Namespace, T>;

package/templates/executor/src/resolver/processData.ts

@@ -0,0 +1,22 @@
+import { createResolver, t } from "@tailor-platform/sdk";
+
+const resolver = createResolver({
+  name: "processData",
+  description: "Processes data and returns a summary",
+  operation: "mutation",
+  input: {
+    data: t.string(),
+  },
+  body: (context) => {
+    return {
+      processed: true,
+      summary: `Processed: ${context.input.data}`,
+    };
+  },
+  output: t.object({
+    processed: t.bool(),
+    summary: t.string(),
+  }),
+});
+
+export default resolver;

package/templates/executor/src/workflow/cleanup.ts

@@ -0,0 +1,13 @@
+import { createWorkflow, createWorkflowJob } from "@tailor-platform/sdk";
+
+export const cleanupOldRecords = createWorkflowJob({
+  name: "cleanup-old-records",
+  body: (input: { daysOld: number }) => {
+    return { deletedCount: 0, daysOld: input.daysOld };
+  },
+});
+
+export default createWorkflow({
+  name: "cleanup-workflow",
+  mainJob: cleanupOldRecords,
+});

package/templates/executor/tailor.config.ts

@@ -0,0 +1,40 @@
+import { defineAuth, defineConfig, defineIdp, definePlugins, t } from "@tailor-platform/sdk";
+import { kyselyTypePlugin } from "@tailor-platform/sdk/plugin/kysely-type";
+
+const idp = defineIdp("main-idp", {
+  authorization: "loggedIn",
+  clients: ["default-idp-client"],
+  userAuthPolicy: {
+    useNonEmailIdentifier: false,
+    allowSelfPasswordReset: true,
+    passwordRequireUppercase: true,
+    passwordRequireLowercase: true,
+    passwordRequireNonAlphanumeric: true,
+    passwordRequireNumeric: true,
+    passwordMinLength: 8,
+    passwordMaxLength: 128,
+  },
+});
+
+export default defineConfig({
+  name: "executor",
+  auth: defineAuth("main-auth", {
+    machineUserAttributes: {
+      role: t.string(),
+    },
+    machineUsers: {
+      admin: {
+        attributes: {
+          role: "admin",
+        },
+      },
+    },
+  }),
+  idp: [idp],
+  db: { "main-db": { files: ["./src/db/*.ts"] } },
+  resolver: { "main-resolver": { files: ["./src/resolver/*.ts"] } },
+  executor: { files: ["./src/executor/*.ts"] },
+  workflow: { files: ["./src/workflow/*.ts"] },
+});
+
+export const plugins = definePlugins(kyselyTypePlugin({ distPath: "./src/generated/db.ts" }));

package/templates/executor/vitest.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    watch: false,
+    projects: [
+      {
+        test: {
+          name: { label: "unit", color: "blue" },
+          include: ["src/**/*.test.ts"],
+        },
+      },
+    ],
+  },
+});

package/templates/generators/.oxfmtrc.json

@@ -0,0 +1,3 @@
+{
+  "ignorePatterns": ["src/generated/", "pnpm-lock.yaml"]
+}