@ontrails/core 1.0.0-beta.2 → 1.0.0-beta.21

package/src/trails/index.ts

@@ -0,0 +1,9 @@
+export { deriveTrail } from './derive-trail.js';
+export type {
+  DeriveTrailInput,
+  DeriveTrailOperation,
+  DeriveTrailOutput,
+  DeriveTrailSpec,
+} from './derive-trail.js';
+export { ingest } from './ingest.js';
+export type { IngestOptions, IngestTransform } from './ingest.js';

package/src/trails/ingest.ts

@@ -0,0 +1,139 @@
+import { z } from 'zod';
+
+import { InternalError } from '../errors.js';
+import { composeLayers } from '../layer.js';
+import type { Layer } from '../layer.js';
+import { Result } from '../result.js';
+import type { Signal } from '../signal.js';
+import { trail } from '../trail.js';
+import type { Trail, TrailExample, TrailSpec } from '../trail.js';
+import type { TrailContext } from '../types.js';
+
+type SchemaValue<TSchema extends z.ZodType> = z.output<TSchema>;
+
+type ExampleBearingSchema<TSchema extends z.ZodType> = TSchema & {
+  readonly examples?: readonly Partial<SchemaValue<TSchema>>[] | undefined;
+};
+
+interface IngestBaseOptions<TSchema extends z.ZodType, TSignal> extends Omit<
+  TrailSpec<SchemaValue<TSchema>, void>,
+  'blaze' | 'examples' | 'fires' | 'input' | 'intent' | 'output' | 'pattern'
+> {
+  /** Override the derived trail id. Defaults to `${signal}.ingest`. */
+  readonly id?: string | undefined;
+  /** Validated external payload shape. */
+  readonly schema: TSchema;
+  /** Signal to fire after verification and optional transformation. */
+  readonly signal: Signal<TSignal>;
+  /** Optional per-trail verification layer, e.g. HMAC signature checks. */
+  readonly verify?: Layer | undefined;
+}
+
+export type IngestTransform<TInput, TSignal> = (
+  payload: TInput,
+  ctx: TrailContext
+) => TSignal | Promise<TSignal>;
+
+export interface IngestOptions<
+  TSchema extends z.ZodType,
+  TSignal,
+> extends IngestBaseOptions<TSchema, TSignal> {
+  readonly transform?:
+    | IngestTransform<SchemaValue<TSchema>, TSignal>
+    | undefined;
+}
+
+const deriveExampleName = (signalId: string, index: number): string =>
+  `Ingest ${signalId} ${index + 1}`;
+
+const deriveExamples = <TSchema extends z.ZodType>(
+  schema: ExampleBearingSchema<TSchema>,
+  signalId: string
+): readonly TrailExample<SchemaValue<TSchema>, void>[] | undefined => {
+  const { examples } = schema;
+  if (examples === undefined || examples.length === 0) {
+    return undefined;
+  }
+
+  return Object.freeze(
+    examples.map((example, index) => ({
+      input: example,
+      name: deriveExampleName(signalId, index),
+    }))
+  );
+};
+
+const createIngestBlaze =
+  <TSchema extends z.ZodType, TSignal>(
+    signalRef: Signal<TSignal>,
+    signalId: string,
+    trailId: string,
+    transform: IngestTransform<SchemaValue<TSchema>, TSignal> | undefined
+  ) =>
+  async (
+    input: SchemaValue<TSchema>,
+    ctx: TrailContext
+  ): Promise<Result<void, Error>> => {
+    if (ctx.fire === undefined) {
+      return Result.err(
+        new InternalError(
+          `ingest("${trailId}") requires topo-backed execution to fire "${signalId}"`
+        )
+      );
+    }
+
+    try {
+      const payload =
+        transform === undefined
+          ? (input as TSignal)
+          : await transform(input, ctx);
+      await ctx.fire(signalRef, payload);
+      return Result.ok();
+    } catch (error) {
+      const message = `ingest("${trailId}"): ${error instanceof Error ? error.message : String(error)}`;
+      return Result.err(
+        error instanceof Error
+          ? new InternalError(message, { cause: error })
+          : new InternalError(message)
+      );
+    }
+  };
+
+export const ingest = <
+  TSchema extends z.ZodType,
+  TSignal = SchemaValue<TSchema>,
+>(
+  options: IngestOptions<TSchema, TSignal>
+): Trail<SchemaValue<TSchema>, void> => {
+  const signalId = options.signal.id;
+  const id = options.id ?? `${signalId}.ingest`;
+  const { id: _id, schema, signal, transform, verify, ...trailSpec } = options;
+  const baseBlaze = createIngestBlaze<TSchema, TSignal>(
+    signal,
+    signalId,
+    id,
+    transform
+  );
+  const baseSpec = {
+    ...trailSpec,
+    blaze: baseBlaze as TrailSpec<unknown, unknown>['blaze'],
+    examples: deriveExamples(schema as ExampleBearingSchema<TSchema>, signalId),
+    fires: [signal],
+    input: schema as z.ZodType<unknown>,
+    intent: 'write',
+    output: z.void(),
+    pattern: 'ingest',
+  } as TrailSpec<unknown, unknown>;
+  const baseTrail = trail(id, baseSpec) as Trail<SchemaValue<TSchema>, void>;
+
+  if (verify === undefined) {
+    return baseTrail;
+  }
+
+  // Verification is a per-factory concern, so compose it locally instead of
+  // mutating runner-wide layer configuration.
+  return Object.freeze({
+    ...baseTrail,
+    blaze: composeLayers([verify], baseTrail, baseTrail.blaze),
+  }) as Trail<SchemaValue<TSchema>, void>;
+};

package/src/trails-db.ts

@@ -0,0 +1,208 @@
+import { Database } from 'bun:sqlite';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+
+import { NotFoundError } from './errors.js';
+
+const TRAILS_DIR = '.trails';
+const TRAILS_DB_FILE = 'trails.db';
+const TRAILS_CACHE_DIR = 'cache';
+const TRAILS_STATE_DIR = 'state';
+const SCHEMA_VERSION_TABLE = 'meta_schema_versions';
+const WORKSPACE_SUBDIRS = [TRAILS_CACHE_DIR, TRAILS_STATE_DIR] as const;
+
+/**
+ * The canonical lines written to a freshly-bootstrapped
+ * `.trails/.gitignore`. Kept as the source of truth for every consumer that
+ * needs to either write the file (scaffold) or audit its content (tests).
+ *
+ * @see {@link WORKSPACE_GITIGNORE_CONTENT} for the rendered string form.
+ */
+export const WORKSPACE_GITIGNORE_LINES = [
+  '# Local config overrides',
+  'config.local.js',
+  'config.local.ts',
+  '',
+  '# Rebuildable cache',
+  'cache/',
+  '',
+  '# Mutable runtime state',
+  'state/',
+  '',
+] as const;
+
+/**
+ * The canonical rendered `.trails/.gitignore` content. Use this when writing
+ * the file eagerly (e.g. during `trails create` scaffolding) or when asserting
+ * on the workspace bootstrap output.
+ */
+export const WORKSPACE_GITIGNORE_CONTENT = `${WORKSPACE_GITIGNORE_LINES.join('\n').trimEnd()}\n`;
+
+export interface TrailsDbLocationOptions {
+  readonly path?: string;
+  readonly rootDir?: string;
+}
+
+export interface EnsureSubsystemSchemaOptions {
+  readonly migrate: (currentVersion: number) => void;
+  readonly subsystem: string;
+  readonly version: number;
+}
+
+interface SchemaVersionRow {
+  readonly version: number;
+}
+
+const deriveRootDir = (rootDir?: string): string =>
+  resolve(rootDir ?? process.cwd());
+
+export const deriveTrailsDir = (options?: TrailsDbLocationOptions): string =>
+  join(deriveRootDir(options?.rootDir), TRAILS_DIR);
+
+export const deriveTrailsDbPath = (options?: TrailsDbLocationOptions): string =>
+  options?.path
+    ? resolve(options.path)
+    : join(deriveTrailsDir(options), TRAILS_STATE_DIR, TRAILS_DB_FILE);
+
+const ensureDbParentDir = (dbPath: string): void => {
+  mkdirSync(dirname(dbPath), { recursive: true });
+};
+
+const appendMissingGitignoreLines = (
+  gitignorePath: string,
+  content: string
+): void => {
+  const existingLines = new Set(content.split('\n').map((l) => l.trim()));
+  const missing = WORKSPACE_GITIGNORE_LINES.filter(
+    (line) => line !== '' && !existingLines.has(line)
+  );
+
+  if (missing.length === 0) {
+    return;
+  }
+
+  const next = `${content.trimEnd()}\n\n${missing.join('\n')}`;
+  writeFileSync(gitignorePath, `${next.trimEnd()}\n`);
+};
+
+const ensureWorkspaceGitignore = (trailsDir: string): void => {
+  const gitignorePath = join(trailsDir, '.gitignore');
+
+  if (!existsSync(gitignorePath)) {
+    writeFileSync(gitignorePath, WORKSPACE_GITIGNORE_CONTENT);
+    return;
+  }
+
+  appendMissingGitignoreLines(
+    gitignorePath,
+    readFileSync(gitignorePath, 'utf8')
+  );
+};
+
+/**
+ * Bootstrap the `.trails/` workspace at `rootDir`.
+ *
+ * Creates the workspace directory plus the canonical `cache/` and `state/`
+ * subdirectories, then either writes a fresh `.gitignore` matching
+ * {@link WORKSPACE_GITIGNORE_CONTENT} or appends any missing canonical lines
+ * to an existing one. Safe to call repeatedly. This is the single canonical
+ * source of truth for workspace layout — scaffolding, configuration loading,
+ * and runtime DB initialization all flow through here.
+ */
+export const ensureTrailsWorkspace = (rootDir: string): void => {
+  const trailsDir = deriveTrailsDir({ rootDir });
+  mkdirSync(trailsDir, { recursive: true });
+  for (const subdir of WORKSPACE_SUBDIRS) {
+    mkdirSync(join(trailsDir, subdir), { recursive: true });
+  }
+  ensureWorkspaceGitignore(trailsDir);
+};
+
+const initializeWritePragmas = (db: Database): void => {
+  db.run('PRAGMA journal_mode = WAL');
+  db.run('PRAGMA synchronous = NORMAL');
+  db.run('PRAGMA foreign_keys = ON');
+};
+
+const ensureSchemaVersionTable = (db: Database): void => {
+  db.run(`CREATE TABLE IF NOT EXISTS ${SCHEMA_VERSION_TABLE} (
+    subsystem TEXT PRIMARY KEY,
+    version INTEGER NOT NULL,
+    updated_at TEXT NOT NULL
+  )`);
+};
+
+const readSubsystemVersion = (db: Database, subsystem: string): number => {
+  const row = db
+    .query<SchemaVersionRow, [string]>(
+      `SELECT version FROM ${SCHEMA_VERSION_TABLE} WHERE subsystem = ?`
+    )
+    .get(subsystem);
+  return row?.version ?? 0;
+};
+
+const writeSubsystemVersion = (
+  db: Database,
+  subsystem: string,
+  version: number
+): void => {
+  db.run(
+    `INSERT INTO ${SCHEMA_VERSION_TABLE} (subsystem, version, updated_at)
+     VALUES (?, ?, ?)
+     ON CONFLICT(subsystem) DO UPDATE SET
+       version = excluded.version,
+       updated_at = excluded.updated_at`,
+    [subsystem, version, new Date().toISOString()]
+  );
+};
+
+export const openWriteTrailsDb = (
+  options?: TrailsDbLocationOptions
+): Database => {
+  const rootDir = deriveRootDir(options?.rootDir);
+  const dbPath = deriveTrailsDbPath(
+    options?.path ? { path: options.path, rootDir } : { rootDir }
+  );
+
+  if (options?.path === undefined) {
+    ensureTrailsWorkspace(rootDir);
+  } else {
+    ensureDbParentDir(dbPath);
+  }
+
+  const db = new Database(dbPath, { create: true });
+  initializeWritePragmas(db);
+  ensureSchemaVersionTable(db);
+  return db;
+};
+
+export const openReadTrailsDb = (
+  options?: TrailsDbLocationOptions
+): Database => {
+  const dbPath = deriveTrailsDbPath(options);
+  if (!existsSync(dbPath)) {
+    throw new NotFoundError(
+      `Trails database not found at "${dbPath}". Run a write operation first to initialize it.`
+    );
+  }
+  const db = new Database(dbPath, { readonly: true });
+  db.run('PRAGMA foreign_keys = ON');
+  return db;
+};
+
+export const ensureSubsystemSchema = (
+  db: Database,
+  options: EnsureSubsystemSchemaOptions
+): void => {
+  ensureSchemaVersionTable(db);
+
+  db.transaction(() => {
+    const currentVersion = readSubsystemVersion(db, options.subsystem);
+    if (currentVersion >= options.version) {
+      return;
+    }
+
+    options.migrate(currentVersion);
+    writeSubsystemVersion(db, options.subsystem, options.version);
+  })();
+};

package/src/transport-error-map.ts

@@ -0,0 +1,174 @@
+import type {
+  ErrorCategory,
+  ErrorCategoryCodes,
+  ErrorClassRegistryEntry,
+  FixedErrorClassRegistryEntry,
+  TrailsError,
+} from './errors.js';
+import {
+  codesByCategory,
+  errorClasses,
+  exitCodeMap,
+  isTrailsError,
+  jsonRpcCodeMap,
+  statusCodeMap,
+} from './errors.js';
+import {
+  INTERNAL_ERROR_PUBLIC_MESSAGE,
+  redactErrorString,
+} from './error-projection.js';
+
+export const surfaceNames = ['cli', 'http', 'jsonRpc', 'mcp'] as const;
+
+export type SurfaceName = (typeof surfaceNames)[number];
+
+const surfaceCodeKeys = {
+  cli: 'exit',
+  http: 'http',
+  jsonRpc: 'jsonRpc',
+  mcp: 'jsonRpc',
+} as const satisfies Record<SurfaceName, keyof ErrorCategoryCodes>;
+
+export type SurfaceErrorMapper<T> = (error: TrailsError) => T;
+
+export type SurfaceErrorMappings<T> = Record<ErrorCategory, T>;
+
+/**
+ * Union of every surface-specific error code emitted by {@link surfaceErrorMap}.
+ *
+ * @remarks
+ * Previously parameterized by surface (`SurfaceErrorCode<'cli'>` etc.), but
+ * the generic collapsed to `number` because the underlying maps were typed as
+ * `Record<ErrorCategory, number>`. With `as const satisfies` on the maps the
+ * per-surface literals are now observable, but TypeScript cannot narrow
+ * `surfaceErrorMap[surface][error.category]` through a generic `TSurface`
+ * without an unsound cast. The non-generic union honestly reflects what
+ * `mapSurfaceError` returns at the call site.
+ */
+export type SurfaceErrorCode =
+  (typeof codesByCategory)[ErrorCategory][(typeof surfaceCodeKeys)[SurfaceName]];
+
+export interface SurfaceErrorProjection {
+  readonly category: ErrorCategory;
+  readonly code: SurfaceErrorCode;
+  readonly message: string;
+  readonly name: string;
+  readonly retryable: boolean;
+  readonly surface: SurfaceName;
+}
+
+export interface ErrorClassSurfaceProjection {
+  readonly category: ErrorCategory;
+  readonly code: SurfaceErrorCode;
+  readonly name: string;
+  readonly retryable: boolean;
+  readonly surface: SurfaceName;
+}
+
+export const createSurfaceErrorMapper =
+  <T>(mappings: SurfaceErrorMappings<T>): SurfaceErrorMapper<T> =>
+  (error) =>
+    mappings[error.category];
+
+export const surfaceErrorMap = {
+  cli: exitCodeMap,
+  http: statusCodeMap,
+  jsonRpc: jsonRpcCodeMap,
+  mcp: jsonRpcCodeMap,
+} as const satisfies Record<SurfaceName, SurfaceErrorMappings<number>>;
+
+export const surfaceErrorRegistry = {
+  cli: {
+    map: createSurfaceErrorMapper(surfaceErrorMap.cli),
+    values: surfaceErrorMap.cli,
+  },
+  http: {
+    map: createSurfaceErrorMapper(surfaceErrorMap.http),
+    values: surfaceErrorMap.http,
+  },
+  jsonRpc: {
+    map: createSurfaceErrorMapper(surfaceErrorMap.jsonRpc),
+    values: surfaceErrorMap.jsonRpc,
+  },
+  mcp: {
+    map: createSurfaceErrorMapper(surfaceErrorMap.mcp),
+    values: surfaceErrorMap.mcp,
+  },
+} as const;
+
+export const mapSurfaceError = (
+  surface: SurfaceName,
+  error: TrailsError
+): SurfaceErrorCode =>
+  codesByCategory[error.category][surfaceCodeKeys[surface]];
+
+export const projectSurfaceError = (
+  surface: SurfaceName,
+  error: TrailsError
+): SurfaceErrorProjection => ({
+  category: error.category,
+  code: mapSurfaceError(surface, error),
+  message: error.message,
+  name: error.name,
+  retryable: error.retryable,
+  surface,
+});
+
+export const projectPublicSurfaceError = (
+  surface: SurfaceName,
+  error: Error
+): SurfaceErrorProjection => {
+  if (isTrailsError(error)) {
+    const projection = projectSurfaceError(surface, error);
+    return {
+      ...projection,
+      message:
+        projection.category === 'internal'
+          ? INTERNAL_ERROR_PUBLIC_MESSAGE
+          : redactErrorString(projection.message),
+    };
+  }
+
+  return {
+    category: 'internal',
+    code: codesByCategory.internal[surfaceCodeKeys[surface]],
+    message: INTERNAL_ERROR_PUBLIC_MESSAGE,
+    name: 'InternalError',
+    retryable: false,
+    surface,
+  };
+};
+
+const isFixedErrorClassEntry = (
+  entry: ErrorClassRegistryEntry
+): entry is FixedErrorClassRegistryEntry => entry.category !== 'dynamic';
+
+const fixedErrorClassByName: ReadonlyMap<string, FixedErrorClassRegistryEntry> =
+  new Map(
+    errorClasses.flatMap((entry): [string, FixedErrorClassRegistryEntry][] =>
+      isFixedErrorClassEntry(entry) ? [[entry.name, entry]] : []
+    )
+  );
+
+/**
+ * Project a known error class name onto a surface without constructing it.
+ *
+ * Dynamic-category errors such as `RetryExhaustedError` return `undefined`
+ * because their surface code depends on the wrapped runtime error.
+ */
+export const projectErrorClassSurface = (
+  surface: SurfaceName,
+  errorName: string
+): ErrorClassSurfaceProjection | undefined => {
+  const entry = fixedErrorClassByName.get(errorName);
+  if (entry === undefined) {
+    return undefined;
+  }
+  return {
+    category: entry.category,
+    code: codesByCategory[entry.category][surfaceCodeKeys[surface]],
+    name: entry.name,
+    retryable: entry.retryable,
+    surface,
+  };
+};

package/src/type-utils.ts

@@ -0,0 +1,87 @@
+/**
+ * Type utilities for extracting input/output types from trails.
+ */
+
+import type { Result } from './result.js';
+import type { AnyTrail, Trail } from './trail.js';
+import type { Implementation } from './types.js';
+import type { z } from 'zod';
+
+// ---------------------------------------------------------------------------
+// Utility types
+// ---------------------------------------------------------------------------
+
+/* oxlint-disable no-explicit-any -- `any` required for conditional type inference; `unknown` breaks inference */
+
+type SchemaInputOrFallback<TSchema extends z.ZodType, TFallback> =
+  unknown extends z.input<TSchema> ? TFallback : z.input<TSchema>;
+
+type ComposeSchemaOf<T extends AnyTrail> = T extends {
+  readonly composeInput?: (infer TComposeSchema) | undefined;
+}
+  ? NonNullable<TComposeSchema>
+  : never;
+
+type ComposeInputPart<T extends AnyTrail> =
+  ComposeSchemaOf<T> extends z.ZodType
+    ? T extends Trail<any, any, infer CI>
+      ? SchemaInputOrFallback<ComposeSchemaOf<T>, CI>
+      : z.input<ComposeSchemaOf<T>>
+    : T extends Trail<any, any, infer CI>
+      ? CI
+      : never;
+
+/** Extract the input type from a Trail. */
+export type TrailInput<T extends AnyTrail> = T extends {
+  readonly input: infer TInputSchema extends z.ZodType;
+}
+  ? T extends Trail<infer I, any, any>
+    ? SchemaInputOrFallback<TInputSchema, I>
+    : z.input<TInputSchema>
+  : never;
+
+/** Extract the output type from a Trail. */
+export type TrailOutput<T extends AnyTrail> = T extends {
+  readonly blaze: Implementation<any, infer O>;
+}
+  ? O
+  : never;
+
+/**
+ * Extract the compose-callable input type from a trail.
+ *
+ * When a trail declares `composeInput`, callers via `ctx.compose()` must pass
+ * both the public input fields and the composition-only fields. This type
+ * merges both schemas so the compiler enforces the full shape at the call
+ * site. Falls back to plain `TrailInput<T>` when no `composeInput` exists.
+ */
+export type ComposeInput<T extends AnyTrail> = [ComposeInputPart<T>] extends [
+  never,
+]
+  ? TrailInput<T>
+  : TrailInput<T> & ComposeInputPart<T>;
+
+/**
+ * Extracts the full `Result<Output, Error>` type from a trail definition.
+ *
+ * @example
+ * ```typescript
+ * type SearchResult = TrailResult<typeof searchTrail>;
+ * // Result<{ results: Item[]; count: number }, Error>
+ * ```
+ */
+export type TrailResult<T extends AnyTrail> = Result<TrailOutput<T>, Error>;
+
+/* oxlint-enable no-explicit-any */
+
+// ---------------------------------------------------------------------------
+// Runtime schema accessors
+// ---------------------------------------------------------------------------
+
+/** Get the input Zod schema from a trail, preserving the specific schema type. */
+export const inputOf = <T extends AnyTrail>(trail: T): T['input'] =>
+  trail.input;
+
+/** Get the output Zod schema from a trail, if defined, preserving the specific schema type. */
+export const outputOf = <T extends AnyTrail>(trail: T): T['output'] =>
+  trail.output;