js-bao 0.5.1 → 0.6.0

package/dist/client.cjs

@@ -93,37 +93,388 @@ var init_yjsValues = __esm({
   }
 });
 
+// src/models/writeLifecycle.ts
+function registerFunctionDefaultGenerator(name, fn) {
+  FUNCTION_DEFAULT_GENERATORS.set(name, fn);
+}
+var Y2, import_ulid, KNOWN_FIELD_TYPE_MAP, KNOWN_FIELD_TYPES, FUNCTION_DEFAULT_GENERATORS;
+var init_writeLifecycle = __esm({
+  "src/models/writeLifecycle.ts"() {
+    "use strict";
+    Y2 = __toESM(require("yjs"), 1);
+    import_ulid = require("ulid");
+    KNOWN_FIELD_TYPE_MAP = {
+      string: true,
+      number: true,
+      boolean: true,
+      date: true,
+      id: true,
+      stringset: true
+    };
+    KNOWN_FIELD_TYPES = new Set(Object.keys(KNOWN_FIELD_TYPE_MAP));
+    FUNCTION_DEFAULT_GENERATORS = /* @__PURE__ */ new Map();
+    registerFunctionDefaultGenerator("generate_ulid", () => (0, import_ulid.ulid)());
+  }
+});
+
 // src/models/metaSync.ts
 function registerFunctionDefault(fn, name) {
   KNOWN_FUNCTION_DEFAULTS.set(fn, name);
 }
-var Y2, KNOWN_FUNCTION_DEFAULTS;
+var Y3, KNOWN_FUNCTION_DEFAULTS;
 var init_metaSync = __esm({
   "src/models/metaSync.ts"() {
     "use strict";
-    Y2 = __toESM(require("yjs"), 1);
+    Y3 = __toESM(require("yjs"), 1);
     init_yjsValues();
+    init_writeLifecycle();
     KNOWN_FUNCTION_DEFAULTS = /* @__PURE__ */ new WeakMap();
   }
 });
 
+// src/utils/uniqueIndex.ts
+var Y4;
+var init_uniqueIndex = __esm({
+  "src/utils/uniqueIndex.ts"() {
+    "use strict";
+    Y4 = __toESM(require("yjs"), 1);
+  }
+});
+
+// src/utils/largeDocuments.ts
+var Y5;
+var init_largeDocuments = __esm({
+  "src/utils/largeDocuments.ts"() {
+    "use strict";
+    Y5 = __toESM(require("yjs"), 1);
+    init_yjsValues();
+  }
+});
+
+// src/models/OrmContext.ts
+var OrmContext, defaultOrmContext, liveOrmContexts;
+var init_OrmContext = __esm({
+  "src/models/OrmContext.ts"() {
+    "use strict";
+    OrmContext = class _OrmContext {
+      /** Declared before the field that reads it: static initialization is ordered. */
+      static instanceCounter = 0;
+      /**
+       * Which instance this is, for diagnostics. A process holding several clients
+       * needs a way to say WHICH one a warning is about, so every context takes the
+       * next number as it is created and keeps it for its lifetime.
+       */
+      instanceId = ++_OrmContext.instanceCounter;
+      /** The engine this instance's models read and write through. */
+      dbEngine = null;
+      connectedDocuments = /* @__PURE__ */ new Map();
+      /** `docId_modelName` → the Y.Map that document holds for that model. */
+      documentYMaps = /* @__PURE__ */ new Map();
+      /** `subscribe()` callbacks, by model name. */
+      listenersMap = /* @__PURE__ */ new Map();
+      // Default-document resolution
+      modelNameToDefaultDocId = /* @__PURE__ */ new Map();
+      globalDefaultDocId = void 0;
+      defaultDocChangedListeners = /* @__PURE__ */ new Set();
+      modelDocMappingChangedListeners = /* @__PURE__ */ new Set();
+      /** Format-2 ("large document", #2816) record stores by document id. */
+      format2Documents = /* @__PURE__ */ new Map();
+      /** Format-2 epoch moves in flight (#2816). */
+      format2Transitions = /* @__PURE__ */ new Map();
+      /**
+       * Nested-Y.Map stringset fields this context has already observed. Per
+       * context, not global: a Y.Doc reconnected to a fresh instance has to be
+       * observed again by that instance, and a global guard would silently
+       * suppress it.
+       */
+      observedStringSetMaps = /* @__PURE__ */ new WeakSet();
+      /**
+       * The registry this instance's schema lookups use. `null` on the standing
+       * default context, where callers fall back to the global singleton.
+       */
+      modelRegistry = null;
+      /** Model classes routed to this context. */
+      boundModels = /* @__PURE__ */ new Set();
+      /** True once {@link destroy} has run; bound classes keep pointing here. */
+      destroyed = false;
+      /** Yjs `unobserve` thunks by owning document id. */
+      observerDisposers = /* @__PURE__ */ new Map();
+      /** Teardown the owner (the document manager) registers for `destroy()`. */
+      teardownHooks = /* @__PURE__ */ new Set();
+      static NO_DOCUMENT_KEY = "__no_document__";
+      /**
+       * Record how to remove an observer this context installed. Every `observe()`
+       * in the ORM pairs with one of these: without it a torn-down instance's
+       * callbacks keep firing on a Y.Doc that outlives it.
+       */
+      registerObserverDisposer(docId, dispose) {
+        const key = docId ?? _OrmContext.NO_DOCUMENT_KEY;
+        const list = this.observerDisposers.get(key);
+        if (list) list.push(dispose);
+        else this.observerDisposers.set(key, [dispose]);
+      }
+      /** Remove every observer this context installed for `docId`. */
+      disposeObserversForDocument(docId) {
+        const list = this.observerDisposers.get(docId);
+        if (!list) return;
+        this.observerDisposers.delete(docId);
+        for (const dispose of list) {
+          try {
+            dispose();
+          } catch {
+          }
+        }
+      }
+      disposeAllObservers() {
+        const buckets = Array.from(this.observerDisposers.values());
+        this.observerDisposers.clear();
+        for (const list of buckets) {
+          for (const dispose of list) {
+            try {
+              dispose();
+            } catch {
+            }
+          }
+        }
+      }
+      /** Run `hook` as part of `destroy()` (the format-2 binding registers here). */
+      onDestroy(hook) {
+        this.teardownHooks.add(hook);
+      }
+      /** The record store for `docId`, or `null` when the document is format 1. */
+      getFormat2Store(docId) {
+        if (!docId) return null;
+        return this.format2Documents.get(docId) ?? null;
+      }
+      /**
+       * The epoch move a write to `docId` has to wait out (#2816, behavior 10), or
+       * `null` when none is in flight.
+       */
+      format2WritesHeld(docId) {
+        if (!docId) return null;
+        return this.format2Transitions.get(docId) ?? null;
+      }
+      /** Run an epoch move with `docId`'s local writes held back (#2816). */
+      async holdFormat2Writes(docId, run) {
+        const inFlight = this.format2Transitions.get(docId);
+        if (inFlight) await inFlight.catch(() => {
+        });
+        let release;
+        const held = new Promise((resolve) => {
+          release = resolve;
+        });
+        this.format2Transitions.set(docId, held);
+        try {
+          return await run();
+        } finally {
+          if (this.format2Transitions.get(docId) === held) {
+            this.format2Transitions.delete(docId);
+          }
+          release();
+        }
+      }
+      /** Notify `subscribe()` callbacks registered on this context for `modelName`. */
+      notifyListeners(modelName, log, onError) {
+        const listeners = this.listenersMap.get(modelName);
+        if (!listeners) return;
+        log?.(`Notifying ${listeners.size} listeners for ${modelName}`);
+        listeners.forEach((callback) => {
+          try {
+            callback();
+          } catch (e) {
+            onError?.(e);
+          }
+        });
+      }
+      // ---- Default-document resolution (the `BaseModel` statics delegate here) ----
+      setModelDefaultDocumentId(modelName, docId) {
+        const previous = this.modelNameToDefaultDocId.get(modelName);
+        this.modelNameToDefaultDocId.set(modelName, docId);
+        this.announceModelDocMapping(modelName, previous, docId);
+      }
+      removeModelDefaultDocumentId(modelName) {
+        const previous = this.modelNameToDefaultDocId.get(modelName);
+        this.modelNameToDefaultDocId.delete(modelName);
+        this.announceModelDocMapping(modelName, previous, void 0);
+      }
+      clearModelDefaultDocumentIds() {
+        const entries = Array.from(this.modelNameToDefaultDocId.entries());
+        this.modelNameToDefaultDocId.clear();
+        for (const [modelName, previous] of entries) {
+          this.announceModelDocMapping(modelName, previous, void 0);
+        }
+      }
+      setGlobalDefaultDocumentId(docId) {
+        const previous = this.globalDefaultDocId;
+        this.globalDefaultDocId = docId;
+        this.announceDefaultDoc(previous, docId);
+      }
+      clearGlobalDefaultDocumentId() {
+        const previous = this.globalDefaultDocId;
+        this.globalDefaultDocId = void 0;
+        this.announceDefaultDoc(previous, void 0);
+      }
+      getModelDefaultDocumentMapping() {
+        return Object.fromEntries(this.modelNameToDefaultDocId.entries());
+      }
+      getDocumentIdForModel(modelName) {
+        return this.modelNameToDefaultDocId.get(modelName);
+      }
+      getGlobalDefaultDocumentId() {
+        return this.globalDefaultDocId;
+      }
+      onDefaultDocChanged(listener) {
+        this.defaultDocChangedListeners.add(listener);
+        return () => this.defaultDocChangedListeners.delete(listener);
+      }
+      onModelDocMappingChanged(listener) {
+        this.modelDocMappingChangedListeners.add(listener);
+        return () => this.modelDocMappingChangedListeners.delete(listener);
+      }
+      /** Drop the model→document defaults that point at a disconnected document. */
+      clearMappingsForDocId(docId) {
+        const toRemove = [];
+        for (const [modelName, mappedDocId] of this.modelNameToDefaultDocId) {
+          if (mappedDocId === docId) toRemove.push(modelName);
+        }
+        for (const modelName of toRemove) {
+          this.removeModelDefaultDocumentId(modelName);
+        }
+        if (this.globalDefaultDocId === docId) {
+          this.clearGlobalDefaultDocumentId();
+        }
+      }
+      announceDefaultDoc(previous, current) {
+        for (const listener of this.defaultDocChangedListeners) {
+          try {
+            listener({ previous, current });
+          } catch {
+          }
+        }
+      }
+      announceModelDocMapping(modelName, previous, current) {
+        for (const listener of this.modelDocMappingChangedListeners) {
+          try {
+            listener({ modelName, previous, current });
+          } catch {
+          }
+        }
+      }
+      /**
+       * Tear this instance down: observers off, engine destroyed, state cleared.
+       *
+       * Deliberately does NOT unbind its model classes. They keep resolving this
+       * context, whose engine is now null, so an operation through them throws the
+       * ordinary not-initialized error instead of silently landing on whatever
+       * other instance happens to be live (#3039, behavior 7). Only a later
+       * `initJsBao` may rebind a class whose context is destroyed.
+       */
+      async destroy() {
+        if (this.destroyed) return;
+        this.destroyed = true;
+        this.disposeAllObservers();
+        const hooks = Array.from(this.teardownHooks);
+        this.teardownHooks.clear();
+        for (const hook of hooks) {
+          try {
+            await hook();
+          } catch {
+          }
+        }
+        const engine = this.dbEngine;
+        this.dbEngine = null;
+        if (engine) {
+          try {
+            await engine.destroy();
+          } catch {
+          }
+        }
+        this.connectedDocuments.clear();
+        this.documentYMaps.clear();
+        this.listenersMap.clear();
+        this.modelNameToDefaultDocId.clear();
+        this.globalDefaultDocId = void 0;
+        this.defaultDocChangedListeners.clear();
+        this.modelDocMappingChangedListeners.clear();
+        this.format2Documents.clear();
+        this.format2Transitions.clear();
+        this.observedStringSetMaps = /* @__PURE__ */ new WeakSet();
+        liveOrmContexts.delete(this);
+        if (defaultOrmContext === this) {
+          defaultOrmContext = new _OrmContext();
+        }
+      }
+    };
+    defaultOrmContext = new OrmContext();
+    liveOrmContexts = /* @__PURE__ */ new Set();
+  }
+});
+
+// src/models/format2QueryProjection.ts
+var FORMAT2_QUERY_PROJECTION_DDL;
+var init_format2QueryProjection = __esm({
+  "src/models/format2QueryProjection.ts"() {
+    "use strict";
+    FORMAT2_QUERY_PROJECTION_DDL = `
+CREATE TABLE IF NOT EXISTS _query_projection (
+  doc_id TEXT NOT NULL,
+  model TEXT NOT NULL,
+  PRIMARY KEY (doc_id, model)
+)`.trim();
+  }
+});
+
+// src/models/format2Observer.ts
+var Y6;
+var init_format2Observer = __esm({
+  "src/models/format2Observer.ts"() {
+    "use strict";
+    Y6 = __toESM(require("yjs"), 1);
+    init_largeDocuments();
+  }
+});
+
+// src/models/format2ClientWrite.ts
+var init_format2ClientWrite = __esm({
+  "src/models/format2ClientWrite.ts"() {
+    "use strict";
+  }
+});
+
+// src/models/format2OfflineWindow.ts
+var DAY_MS;
+var init_format2OfflineWindow = __esm({
+  "src/models/format2OfflineWindow.ts"() {
+    "use strict";
+    DAY_MS = 24 * 60 * 60 * 1e3;
+  }
+});
+
 // src/models/BaseModel.ts
 function generateULID() {
-  return (0, import_ulid.ulid)();
+  return (0, import_ulid2.ulid)();
 }
-var Y3, import_ulid, Logger;
+var Y7, import_ulid2, Logger;
 var init_BaseModel = __esm({
   "src/models/BaseModel.ts"() {
     "use strict";
-    Y3 = __toESM(require("yjs"), 1);
-    import_ulid = require("ulid");
+    Y7 = __toESM(require("yjs"), 1);
+    import_ulid2 = require("ulid");
     init_StringSet();
     init_documentTypes();
     init_DocumentQueryTranslator();
     init_CursorManager();
     init_sql();
     init_metaSync();
+    init_writeLifecycle();
     init_yjsValues();
+    init_uniqueIndex();
+    init_largeDocuments();
+    init_OrmContext();
+    init_format2QueryProjection();
+    init_format2Observer();
+    init_format2ClientWrite();
+    init_format2OfflineWindow();
     Logger = class {
       static _logLevel = 1 /* ERROR */;
       static _logCallback = null;
@@ -239,6 +590,32 @@ var DatabaseEngine = class {
   getTableName(_modelName) {
     throw new Error("Method not implemented.");
   }
+  /**
+   * A SYNCHRONOUS SQL executor over this engine's database, used by the
+   * large-document (format 2) record store. That store commits a merged
+   * record row and its pending-operation entry as one transaction — the
+   * barrier a `save()` resolves behind — which the async `query()` API cannot
+   * express. Engines whose underlying SQLite is synchronous (better-sqlite3,
+   * SQL.js) provide it; anything else leaves it undefined and cannot host a
+   * large document.
+   */
+  createFormat2Sql;
+  /**
+   * Whether what {@link createFormat2Sql} writes survives this process.
+   *
+   * On a large document the merged record view IS the document: the Y.Doc
+   * holds one epoch's overlay, and everything else — including a record a
+   * `save()` has already resolved, and the pending write that still owes it to
+   * the server — lives only in this store. An engine whose database is in
+   * memory therefore cannot host one: a reload does not cost a cache, it costs
+   * the document and the writes nobody has acknowledged yet.
+   *
+   * The platform is asked separately about its storage quota; this answers the
+   * half only the engine knows. An engine that does not implement it is taken
+   * at the platform's word, which is what keeps hosts with storage of their
+   * own — a worker handed a file store, a test — working unchanged.
+   */
+  format2StorageIsDurable;
   // Transaction support
   async withTransaction(_callback) {
     throw new Error("Method not implemented.");