@ontrails/warden 1.0.0-beta.3 → 1.0.0-beta.32

package/src/trails/no-redundant-result-error-wrap.trail.ts

@@ -0,0 +1,55 @@
+import { noRedundantResultErrorWrap } from '../rules/no-redundant-result-error-wrap.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noRedundantResultErrorWrapTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'entity.ts',
+        sourceCode: `import { Result, trail } from "@ontrails/core";
+
+trail("entity.load", {
+  blaze: async (input, ctx) => {
+    const loaded = await ctx.compose("entity.fetch", input);
+    if (loaded.isErr()) {
+      return loaded;
+    }
+    return Result.ok(loaded.value);
+  },
+});`,
+      },
+      name: 'Existing Result values pass through directly',
+    },
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: 'entity.ts',
+            line: 7,
+            message:
+              'Trail "entity.load": Result.err(loaded.error) re-wraps a Result that already carries that error. Return loaded directly to preserve the original Result boundary.',
+            rule: 'no-redundant-result-error-wrap',
+            severity: 'warn',
+          },
+        ],
+      },
+      input: {
+        filePath: 'entity.ts',
+        sourceCode: `import { Result, trail } from "@ontrails/core";
+
+trail("entity.load", {
+  blaze: async (input, ctx) => {
+    const loaded = await ctx.compose("entity.fetch", input);
+    if (loaded.isErr()) {
+      return Result.err(loaded.error);
+    }
+    return Result.ok(loaded.value);
+  },
+});`,
+      },
+      name: 'Warns when an existing Result error is re-wrapped',
+    },
+  ],
+  rule: noRedundantResultErrorWrap,
+});

package/src/trails/no-retired-cross-vocabulary.trail.ts

@@ -0,0 +1,42 @@
+import { noRetiredCrossVocabulary } from '../rules/no-retired-cross-vocabulary.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noRetiredCrossVocabularyTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'apps/example/src/trails/play.ts',
+        sourceCode: 'export const play = trail("play", { composes: [] });\n',
+      },
+      name: 'Source files using compose vocabulary are clean',
+    },
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: 'apps/example/src/trails/play.ts',
+            fix: {
+              class: 'term-rewrite',
+              edits: [{ end: 43, replacement: 'composes', start: 36 }],
+              reason:
+                "Retired composition vocabulary 'crosses' has a mechanical beta.19 replacement 'composes'.",
+              safety: 'safe',
+            },
+            line: 1,
+            message:
+              "Retired composition vocabulary 'crosses' should be 'composes' after the beta.19 compose cutover.",
+            rule: 'no-retired-cross-vocabulary',
+            severity: 'error',
+          },
+        ],
+      },
+      input: {
+        filePath: 'apps/example/src/trails/play.ts',
+        sourceCode: 'export const play = trail("play", { crosses: [] });\n',
+      },
+      name: 'Retired crosses declarations produce safe migration diagnostics',
+    },
+  ],
+  rule: noRetiredCrossVocabulary,
+});

package/src/trails/no-sync-result-assumption.trail.ts

@@ -0,0 +1,19 @@
+import { noSyncResultAssumption } from '../rules/no-sync-result-assumption.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noSyncResultAssumptionTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'clean.ts',
+        sourceCode: `const result = await myTrail.blaze(input, ctx);
+if (result.isOk()) {
+  console.log(result.value);
+}`,
+      },
+      name: 'Properly awaited .blaze() call',
+    },
+  ],
+  rule: noSyncResultAssumption,
+});

package/src/trails/no-throw-in-detour-recover.trail.ts

@@ -0,0 +1,24 @@
+import { noThrowInDetourRecover } from '../rules/no-throw-in-detour-recover.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noThrowInDetourRecoverTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'clean.ts',
+        sourceCode: `trail("entity.save", {
+  detours: [
+    {
+      on: ConflictError,
+      recover: async () => Result.ok({ recovered: true }),
+    },
+  ],
+  blaze: () => Result.err(new ConflictError("conflict")),
+})`,
+      },
+      name: 'Detour recover without throw',
+    },
+  ],
+  rule: noThrowInDetourRecover,
+});

package/src/trails/no-throw-in-implementation.trail.ts

@@ -0,0 +1,20 @@
+import { noThrowInImplementation } from '../rules/no-throw-in-implementation.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noThrowInImplementationTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'clean.ts',
+        sourceCode: `trail("entity.show", {
+  blaze: async (input, ctx) => {
+    return Result.ok({ name: "test" });
+  }
+})`,
+      },
+      name: 'Clean implementation without throw',
+    },
+  ],
+  rule: noThrowInImplementation,
+});

package/src/trails/no-top-level-surface.trail.ts

@@ -0,0 +1,43 @@
+import { noTopLevelSurface } from '../rules/no-top-level-surface.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const noTopLevelSurfaceTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'src/mcp.ts',
+        sourceCode: `import { surface } from "@ontrails/mcp";
+import graph from "./app";
+
+await surface(graph);`,
+      },
+      name: 'Allows dedicated surface entry modules',
+    },
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: 'src/app.ts',
+            line: 6,
+            message:
+              'This module exports a topo and opens a surface at module top level. Trails introspection commands (`survey`, `guide`, `compile`) import topo entry modules, so opening a surface here can trigger sockets or transports during introspection. Move surface-opening to a separate entry/bin and keep the topo-export module side-effect-free.',
+            rule: 'no-top-level-surface',
+            severity: 'warn',
+          },
+        ],
+      },
+      input: {
+        filePath: 'src/app.ts',
+        sourceCode: `import { topo } from "@ontrails/core";
+import { surface } from "@ontrails/mcp";
+import * as trails from "./trails";
+
+export const graph = topo("app", trails);
+await surface(graph);`,
+      },
+      name: 'Warns when a topo export module opens a surface',
+    },
+  ],
+  rule: noTopLevelSurface,
+});

package/src/trails/on-references-exist.trail.ts

@@ -0,0 +1,21 @@
+import { onReferencesExist } from '../rules/on-references-exist.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const onReferencesExistTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'consumer.ts',
+        knownSignalIds: ['entity.created'],
+        knownTrailIds: ['notify'],
+        sourceCode: `trail("notify", {
+  on: ["entity.created"],
+  blaze: async (input, ctx) => Result.ok({}),
+})`,
+      },
+      name: 'Resolved on: reference',
+    },
+  ],
+  rule: onReferencesExist,
+});

package/src/trails/orphaned-signal.trail.ts

@@ -0,0 +1,36 @@
+import { orphanedSignal } from '../rules/orphaned-signal.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const orphanedSignalTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        // Composite keys: `${storeBinding}:${tableName}` so two stores with
+        // the same table name don't collide.
+        crudTableIds: ['definition:notes'],
+        filePath: 'clean.ts',
+        knownTrailIds: ['notes.notify'],
+        onTargetSignalIds: [
+          'definition:notes.created',
+          'definition:notes.updated',
+          'definition:notes.removed',
+        ],
+        sourceCode: `import { store } from '@ontrails/store';
+import { z } from 'zod';
+
+const definition = store({
+  notes: {
+    identity: 'id',
+    schema: z.object({
+      id: z.string(),
+      title: z.string(),
+    }),
+  },
+});`,
+      },
+      name: 'Derived store signals stay quiet when trail on consumers exist',
+    },
+  ],
+  rule: orphanedSignal,
+});

package/src/trails/owner-projection-parity.trail.ts

@@ -0,0 +1,26 @@
+import { fileURLToPath } from 'node:url';
+
+import { ownerProjectionParity } from '../rules/owner-projection-parity.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const ownerProjectionParityTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: fileURLToPath(
+          new URL('../../../http/src/method.ts', import.meta.url)
+        ),
+        sourceCode: `import type { Intent } from '@ontrails/core';
+
+export const httpMethodByIntent = {
+  destroy: 'DELETE',
+  read: 'GET',
+  write: 'POST',
+} as const satisfies Record<Intent, 'GET' | 'POST' | 'DELETE'>;`,
+      },
+      name: 'HTTP method projection covers core intent values',
+    },
+  ],
+  rule: ownerProjectionParity,
+});

package/src/trails/pending-force.trail.ts

@@ -0,0 +1,21 @@
+import { topo } from '@ontrails/core';
+import { deriveTopoGraph } from '@ontrails/topographer';
+
+import { pendingForce } from '../rules/trail-versioning-topo.js';
+import { wrapTopoRule } from './wrap-rule.js';
+
+const emptyTopo = topo('pending-force-clean', {});
+
+export const pendingForceTrail = wrapTopoRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        graph: deriveTopoGraph(emptyTopo),
+        topo: emptyTopo,
+      },
+      name: 'No pending force audit events passes',
+    },
+  ],
+  rule: pendingForce,
+});

package/src/trails/permit-governance.trail.ts

@@ -0,0 +1,51 @@
+import { Result, topo, trail } from '@ontrails/core';
+import { z } from 'zod';
+
+import { permitGovernance } from '../rules/permit-governance.js';
+import { wrapTopoRule } from './wrap-rule.js';
+
+const destroyWithoutPermit = trail('entity.delete', {
+  blaze: () => Result.ok({ ok: true }),
+  input: z.object({}),
+  intent: 'destroy',
+  output: z.object({ ok: z.boolean() }),
+});
+
+const scopedDestroy = trail('entity.delete', {
+  blaze: () => Result.ok({ ok: true }),
+  input: z.object({}),
+  intent: 'destroy',
+  output: z.object({ ok: z.boolean() }),
+  permit: { scopes: ['entity:delete'] },
+});
+
+export const permitGovernanceTrail = wrapTopoRule({
+  examples: [
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: '<topo>',
+            line: 1,
+            message:
+              'Trail "entity.delete" has intent \'destroy\' but no permit declaration',
+            rule: 'permit.destroyWithoutPermit',
+            severity: 'error',
+          },
+        ],
+      },
+      input: {
+        topo: topo('trl-377-missing-permit', { destroyWithoutPermit }),
+      },
+      name: 'Destroy trails without permits emit an error',
+    },
+    {
+      expected: { diagnostics: [] },
+      input: {
+        topo: topo('trl-377-scoped-destroy', { scopedDestroy }),
+      },
+      name: 'Scoped destroy permits keep permit governance clean',
+    },
+  ],
+  rule: permitGovernance,
+});

package/src/trails/prefer-schema-inference.trail.ts

@@ -0,0 +1,21 @@
+import { preferSchemaInference } from '../rules/prefer-schema-inference.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const preferSchemaInferenceTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'clean.ts',
+        sourceCode: `trail("entity.show", {
+  input: z.object({ name: z.string() }),
+  blaze: async (input, ctx) => {
+    return Result.ok({ name: input.name });
+  }
+})`,
+      },
+      name: 'Trail without redundant field overrides',
+    },
+  ],
+  rule: preferSchemaInference,
+});

package/src/trails/public-export-example-coverage.trail.ts

@@ -0,0 +1,16 @@
+import { publicExportExampleCoverage } from '../rules/public-export-example-coverage.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const publicExportExampleCoverageTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'packages/other-pkg/src/index.ts',
+        sourceCode: `export { somethingElse } from './other.js';\n`,
+      },
+      name: 'Ignores barrels outside the public API example policy',
+    },
+  ],
+  rule: publicExportExampleCoverage,
+});

package/src/trails/public-internal-deep-imports.trail.ts

@@ -0,0 +1,94 @@
+import { publicInternalDeepImports } from '../rules/public-internal-deep-imports.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const publicInternalDeepImportsTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'packages/store/src/trails/example.ts',
+        importResolutionsByFile: {
+          'packages/store/src/trails/example.ts': [
+            {
+              crossesPackageBoundary: true,
+              importSource: '@ontrails/core/trails',
+              importerPath: 'packages/store/src/trails/example.ts',
+              isInternalTarget: false,
+              line: 1,
+              packageName: '@ontrails/core',
+              packageRoot: 'packages/core',
+              resolvedPath: 'packages/core/src/trails/index.ts',
+              usesPublicExport: true,
+            },
+          ],
+        },
+        knownTrailIds: [],
+        publicWorkspaces: {
+          '@ontrails/core': {
+            hasExports: true,
+            name: '@ontrails/core',
+            packageJsonPath: 'packages/core/package.json',
+            rootDir: 'packages/core',
+          },
+          '@ontrails/store': {
+            hasExports: true,
+            name: '@ontrails/store',
+            packageJsonPath: 'packages/store/package.json',
+            rootDir: 'packages/store',
+          },
+        },
+        sourceCode: `import { deriveTrail } from '@ontrails/core/trails';\n`,
+      },
+      name: 'Allows exported package subpaths',
+    },
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: 'packages/store/src/trails/example.ts',
+            line: 1,
+            message:
+              '@ontrails specifier "@ontrails/core/src/internal/hidden" is not exported by @ontrails/core. Use the package root or an exported subpath; if the API is missing, add an owner export follow-up instead of importing internals.',
+            rule: 'public-internal-deep-imports',
+            severity: 'error',
+          },
+        ],
+      },
+      input: {
+        filePath: 'packages/store/src/trails/example.ts',
+        importResolutionsByFile: {
+          'packages/store/src/trails/example.ts': [
+            {
+              crossesPackageBoundary: true,
+              errorKind: 'package-path-not-exported',
+              importSource: '@ontrails/core/src/internal/hidden',
+              importerPath: 'packages/store/src/trails/example.ts',
+              isInternalTarget: false,
+              line: 1,
+              packageName: '@ontrails/core',
+              usesPublicExport: false,
+            },
+          ],
+        },
+        knownTrailIds: [],
+        publicWorkspaces: {
+          '@ontrails/core': {
+            hasExports: true,
+            name: '@ontrails/core',
+            packageJsonPath: 'packages/core/package.json',
+            rootDir: 'packages/core',
+          },
+          '@ontrails/store': {
+            hasExports: true,
+            name: '@ontrails/store',
+            packageJsonPath: 'packages/store/package.json',
+            rootDir: 'packages/store',
+          },
+        },
+        sourceCode: `import { hidden } from '@ontrails/core/src/internal/hidden';\n`,
+      },
+      name: 'Flags compose-package imports into owner internals',
+    },
+  ],
+  rule: publicInternalDeepImports,
+});

package/src/trails/public-output-schema.trail.ts

@@ -0,0 +1,55 @@
+import { Result, topo, trail } from '@ontrails/core';
+import { z } from 'zod';
+
+import { publicOutputSchema } from '../rules/public-output-schema.js';
+import { wrapTopoRule } from './wrap-rule.js';
+
+const cleanTrail = trail('report.read', {
+  blaze: () => Result.ok({ ok: true }),
+  input: z.object({}),
+  output: z.object({ ok: z.boolean() }),
+});
+
+const cleanTopo = topo('public-output-schema-clean', {
+  cleanTrail,
+});
+
+const missingOutputTrail = trail('report.missing', {
+  blaze: () => Result.ok({ ok: true }),
+  input: z.object({}),
+});
+
+const missingOutputTopo = topo('public-output-schema-missing', {
+  missingOutputTrail,
+});
+
+export const publicOutputSchemaTrail = wrapTopoRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        topo: cleanTopo,
+      },
+      name: 'Public surface trails declare output schemas',
+    },
+    {
+      expected: {
+        diagnostics: [
+          {
+            filePath: '<topo>',
+            line: 1,
+            message:
+              'Trail "report.missing" is visible to public MCP/HTTP surface projection but does not declare an output schema. Add an explicit output schema, or mark the trail visibility as internal if it is composition-only.',
+            rule: 'public-output-schema',
+            severity: 'error',
+          },
+        ],
+      },
+      input: {
+        topo: missingOutputTopo,
+      },
+      name: 'Public surface trails without output schemas are flagged',
+    },
+  ],
+  rule: publicOutputSchema,
+});

package/src/trails/public-union-output-discriminants.trail.ts

@@ -0,0 +1,33 @@
+import { Result, topo, trail } from '@ontrails/core';
+import { z } from 'zod';
+
+import { publicUnionOutputDiscriminants } from '../rules/public-union-output-discriminants.js';
+import { wrapTopoRule } from './wrap-rule.js';
+
+const cleanOutput = z.discriminatedUnion('kind', [
+  z.object({ kind: z.literal('message'), message: z.string() }),
+  z.object({ count: z.number(), kind: z.literal('count') }),
+]);
+
+const cleanTrail = trail('report.read', {
+  blaze: () => Result.ok({ kind: 'message' as const, message: 'ok' }),
+  input: z.object({}),
+  output: cleanOutput,
+});
+
+const cleanTopo = topo('public-union-output-discriminants-clean', {
+  cleanTrail,
+});
+
+export const publicUnionOutputDiscriminantsTrail = wrapTopoRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        topo: cleanTopo,
+      },
+      name: 'Public output object unions expose a literal discriminator',
+    },
+  ],
+  rule: publicUnionOutputDiscriminants,
+});

package/src/trails/read-intent-fires.trail.ts

@@ -0,0 +1,20 @@
+import { readIntentFires } from '../rules/read-intent-fires.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const readIntentFiresTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'clean.ts',
+        sourceCode: `const entityLoaded = signal('entity.loaded', { payload: z.object({}) });
+trail('entity.read', {
+  intent: 'read',
+  blaze: async () => Result.ok({}),
+});`,
+      },
+      name: 'Read trails without fires stay quiet',
+    },
+  ],
+  rule: readIntentFires,
+});

package/src/trails/reference-exists.trail.ts

@@ -0,0 +1,25 @@
+import { referenceExists } from '../rules/reference-exists.js';
+import { wrapRule } from './wrap-rule.js';
+
+export const referenceExistsTrail = wrapRule({
+  examples: [
+    {
+      expected: { diagnostics: [] },
+      input: {
+        filePath: 'contours.ts',
+        knownContourIds: ['gist', 'user'],
+        knownTrailIds: [],
+        sourceCode: `const user = contour("user", {
+  id: z.string().uuid(),
+}, { identity: "id" });
+
+const gist = contour("gist", {
+  id: z.string().uuid(),
+  ownerId: user.id(),
+}, { identity: "id" });`,
+      },
+      name: 'Contour references resolve to known project contours',
+    },
+  ],
+  rule: referenceExists,
+});