Tailor Platform SDK

@tailor-platform/sdk is a TypeScript SDK for building applications on the Tailor Platform.

Overview

Tailor Platform is a headless business platform that provides backend services for building enterprise applications. The SDK enables you to:

• Define type-safe database schemas with TailorDB
• Create custom GraphQL resolvers with business logic
• Set up event-driven executors for automation
• Orchestrate complex workflows with multiple jobs
• Configure authentication and authorization

All configurations are written in TypeScript, providing full type safety.

Important Notes

Some SDK concepts differ from the native Tailor Platform. Be aware of these differences when referring to the official Tailor Platform documentation.

Resolver

The SDK's Resolver corresponds to Tailor Platform's Pipeline Resolver. The key difference is that Pipeline steps are replaced with a single body function. See Resolver for details.

Installation

npm install @tailor-platform/sdk
# OR
yarn add @tailor-platform/sdk
# OR
pnpm add @tailor-platform/sdk
# OR
bun add @tailor-platform/sdk

Quick Start

Create a new project using the CLI:

npm create @tailor-platform/sdk -- --template hello-world my-app
cd my-app
npm run deploy -- --workspace-id <your-workspace-id>

See Available Templates for more options.

For more details, see the Quickstart Guide.

Agent Skill

Install the tailor-sdk skill from the locally installed SDK package:

npx tailor-sdk skills install

# Example: install to Codex in non-interactive mode
npx tailor-sdk skills install -a codex -y

This uses the skills CLI under the hood, sourcing the skill from node_modules/@tailor-platform/sdk/skills so the skill version always matches the installed SDK version. Files are copied (not symlinked) so they survive pnpm install wiping node_modules.

Learn More

Configuration

• Configuration - Application and service configuration

Services

| Service | Description | | -------------------------------------------------- | -------------------------------------------- | | TailorDB | Type-safe database schema definition | | Resolver | Custom GraphQL resolvers with business logic | | Executor | Event-driven handlers for automation | | Workflow | Job orchestration for complex operations | | Auth | Authentication and authorization | | IdP | Built-in identity provider | | Static Website | Static file hosting | | Secret Manager | Secure credential storage |

Guides

• Testing Guide - Unit and E2E testing patterns
• CLI Reference - Command-line interface documentation

Templates

See Create Tailor Platform SDK for available project templates.

Requirements

• Node.js 22 or later (or Bun)
• A Tailor Platform account (request access)

Dependabot Noise

Installing @tailor-platform/sdk pulls in a few transitive advisories that are not exploitable in practice. They are listed here so you can triage reports from npm audit / pnpm audit / Dependabot without diffing our lockfile.

valibot ReDoS (GHSA-vqpr-j7v3-hqw9)

• Why it shows up: @liam-hq/[email protected] pins [email protected], which falls in the vulnerable range (< 1.2.0).

• Why it's safe here: @liam-hq/cli is invoked only by tailor-sdk tailordb erd export as a child process, against developer-controlled schema files. The vulnerable code path (v.emoji() on attacker-controlled strings) is never reached.

• If you want to silence it: add an override to your project so valibot resolves to >=1.2.0. @toiroakr/lines-db declares valibot as an optional peer with range >=1.0.0, so forcing 1.2.0+ is safe.

  // pnpm (package.json)
  "pnpm": { "overrides": { "valibot": ">=1.2.0" } }
  
  // npm (package.json)
  "overrides": { "valibot": ">=1.2.0" }
  
  // yarn (package.json)
  "resolutions": { "valibot": ">=1.2.0" }

  This fix has to live in your project's package.json — overrides in a published package do not propagate to consumers.