@ontrails/core 1.0.0-beta.12 → 1.0.0-beta.13

package/src/provision.ts

@@ -0,0 +1,148 @@
+import { NotFoundError } from './errors.js';
+import type { Result } from './result.js';
+import type { ProvisionLookup, TrailContext } from './types.js';
+import type { z } from 'zod';
+
+/**
+ * Stable process-scoped fields available when constructing a provision.
+ *
+ * Provisions are app-level singletons, so they intentionally do not receive
+ * the full per-request TrailContext. When a provision declares a `config` schema,
+ * the validated config is passed as `svc.config`.
+ */
+export type ProvisionContext<C = unknown> = Pick<
+  TrailContext,
+  'cwd' | 'env' | 'workspaceRoot'
+> & {
+  readonly config: C;
+};
+
+/**
+ * Everything needed to describe a provision before a factory is introduced.
+ *
+ * When `config` is a Zod schema, the `create` callback receives
+ * `ProvisionContext<C>` with the validated config value.
+ */
+export interface ProvisionSpec<T, C = unknown> {
+  /** Create the provision instance from stable process-scoped context. */
+  readonly create: (
+    svc: ProvisionContext<C>
+  ) => Result<T, Error> | Promise<Result<T, Error>>;
+  /** Config schema — when present, config is validated and passed to `create`. */
+  readonly config?: z.ZodType<C> | undefined;
+  /** Optional cleanup performed when the hosting trailhead shuts down. */
+  readonly dispose?: ((provision: T) => void | Promise<void>) | undefined;
+  /** Optional operational readiness probe for introspection tooling. */
+  readonly health?:
+    | ((
+        provision: T
+      ) => Result<unknown, Error> | Promise<Result<unknown, Error>>)
+    | undefined;
+  /** Optional test factory used by higher-level helpers. */
+  readonly mock?: (() => T | Promise<T>) | undefined;
+  /** Human-readable description. */
+  readonly description?: string | undefined;
+  /** Arbitrary meta for tooling and filtering. */
+  readonly meta?: Readonly<Record<string, unknown>> | undefined;
+}
+
+/** A typed provision definition. */
+export interface Provision<T> extends ProvisionSpec<T> {
+  readonly kind: 'provision';
+  readonly id: string;
+  /** Read the resolved provision instance from a trail context. */
+  from(ctx: TrailContext): T;
+}
+
+/**
+ * Existential type for heterogeneous provision collections.
+ *
+ * `Provision<T>` includes function parameters in `dispose`/`health`, so
+ * `unknown` is too narrow for mixed provision arrays. `any` is the correct
+ * existential here.
+ */
+// oxlint-disable-next-line no-explicit-any -- existential type for heterogeneous provision collections
+export type AnyProvision = Provision<any>;
+
+/** Explicit runtime overrides keyed by provision ID. */
+export type ProvisionOverrideMap = Readonly<Record<string, unknown>>;
+
+const getProvisionId = <T>(
+  provisionOrId: string | Pick<Provision<T>, 'id'>
+): string =>
+  typeof provisionOrId === 'string' ? provisionOrId : provisionOrId.id;
+
+const getProvisionInstance = <T>(
+  ctx: Pick<TrailContext, 'extensions'>,
+  provisionOrId: string | Pick<Provision<T>, 'id'>
+): T => {
+  const id = getProvisionId(provisionOrId);
+  return ctx.extensions?.[id] as T;
+};
+
+const hasProvisionInstance = (
+  ctx: Pick<TrailContext, 'extensions'>,
+  provisionOrId: string | Pick<AnyProvision, 'id'>
+): boolean =>
+  Object.hasOwn(ctx.extensions ?? {}, getProvisionId(provisionOrId));
+
+/** Create a `ctx.provision(...)` accessor bound to a concrete context snapshot. */
+export const createProvisionLookup = (
+  getContext: () => Pick<TrailContext, 'extensions'>
+): ProvisionLookup =>
+  ((provisionOrId: string | Pick<AnyProvision, 'id'>) => {
+    const id = getProvisionId(provisionOrId);
+    const ctx = getContext();
+    if (!hasProvisionInstance(ctx, id)) {
+      throw new NotFoundError(`Provision "${id}" not found in trail context`);
+    }
+    return getProvisionInstance(ctx, id);
+  }) as ProvisionLookup;
+
+/**
+ * Create a typed provision definition.
+ *
+ * The provision object is inert until a later execution branch resolves concrete
+ * instances into TrailContext extensions.
+ */
+export const provision = <T>(
+  id: string,
+  spec: ProvisionSpec<T>
+): Provision<T> =>
+  Object.freeze({
+    ...spec,
+    from(ctx: TrailContext): T {
+      const lookup = ctx.provision ?? createProvisionLookup(() => ctx);
+      return lookup(this);
+    },
+    id,
+    kind: 'provision' as const,
+  });
+
+/** Narrow unknown values to provision definitions during topo discovery. */
+export const isProvision = (value: unknown): value is AnyProvision => {
+  if (typeof value !== 'object' || value === null) {
+    return false;
+  }
+  const v = value as { kind?: unknown; id?: unknown };
+  return v.kind === 'provision' && typeof v.id === 'string';
+};
+
+/**
+ * Return the first duplicate provision ID in a collection, if any.
+ *
+ * This supports later topo registration without each caller duplicating the
+ * same scan logic.
+ */
+export const findDuplicateProvisionId = (
+  provisions: readonly Pick<AnyProvision, 'id'>[]
+): string | undefined => {
+  const seen = new Set<string>();
+  for (const candidate of provisions) {
+    if (seen.has(candidate.id)) {
+      return candidate.id;
+    }
+    seen.add(candidate.id);
+  }
+  return undefined;
+};

package/src/{dispatch.ts → run.ts}

@@ -1,5 +1,5 @@
 /**
- * Headless trail execution — the "no-surface" surface.
+ * Headless trail execution without mounting a trailhead.
  *
  * Looks up a trail by ID in a topo, then delegates to `executeTrail`.
  * Returns a `Result` and never throws.
@@ -15,15 +15,15 @@ import { Result } from './result.js';
 // Options
 // ---------------------------------------------------------------------------
 
-/** Options forwarded to `executeTrail` from `dispatch`. */
-export type DispatchOptions = ExecuteTrailOptions;
+/** Options forwarded to `executeTrail` from `run`. */
+export type RunOptions = ExecuteTrailOptions;
 
 // ---------------------------------------------------------------------------
-// dispatch()
+// run()
 // ---------------------------------------------------------------------------
 
 /**
- * Execute a trail by ID from a topo without mounting a surface.
+ * Execute a trail by ID from a topo without mounting a trailhead.
  *
  * Resolves the trail from the topo, then runs it through the standard
  * `executeTrail` pipeline. Returns `Result.err(NotFoundError)` if the
@@ -32,15 +32,15 @@ export type DispatchOptions = ExecuteTrailOptions;
  *
  * @example
  * ```typescript
- * const result = await dispatch(myTopo, 'greet', { name: 'Alice' });
+ * const result = await run(myTopo, 'greet', { name: 'Alice' });
  * if (result.isOk()) console.log(result.value);
  * ```
  */
-export const dispatch = (
+export const run = (
   topo: Topo,
   id: string,
   input: unknown,
-  options?: DispatchOptions
+  options?: RunOptions
 ): Promise<Result<unknown, Error>> => {
   const trail = topo.get(id);
   if (trail === undefined) {

package/src/signal.ts

@@ -0,0 +1,65 @@
+/**
+ * Signal — a named payload schema with optional provenance meta.
+ */
+
+import type { z } from 'zod';
+
+// ---------------------------------------------------------------------------
+// Spec (input to the factory)
+// ---------------------------------------------------------------------------
+
+export interface SignalSpec<T> {
+  readonly payload: z.ZodType<T>;
+  readonly description?: string | undefined;
+  readonly meta?: Readonly<Record<string, unknown>> | undefined;
+  /** Trail IDs that produce this signal (e.g. the trails it originates from). */
+  readonly from?: readonly string[] | undefined;
+}
+
+// ---------------------------------------------------------------------------
+// Shape (output of the factory)
+// ---------------------------------------------------------------------------
+
+export interface Signal<T> {
+  readonly id: string;
+  readonly kind: 'signal';
+  readonly payload: z.ZodType<T>;
+  readonly description?: string | undefined;
+  readonly meta?: Readonly<Record<string, unknown>> | undefined;
+  /** Trail IDs that produce this signal (e.g. the trails it originates from). */
+  readonly from?: readonly string[] | undefined;
+}
+
+// ---------------------------------------------------------------------------
+// Factory
+// ---------------------------------------------------------------------------
+
+/**
+ * Create a signal definition.
+ *
+ * A signal is a named payload schema describing something that happened.
+ * Returns a frozen object with `kind: "signal"` and all spec fields.
+ */
+export function signal<T>(id: string, spec: SignalSpec<T>): Signal<T>;
+export function signal<T>(
+  spec: SignalSpec<T> & { readonly id: string }
+): Signal<T>;
+export function signal<T>(
+  idOrSpec: string | (SignalSpec<T> & { readonly id: string }),
+  maybeSpec?: SignalSpec<T>
+): Signal<T> {
+  const resolvedId = typeof idOrSpec === 'string' ? idOrSpec : idOrSpec.id;
+  // oxlint-disable-next-line no-non-null-assertion -- overload guarantees maybeSpec when idOrSpec is string
+  const resolvedSpec = typeof idOrSpec === 'string' ? maybeSpec! : idOrSpec;
+  return Object.freeze({
+    description: resolvedSpec.description,
+    from: resolvedSpec.from ? Object.freeze([...resolvedSpec.from]) : undefined,
+    id: resolvedId,
+    kind: 'signal' as const,
+    meta: resolvedSpec.meta,
+    payload: resolvedSpec.payload,
+  });
+}
+
+/** Existential type for heterogeneous signal collections */
+export type AnySignal = Signal<unknown>;

package/src/topo.ts

@@ -3,9 +3,9 @@
  */
 
 import { ValidationError } from './errors.js';
-import type { AnyEvent } from './event.js';
-import type { AnyService } from './service.js';
-import { isService } from './service.js';
+import type { AnySignal } from './event.js';
+import type { AnyProvision } from './provision.js';
+import { isProvision } from './provision.js';
 import type { AnyTrail } from './trail.js';
 
 // ---------------------------------------------------------------------------
@@ -15,33 +15,33 @@ import type { AnyTrail } from './trail.js';
 export interface Topo {
   readonly name: string;
   readonly trails: ReadonlyMap<string, AnyTrail>;
-  readonly events: ReadonlyMap<string, AnyEvent>;
-  readonly services: ReadonlyMap<string, AnyService>;
+  readonly signals: ReadonlyMap<string, AnySignal>;
+  readonly provisions: ReadonlyMap<string, AnyProvision>;
   readonly count: number;
-  readonly serviceCount: number;
+  readonly provisionCount: number;
   get(id: string): AnyTrail | undefined;
-  getService(id: string): AnyService | undefined;
+  getProvision(id: string): AnyProvision | undefined;
   has(id: string): boolean;
-  hasService(id: string): boolean;
+  hasProvision(id: string): boolean;
   ids(): string[];
-  serviceIds(): string[];
+  provisionIds(): string[];
   list(): AnyTrail[];
-  listEvents(): AnyEvent[];
-  listServices(): AnyService[];
+  listSignals(): AnySignal[];
+  listProvisions(): AnyProvision[];
 }
 
 // ---------------------------------------------------------------------------
 // Kind discriminant check
 // ---------------------------------------------------------------------------
 
-type Registrable = AnyTrail | AnyEvent | AnyService;
+type Registrable = AnyTrail | AnySignal | AnyProvision;
 
 const isRegistrable = (value: unknown): value is Registrable => {
   if (typeof value !== 'object' || value === null) {
     return false;
   }
   const { kind } = value as Record<string, unknown>;
-  return kind === 'trail' || kind === 'event';
+  return kind === 'trail' || kind === 'signal';
 };
 
 // ---------------------------------------------------------------------------
@@ -51,24 +51,22 @@ const isRegistrable = (value: unknown): value is Registrable => {
 const createTopo = (
   name: string,
   trails: ReadonlyMap<string, AnyTrail>,
-  events: ReadonlyMap<string, AnyEvent>,
-  services: ReadonlyMap<string, AnyService>
+  signals: ReadonlyMap<string, AnySignal>,
+  provisions: ReadonlyMap<string, AnyProvision>
 ): Topo => ({
   count: trails.size,
-  events,
   get(id: string): AnyTrail | undefined {
     return trails.get(id);
   },
-  getService(id: string): AnyService | undefined {
-    return services.get(id);
+  getProvision(id: string): AnyProvision | undefined {
+    return provisions.get(id);
   },
   has(id: string): boolean {
     return trails.has(id);
   },
-  hasService(id: string): boolean {
-    return services.has(id);
+  hasProvision(id: string): boolean {
+    return provisions.has(id);
   },
-
   ids(): string[] {
     return [...trails.keys()];
   },
@@ -76,21 +74,22 @@ const createTopo = (
   list(): AnyTrail[] {
     return [...trails.values()];
   },
-
-  listEvents(): AnyEvent[] {
-    return [...events.values()];
+  listProvisions(): AnyProvision[] {
+    return [...provisions.values()];
   },
-  listServices(): AnyService[] {
-    return [...services.values()];
+
+  listSignals(): AnySignal[] {
+    return [...signals.values()];
   },
 
   name,
-  serviceCount: services.size,
-  serviceIds(): string[] {
-    return [...services.keys()];
-  },
+  provisionCount: provisions.size,
 
-  services,
+  provisionIds(): string[] {
+    return [...provisions.keys()];
+  },
+  provisions,
+  signals,
   trails,
 });
 
@@ -102,22 +101,22 @@ const createTopo = (
 const register = (
   value: Registrable,
   trails: Map<string, AnyTrail>,
-  events: Map<string, AnyEvent>,
-  services: Map<string, AnyService>
+  signals: Map<string, AnySignal>,
+  provisions: Map<string, AnyProvision>
 ): void => {
   const { id } = value as { id: string };
   const registrars: Record<string, () => void> = {
-    event: () => {
-      if (events.has(id)) {
-        throw new ValidationError(`Duplicate event ID: "${id}"`);
+    provision: () => {
+      if (provisions.has(id)) {
+        throw new ValidationError(`Duplicate provision ID: "${id}"`);
       }
-      events.set(id, value as AnyEvent);
+      provisions.set(id, value as AnyProvision);
     },
-    service: () => {
-      if (services.has(id)) {
-        throw new ValidationError(`Duplicate service ID: "${id}"`);
+    signal: () => {
+      if (signals.has(id)) {
+        throw new ValidationError(`Duplicate signal ID: "${id}"`);
       }
-      services.set(id, value as AnyService);
+      signals.set(id, value as AnySignal);
     },
     trail: () => {
       if (trails.has(id)) {
@@ -129,20 +128,43 @@ const register = (
   registrars[value.kind]?.();
 };
 
+const markUniqueObject = (
+  value: unknown,
+  seenValues: WeakSet<object>
+): boolean => {
+  if (typeof value !== 'object' || value === null) {
+    return true;
+  }
+  if (seenValues.has(value)) {
+    return false;
+  }
+  seenValues.add(value);
+  return true;
+};
+
+const registerModuleValue = (
+  value: unknown,
+  trails: Map<string, AnyTrail>,
+  signals: Map<string, AnySignal>,
+  provisions: Map<string, AnyProvision>
+): void => {
+  if (isProvision(value) || isRegistrable(value)) {
+    register(value, trails, signals, provisions);
+  }
+};
+
 const registerModuleValues = (
   mod: Record<string, unknown>,
   trails: Map<string, AnyTrail>,
-  events: Map<string, AnyEvent>,
-  services: Map<string, AnyService>
+  signals: Map<string, AnySignal>,
+  provisions: Map<string, AnyProvision>
 ): void => {
+  const seenValues = new WeakSet<object>();
   for (const value of Object.values(mod)) {
-    if (isService(value)) {
-      register(value, trails, events, services);
+    if (!markUniqueObject(value, seenValues)) {
       continue;
     }
-    if (isRegistrable(value)) {
-      register(value, trails, events, services);
-    }
+    registerModuleValue(value, trails, signals, provisions);
   }
 };
 
@@ -151,12 +173,12 @@ export const topo = (
   ...modules: Record<string, unknown>[]
 ): Topo => {
   const trails = new Map<string, AnyTrail>();
-  const events = new Map<string, AnyEvent>();
-  const services = new Map<string, AnyService>();
+  const signals = new Map<string, AnySignal>();
+  const provisions = new Map<string, AnyProvision>();
 
   for (const mod of modules) {
-    registerModuleValues(mod, trails, events, services);
+    registerModuleValues(mod, trails, signals, provisions);
   }
 
-  return createTopo(name, trails, events, services);
+  return createTopo(name, trails, signals, provisions);
 };

package/src/trail.ts

@@ -2,7 +2,7 @@ import type { z } from 'zod';
 
 import type { FieldOverride } from './derive.js';
 import type { Result } from './result.js';
-import type { AnyService } from './service.js';
+import type { AnyProvision } from './provision.js';
 import type {
   Implementation,
   PermitRequirement,
@@ -44,7 +44,7 @@ export interface TrailSpec<I, O> {
   /** Zod schema for validating output (optional — some trails are fire-and-forget) */
   readonly output?: z.ZodType<O> | undefined;
   /** The pure function that does the work (sync or async authoring) */
-  readonly run: Implementation<I, O>;
+  readonly blaze: Implementation<I, O>;
   /** Human-readable description */
   readonly description?: string | undefined;
   /** Named examples for docs and testing */
@@ -53,16 +53,16 @@ export interface TrailSpec<I, O> {
   readonly intent?: 'read' | 'write' | 'destroy' | undefined;
   /** Trail is idempotent (safe to retry) */
   readonly idempotent?: boolean | undefined;
-  /** Arbitrary metadata for tooling and filtering */
-  readonly metadata?: Readonly<Record<string, unknown>> | undefined;
+  /** Arbitrary meta for tooling and filtering */
+  readonly meta?: Readonly<Record<string, unknown>> | undefined;
   /** Named sets of downstream trail IDs that may be invoked */
   readonly detours?: Readonly<Record<string, readonly string[]>> | undefined;
   /** Per-field overrides for deriveFields() (labels, hints, options) */
   readonly fields?: Readonly<Record<string, FieldOverride>> | undefined;
-  /** IDs of downstream trails this trail may invoke via ctx.follow() */
-  readonly follow?: readonly string[] | undefined;
-  /** Services this trail may access via service.from(ctx) */
-  readonly services?: readonly AnyService[] | undefined;
+  /** IDs of downstream trails this trail may invoke via ctx.cross() */
+  readonly crosses?: readonly string[] | undefined;
+  /** Provisions this trail may access via provision.from(ctx) */
+  readonly provisions?: readonly AnyProvision[] | undefined;
   /** Auth requirement: scopes object, 'public', or omitted (undeclared) */
   readonly permit?: PermitRequirement | undefined;
 }
@@ -77,15 +77,15 @@ export type Intent = 'read' | 'write' | 'destroy';
 /** A fully-defined trail — the unit of work in the Trails system */
 export interface Trail<I, O> extends Omit<
   TrailSpec<I, O>,
-  'run' | 'follow' | 'intent' | 'services'
+  'blaze' | 'crosses' | 'intent' | 'provisions'
 > {
   readonly kind: 'trail';
   readonly id: string;
-  readonly run: Implementation<I, O>;
-  /** IDs of downstream trails this trail may invoke via ctx.follow() (always present, default []) */
-  readonly follow: readonly string[];
-  /** Services this trail may access via service.from(ctx) (always present, default []) */
-  readonly services: readonly AnyService[];
+  readonly blaze: Implementation<I, O>;
+  /** IDs of downstream trails this trail may invoke via ctx.cross() (always present, default []) */
+  readonly crosses: readonly string[];
+  /** Provisions this trail may access via provision.from(ctx) (always present, default []) */
+  readonly provisions: readonly AnyProvision[];
   /** What this trail does to the world (always present, default 'write') */
   readonly intent: Intent;
 }
@@ -105,14 +105,14 @@ export interface Trail<I, O> extends Omit<
  * // ID as first argument (recommended for human authoring)
  * const show = trail("entity.show", {
  *   input: z.object({ name: z.string() }),
- *   run: (input) => Result.ok(entity),
+ *   blaze: (input) => Result.ok(entity),
  * });
  *
  * // Full spec object (for programmatic generation)
  * const show = trail({
  *   id: "entity.show",
  *   input: z.object({ name: z.string() }),
- *   run: (input) => Result.ok(entity),
+ *   blaze: (input) => Result.ok(entity),
  * });
  * ```
  */
@@ -134,21 +134,22 @@ export function trail<I, O>(
   }
 
   const {
-    run,
-    follow: rawFollow,
+    blaze,
+    crosses: rawCrosses,
     intent: rawIntent,
-    services: rawServices,
+    provisions: rawProvisions,
     ...spec
   } = resolved.spec;
+  const provisions = Object.freeze([...(rawProvisions ?? [])]);
 
   return Object.freeze({
     ...spec,
-    follow: Object.freeze([...(rawFollow ?? [])]),
+    blaze: async (input: I, ctx: TrailContext) => await blaze(input, ctx),
+    crosses: Object.freeze([...(rawCrosses ?? [])]),
     id: resolved.id,
     intent: rawIntent ?? 'write',
     kind: 'trail' as const,
-    run: async (input: I, ctx: TrailContext) => await run(input, ctx),
-    services: Object.freeze([...(rawServices ?? [])]),
+    provisions,
   });
 }
 

package/src/types.ts

@@ -12,14 +12,14 @@ export type Implementation<I, O> = (
 ) => Result<O, Error> | Promise<Result<O, Error>>;
 
 /** Invoke another trail by id — used for trail composition */
-export type FollowFn = <O>(
+export type CrossFn = <O>(
   id: string,
   input: unknown
 ) => Promise<Result<O, Error>>;
 
-/** Resolve a service instance from the current trail context. */
-export type ServiceLookup = <T = unknown>(
-  serviceOrId: { readonly id: string } | string
+/** Resolve a provision instance from the current trail context. */
+export type ProvisionLookup = <T = unknown>(
+  provisionOrId: { readonly id: string } | string
 ) => T;
 
 /** Callback for reporting progress from long-running trails */
@@ -46,8 +46,8 @@ export interface Logger {
   child(context: Record<string, unknown>): Logger;
 }
 
-/** Context extension key for the invoking surface name. */
-export const SURFACE_KEY = '__trails_surface' as const;
+/** Context extension key for the invoking trailhead name. */
+export const TRAILHEAD_KEY = '__trails_trailhead' as const;
 
 /** Minimal permit shape available on TrailContext. Permits extends this. */
 export interface BasePermit {
@@ -58,8 +58,8 @@ export interface BasePermit {
 /** Runtime context threaded through every trail execution */
 export interface TrailContext {
   readonly requestId: string;
-  readonly signal: AbortSignal;
-  readonly follow?: FollowFn | undefined;
+  readonly abortSignal: AbortSignal;
+  readonly cross?: CrossFn | undefined;
   readonly permit?: BasePermit;
   readonly workspaceRoot?: string | undefined;
   readonly logger?: Logger | undefined;
@@ -67,7 +67,7 @@ export interface TrailContext {
   readonly cwd?: string | undefined;
   readonly env?: Record<string, string | undefined> | undefined;
   readonly extensions?: Readonly<Record<string, unknown>> | undefined;
-  readonly service?: ServiceLookup | undefined;
+  readonly provision?: ProvisionLookup | undefined;
 }
 
 /**
@@ -82,6 +82,6 @@ export type PermitRequirement =
   | 'public';
 
 /** Input shape used to seed a runtime TrailContext before resolution. */
-export type TrailContextInit = Omit<TrailContext, 'service'> & {
-  readonly service?: ServiceLookup | undefined;
+export type TrailContextInit = Omit<TrailContext, 'provision'> & {
+  readonly provision?: ProvisionLookup | undefined;
 };