anchordb 0.2.0

package/dist/esm/interop/export-import.d.ts

@@ -0,0 +1,98 @@
+import type { AnchorDB } from "../core/anchor-db.js";
+import type { Model } from "../model/model.js";
+import { parseEJSON, stringifyEJSON, toEJSON, fromEJSON, type EJsonMode } from "./ejson.js";
+import type { Filter } from "../query/filter.js";
+/**
+ * Two-way interchange with a real MongoDB (§47).
+ *
+ * The target is not "some JSON" but specifically what `mongoimport` consumes and `mongoexport`
+ * produces, so moving data between a device and a real database needs no conversion step in either
+ * direction.
+ *
+ * `mongoexport` writes **NDJSON** by default (one document per line, no wrapping array), which is
+ * also what `mongoimport` reads by default. `array` format is offered for readability and matches
+ * `mongoimport --jsonArray`.
+ */
+export type ExportFormat = "ndjson" | "array" | "csv";
+export interface ExportOptions {
+    format?: ExportFormat;
+    mode?: EJsonMode;
+    pretty?: boolean;
+    /**
+     * Export only the documents matching this filter — Compass calls this "Export query results".
+     *
+     * Runs as a real query rather than a second filter implementation, so the filter is cast through
+     * the schema (a hex `_id` becomes an ObjectId) and the planner can use an index. Cannot be
+     * combined with `includeDeleted` or `includeSyncMetadata`, which describe storage state that a
+     * query does not see.
+     */
+    filter?: Filter;
+    /** Include tombstoned documents. Off by default — they are a sync detail, not user data. */
+    includeDeleted?: boolean;
+    /** Include the `_sync` block. Off by default: a fresh import should not inherit our versions. */
+    includeSyncMetadata?: boolean;
+}
+export interface CollectionExport {
+    collection: string;
+    count: number;
+    format: ExportFormat;
+    /** The file body, ready to write to disk and hand to mongoimport. */
+    data: string;
+}
+export interface DatabaseExport {
+    database: string;
+    exportedAt: string;
+    collections: CollectionExport[];
+}
+/** Export one collection in a `mongoimport`-ready form. */
+export declare function exportCollection(db: AnchorDB, collection: string, options?: ExportOptions): Promise<CollectionExport>;
+export declare function exportDatabase(db: AnchorDB, options?: ExportOptions): Promise<DatabaseExport>;
+export interface ImportOptions {
+    /**
+     * `insert` skips documents whose `_id` already exists, `upsert` overwrites them, and `replace`
+     * clears the collection first. Named to match the semantics developers already expect.
+     */
+    mode?: "insert" | "upsert" | "replace";
+    /**
+     * Whether imported documents should be queued for sync.
+     *
+     * **Defaults to false**, deliberately. A bulk restore of 100k documents must not manufacture
+     * 100k mutations — that would flood the queue and re-upload data the server may already have.
+     * Set true when the import represents genuine user edits that the backend has not seen.
+     */
+    sync?: boolean;
+    format?: ExportFormat;
+}
+export interface ImportResult {
+    collection: string;
+    inserted: number;
+    updated: number;
+    skipped: number;
+}
+/**
+ * Import documents produced by `mongoexport`, `exportCollection`, or any Extended JSON source.
+ *
+ * Accepts NDJSON or a JSON array, auto-detected, because those are the two things real tooling
+ * emits and making the caller declare which one is friction with no benefit.
+ */
+export declare function importCollection(db: AnchorDB, collection: string, input: string | unknown[], options?: ImportOptions): Promise<ImportResult>;
+export declare function importDatabase(db: AnchorDB, data: DatabaseExport, options?: ImportOptions): Promise<ImportResult[]>;
+/**
+ * Work out what a file actually is, so an import does not need the user to declare it.
+ *
+ * Compass does the same on its import dialog: you pick a file and it tells you what it found. Being
+ * wrong here is an unhelpful parse error several steps later, so the checks are ordered from the
+ * least ambiguous (a leading bracket) to the most (a comma-bearing header row).
+ */
+export declare function detectImportFormat(text: string): ExportFormat;
+/** The exact command that ingests an export produced by `exportCollection`. */
+export declare function mongoimportCommand(opts: {
+    file: string;
+    database: string;
+    collection: string;
+    format?: ExportFormat;
+    uri?: string;
+}): string;
+export { toEJSON, fromEJSON, stringifyEJSON, parseEJSON };
+export type { Model };
+//# sourceMappingURL=export-import.d.ts.map

package/dist/esm/interop/export-import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-import.d.ts","sourceRoot":"","sources":["../../../src/interop/export-import.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAI/C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGjD;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,YAAY,CAAC;IACrB,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAED,2DAA2D;AAC3D,wBAAsB,gBAAgB,CACpC,EAAE,EAAE,QAAQ,EACZ,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAsC3B;AAED,wBAAsB,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAQvG;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,EAAE,EAAE,QAAQ,EACZ,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,EACzB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAqEvB;AAED,wBAAsB,cAAc,CAClC,EAAE,EAAE,QAAQ,EACZ,IAAI,EAAE,cAAc,EACpB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,YAAY,EAAE,CAAC,CAMzB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAK7D;AAED,+EAA+E;AAC/E,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GAAG,MAAM,CAYT;AAiED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC;AAC1D,YAAY,EAAE,KAAK,EAAE,CAAC"}

package/dist/esm/interop/export-import.js

@@ -0,0 +1,210 @@
+import { AnchorError } from "../core/errors.js";
+import { ObjectId } from "../core/object-id.js";
+import { hydrateDoc } from "../model/model.js";
+import { parseEJSON, stringifyEJSON, toEJSON, fromEJSON } from "./ejson.js";
+import { fromCsv, looksLikeCsv, toCsv } from "./csv.js";
+/** Export one collection in a `mongoimport`-ready form. */
+export async function exportCollection(db, collection, options = {}) {
+    await db.open();
+    const format = options.format ?? "ndjson";
+    const mode = options.mode ?? "canonical";
+    // Storage keeps ObjectIds and Dates as strings. Hydrating through the schema restores their real
+    // types so the encoder emits $oid and $date — without this, mongoimport would store plain Strings
+    // and every join or date range query against the imported data would quietly fail.
+    const model = db.modelForCollection(collection);
+    const docs = [];
+    const filter = options.filter;
+    if (filter && Object.keys(filter).length > 0) {
+        if (options.includeDeleted || options.includeSyncMetadata) {
+            throw new AnchorError("exportCollection: filter cannot be combined with includeDeleted or includeSyncMetadata. " +
+                "A filtered export runs as a query, which by definition sees neither tombstones nor sync metadata.");
+        }
+        // The same path Model.find() takes — casting, index selection and matching all happen once, in
+        // the query engine, instead of being reimplemented here and drifting from it.
+        const source = model ?? db.collection(collection);
+        const rows = await source.find(filter).lean().exec();
+        docs.push(...rows);
+    }
+    else {
+        for await (const row of db.adapter.scan(collection, { includeDeleted: options.includeDeleted ?? false })) {
+            docs.push(toExportable(row, options, model?.schema));
+        }
+    }
+    const data = format === "csv"
+        ? toCsv(docs)
+        : format === "ndjson"
+            ? docs.map((d) => stringifyEJSON(d, { mode })).join("\n")
+            : stringifyEJSON(docs, { mode, ...(options.pretty ? { pretty: true } : {}) });
+    return { collection, count: docs.length, format, data };
+}
+export async function exportDatabase(db, options = {}) {
+    await db.open();
+    const collections = (await db.adapter.listCollections()).filter((c) => !c.startsWith("__anchor"));
+    const out = [];
+    for (const collection of collections) {
+        out.push(await exportCollection(db, collection, options));
+    }
+    return { database: db.name, exportedAt: db.time.now(), collections: out };
+}
+/**
+ * Import documents produced by `mongoexport`, `exportCollection`, or any Extended JSON source.
+ *
+ * Accepts NDJSON or a JSON array, auto-detected, because those are the two things real tooling
+ * emits and making the caller declare which one is friction with no benefit.
+ */
+export async function importCollection(db, collection, input, options = {}) {
+    await db.open();
+    const mode = options.mode ?? "insert";
+    const schema = db.modelForCollection(collection)?.schema;
+    const docs = typeof input === "string" ? parseDocuments(input, options.format, schema) : input.map(fromEJSON);
+    const model = db.collection(collection);
+    await db.adapter.ensureCollection(collection);
+    if (mode === "replace") {
+        const existing = [];
+        for await (const row of db.adapter.scan(collection, { includeDeleted: true }))
+            existing.push(row.doc._id);
+        if (existing.length > 0) {
+            await db.adapter.write(existing.map((id) => ({ type: "hardDelete", collection, _id: id })));
+        }
+    }
+    const result = { collection, inserted: 0, updated: 0, skipped: 0 };
+    for (const raw of docs) {
+        if (raw === null || typeof raw !== "object") {
+            throw new AnchorError(`Import expected documents but found ${typeof raw}`);
+        }
+        const doc = raw;
+        const id = doc._id === undefined || doc._id === null ? undefined : String(doc._id);
+        const existing = id ? await db.adapter.get(collection, id, true) : null;
+        if (existing && mode === "insert") {
+            result.skipped++;
+            continue;
+        }
+        if (options.sync) {
+            // Route through the model so the write behaves exactly like a user edit: validation,
+            // timestamps, change events and a queued mutation.
+            if (existing) {
+                await model.replaceOne({ _id: id }, doc);
+                result.updated++;
+            }
+            else {
+                await model.insertOne(doc);
+                result.inserted++;
+            }
+            continue;
+        }
+        // Bulk restore path: write straight to storage, clean and unqueued.
+        const now = db.time.now();
+        const row = {
+            doc: { ...stripSync(doc), _id: id ?? String(doc._id) },
+            meta: {
+                version: readSyncVersion(doc),
+                hlc: "",
+                dirty: false,
+                deleted: false,
+                createdAt: String(doc.createdAt ?? now),
+                updatedAt: String(doc.updatedAt ?? now),
+            },
+        };
+        await db.adapter.write([
+            { type: existing ? "update" : "insert", collection, _id: row.doc._id, row },
+        ]);
+        if (existing)
+            result.updated++;
+        else
+            result.inserted++;
+    }
+    return result;
+}
+export async function importDatabase(db, data, options = {}) {
+    const out = [];
+    for (const c of data.collections) {
+        out.push(await importCollection(db, c.collection, c.data, { ...options, format: c.format }));
+    }
+    return out;
+}
+/**
+ * Work out what a file actually is, so an import does not need the user to declare it.
+ *
+ * Compass does the same on its import dialog: you pick a file and it tells you what it found. Being
+ * wrong here is an unhelpful parse error several steps later, so the checks are ordered from the
+ * least ambiguous (a leading bracket) to the most (a comma-bearing header row).
+ */
+export function detectImportFormat(text) {
+    const trimmed = text.trimStart();
+    if (trimmed.startsWith("["))
+        return "array";
+    if (trimmed.startsWith("{"))
+        return "ndjson";
+    return looksLikeCsv(trimmed) ? "csv" : "ndjson";
+}
+/** The exact command that ingests an export produced by `exportCollection`. */
+export function mongoimportCommand(opts) {
+    const parts = [
+        "mongoimport",
+        opts.uri ? `--uri="${opts.uri}"` : "",
+        `--db=${opts.database}`,
+        `--collection=${opts.collection}`,
+        `--file=${opts.file}`,
+        opts.format === "array" ? "--jsonArray" : "",
+        // --headerline tells mongoimport the first row names the fields, which is how toCsv writes it.
+        opts.format === "csv" ? "--type=csv --headerline" : "",
+    ];
+    return parts.filter(Boolean).join(" ");
+}
+function parseDocuments(input, format, schema) {
+    const trimmed = input.trim();
+    if (trimmed === "")
+        return [];
+    const detected = format ?? detectImportFormat(trimmed);
+    // CSV carries no types, so the collection schema does the work of restoring them. See csv.ts for
+    // what CSV can and cannot round-trip.
+    if (detected === "csv")
+        return fromCsv(trimmed, schema);
+    // Auto-detect rather than require the caller to declare it: mongoexport emits NDJSON, our own
+    // array format is bracketed, and getting it wrong is an unhelpful failure.
+    const looksLikeArray = detected === "array";
+    if (looksLikeArray) {
+        const parsed = parseEJSON(trimmed);
+        if (!Array.isArray(parsed))
+            throw new AnchorError("Expected a JSON array of documents");
+        return parsed;
+    }
+    return trimmed
+        .split("\n")
+        .map((line) => line.trim())
+        .filter(Boolean)
+        .map((line, i) => {
+        try {
+            return parseEJSON(line);
+        }
+        catch (err) {
+            throw new AnchorError(`Malformed NDJSON on line ${i + 1}: ${err.message}`);
+        }
+    });
+}
+function toExportable(row, options, schema) {
+    const hydrated = schema ? hydrateDoc(row, schema) : { ...row.doc };
+    const doc = { ...hydrated };
+    // _id is always an ObjectId when it looks like one, whether or not a schema was registered.
+    if (typeof doc._id === "string" && ObjectId.isValid(doc._id))
+        doc._id = new ObjectId(doc._id);
+    if (options.includeSyncMetadata) {
+        doc._sync = {
+            version: row.meta.version,
+            updatedAt: row.meta.updatedAt,
+            deleted: row.meta.deleted,
+        };
+    }
+    return doc;
+}
+function stripSync(doc) {
+    const { _sync, ...rest } = doc;
+    void _sync;
+    return rest;
+}
+function readSyncVersion(doc) {
+    const sync = doc._sync;
+    return typeof sync?.version === "number" ? sync.version : 0;
+}
+export { toEJSON, fromEJSON, stringifyEJSON, parseEJSON };
+//# sourceMappingURL=export-import.js.map

package/dist/esm/interop/export-import.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-import.js","sourceRoot":"","sources":["../../../src/interop/export-import.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAC5F,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAmDxD,2DAA2D;AAC3D,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,EAAY,EACZ,UAAkB,EAClB,UAAyB,EAAE;IAE3B,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAChB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC;IAEzC,iGAAiG;IACjG,kGAAkG;IAClG,mFAAmF;IACnF,MAAM,KAAK,GAAG,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,IAAI,GAAmC,EAAE,CAAC;IAChD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE9B,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,IAAI,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;YAC1D,MAAM,IAAI,WAAW,CACnB,0FAA0F;gBACxF,mGAAmG,CACtG,CAAC;QACJ,CAAC;QACD,+FAA+F;QAC/F,8EAA8E;QAC9E,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,GAAI,IAAuC,CAAC,CAAC;IACzD,CAAC;SAAM,CAAC;QACN,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK,EAAE,CAAC,EAAE,CAAC;YACzG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GACR,MAAM,KAAK,KAAK;QACd,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACb,CAAC,CAAC,MAAM,KAAK,QAAQ;YACnB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAEpF,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EAAY,EAAE,UAAyB,EAAE;IAC5E,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAChB,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAClG,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,GAAG,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;AAC5E,CAAC;AA0BD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,EAAY,EACZ,UAAkB,EAClB,KAAyB,EACzB,UAAyB,EAAE;IAE3B,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;IAChB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC;IACtC,MAAM,MAAM,GAAG,EAAE,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IACzD,MAAM,IAAI,GACR,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAEnG,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACxC,MAAM,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAE9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1G,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CACpB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,YAAqB,EAAE,UAAU,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAC7E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAEjF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,MAAM,IAAI,WAAW,CAAC,uCAAuC,OAAO,GAAG,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,MAAM,GAAG,GAAG,GAA8B,CAAC;QAC3C,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEnF,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxE,IAAI,QAAQ,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClC,MAAM,CAAC,OAAO,EAAE,CAAC;YACjB,SAAS;QACX,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,qFAAqF;YACrF,mDAAmD;YACnD,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,GAAY,CAAC,CAAC;gBAClD,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,SAAS,CAAC,GAAY,CAAC,CAAC;gBACpC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,CAAC;YACD,SAAS;QACX,CAAC;QAED,oEAAoE;QACpE,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAc;YACrB,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAsB;YAC1E,IAAI,EAAE;gBACJ,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC;gBAC7B,GAAG,EAAE,EAAE;gBACP,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC;gBACvC,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC;aACxC;SACF,CAAC;QACF,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;YACrB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE;SAC5E,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;YAC1B,MAAM,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,EAAY,EACZ,IAAoB,EACpB,UAAyB,EAAE;IAE3B,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACjC,GAAG,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IACjC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5C,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC7C,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClD,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,kBAAkB,CAAC,IAMlC;IACC,MAAM,KAAK,GAAG;QACZ,aAAa;QACb,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE;QACrC,QAAQ,IAAI,CAAC,QAAQ,EAAE;QACvB,gBAAgB,IAAI,CAAC,UAAU,EAAE;QACjC,UAAU,IAAI,CAAC,IAAI,EAAE;QACrB,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;QAC5C,+FAA+F;QAC/F,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE;KACvD,CAAC;IACF,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,cAAc,CAAC,KAAa,EAAE,MAAqB,EAAE,MAAe;IAC3E,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAEvD,iGAAiG;IACjG,sCAAsC;IACtC,IAAI,QAAQ,KAAK,KAAK;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAExD,8FAA8F;IAC9F,2EAA2E;IAC3E,MAAM,cAAc,GAAG,QAAQ,KAAK,OAAO,CAAC;IAC5C,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,oCAAoC,CAAC,CAAC;QACxF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,OAAO;SACX,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,OAAO,CAAC;SACf,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACf,IAAI,CAAC;YACH,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,WAAW,CAAC,4BAA4B,CAAC,GAAG,CAAC,KAAM,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QACxF,CAAC;IACH,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,YAAY,CAAC,GAAc,EAAE,OAAsB,EAAE,MAAmB;IAC/E,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,MAAe,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;IAC5E,MAAM,GAAG,GAA4B,EAAE,GAAG,QAAQ,EAAE,CAAC;IAErD,4FAA4F;IAC5F,IAAI,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,GAAG,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE9F,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAChC,GAAG,CAAC,KAAK,GAAG;YACV,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO;YACzB,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS;YAC7B,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO;SAC1B,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,SAAS,CAAC,GAA4B;IAC7C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAC;IAC/B,KAAK,KAAK,CAAC;IACX,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,GAA4B;IACnD,MAAM,IAAI,GAAG,GAAG,CAAC,KAAyC,CAAC;IAC3D,OAAO,OAAO,IAAI,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAKD,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC"}

package/dist/esm/model/document.d.ts

@@ -0,0 +1,66 @@
+import type { Schema } from "../schema/schema.js";
+import type { Model } from "./model.js";
+export interface ToObjectOptions {
+    virtuals?: boolean;
+    versionKey?: boolean;
+    /** Strip `_id`. Mongoose calls this `_id: false` on the schema; here it is per-call. */
+    omitId?: boolean;
+    transform?: (doc: AnchorDocument, ret: Record<string, unknown>) => Record<string, unknown> | void;
+}
+export declare class AnchorDocument {
+    constructor(model: Model, data?: Record<string, unknown>, isNew?: boolean);
+    /** The model this document belongs to. */
+    get $model(): Model;
+    get schema(): Schema;
+    /** True until the document has been persisted. */
+    get isNew(): boolean;
+    /** Mongoose's `doc.id` — the string form of `_id`. */
+    get id(): string | undefined;
+    /** Paths whose value differs from the loaded snapshot, plus any forced by `markModified`. */
+    modifiedPaths(): string[];
+    isModified(path?: string): boolean;
+    /**
+     * Force a path to be treated as changed.
+     *
+     * Needed for `Mixed` values mutated in place in ways a diff cannot attribute, and provided for
+     * exact Mongoose compatibility.
+     */
+    markModified(path: string): this;
+    /** Plain object, with virtuals and transforms applied per the schema's `toObject` options. */
+    toObject(options?: ToObjectOptions): Record<string, unknown>;
+    /** What `JSON.stringify(doc)` uses. Defaults to including virtuals, as Mongoose's toJSON does. */
+    toJSON(options?: ToObjectOptions): Record<string, unknown>;
+    validate(): Promise<void>;
+    /**
+     * Insert when new, otherwise write only the paths that actually changed.
+     *
+     * Sending a `$set` of the modified paths rather than the whole document matters for sync: a
+     * whole-document write would look like an edit to every field and would conflict with any
+     * concurrent change, even to an untouched field.
+     */
+    save(): Promise<this>;
+    deleteOne(): Promise<{
+        acknowledged: boolean;
+        deletedCount: number;
+    }>;
+    /** Populate a ref on this single document. */
+    populate(path: string | {
+        path: string;
+        select?: string;
+    }): Promise<this>;
+    /** Discard local changes and reload from storage. */
+    reload(): Promise<this>;
+}
+/**
+ * Build the callable model — `new User({...})` alongside `User.find()`.
+ *
+ * Mongoose's `model()` returns something that is both a constructor and a namespace of statics.
+ * Reproducing that shape is what lets a Mongoose codebase move over untouched.
+ */
+export interface ModelConstructor<T extends Record<string, unknown> = Record<string, unknown>> extends Omit<Model<T>, never> {
+    new (data?: Partial<T>): AnchorDocument & T;
+    /** Wrap an existing plain object as a document, without marking it new. */
+    hydrate(data: Record<string, unknown>): AnchorDocument & T;
+}
+export declare function createModelConstructor<T extends Record<string, unknown>>(model: Model<T>): ModelConstructor<T>;
+//# sourceMappingURL=document.d.ts.map

package/dist/esm/model/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/model/document.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AA6BxC,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,wFAAwF;IACxF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACnG;AAED,qBAAa,cAAc;gBACb,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAAE,KAAK,UAAO;IAsB1E,0CAA0C;IAC1C,IAAI,MAAM,IAAI,KAAK,CAElB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,kDAAkD;IAClD,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,sDAAsD;IACtD,IAAI,EAAE,IAAI,MAAM,GAAG,SAAS,CAG3B;IAED,6FAA6F;IAC7F,aAAa,IAAI,MAAM,EAAE;IAoBzB,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAOlC;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKhC,8FAA8F;IAC9F,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAyBhE,kGAAkG;IAClG,MAAM,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKxD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAM/B;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiDrB,SAAS,IAAI,OAAO,CAAC;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAK3E,8CAA8C;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAc/E,qDAAqD;IAC/C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAc9B;AAcD;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC3F,SAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;IAC7B,KAAK,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,cAAc,GAAG,CAAC,CAAC;IAC5C,2EAA2E;IAC3E,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,cAAc,GAAG,CAAC,CAAC;CAC5D;AAED,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAkE9G"}