@hawkeyexl/manni 2.10.1 → 2.11.0

package/dist/docmeta.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 import {
   buildProgram
-} from "./chunk-5GVRMS6B.js";
+} from "./chunk-V5NTFMUD.js";
 import {
   runIfMain
-} from "./chunk-O2V45AVG.js";
+} from "./chunk-BUXVMARH.js";
 
 // src/docmeta.ts
 runIfMain(import.meta.url, () => buildProgram().name("docmeta"));

package/dist/index.d.ts

@@ -1491,6 +1491,14 @@ interface LoadExternalMetadataOptions {
     timeoutMs?: number;
     /** For tests: the environment `tokenEnv` is read from. */
     env?: Record<string, string | undefined>;
+    /**
+     * The run's documents, as absolute paths (proposal 0058). An entry whose
+     * `file` holds `{page}` names one manifest per page, so it is read for
+     * exactly these pages, each that belongs to its collection, and for nothing
+     * else. Absent, such an entry reads no file. An entry without the
+     * placeholder ignores this and loads its one manifest as it always has.
+     */
+    pages?: readonly string[];
 }
 /** A place a merged value lives, for a finding that must name it. */
 interface SourceLocation {
@@ -1594,6 +1602,14 @@ declare function externalMetadataPointer(key: string): string;
  * the run is the config corpus (the same invariant corpus checks use): a
  * positional path means the operator chose to look at part of the corpus,
  * and an entry for the rest is expected, not orphaned.
+ *
+ * A `{page}` entry (proposal 0058) is never orphaned inside a file the run
+ * read, because each file is named after its page. Its orphan is a stray
+ * *file*, left behind by a `git mv` or a deletion, so on a run with no
+ * `collections` narrowing the pattern's glob is walked and every manifest of
+ * a page the run did not load is reported after the entries above. A
+ * `--collection` run skips the walk: another collection's pages, which it
+ * did not load, could share the pattern.
  */
 declare function orphanEntries(index: ExternalMetadataIndex | null, loaded: readonly string[], base: string, collections?: readonly string[]): ExternalMetadataEntry[];
 /**
@@ -3453,7 +3469,18 @@ path: string,
  * of a payload that is not valid UTF-8 — so the pin would be wrong the first
  * time anything checked it.
  */
-contents: string | Uint8Array): Promise<void>;
+contents: string | Uint8Array, 
+/**
+ * `createParents` makes the target's directory, recursively, before the
+ * temp file that lives in it. A manifest writer asks for it: a mirrored
+ * per-page manifest (proposal 0058), `./meta/{page}.citations.yaml`, may be
+ * the first file in its directory. Every other writer leaves it off, so a
+ * missing directory stays the failure it always was (`--write-baseline`
+ * into a directory that is not there, say).
+ */
+options?: {
+    createParents?: boolean;
+}): Promise<void>;
 
 /**
  * Extractor registry. Maps file extensions to extractors and resolves an
@@ -4032,6 +4059,11 @@ interface UpdateOptions extends Omit<CheckOptions, "baseline" | "writeBaseline">
     accept?: boolean;
     only?: string[];
     dryRun?: boolean;
+    /**
+     * Re-record `commit-sha` where the recorded commit does not contain the
+     * pinned lines. Rewrites that one field and nothing else.
+     */
+    recommit?: boolean;
 }
 /**
  * One end `update` rewrote.
@@ -4052,7 +4084,7 @@ interface UpdateRewrite {
      * and the words held while the anchor moved (0053). `status` is what tells
      * those apart. `replaced` is a claim `--accept` refused to re-pin.
      */
-    reason: "moved" | "accepted" | "re-anchored" | "shifted" | "replaced";
+    reason: "moved" | "accepted" | "re-anchored" | "shifted" | "replaced" | "recommitted";
     /**
      * The status that was repaired. `replaced` is a claim whose line held
      * wholly other text, accepted because `--only` named it.
@@ -4071,6 +4103,9 @@ interface UpdateRewrite {
     /** An accepted or re-anchored end: its pin, before and after. */
     fromPin?: string;
     toPin?: string;
+    /** A re-committed source: the commit it recorded, and the one it records now. */
+    fromCommit?: string;
+    toCommit?: string;
     /** A re-anchored claim: the span that held, in file lines. */
     lines?: string;
     /** A re-anchored claim: the span now pinned, in file lines. */
@@ -4950,6 +4985,13 @@ interface CitationManifest {
     file: string;
     /** `path`, or the page field the manifest joins on. */
     join: string;
+    /**
+     * The `{page}` pattern as the config writes it (proposal 0058), present
+     * only when each page has a manifest of its own. The page's file is
+     * resolved from it, and one that does not exist yet reads as empty and is
+     * created by the first write.
+     */
+    pattern?: string;
 }
 /** Where one page's citations are kept, and what the manifest already holds. */
 interface PageSidecar {
@@ -4983,6 +5025,12 @@ interface CitationSidecars {
     orphans(loaded: readonly string[], covered?: readonly string[]): ExternalMetadataEntry[];
     /** Field entries no loaded page matched, same invariant. */
     orphanJoins(matched: ReadonlyMap<string, ReadonlySet<string>>, covered?: readonly string[]): ExternalMetadataEntry[];
+    /**
+     * The `{page}` manifests (proposal 0058) of the loaded pages that exist and
+     * that `.gitignore` covers, as the run reports them. A checkout would have
+     * none of them, so CI would read those pages as citing nothing.
+     */
+    ignoredManifests(loaded: readonly string[]): Promise<string[]>;
 }
 interface LoadSidecarOptions {
     /** Every collection the config declares, not only the ones the run selected. */
@@ -4993,6 +5041,11 @@ interface LoadSidecarOptions {
     base: string;
     /** The config file as the user would name it, for the URL refusal. */
     configSource: string;
+    /**
+     * The run's pages, as absolute paths. A `{page}` manifest (proposal 0058)
+     * is read for exactly these; without them it reads nothing.
+     */
+    pages?: readonly string[];
     /** The family encryption key, for a join field a page holds encrypted. */
     key?: string;
     /** The tool's error class; `CiteError` unless a sibling command says otherwise. */
@@ -5025,10 +5078,13 @@ declare function duplicateJoinRefusal(field: string, value: string, file: string
  * citations manifest. `base` overrides the run's when a command labels its
  * pages from somewhere else — `add` takes one page from the command line and
  * labels it from the working directory, whatever the collections would.
+ * `pages` are the run's pages as absolute paths, which a `{page}` manifest
+ * (proposal 0058) is read for.
  */
 declare function sidecarsFor(run: CiteRun, over?: {
     base?: string;
     toError?: (message: string) => Error;
+    pages?: readonly string[];
 }): Promise<CitationSidecars | null>;
 
 interface SpliceManifestOptions {
@@ -5103,6 +5159,14 @@ interface HeldManifest$1<Op extends ManifestOp$1> {
     ops: Op[];
     /** Each entry key this run rewrote, and what it held first. */
     bases: Map<string, KeyBase>;
+    /**
+     * The file did not exist when it was held, so `before` is empty text
+     * standing in for no file (proposal 0058). A distinct state from a file
+     * that exists and is empty: a commit that still finds nothing creates the
+     * file, and one that finds any bytes, empty ones included, rebases onto
+     * them, since another writer created it in between.
+     */
+    absent: boolean;
 }
 /** What a caller may substitute when it writes the manifests it held. */
 interface CommitIo$1<Change> {

package/dist/index.js

@@ -5,7 +5,7 @@ import {
   reencryptMetadata,
   runKeyRotate,
   runKeySet
-} from "./chunk-HA4CK35M.js";
+} from "./chunk-VYFRHPCL.js";
 import {
   BinMissing,
   COMMON_FORMATS,
@@ -127,7 +127,7 @@ import {
   valueOf,
   vendorFileName,
   writeFileAtomic
-} from "./chunk-O2V45AVG.js";
+} from "./chunk-BUXVMARH.js";
 
 // src/key/index.ts
 var key_exports = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawkeyexl/manni",
-  "version": "2.10.1",
+  "version": "2.11.0",
   "description": "One command line for documentation that is meant to be checked. `manni meta` validates the presence and format of document metadata (Markdown frontmatter and more) against JSON Schema, built for CI. Formerly docmeta.",
   "type": "module",
   "bin": {