@tailor-platform/create-sdk 1.20.0 → 1.22.0

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"]
+}

package/templates/generators/.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/", "src/seed/"],
+  "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/generators/.prettierignore

@@ -0,0 +1 @@
+src/seed/

package/templates/generators/.prettierrc

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

package/templates/generators/README.md

@@ -0,0 +1,30 @@
+# Generators Template
+
+Demonstrates all built-in generator plugins for the Tailor Platform SDK.
+
+## Plugins
+
+- **kyselyTypePlugin** - Generates Kysely type definitions for type-safe database queries
+- **enumConstantsPlugin** - Generates enum constant objects from `db.enum()` fields
+- **fileUtilsPlugin** - Generates file upload/download utility functions
+- **seedPlugin** - Generates seed data templates and execution script
+
+## Generated Files
+
+- `src/generated/db.ts` - Kysely database types
+- `src/generated/enums.ts` - Enum constants
+- `src/generated/files.ts` - File operation utilities
+
+## Getting Started
+
+```bash
+pnpm install
+pnpm generate    # Regenerate all generated files
+pnpm deploy
+```
+
+## Testing
+
+```bash
+pnpm test
+```

package/templates/generators/__dot__gitignore

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

package/templates/generators/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/", "src/seed/"]),
+  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/generators/package.json

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

@@ -0,0 +1,25 @@
+import { db } from "@tailor-platform/sdk";
+
+export const category = db
+  .type("Category", {
+    name: db.string(),
+    slug: db.string().unique(),
+    parentCategoryId: db.uuid({ optional: true }).relation({
+      type: "n-1",
+      toward: { type: "self" },
+      backward: "children",
+    }),
+  })
+  .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/generators/src/db/order.ts

@@ -0,0 +1,38 @@
+import { db } from "@tailor-platform/sdk";
+import { product } from "./product";
+import { user } from "./user";
+
+export const order = db
+  .type("Order", {
+    productId: db.uuid().relation({
+      type: "n-1",
+      toward: { type: product },
+    }),
+    userId: db.uuid().relation({
+      type: "n-1",
+      toward: { type: user },
+    }),
+    quantity: db.int(),
+    totalPrice: db.float(),
+    status: db.enum([
+      { value: "PENDING", description: "Awaiting confirmation" },
+      { value: "CONFIRMED", description: "Order confirmed" },
+      { value: "SHIPPED", description: "In transit" },
+      { value: "DELIVERED", description: "Successfully delivered" },
+      { value: "CANCELLED", description: "Order cancelled" },
+    ]),
+    ...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/generators/src/db/product.ts

@@ -0,0 +1,34 @@
+import { db } from "@tailor-platform/sdk";
+import { category } from "./category";
+
+export const product = db
+  .type("Product", {
+    name: db.string(),
+    description: db.string({ optional: true }),
+    price: db.float(),
+    status: db.enum([
+      { value: "DRAFT", description: "Not yet published" },
+      { value: "ACTIVE", description: "Available for purchase" },
+      { value: "DISCONTINUED", description: "No longer sold" },
+    ]),
+    categoryId: db.uuid({ optional: true }).relation({
+      type: "n-1",
+      toward: { type: category },
+    }),
+    ...db.fields.timestamps(),
+  })
+  .files({ image: "Product image" })
+  .indexes({ fields: ["status", "categoryId"], 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/generators/src/db/user.ts

@@ -0,0 +1,26 @@
+import { db } from "@tailor-platform/sdk";
+
+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" },
+    ]),
+    ...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/generators/src/generated/db.ts

@@ -0,0 +1,68 @@
+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;
+      slug: string;
+      parentCategoryId: string | null;
+    }
+
+    Order: {
+      id: Generated<string>;
+      productId: string;
+      userId: string;
+      quantity: number;
+      totalPrice: number;
+      status: "PENDING" | "CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELLED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Product: {
+      id: Generated<string>;
+      name: string;
+      description: string | null;
+      price: number;
+      status: "DRAFT" | "ACTIVE" | "DISCONTINUED";
+      categoryId: string | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    User: {
+      id: Generated<string>;
+      name: string;
+      email: string;
+      role: "ADMIN" | "MEMBER" | "VIEWER";
+      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/generators/src/generated/enums.ts

@@ -0,0 +1,39 @@
+/**
+ * @property PENDING - Awaiting confirmation
+ * @property CONFIRMED - Order confirmed
+ * @property SHIPPED - In transit
+ * @property DELIVERED - Successfully delivered
+ * @property CANCELLED - Order cancelled
+ */
+export const OrderStatus = {
+  "PENDING": "PENDING",
+  "CONFIRMED": "CONFIRMED",
+  "SHIPPED": "SHIPPED",
+  "DELIVERED": "DELIVERED",
+  "CANCELLED": "CANCELLED"
+} as const;
+export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
+
+/**
+ * @property DRAFT - Not yet published
+ * @property ACTIVE - Available for purchase
+ * @property DISCONTINUED - No longer sold
+ */
+export const ProductStatus = {
+  "DRAFT": "DRAFT",
+  "ACTIVE": "ACTIVE",
+  "DISCONTINUED": "DISCONTINUED"
+} as const;
+export type ProductStatus = (typeof ProductStatus)[keyof typeof ProductStatus];
+
+/**
+ * @property ADMIN - Administrator with full access
+ * @property MEMBER - Regular team member
+ * @property VIEWER - Read-only access
+ */
+export const UserRole = {
+  "ADMIN": "ADMIN",
+  "MEMBER": "MEMBER",
+  "VIEWER": "VIEWER"
+} as const;
+export type UserRole = (typeof UserRole)[keyof typeof UserRole];

package/templates/generators/src/generated/files.ts

@@ -0,0 +1,51 @@
+export interface TypeWithFiles {
+  Product: {
+    fields: "image";
+  };
+}
+
+const namespaces: Record<keyof TypeWithFiles, string> = {
+  Product: "main-db",
+};
+
+export async function downloadFile<T extends keyof TypeWithFiles>(
+  type: T,
+  field: TypeWithFiles[T]["fields"],
+  recordId: string,
+) {
+  return await tailordb.file.download(namespaces[type], type, field, recordId);
+}
+
+export async function uploadFile<T extends keyof TypeWithFiles>(
+  type: T,
+  field: TypeWithFiles[T]["fields"],
+  recordId: string,
+  data: string | ArrayBuffer | Uint8Array<ArrayBufferLike> | number[],
+  options?: FileUploadOptions,
+): Promise<FileUploadResponse> {
+  return await tailordb.file.upload(namespaces[type], type, field, recordId, data, options);
+}
+
+export async function deleteFile<T extends keyof TypeWithFiles>(
+  type: T,
+  field: TypeWithFiles[T]["fields"],
+  recordId: string,
+): Promise<void> {
+  return await tailordb.file.delete(namespaces[type], type, field, recordId);
+}
+
+export async function getFileMetadata<T extends keyof TypeWithFiles>(
+  type: T,
+  field: TypeWithFiles[T]["fields"],
+  recordId: string,
+): Promise<FileMetadata> {
+  return await tailordb.file.getMetadata(namespaces[type], type, field, recordId);
+}
+
+export async function openFileDownloadStream<T extends keyof TypeWithFiles>(
+  type: T,
+  field: TypeWithFiles[T]["fields"],
+  recordId: string,
+): Promise<FileStreamIterator> {
+  return await tailordb.file.openDownloadStream(namespaces[type], type, field, recordId);
+}