@dogsbay/corpus 0.2.0-beta.133 → 0.2.0-beta.135

package/dist/index.d.ts

@@ -40,9 +40,36 @@ export declare function corpusFromMap(files: CorpusFiles, opts?: MapCorpusOption
 export interface Unfetched {
     read: string[];
     copy: string[];
+    /**
+     * `copy` with where each file goes in `files` (its output path), in the same order: the host
+     * adds the fetched bytes itself, without converting again.
+     */
+    copyTo: {
+        from: string;
+        to: string;
+    }[];
 }
+/** `copyTo`'s pairs sorted by source path, and `copy` (the sources) in the same order. */
+export declare function pendingCopies(pairs: {
+    from: string;
+    to: string;
+}[]): Pick<Unfetched, "copy" | "copyTo">;
 /**
  * The ledger message for a conversion that still needs files (undefined when none), with the
  * error the import stopped on, when it stopped.
  */
 export declare function unfetchedMessage(read: string[], stoppedOn?: unknown): string | undefined;
+/**
+ * Each written page's source file → its path in the project, from the pages in the order they
+ * were written: a later page at the same path replaces an earlier one, whose file then has no
+ * page (its notes would otherwise open another file's page).
+ */
+export declare function pageSources(written: Iterable<{
+    file: string;
+    path: string;
+}>): Map<string, string>;
+/** The ledger, each entry about a written page's source file given its `page`. */
+export declare function withPages<E extends {
+    file?: string;
+    page?: string;
+}>(ledger: E[], pageOf: ReadonlyMap<string, string>): E[];

package/dist/index.js

@@ -32,6 +32,11 @@ export function corpusFromMap(files, opts = {}) {
         missing: () => [...missing].sort(),
     };
 }
+/** `copyTo`'s pairs sorted by source path, and `copy` (the sources) in the same order. */
+export function pendingCopies(pairs) {
+    const copyTo = [...pairs].sort((a, b) => (a.from < b.from ? -1 : a.from > b.from ? 1 : 0));
+    return { copy: copyTo.map((p) => p.from), copyTo };
+}
 /**
  * The ledger message for a conversion that still needs files (undefined when none), with the
  * error the import stopped on, when it stopped.
@@ -43,3 +48,24 @@ export function unfetchedMessage(read, stoppedOn) {
     const stopped = stoppedOn instanceof Error ? ` It stopped on: ${stoppedOn.message}` : "";
     return `${read.length} file${read.length === 1 ? "" : "s"} the conversion reads ${read.length === 1 ? "was" : "were"} not given (${names}): fetch them and convert again.${stopped}`;
 }
+/**
+ * Each written page's source file → its path in the project, from the pages in the order they
+ * were written: a later page at the same path replaces an earlier one, whose file then has no
+ * page (its notes would otherwise open another file's page).
+ */
+export function pageSources(written) {
+    const fileAt = new Map();
+    for (const { file, path } of written)
+        fileAt.set(path, file);
+    const pageOf = new Map();
+    for (const [path, file] of fileAt)
+        pageOf.set(file, path);
+    return pageOf;
+}
+/** The ledger, each entry about a written page's source file given its `page`. */
+export function withPages(ledger, pageOf) {
+    return ledger.map((e) => {
+        const page = e.file === undefined ? undefined : pageOf.get(e.file);
+        return page === undefined ? e : { ...e, page };
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/corpus",
-  "version": "0.2.0-beta.133",
+  "version": "0.2.0-beta.135",
   "description": "A documentation repository as its importers read it, in the browser or in Node: plain paths plus text on demand, from a map of files or from a folder whose symlinks are kept inside it",
   "type": "module",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@dogsbay/detect": "0.2.0-beta.133"
+    "@dogsbay/detect": "0.2.0-beta.135"
   },
   "devDependencies": {
     "@types/node": "^22.20.1",