Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tailor-platform/sdk/llms.txt

Use this file to discover all available pages before exploring further.

Build applications on Tailor Platform with TypeScript

Tailor Platform SDK is a TypeScript SDK for building backend applications on the Tailor Platform. Write your entire backend configuration in TypeScript with full type safety and deploy to production with a single command.

Quickstart

Get started with a working example in minutes

Installation

Install the SDK and set up your development environment

TailorDB

Define type-safe database schemas

Resolvers

Create custom GraphQL resolvers with business logic

Executors

Build event-driven handlers for automation

Workflows

Orchestrate complex multi-step operations

Key features

The Tailor Platform SDK provides everything you need to build enterprise applications:

Type-safe database schemas

Define your database schema in TypeScript with automatic type generation and validation

Custom GraphQL resolvers

Create business logic with full type safety and automatic GraphQL schema generation

Event-driven executors

React to database changes, webhooks, schedules, and authentication events

Multi-step workflows

Orchestrate complex operations with job chaining and parallel execution

Authentication & authorization

Built-in auth service with OAuth2, machine users, and role-based access control

Identity provider

Integrated IdP with customizable password policies and user management

Static website hosting

Deploy frontend applications with automatic URL resolution in CORS settings

Secret management

Secure credential storage for API keys and sensitive configuration

What makes this SDK unique

TypeScript configuration

Unlike traditional backend platforms that use YAML or JSON, the Tailor Platform SDK uses TypeScript for all configuration. This provides:
  • Full IntelliSense and autocomplete in your editor
  • Compile-time type checking for your entire configuration
  • Ability to share and reuse code across services
  • Type-safe environment variables and dependencies
import { defineConfig, defineAuth } from "@tailor-platform/sdk";
import { user } from "./tailordb/user";

export default defineConfig({
  name: "my-app",
  db: { "main-db": { files: ["./db/*.ts"] } },
  resolver: { "main-resolver": { files: ["./resolvers/**/*.ts"] } },
  auth: defineAuth("my-auth", {
    userProfile: {
      type: user,
      usernameField: "email",
      attributes: { role: true },
    },
  }),
});

End-to-end type safety

From database schema to resolver outputs, the SDK ensures type safety across your entire application:
// Define a type-safe database model
export const user = db
  .type("User", {
    name: db.string(),
    email: db.string().unique(),
    role: db.enum(["MANAGER", "STAFF"]),
    ...db.fields.timestamps(),
  })
  .permission(defaultPermission)
  .gqlPermission(defaultGqlPermission);

// Use it in a type-safe resolver
export default createResolver({
  name: "hello",
  operation: "query",
  input: {
    name: t.string().description("Name to greet"),
  },
  body: (context) => {
    return {
      message: `Hello, ${context.input.name}!`,
    };
  },
  output: t.object({
    message: t.string().description("Greeting message"),
  }),
});

Built for enterprise

The SDK includes enterprise-ready features out of the box:
  • Role-based permissions on every database type and GraphQL operation
  • Machine users for API-to-API communication
  • IP allowlisting for network security
  • Database migrations with automatic execution on deployment
  • Code generation plugins for Kysely types, enum constants, and seed data

Next steps

Get started with the quickstart

Create your first application in under 5 minutes

Explore the templates

Browse example projects including inventory management and testing patterns