@syv-ai/rulecast 0.1.1 → 0.2.0

package/dist/index.js

@@ -1,33 +1,20 @@
 import {
   ADAPTERS,
-  CONFIG_FILE,
-  LlmUnavailableError,
-  MANIFEST_FILE,
-  MODEL_ALIASES,
-  VERSION,
   adapterByName,
   builtinDetectors,
-  cacheHome,
-  cachedRepos,
-  checkDetectors,
-  checkableKinds,
   claudeCodeAdapter,
-  compile,
-  compileManifest,
-  createRegistry,
+  createRegistry
+} from "./chunk-C6C5EER7.js";
+import {
+  LlmUnavailableError,
+  VERSION,
   defaultDetectorSettings,
   emptyDelivery,
-  fetchingRepos,
-  fixedRepo,
+  isDetectorRule,
   memoryCache,
   perRule,
-  projectStateDir,
-  providerByName,
-  readSourceFile,
-  renderAgentText,
-  resolveModel,
-  runPipeline
-} from "./chunk-3HRTZULM.js";
+  readSourceFile
+} from "./chunk-ZEFEQKG5.js";
 
 // src/testing/adapter-contract.ts
 import assert from "assert/strict";
@@ -176,7 +163,9 @@ function run(detector, rules, cwd, signal) {
     cache: memoryCache(),
     settings: defaultDetectorSettings(),
     cwd,
-    signal
+    signal,
+    // The contract suite is not measuring the clock; a deadline far ahead keeps it out of the way.
+    deadlineAt: Date.now() + 6e4
   });
 }
 function assertResultShape(result, ids) {
@@ -298,30 +287,15 @@ function detectorContract(detector, fixture) {
 }
 export {
   ADAPTERS,
-  CONFIG_FILE,
   LlmUnavailableError,
-  MANIFEST_FILE,
-  MODEL_ALIASES,
   VERSION,
   adapterByName,
   adapterContract,
   builtinDetectors,
-  cacheHome,
-  cachedRepos,
-  checkDetectors,
-  checkableKinds,
   claudeCodeAdapter,
-  compile,
-  compileManifest,
   createRegistry,
   detectorContract,
   emptyDelivery,
-  fetchingRepos,
-  fixedRepo,
-  perRule,
-  projectStateDir,
-  providerByName,
-  renderAgentText,
-  resolveModel,
-  runPipeline
+  isDetectorRule,
+  perRule
 };

package/dist/internal.d.ts

@@ -0,0 +1,136 @@
+import { n as DetectorRegistry, K as Config, j as CompiledRule, e as Delivery, h as CheckResult, q as DetectorSettings, E as Event, v as LlmProviderName, u as LlmProvider } from './types-2oz2AlwA.js';
+export { N as RuleEntry, P as Stage } from './types-2oz2AlwA.js';
+import 'zod';
+
+type Checkout = {
+    ok: true;
+    dir: string;
+    label: string;
+} | {
+    ok: false;
+    message: string;
+    missing: boolean;
+};
+/** Where compile finds a pinned rule repo's files. */
+interface RepoProvider {
+    checkout(url: string, rev: string): Promise<Checkout>;
+}
+/** For hooks, which never fetch (spec §4): a repo missing from the cache is reported, not fetched. */
+declare function cachedRepos(home: string): RepoProvider;
+/** For the CLI: fetches repos missing from the cache. */
+declare function fetchingRepos(home: string): RepoProvider;
+/** For try-repo: every repo is `dir`. */
+declare function fixedRepo(dir: string, label: string): RepoProvider;
+
+interface Diagnostic {
+    /** ".rulecast-config.yaml", ".rulecast-rules.yaml", or "<repo url>@<rev>" for a rule repo. */
+    source: string;
+    rule: string | null;
+    message: string;
+    level: "error" | "warning";
+    /** What a hook tells the developer to run; default "rulecast validate". Missing repos: "rulecast install". */
+    hint?: string;
+}
+interface CompiledProject {
+    root: string;
+    config: Config;
+    rules: CompiledRule[];
+    diagnostics: Diagnostic[];
+}
+interface CompileOptions {
+    root: string;
+    registry: DetectorRegistry;
+    repos: RepoProvider;
+    /** Config data to compile instead of the project's .rulecast-config.yaml (try-repo). */
+    configData?: unknown;
+}
+/** The project config and the manifests of its pinned repos → ready rules plus diagnostics (spec §5). */
+declare function compile(options: CompileOptions): Promise<CompiledProject>;
+/** A manifest on its own (validate, the init catalog): references resolve against `dir`. */
+declare function compileManifest(dir: string, registry: DetectorRegistry): Promise<{
+    rules: CompiledRule[];
+    diagnostics: Diagnostic[];
+}>;
+
+declare const CONFIG_FILE = ".rulecast-config.yaml";
+declare const MANIFEST_FILE = ".rulecast-rules.yaml";
+
+interface RenderOptions {
+    maxMatchesPerRule: number;
+}
+declare function renderAgentText(delivery: Delivery, options: RenderOptions): string;
+
+interface CheckOptions {
+    project: CompiledProject;
+    registry: DetectorRegistry;
+    /** Project settings, as a detector run would get them. */
+    settings: DetectorSettings;
+    env: Readonly<Record<string, string | undefined>>;
+    timeoutMs: number;
+}
+/** A check's answer, and which detector gave it. */
+type KindCheckResult = CheckResult & {
+    kind: string;
+};
+/** Detector kinds used by the project's rules whose detector has environment checks. */
+declare function checkableKinds(project: CompiledProject, registry: DetectorRegistry): string[];
+/**
+ * Every used detector's own checks (spec §5). Kinds run in parallel; results come back grouped by
+ * kind in checkableKinds order, so doctor's output is stable between runs.
+ */
+declare function checkDetectors(options: CheckOptions): Promise<KindCheckResult[]>;
+
+type Env = Readonly<Record<string, string | undefined>>;
+/** $RULECAST_HOME, else $XDG_CACHE_HOME/rulecast, else ~/.cache/rulecast. Empty values count as unset. */
+declare function cacheHome(env: Env): string;
+/**
+ * <home>/projects/<first 16 hex of sha256(realpath(root))>. Keyed by the real path, so separate checkouts and
+ * worktrees of one repository get separate directories and a symlinked path shares its target's.
+ */
+declare function projectStateDir(home: string, root: string): string;
+
+interface PipelineOptions {
+    /** Compiled by the caller: hooks never fetch rule repos, the CLI does (spec §4). */
+    project: CompiledProject;
+    /** The project's directory in the cache (spec §12): sessions and detector caches. */
+    stateDir: string;
+    event: Event;
+    registry: DetectorRegistry;
+    /** From the adapter; null = unlimited. */
+    maxContextChars: number | null;
+    /** Recently accessed files the agent re-attaches after compaction (adapter.restoredFiles); reset re-delivers their touch context. */
+    restoredFiles?: number;
+    /** Detector kinds to skip entirely (run --no-llm). */
+    skipDetectorKinds?: ReadonlySet<string>;
+    /** Run only these rules (rulecast run RULE_ID); touch rules are unaffected. */
+    onlyRules?: ReadonlySet<string>;
+    /** verify from an agent's stop: decide block / allow / capReached. Needs a session. */
+    stopGate?: boolean;
+    /** Debug log sink. */
+    log?: (line: string) => void;
+}
+interface PipelineResult {
+    delivery: Delivery;
+    /** rulecast itself failed: compile diagnostics, detector errors or verify timeouts. */
+    failed: boolean;
+    /** Detector kinds whose results were dropped at the edit deadline (§13). */
+    deadlineMissed: string[];
+}
+declare function runPipeline(options: PipelineOptions): Promise<PipelineResult>;
+
+declare const MODEL_ALIASES: readonly string[];
+/**
+ * The provider's own name for a model. A name that is not an alias is passed through unchanged, so
+ * a new model or a local Ollama tag needs no rulecast release. null: a known alias this provider
+ * cannot express, which the detector turns into a per-rule error naming both.
+ */
+declare function resolveModel(model: string, provider: LlmProviderName): string | null;
+
+/**
+ * The provider for a configured name. Throws LlmUnavailableError, which spec §14 turns into one
+ * warning disabling every llm rule — the guard survives because a config can name a provider a
+ * future build has dropped.
+ */
+declare function providerByName(name: LlmProviderName): LlmProvider;
+
+export { CONFIG_FILE, type Checkout, type CompileOptions, type CompiledProject, Config, type Diagnostic, type Env, type KindCheckResult, MANIFEST_FILE, MODEL_ALIASES, type PipelineOptions, type PipelineResult, type RepoProvider, cacheHome, cachedRepos, checkDetectors, checkableKinds, compile, compileManifest, fetchingRepos, fixedRepo, projectStateDir, providerByName, renderAgentText, resolveModel, runPipeline };

package/dist/internal.js

@@ -0,0 +1,38 @@
+import {
+  CONFIG_FILE,
+  MANIFEST_FILE,
+  cacheHome,
+  cachedRepos,
+  checkDetectors,
+  checkableKinds,
+  compile,
+  compileManifest,
+  fetchingRepos,
+  fixedRepo,
+  projectStateDir,
+  runPipeline
+} from "./chunk-RODZRI7B.js";
+import {
+  MODEL_ALIASES,
+  providerByName,
+  renderAgentText,
+  resolveModel
+} from "./chunk-ZEFEQKG5.js";
+export {
+  CONFIG_FILE,
+  MANIFEST_FILE,
+  MODEL_ALIASES,
+  cacheHome,
+  cachedRepos,
+  checkDetectors,
+  checkableKinds,
+  compile,
+  compileManifest,
+  fetchingRepos,
+  fixedRepo,
+  projectStateDir,
+  providerByName,
+  renderAgentText,
+  resolveModel,
+  runPipeline
+};