Types Reference

type CreateInput = {
  projectName?: string;
  template?: Template;
  frontend?: Frontend[];
  backend?: Backend;
  runtime?: Runtime;
  database?: Database;
  orm?: ORM;
  api?: API;
  auth?: Auth;
  payments?: Payments;
  addons?: Addons[];
  examples?: Examples[];
  packageManager?: PackageManager;
  install?: boolean;
  git?: boolean;
  dbSetup?: DatabaseSetup;
  webDeploy?: WebDeploy;
  serverDeploy?: ServerDeploy;
  directoryConflict?: DirectoryConflict;
  yes?: boolean;
  yolo?: boolean;
  disableAnalytics?: boolean;
  manualDb?: boolean;
}

type InitResult = {
  success: boolean;
  projectConfig: ProjectConfig;
  reproducibleCommand: string;
  timeScaffolded: string;
  elapsedTimeMs: number;
  projectDirectory: string;
  relativePath: string;
  error?: string;
}

type ProjectConfig = {
  projectName: string;
  projectDir: string;
  relativePath: string;
  database: Database;
  orm: ORM;
  backend: Backend;
  runtime: Runtime;
  frontend: Frontend[];
  addons: Addons[];
  examples: Examples[];
  auth: Auth;
  payments: Payments;
  git: boolean;
  packageManager: PackageManager;
  install: boolean;
  dbSetup: DatabaseSetup;
  api: API;
  webDeploy: WebDeploy;
  serverDeploy: ServerDeploy;
}

type AddResult = {
  success: boolean;
  addedAddons: Addons[];
  projectDir: string;
  error?: string;
}

type Database =
  | "sqlite"
  | "postgres"
  | "mysql"
  | "mongo"
  | "none"

type ORM =
  | "drizzle"
  | "prisma"
  | "mongoose"
  | "none"

type Backend =
  | "hono"
  | "express"
  | "fastify"
  | "elysia"
  | "none"

type Runtime =
  | "bun"
  | "node"

type Frontend =
  | "tanstack-router"
  | "tanstack-start"
  | "react-router"
  | "next"
  | "nuxt"
  | "svelte"
  | "solid"
  | "native-bare"
  | "native-uniwind"
  | "native-unistyles"
  | "none"

type API =
  | "trpc"
  | "none"

type Auth =
  | "better-auth"
  | "none"

type Payments =
  | "stripe"
  | "none"

type Addons =
  | "biome"
  | "playwright"
  | "husky"
  | "mcp"
  | "alchemy"
  | "pwa"
  | "posthog"

type Examples =
  | "todo"
  | "crud"
  | "form"

type PackageManager =
  | "bun"
  | "npm"
  | "pnpm"
  | "yarn"

type DatabaseSetup =
  | "auto"
  | "manual"
  | "none"

type WebDeploy =
  | "vercel"
  | "netlify"
  | "cloudflare"
  | "none"

type ServerDeploy =
  | "railway"
  | "fly"
  | "render"
  | "none"

type Template =
  | "tanstack"
  | "next"
  | "nuxt"
  | "svelte"
  | "solid"
  | "native"
  | "api"

type DirectoryConflict =
  | "error"      // Throw error if directory exists
  | "overwrite"  // Delete and recreate directory
  | "merge"      // Merge with existing files
  | "increment"  // Auto-increment name (my-app-1, my-app-2, ...)

type VirtualFileTree = {
  root: VirtualDirectory;
  fileCount: number;
  directoryCount: number;
  config: ProjectConfig;
}

type VirtualFile = {
  type: "file";
  path: string;        // "src/index.ts"
  name: string;        // "index.ts"
  content: string;     // File contents
  extension: string;   // "ts"
  sourcePath?: string; // Original template path
}

type VirtualDirectory = {
  type: "directory";
  path: string;        // "src/components"
  name: string;        // "components"
  children: VirtualNode[];
}

type VirtualNode = VirtualFile | VirtualDirectory

type GeneratorOptions = {
  config: ProjectConfig;
  templateBasePath?: string;
  templates?: Map<string, string>;
  version?: string; // CLI version for bts.jsonc
}

type CreateError = UserCancelledError | CLIError | ProjectCreationError

type Result<T, E> = Ok<T> | Err<E>

interface Ok<T> {
  isOk(): true;
  isErr(): false;
  value: T;
  unwrap(): T;
  unwrapOr(defaultValue: T): T;
  match<U>(handlers: { ok: (value: T) => U; err: (error: E) => U }): U;
}

interface Err<E> {
  isOk(): false;
  isErr(): true;
  error: E;
  unwrap(): never;
  unwrapOr<T>(defaultValue: T): T;
  match<U>(handlers: { ok: (value: T) => U; err: (error: E) => U }): U;
}

create("my-app", options?: Partial<CreateInput>)

type WebFrontend =
  | "tanstack-router"
  | "react-router"
  | "tanstack-start"
  | "next"
  | "nuxt"
  | "svelte"
  | "solid"
  | "none"

type NativeFrontend =
  | "native-bare"
  | "native-uniwind"
  | "native-unistyles"
  | "none"

import type {
  CreateInput,
  InitResult,
  ProjectConfig,
  AddResult,
} from "create-better-t-stack";

import type {
  Database,
  ORM,
  Backend,
  Runtime,
  Frontend,
  Addons,
  PackageManager,
} from "create-better-t-stack";

import type {
  VirtualFileTree,
  VirtualFile,
  VirtualDirectory,
  VirtualNode,
} from "create-better-t-stack";

import {
  UserCancelledError,
  CLIError,
  ProjectCreationError,
  ValidationError,
  type CreateError,
} from "create-better-t-stack";

import { Result } from "create-better-t-stack";

// Or from better-result directly
import { Result } from "better-result";