@de-otio/bibcheck 0.1.0

package/dist/canonical.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canonical.js","sourceRoot":"","sources":["../src/canonical.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,IAAI,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAQ1D,8EAA8E;AAC9E,6DAA6D;AAC7D,8EAA8E;AAE9E,MAAM,uBAAuB,GAA6B;IACxD,kBAAkB,EAAE,CAAC,mCAAmC,EAAE,aAAa,CAAC;IACxE,SAAS,EAAW,CAAC,qBAAqB,CAAC;IAC3C,WAAW,EAAS,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IAC7D,YAAY,EAAQ,CAAC,qBAAqB,CAAC;CAC5C,CAAC;AAIF;;;GAGG;AACH,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACtE,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,IAAI,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACzE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,gDAAgD,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9F,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,IAAY,EAAE,YAAsB;IAChE,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7B,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;QACnC,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,GAAG,EAAE,CAAC;YAAE,OAAO,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAoBD,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAsB;IACvD,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,IAAI,gBAAgB,CAAC;IAEvD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,MAAM,CAAC,MAAe,CAAC;IAC/B,CAAC;IAED,MAAM,OAAO,GAAgD,EAAE,CAAC;IAEhE,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,MAAM,CAAC,MAAe,CAAC;QAC/B,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACtF,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,8EAA8E;AAC9E,uBAAuB;AACvB,8EAA8E;AAE9E,KAAK,UAAU,YAAY,CACzB,KAAe,EACf,MAAc,EACd,IAAgB,EAChB,KAAwB,EACxB,MAAmB,EACnB,WAAoC;IAEpC,8BAA8B;IAC9B,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACxD,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9D,CAAC;IAED,sBAAsB;IACtB,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IAC1D,CAAC;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IAEtB,mEAAmE;IACnE,IAAI,WAA4B,CAAC;IACjC,IAAI,CAAC;QACH,WAAW,GAAG,MAAM,WAAW,CAC7B,GAAG,EACH;YACE,IAAI;YACJ,KAAK;YACL,YAAY,EAAE,MAAM,CAAC,aAAa,CAAC,KAAK;SACzC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,uDAAuD;QACvD,IAAI,MAAM,CAAC,OAAO;YAAE,MAAM,GAAG,CAAC;QAC9B,wCAAwC;QACxC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;IACxD,CAAC;IAED,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;QACpB,QAAQ,WAAW,CAAC,MAAM,EAAE,CAAC;YAC3B,KAAK,YAAY;gBACf,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;YAC1D,KAAK,UAAU,CAAC;YAChB,KAAK,oBAAoB,CAAC;YAC1B,KAAK,SAAS,CAAC;YACf,KAAK,eAAe;gBAClB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,0BAA0B;IAC1B,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;IAEtD,qCAAqC;IACrC,IAAI,IAAI,KAAK,oBAAoB,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YACrC,OAAO,EAAE,MAAM,EAAE,gCAAgC,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;QACpF,CAAC;IACH,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,YAAY,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;YACtD,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC5E,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YAChE,CAAC;QACH,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;AACxE,CAAC"}

package/dist/check.d.ts

@@ -0,0 +1,140 @@
+/**
+ * `bibcheck check` orchestrator.
+ *
+ * Composes all five subcommands (existence, canonical, linkage, phrases,
+ * worklist) and assembles the top-level Output.
+ *
+ * Design notes:
+ * - Subcommands run sequentially for deterministic log output.
+ * - Each subcommand runs with its own 5-minute deadline.
+ * - If a subcommand throws, the error is caught, logged, and a degraded
+ *   (error-flavored) result is emitted for that layer; the run continues.
+ * - The final Output is validated against OutputSchema before return.
+ */
+import { type ParsedAllow, type FindingType } from './suppression.js';
+import type { Config } from './config.js';
+import type { CslEntry } from './schema/csl.js';
+import type { CompiledPattern } from './phrases/load.js';
+import type { HttpClient } from './http.js';
+import type { Cache } from './cache/fs-cache.js';
+import type { Output } from './schema/output.js';
+import type { RunExistenceDeps, RunExistenceResult } from './existence.js';
+import type { RunCanonicalDeps, RunCanonicalResult } from './canonical.js';
+import type { RunLinkageDeps, RunLinkageResult } from './linkage.js';
+import type { RunPhrasesDeps, RunPhrasesResult } from './phrases.js';
+import type { RunWorklistDeps, RunWorklistResult } from './worklist.js';
+export interface Logger {
+    info(event: string, ctx?: Record<string, unknown>): void;
+    warn(event: string, ctx?: Record<string, unknown>): void;
+    error(event: string, ctx?: Record<string, unknown>): void;
+}
+export interface RunCheckDeps {
+    config: Config;
+    cwd: string;
+    bibliography: CslEntry[];
+    patterns: CompiledPattern[];
+    http: HttpClient;
+    cache: Cache;
+    logger: Logger;
+    signal: AbortSignal;
+    skip?: ReadonlySet<'existence' | 'canonical' | 'linkage' | 'phrases' | 'worklist'>;
+    readFile?: (path: string) => Promise<string>;
+    _runExistence?: (deps: RunExistenceDeps) => Promise<RunExistenceResult>;
+    _runCanonical?: (deps: RunCanonicalDeps) => Promise<RunCanonicalResult>;
+    _runLinkage?: (deps: RunLinkageDeps) => Promise<RunLinkageResult>;
+    _runPhrases?: (deps: RunPhrasesDeps) => Promise<RunPhrasesResult>;
+    _runWorklist?: (deps: RunWorklistDeps) => Promise<RunWorklistResult>;
+}
+export interface BuildCheckDepsOptions {
+    config: Config;
+    cwd: string;
+    signal: AbortSignal;
+    logger?: Logger;
+    userAgent?: string;
+}
+export declare function buildCheckDeps(opts: BuildCheckDepsOptions): Promise<RunCheckDeps>;
+/**
+ * Orchestrates all five subcommands and assembles the validated Output.
+ *
+ * Subcommands run sequentially. Each has a 5-minute deadline via
+ * `AbortSignal.any([deps.signal, AbortSignal.timeout(300_000)])`.
+ *
+ * If a subcommand throws (including timeout), the error is caught, logged,
+ * and a degraded result is emitted for that layer. The run continues with
+ * remaining subcommands.
+ */
+export declare function runCheck(deps: RunCheckDeps): Promise<Output>;
+export declare const CHECK_NON_ZERO_REASON: {
+    readonly flagged_phrase: "flagged_phrase";
+    readonly unresolved_linkage: "unresolved_linkage";
+    readonly canonical_issue: "canonical_issue";
+    readonly metadata_mismatch: "metadata_mismatch";
+    readonly not_found_in_databases: "not_found_in_databases";
+    readonly malformed_identifier: "malformed_identifier";
+};
+/**
+ * T23 suppression context, passed through from `runCheck` to
+ * `checkExitReasons`. Carries the per-entry CSL `type` (not present on the
+ * frozen Output schema, but needed to resolve source-type exemptions) plus the
+ * parsed per-entry `bibcheck-allow` directives and the config. Pure data.
+ */
+export interface SuppressionContext {
+    config: Config;
+    /** citekey → CSL `type` (undefined when the entry has no type). */
+    cslTypeByCitekey: ReadonlyMap<string, string | undefined>;
+    allows: readonly ParsedAllow[];
+}
+/** A finding that gated by default would have, but was suppressed (T23). */
+export interface AcknowledgedFinding {
+    citekey: string;
+    findingType: FindingType;
+    /** Why it was suppressed: a source-type rule or a per-entry allow. */
+    reason: 'source-type' | 'allow';
+}
+/**
+ * Returns the list of finding kinds that should cause a non-zero exit.
+ * Empty array → exit 0.
+ *
+ * Rules:
+ *   - 'flagged_phrase' if any phraseFlags[].status === 'flagged'
+ *   - 'unresolved_linkage' if any linkage[].status === 'unresolved'
+ *   - 'canonical_issue' if any entry's canonical.status is in the problem set
+ *   - 'metadata_mismatch' if any entry's existence.status === 'metadata-mismatch'
+ *   - 'not_found_in_databases' if any (non-suppressed) entry's existence.status
+ *     === 'not-found-in-databases' (B1 fix — absence is a fabrication signal
+ *     and gates by default per Q1)
+ *   - 'malformed_identifier' if any (non-suppressed) entry has a malformed
+ *     DOI/ISBN/URL (a cheap fabrication signal; gates by default)
+ *
+ * Does NOT trigger non-zero exit:
+ *   - acknowledged phrases
+ *   - worklist items
+ *   - unverifiable existence (graceful degradation)
+ *
+ * T23: the optional `ctx` filters WHICH entries reach the gate. A not-found or
+ * malformed finding does NOT gate when `isGated` resolves it to a source-type
+ * exemption or a valid per-entry allow — the gate itself is unchanged, only the
+ * per-entry predicate is narrowed. Suppressed findings remain in the Output
+ * document (entries + summary counts) and are NOT removed; they are surfaced as
+ * informational acknowledgements (see `collectAcknowledgedFindings`). When
+ * `ctx` is omitted, every not-found / malformed finding gates unconditionally
+ * (the pre-T23 secure default).
+ */
+export declare function checkExitReasons(output: Output, ctx?: SuppressionContext): string[];
+/**
+ * Collect the not-found / malformed findings that WOULD have gated but were
+ * suppressed by a source-type exemption or a per-entry allow. These stay in the
+ * Output document (totals are unchanged); this list drives the informational
+ * `check.acknowledged_finding` log entries, mirroring how an acknowledged
+ * phrase is reported rather than dropped. Pure.
+ */
+export declare function collectAcknowledgedFindings(output: Output, ctx: SuppressionContext): AcknowledgedFinding[];
+/**
+ * Build the T23 suppression context from the config and the loaded
+ * bibliography: the citekey → CSL-type map (the frozen Output schema does not
+ * carry `type`, but it is needed to resolve source-type exemptions) and the
+ * parsed per-entry `bibcheck-allow` directives. Pure. The CLI calls this and
+ * passes the result to `checkExitReasons`.
+ */
+export declare function buildSuppressionContext(config: Config, bibliography: CslEntry[]): SuppressionContext;
+//# sourceMappingURL=check.d.ts.map

package/dist/check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../src/check.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAMH,OAAO,EAGL,KAAK,WAAW,EAChB,KAAK,WAAW,EACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EACV,MAAM,EAKP,MAAM,oBAAoB,CAAC;AAe5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAI3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAG3E,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGrE,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGrE,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAMxE,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACzD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACzD,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3D;AAYD,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;IAEpB,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC,CAAC;IAEnF,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7C,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACxE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACxE,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAClE,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAClE,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtE;AAMD,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,wBAAsB,cAAc,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC,CAkEvF;AAmDD;;;;;;;;;GASG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CA+WlE;AAMD,eAAO,MAAM,qBAAqB;;;;;;;CAUxB,CAAC;AAaX;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,gBAAgB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1D,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;CAChC;AAED,4EAA4E;AAC5E,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;IACzB,sEAAsE;IACtE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC;CACjC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,kBAAkB,GAAG,MAAM,EAAE,CAyDnF;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,kBAAkB,GACtB,mBAAmB,EAAE,CA8BvB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,QAAQ,EAAE,GACvB,kBAAkB,CASpB"}