@tailor-platform/create-sdk 1.20.0 → 1.21.0

package/templates/tailordb/.oxlintrc.json

@@ -0,0 +1,197 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["typescript"],
+  "categories": {
+    "correctness": "off"
+  },
+  "env": {
+    "builtin": true
+  },
+  "ignorePatterns": [".tailor-sdk/", "src/generated/"],
+  "rules": {
+    "constructor-super": "error",
+    "for-direction": "error",
+    "no-async-promise-executor": "error",
+    "no-case-declarations": "error",
+    "no-class-assign": "error",
+    "no-compare-neg-zero": "error",
+    "no-cond-assign": "error",
+    "no-const-assign": "error",
+    "no-constant-binary-expression": "error",
+    "no-constant-condition": "error",
+    "no-control-regex": "error",
+    "no-debugger": "error",
+    "no-delete-var": "error",
+    "no-dupe-class-members": "error",
+    "no-dupe-else-if": "error",
+    "no-dupe-keys": "error",
+    "no-duplicate-case": "error",
+    "no-empty": "error",
+    "no-empty-character-class": "error",
+    "no-empty-pattern": "error",
+    "no-empty-static-block": "error",
+    "no-ex-assign": "error",
+    "no-extra-boolean-cast": "error",
+    "no-fallthrough": "error",
+    "no-func-assign": "error",
+    "no-global-assign": "error",
+    "no-import-assign": "error",
+    "no-invalid-regexp": "error",
+    "no-irregular-whitespace": "error",
+    "no-loss-of-precision": "error",
+    "no-new-native-nonconstructor": "error",
+    "no-nonoctal-decimal-escape": "error",
+    "no-obj-calls": "error",
+    "no-prototype-builtins": "error",
+    "no-redeclare": "error",
+    "no-regex-spaces": "error",
+    "no-self-assign": "error",
+    "no-setter-return": "error",
+    "no-shadow-restricted-names": "error",
+    "no-sparse-arrays": "error",
+    "no-this-before-super": "error",
+    "no-unexpected-multiline": "error",
+    "no-unsafe-finally": "error",
+    "no-unsafe-negation": "error",
+    "no-unsafe-optional-chaining": "error",
+    "no-unused-labels": "error",
+    "no-unused-private-class-members": "error",
+    "no-unused-vars": "error",
+    "no-useless-backreference": "error",
+    "no-useless-catch": "error",
+    "no-useless-escape": "error",
+    "no-with": "error",
+    "require-yield": "error",
+    "use-isnan": "error",
+    "valid-typeof": "error",
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/ban-ts-comment": "error",
+    "no-array-constructor": "error",
+    "@typescript-eslint/no-array-delete": "error",
+    "@typescript-eslint/no-base-to-string": "error",
+    "@typescript-eslint/no-duplicate-enum-values": "error",
+    "@typescript-eslint/no-duplicate-type-constituents": "error",
+    "@typescript-eslint/no-empty-object-type": "error",
+    "@typescript-eslint/no-explicit-any": "error",
+    "@typescript-eslint/no-extra-non-null-assertion": "error",
+    "@typescript-eslint/no-floating-promises": "error",
+    "@typescript-eslint/no-for-in-array": "error",
+    "@typescript-eslint/no-implied-eval": "error",
+    "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/no-misused-promises": "error",
+    "@typescript-eslint/no-namespace": "error",
+    "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+    "@typescript-eslint/no-redundant-type-constituents": "error",
+    "@typescript-eslint/no-require-imports": "error",
+    "@typescript-eslint/no-this-alias": "error",
+    "@typescript-eslint/no-unnecessary-type-assertion": "error",
+    "@typescript-eslint/no-unnecessary-type-constraint": "error",
+    "@typescript-eslint/no-unsafe-argument": "error",
+    "@typescript-eslint/no-unsafe-assignment": "error",
+    "@typescript-eslint/no-unsafe-call": "error",
+    "@typescript-eslint/no-unsafe-declaration-merging": "error",
+    "@typescript-eslint/no-unsafe-enum-comparison": "error",
+    "@typescript-eslint/no-unsafe-function-type": "error",
+    "@typescript-eslint/no-unsafe-member-access": "error",
+    "@typescript-eslint/no-unsafe-return": "error",
+    "@typescript-eslint/no-unsafe-unary-minus": "error",
+    "no-unused-expressions": "error",
+    "@typescript-eslint/no-wrapper-object-types": "error",
+    "@typescript-eslint/only-throw-error": "error",
+    "@typescript-eslint/prefer-as-const": "error",
+    "@typescript-eslint/prefer-namespace-keyword": "error",
+    "@typescript-eslint/prefer-promise-reject-errors": "error",
+    "@typescript-eslint/require-await": "error",
+    "@typescript-eslint/restrict-plus-operands": "error",
+    "@typescript-eslint/restrict-template-expressions": "error",
+    "@typescript-eslint/triple-slash-reference": "error",
+    "@typescript-eslint/unbound-method": "error",
+    "@typescript-eslint/adjacent-overload-signatures": "error",
+    "@typescript-eslint/array-type": "error",
+    "@typescript-eslint/ban-tslint-comment": "error",
+    "@typescript-eslint/consistent-generic-constructors": "error",
+    "@typescript-eslint/consistent-indexed-object-style": "error",
+    "@typescript-eslint/consistent-type-definitions": "error",
+    "@typescript-eslint/no-confusing-non-null-assertion": "error",
+    "no-empty-function": "error",
+    "@typescript-eslint/no-inferrable-types": "error",
+    "@typescript-eslint/non-nullable-type-assertion-style": "error",
+    "@typescript-eslint/prefer-for-of": "error",
+    "@typescript-eslint/prefer-function-type": "error",
+    "@typescript-eslint/prefer-includes": "error",
+    "@typescript-eslint/prefer-nullish-coalescing": "error"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
+      "rules": {
+        "constructor-super": "off",
+        "no-class-assign": "off",
+        "no-const-assign": "off",
+        "no-dupe-class-members": "off",
+        "no-dupe-keys": "off",
+        "no-func-assign": "off",
+        "no-import-assign": "off",
+        "no-new-native-nonconstructor": "off",
+        "no-obj-calls": "off",
+        "no-redeclare": "off",
+        "no-setter-return": "off",
+        "no-this-before-super": "off",
+        "no-unsafe-negation": "off",
+        "no-var": "error",
+        "no-with": "off",
+        "prefer-rest-params": "error",
+        "prefer-spread": "error"
+      }
+    },
+    {
+      "files": ["eslint.config.js"],
+      "rules": {
+        "@typescript-eslint/await-thenable": "off",
+        "@typescript-eslint/no-array-delete": "off",
+        "@typescript-eslint/no-base-to-string": "off",
+        "@typescript-eslint/no-confusing-void-expression": "off",
+        "@typescript-eslint/no-deprecated": "off",
+        "@typescript-eslint/no-duplicate-type-constituents": "off",
+        "@typescript-eslint/no-floating-promises": "off",
+        "@typescript-eslint/no-for-in-array": "off",
+        "@typescript-eslint/no-implied-eval": "off",
+        "@typescript-eslint/no-meaningless-void-operator": "off",
+        "@typescript-eslint/no-misused-promises": "off",
+        "@typescript-eslint/no-misused-spread": "off",
+        "@typescript-eslint/no-mixed-enums": "off",
+        "@typescript-eslint/no-redundant-type-constituents": "off",
+        "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
+        "@typescript-eslint/no-unnecessary-template-expression": "off",
+        "@typescript-eslint/no-unnecessary-type-arguments": "off",
+        "@typescript-eslint/no-unnecessary-type-assertion": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-enum-comparison": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "@typescript-eslint/no-unsafe-type-assertion": "off",
+        "@typescript-eslint/no-unsafe-unary-minus": "off",
+        "@typescript-eslint/non-nullable-type-assertion-style": "off",
+        "@typescript-eslint/only-throw-error": "off",
+        "@typescript-eslint/prefer-includes": "off",
+        "@typescript-eslint/prefer-nullish-coalescing": "off",
+        "@typescript-eslint/prefer-promise-reject-errors": "off",
+        "@typescript-eslint/prefer-reduce-type-parameter": "off",
+        "@typescript-eslint/prefer-return-this-type": "off",
+        "@typescript-eslint/promise-function-async": "off",
+        "@typescript-eslint/related-getter-setter-pairs": "off",
+        "@typescript-eslint/require-array-sort-compare": "off",
+        "@typescript-eslint/require-await": "off",
+        "@typescript-eslint/restrict-plus-operands": "off",
+        "@typescript-eslint/restrict-template-expressions": "off",
+        "@typescript-eslint/return-await": "off",
+        "@typescript-eslint/strict-boolean-expressions": "off",
+        "@typescript-eslint/switch-exhaustiveness-check": "off",
+        "@typescript-eslint/unbound-method": "off",
+        "@typescript-eslint/use-unknown-in-catch-callback-variable": "off"
+      }
+    }
+  ]
+}

package/templates/tailordb/.prettierrc

@@ -0,0 +1 @@
+{}

package/templates/tailordb/README.md

@@ -0,0 +1,29 @@
+# TailorDB Template
+
+Comprehensive TailorDB type definitions demonstrating all features of `db.type()`.
+
+## Features
+
+- All field types (string, int, float, datetime, uuid, enum, boolean)
+- Relations (n-1, self-referential)
+- Validations (field-level and type-level)
+- Hooks (computed fields)
+- File attachments
+- Composite indexes
+- Role-based permissions
+- Nested objects
+- Timestamps
+
+## Getting Started
+
+```bash
+pnpm install
+pnpm generate
+pnpm deploy
+```
+
+## Testing
+
+```bash
+pnpm test
+```

package/templates/tailordb/__dot__gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.tailor-sdk/
+.eslintcache

package/templates/tailordb/eslint.config.js

@@ -0,0 +1,24 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import { defineConfig, globalIgnores } from "eslint/config";
+import oxlint from "eslint-plugin-oxlint";
+
+export default defineConfig([
+  globalIgnores([".tailor-sdk/", "src/generated/"]),
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  tseslint.configs.stylisticTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    files: ["eslint.config.js"],
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+  ...oxlint.buildFromOxlintConfigFile("./.oxlintrc.json"),
+]);

package/templates/tailordb/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "tailordb",
+  "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/tailordb/src/db/category.ts

@@ -0,0 +1,15 @@
+import { db } from "@tailor-platform/sdk";
+import { allPermission, allGqlPermission } from "./permission";
+
+export const category = db
+  .type("Category", "Task category with hierarchical structure", {
+    name: db.string(),
+    description: db.string({ optional: true }),
+    parentCategoryId: db.uuid({ optional: true }).relation({
+      type: "n-1",
+      toward: { type: "self" },
+      backward: "children",
+    }),
+  })
+  .permission(allPermission)
+  .gqlPermission(allGqlPermission);

package/templates/tailordb/src/db/comment.ts

@@ -0,0 +1,26 @@
+import { db } from "@tailor-platform/sdk";
+import { allPermission, allGqlPermission } from "./permission";
+import { task } from "./task";
+import { user } from "./user";
+
+export const comment = db
+  .type("Comment", "A comment on a task", {
+    body: db.string().validate([({ value }) => value.length >= 1, "Comment must not be empty"]),
+    taskId: db.uuid().relation({
+      type: "n-1",
+      toward: { type: task },
+    }),
+    authorId: db.uuid().relation({
+      type: "n-1",
+      toward: { type: user },
+    }),
+    metadata: db.object({
+      source: db.string().description("Where the comment was posted from"),
+      editedAt: db.datetime({ optional: true }),
+      isInternal: db.bool().description("Whether comment is internal only"),
+    }),
+    ...db.fields.timestamps(),
+  })
+  .indexes({ fields: ["taskId", "createdAt"], unique: false })
+  .permission(allPermission)
+  .gqlPermission(allGqlPermission);

package/templates/tailordb/src/db/permission.ts

@@ -0,0 +1,43 @@
+import type {
+  PermissionCondition,
+  TailorTypePermission,
+  TailorTypeGqlPermission,
+} from "@tailor-platform/sdk";
+
+const loggedIn = [{ user: "_loggedIn" }, "=", true] as const satisfies PermissionCondition;
+const isAdmin = [{ user: "role" }, "=", "admin"] as const satisfies PermissionCondition;
+
+export const allPermission: TailorTypePermission = {
+  create: [loggedIn],
+  read: [loggedIn],
+  update: [loggedIn],
+  delete: [loggedIn],
+};
+
+export const rolePermission: TailorTypePermission = {
+  create: [isAdmin, loggedIn],
+  read: [loggedIn],
+  update: [isAdmin, loggedIn],
+  delete: [isAdmin],
+};
+
+export const allGqlPermission: TailorTypeGqlPermission = [
+  {
+    conditions: [loggedIn],
+    actions: "all",
+    permit: true,
+  },
+];
+
+export const roleGqlPermission: TailorTypeGqlPermission = [
+  {
+    conditions: [isAdmin],
+    actions: ["create", "read", "update", "delete"],
+    permit: true,
+  },
+  {
+    conditions: [loggedIn],
+    actions: ["read"],
+    permit: true,
+  },
+];

package/templates/tailordb/src/db/task.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, test } from "vitest";
+import { task } from "./task";
+import { user } from "./user";
+import { category } from "./category";
+import { comment } from "./comment";
+
+describe("TailorDB type definitions", () => {
+  test("task type has expected fields", () => {
+    const { fields } = task;
+    expect(fields).toHaveProperty("title");
+    expect(fields).toHaveProperty("status");
+    expect(fields).toHaveProperty("priority");
+    expect(fields).toHaveProperty("dueDate");
+    expect(fields).toHaveProperty("assigneeId");
+    expect(fields).toHaveProperty("categoryId");
+    expect(fields).toHaveProperty("isArchived");
+  });
+
+  test("user type has expected fields", () => {
+    const { fields } = user;
+    expect(fields).toHaveProperty("name");
+    expect(fields).toHaveProperty("email");
+    expect(fields).toHaveProperty("role");
+    expect(fields).toHaveProperty("bio");
+  });
+
+  test("category type has expected fields", () => {
+    const { fields } = category;
+    expect(fields).toHaveProperty("name");
+    expect(fields).toHaveProperty("description");
+    expect(fields).toHaveProperty("parentCategoryId");
+  });
+
+  test("comment type has expected fields", () => {
+    const { fields } = comment;
+    expect(fields).toHaveProperty("body");
+    expect(fields).toHaveProperty("taskId");
+    expect(fields).toHaveProperty("authorId");
+    expect(fields).toHaveProperty("metadata");
+  });
+});

package/templates/tailordb/src/db/task.ts

@@ -0,0 +1,58 @@
+import { db } from "@tailor-platform/sdk";
+import { category } from "./category";
+import { rolePermission, roleGqlPermission } from "./permission";
+import { user } from "./user";
+
+export const task = db
+  .type("Task", "A task with comprehensive features", {
+    title: db
+      .string()
+      .validate(
+        [({ value }) => value.length >= 3, "Title must be at least 3 characters"],
+        [({ value }) => value.length <= 200, "Title must be at most 200 characters"],
+      ),
+    description: db.string({ optional: true }),
+    status: db.enum([
+      { value: "TODO", description: "Not started" },
+      { value: "IN_PROGRESS", description: "Currently being worked on" },
+      { value: "DONE", description: "Completed" },
+      { value: "CANCELLED", description: "No longer needed" },
+    ]),
+    priority: db
+      .int()
+      .validate(
+        [({ value }) => value >= 0, "Priority must be non-negative"],
+        [({ value }) => value <= 4, "Priority must be at most 4"],
+      ),
+    dueDate: db.datetime({ optional: true }),
+    assigneeId: db.uuid({ optional: true }).relation({
+      type: "n-1",
+      toward: { type: user },
+    }),
+    categoryId: db.uuid({ optional: true }).relation({
+      type: "n-1",
+      toward: { type: category },
+    }),
+    isArchived: db.bool().description("Whether the task is archived"),
+    ...db.fields.timestamps(),
+  })
+  .hooks({
+    isArchived: {
+      create: () => false,
+    },
+  })
+  .indexes(
+    { fields: ["status", "priority"], unique: false },
+    { fields: ["assigneeId", "status"], unique: false, name: "task_assignee_status_idx" },
+  )
+  .validate({
+    status: [
+      ({ value, data }) => {
+        const d = data as { dueDate: string | null };
+        return !(value === "DONE" && d.dueDate === null);
+      },
+      "Completed tasks must have a due date",
+    ],
+  })
+  .permission(rolePermission)
+  .gqlPermission(roleGqlPermission);

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

@@ -0,0 +1,19 @@
+import { db } from "@tailor-platform/sdk";
+import { allPermission, allGqlPermission } from "./permission";
+
+export const user = db
+  .type("User", {
+    name: db.string(),
+    email: db.string().unique(),
+    role: db.enum([
+      { value: "ADMIN", description: "Administrator with full access" },
+      { value: "MEMBER", description: "Regular team member" },
+      { value: "VIEWER", description: "Read-only access" },
+    ]),
+    bio: db.string({ optional: true }).description("Short biography"),
+    ...db.fields.timestamps(),
+  })
+  .files({ avatar: "Profile image" })
+  .indexes({ fields: ["role", "createdAt"], unique: false })
+  .permission(allPermission)
+  .gqlPermission(allGqlPermission);

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

@@ -0,0 +1,75 @@
+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": {
+    Category: {
+      id: Generated<string>;
+      name: string;
+      description: string | null;
+      parentCategoryId: string | null;
+    }
+
+    Comment: {
+      id: Generated<string>;
+      body: string;
+      taskId: string;
+      authorId: string;
+      metadata: {
+        source: string;
+        editedAt: Timestamp | null;
+        isInternal: boolean;
+      };
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Task: {
+      id: Generated<string>;
+      title: string;
+      description: string | null;
+      status: "TODO" | "IN_PROGRESS" | "DONE" | "CANCELLED";
+      priority: number;
+      dueDate: Timestamp | null;
+      assigneeId: string | null;
+      categoryId: string | null;
+      isArchived: Generated<boolean>;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    User: {
+      id: Generated<string>;
+      name: string;
+      email: string;
+      role: "ADMIN" | "MEMBER" | "VIEWER";
+      bio: string | null;
+      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/tailordb/tailor.config.ts

@@ -0,0 +1,26 @@
+import { defineAuth, defineConfig, definePlugins, t } from "@tailor-platform/sdk";
+import { kyselyTypePlugin } from "@tailor-platform/sdk/plugin/kysely-type";
+
+export default defineConfig({
+  name: "tailordb",
+  auth: defineAuth("main-auth", {
+    machineUserAttributes: {
+      role: t.string(),
+    },
+    machineUsers: {
+      admin: {
+        attributes: {
+          role: "admin",
+        },
+      },
+      viewer: {
+        attributes: {
+          role: "viewer",
+        },
+      },
+    },
+  }),
+  db: { "main-db": { files: ["./src/db/*.ts"] } },
+});
+
+export const plugins = definePlugins(kyselyTypePlugin({ distPath: "./src/generated/db.ts" }));

package/templates/tailordb/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": ["node", "@tailor-platform/function-types"]
+  },
+  "include": ["**/*.ts"]
+}

package/templates/tailordb/user-defined.d.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @tailor-platform/sdk
+// Do not edit this file manually
+// Regenerated automatically when running 'tailor-sdk apply' or 'tailor-sdk generate'
+
+declare module "@tailor-platform/sdk" {
+  interface AttributeMap {
+    role: string;
+  }
+  interface AttributeList {
+    __tuple?: [];
+  }
+  interface Env {}
+}
+
+export {};

package/templates/tailordb/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/workflow/.oxfmtrc.json

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