clay-server 5.2.0-beta.1 → 5.2.0-beta.11

package/lib/knowledge-db-service.js

@@ -1,17 +1,17 @@
 var crypto = require("crypto");
-var fs = require("fs");
-var path = require("path");
-var Datastore = require("@seald-io/nedb");
 var validation = require("./knowledge-db-validation");
+var imports = require("./knowledge-db-import");
+var storageModule = require("./knowledge-db-storage");
 
 var MAX_HISTORY = 50;
 var MAX_RECEIPTS = 500;
 var MAX_PAGE = 100;
 var MAX_FILTERS = 20;
 var MAX_SORTS = 10;
-var MAX_AGGREGATE_BYTES = 8 * 1024 * 1024;
+// Synthetic imports use 8.36 MB for 8563 narrative rows and exceed 8 MiB at
+// 11400 short rows. Keep finite headroom for the 20000-row envelope and history.
+var MAX_AGGREGATE_BYTES = 16 * 1024 * 1024;
 var IDEMPOTENCY_WINDOW_MS = 24 * 60 * 60 * 1000;
-var STORE_REGISTRY = {};
 
 function clone(value) { return JSON.parse(JSON.stringify(value)); }
 function error(message, code, currentRevision) { return Object.assign(new Error(message), { code: code || "FAILED", currentRevision: currentRevision }); }
@@ -30,7 +30,7 @@ function canonical(value) {
   if (!value || typeof value !== "object") return value;
   var out = {}; Object.keys(value).sort().forEach(function (key) { out[key] = canonical(value[key]); }); return out;
 }
-function fingerprint(label, args) { var envelope = Object.assign({}, args); delete envelope.actor; delete envelope.operationId; return crypto.createHash("sha256").update(label + ":" + JSON.stringify(canonical(envelope))).digest("hex"); }
+function fingerprint(label, args) { var envelope = Object.assign({}, args); delete envelope.actor; delete envelope.operationId; delete envelope.revalidate; return crypto.createHash("sha256").update(label + ":" + JSON.stringify(canonical(envelope))).digest("hex"); }
 function ensureRevision(value, current, label) {
   if (!Number.isInteger(value) || value < 1) throw error("A valid " + label + " revision is required.", "STALE", current);
   if (value !== current) throw error("This " + label + " changed since it was opened.", "STALE", current);
@@ -107,49 +107,39 @@ function queryRecords(database, args, databases, settings) {
 }
 
 function createKnowledgeDbService(options) {
-  var settings = options || {}; var projectDir = path.resolve(settings.projectDir); var projectReal = null; var knowledgeDir = path.join(projectDir, "knowledge"); var dataDir = path.join(knowledgeDir, ".clay-db"); var filename = path.join(dataDir, "databases.db");
+  var settings = options || {}; var storage = storageModule.createKnowledgeDbStorage(settings);
   var aggregateLimit = Number.isInteger(settings.maxAggregateBytes) && settings.maxAggregateBytes > 1024 ? Math.min(MAX_AGGREGATE_BYTES, settings.maxAggregateBytes) : MAX_AGGREGATE_BYTES;
-  var entry = STORE_REGISTRY[filename];
-  if (!entry) { entry = { queues: {}, database: null, loading: null, ready: false }; STORE_REGISTRY[filename] = entry; }
-  function safeDirectory(target, create) {
-    var stat; try { stat = fs.lstatSync(target); } catch (cause) { if (!create || cause.code !== "ENOENT") throw cause; fs.mkdirSync(target, { recursive: true, mode: 0o700 }); stat = fs.lstatSync(target); }
-    if (!stat.isDirectory() || stat.isSymbolicLink()) throw error("Knowledge database path is unsafe.", "UNSAFE_PATH");
-    var real = fs.realpathSync(target); if (real !== projectReal && !real.startsWith(projectReal + path.sep)) throw error("Knowledge database path escapes the Mate project.", "UNSAFE_PATH");
-  }
-  function open() {
-    if (entry.loading) return entry.loading;
-    entry.loading = Promise.resolve().then(function () { projectReal = fs.realpathSync(projectDir); safeDirectory(knowledgeDir, true); safeDirectory(dataDir, true); var stat; try { stat = fs.lstatSync(filename); } catch (cause) { if (cause.code !== "ENOENT") throw cause; }
-      if (stat && (!stat.isFile() || stat.isSymbolicLink())) throw error("Knowledge database file is unsafe.", "UNSAFE_PATH"); entry.database = new Datastore({ filename: filename }); return entry.database.loadDatabaseAsync(); }).then(function () { return entry.database.ensureIndexAsync({ fieldName: "_id", unique: true }); }).then(function () { entry.ready = true; return entry.database; }).catch(function (cause) { entry.database = null; entry.loading = null; entry.ready = false; throw cause; });
-    return entry.loading;
-  }
-  function serialize(key, work) { var previous = entry.queues[key] || Promise.resolve(); var next = previous.catch(function () {}).then(work); entry.queues[key] = next.catch(function () {}); return next; }
-  function load(id) { return open().then(function (store) { return store.findOneAsync({ _id: validation.id(id, "database id") }); }).then(function (found) { if (!found) throw error("Knowledge database not found.", "NOT_FOUND"); return found; }); }
-  function all() { return open().then(function (store) { return store.findAsync({}); }); }
-  function listCached(args) { var items = entry.database ? entry.database.getAllData() : []; return { databases: items.filter(function (item) { return args && args.archived === true ? !!item.archivedAt : !item.archivedAt; }).sort(function (a, b) { return b.updatedAt - a.updatedAt || (a._id === b._id ? 0 : a._id < b._id ? -1 : 1); }).map(function (item) { return publicDatabase(item, false); }) }; }
-  function assertAggregate(next) { if (Buffer.byteLength(JSON.stringify(next), "utf8") > aggregateLimit) throw error("Knowledge database reached its storage limit.", "LIMIT"); }
-  function replace(current, next) { assertAggregate(next); return entry.database.updateAsync({ _id: current._id, revision: current.revision }, next, {}).then(function (result) { if (result.numAffected !== 1) throw error("This database changed during the operation.", "STALE", current.revision); return next; }); }
+  function serialize(key, work) { return storage.serialize(key, work); }
+  function load(id) { return storage.get(validation.id(id, "database id")).then(function (found) { if (!found) throw error("Knowledge database not found.", "NOT_FOUND"); return found; }); }
+  function all() { return storage.list(); }
+  function listCached(args) { var items = storage.getCached(); return { databases: items.filter(function (item) { return args && args.archived === true ? !!item.archivedAt : !item.archivedAt; }).sort(function (a, b) { return b.updatedAt - a.updatedAt || (a._id === b._id ? 0 : a._id < b._id ? -1 : 1); }).map(function (item) { return publicDatabase(item, false); }) }; }
+  function assertAggregate(next) { if (Buffer.byteLength(JSON.stringify(next), "utf8") > aggregateLimit) throw error("Knowledge database exceeds the " + aggregateLimit + " byte aggregate storage limit (records, history, mappings and live receipts).", "LIMIT"); }
+  function guard(args, current, phase) { if (args && typeof args.revalidate === 'function') args.revalidate(current ? publicDatabase(current, false) : null, phase); }
+  function replace(current, next, control) { assertAggregate(next); guard(control, current, 'saving'); return storage.replaceIfRevision(current._id, current.revision, next).then(function (replaced) { if (typeof replaced !== "boolean") throw storageModule.invalid("replaceIfRevision must resolve to a boolean."); if (!replaced) throw Object.assign(error("This database changed during the operation.", "STALE", current.revision), { persisted: false }); guard(control, null, "saved"); return next; }); }
   function projectionContent(value) { return JSON.stringify({ schemaVersion: 1, namespace: "knowledge-database-summary", databaseId: value._id, name: value.name, archived: !!value.archivedAt, revision: value.revision, fields: value.schema.filter(function (field) { return !field.archived; }).map(function (field) { return { id: field.id, name: field.name, type: field.type }; }), views: (value.views || []).filter(function (view) { return !view.archived; }).map(function (view) { return { id: view.id, name: view.name, type: "table" }; }), recordCount: value.records.filter(function (record) { return !record.archivedAt; }).length }); }
   function project(value, actorValue) {
     if (typeof settings.projectSummary !== "function") return Promise.resolve({ pending: false });
     return Promise.resolve().then(function () { return settings.projectSummary({ databaseId: value._id, name: value.name, revision: value.revision, archived: !!value.archivedAt, content: projectionContent(value), actor: actorValue }); }).then(function () {
-      var clean = clone(value); clean.projectionPending = false; clean.projectionError = null; return entry.database.updateAsync({ _id: value._id, revision: value.revision }, clean, {}).then(function (result) { if (result.numAffected !== 1) return { pending: true, error: "A newer database revision still needs summary projection." }; return { pending: false }; });
-    }).catch(function (cause) { var message = cause.message || "Knowledge database summary projection failed."; var failed = clone(value); failed.projectionPending = true; failed.projectionError = message; return entry.database.updateAsync({ _id: value._id, revision: value.revision }, failed, {}).then(function () { return { pending: true, error: message }; }, function () { return { pending: true, error: message }; }); });
+      var clean = clone(value); clean.projectionPending = false; clean.projectionError = null; return replace(value, clean).then(function () { return { pending: false }; });
+    }).catch(function (cause) { var message = cause.message || "Knowledge database summary projection failed."; var failed = clone(value); failed.projectionPending = true; failed.projectionError = message; return replace(value, failed).then(function () { return { pending: true, error: message }; }, function () { return { pending: true, error: message }; }); });
   }
   function finish(value, result, actorValue) { return project(value, actorValue).then(function (projection) { return Object.assign({}, result, { projectionPending: projection.pending, projectionError: projection.error || null }); }); }
   function mutate(databaseId, args, label, fn) {
     var operationId = mutationId(args.operationId); var operationFingerprint = fingerprint(label, args); return serialize(databaseId, function () { return load(databaseId).then(function (current) {
+      guard(args, current);
       var duplicate = receipt(current, operationId, operationFingerprint); if (duplicate) return Object.assign({}, duplicate, { projectionPending: current.projectionPending === true, projectionError: current.projectionError || null });
       if (current.archivedAt && label !== "database") throw error("Knowledge database is archived.", "ARCHIVED", current.revision);
-      var next = clone(current); var result = fn(next, current); next.projectionPending = true; next.projectionError = null; remember(next, operationId, operationFingerprint, result); return replace(current, next).then(function () { return finish(next, result, actor(args.actor)); });
+      var next = clone(current); var result = fn(next, current); next.projectionPending = true; next.projectionError = null; remember(next, operationId, operationFingerprint, result); return replace(current, next, args).then(function () { return finish(next, result, actor(args.actor)); });
     }); });
   }
   function create(args) {
     var input = args || {}; var operationId = mutationId(input.operationId); var operationFingerprint = fingerprint("create", input); return serialize("create:" + operationId, function () { return all().then(function (items) {
+      guard(input);
       var duplicate; var duplicateDatabase; items.some(function (item) { duplicate = receipt(item, operationId, operationFingerprint); if (duplicate) duplicateDatabase = item; return !!duplicate; }); if (duplicate) return Object.assign({}, duplicate, { projectionPending: duplicateDatabase.projectionPending === true, projectionError: duplicateDatabase.projectionError || null });
       var at = now(); var who = actor(input.actor); var titleId = newId("fld"); var schema = input.schema ? validation.normalizeSchema(input.schema) : validation.normalizeSchema([{ id: titleId, name: "Name", type: "title", required: true }]);
       var viewId = newId("view"); var item = { _id: newId("db"), name: validation.text(input.name, "Database name", 120, false), revision: 1, archivedAt: null, schema: schema,
         views: [{ id: viewId, name: "Table", type: "table", columns: schema.filter(function (field) { return !field.archived; }).map(function (field) { return field.id; }), filters: [], sorts: [], archived: false }], records: [], recordHistory: {}, databaseHistory: [], receipts: [], createdAt: at, updatedAt: at, createdBy: who, updatedBy: who, projectionPending: true, projectionError: null };
-      var result = { database: publicDatabase(item, false) }; remember(item, operationId, operationFingerprint, result); assertAggregate(item); return open().then(function (store) { return store.insertAsync(item); }).then(function () { return finish(item, result, who); });
+      var result = { database: publicDatabase(item, false) }; remember(item, operationId, operationFingerprint, result); assertAggregate(item); guard(input, null, "saving"); return storage.insert(item).then(function () { guard(input, null, "saved"); return finish(item, result, who); });
     }); });
   }
   function list(args) { return all().then(function (items) { return { databases: items.filter(function (item) { return args && args.archived === true ? !!item.archivedAt : !item.archivedAt; }).sort(function (a, b) { return b.updatedAt - a.updatedAt || (a._id === b._id ? 0 : a._id < b._id ? -1 : 1); }).map(function (item) { return publicDatabase(item, false); }) }; }); }
@@ -163,13 +153,14 @@ function createKnowledgeDbService(options) {
   function updateSchema(args) { return mutate(args.databaseId, args, "schema", function (next, current) { ensureRevision(args.expectedRevision, current.revision, "database"); var schema = validation.normalizeSchema(args.schema); validation.assertCompatibleSchema(current.schema, schema, current.records); next.databaseHistory = next.databaseHistory.concat([{ revision: current.revision, at: now(), actor: actor(args.actor), action: "schema", schema: current.schema }]).slice(-MAX_HISTORY); next.schema = schema; next.views = reconcileViews(next.views, schema); next.revision++; next.updatedAt = now(); next.updatedBy = actor(args.actor); return { database: publicDatabase(next, false) }; }); }
   function saveView(args) { return mutate(args.databaseId, args, "view", function (next, current) { ensureRevision(args.expectedRevision, current.revision, "database"); var view = validation.normalizeView(args.view, current.schema); var index = next.views.findIndex(function (entry) { return entry.id === view.id; }); if (index === -1 && next.views.length >= validation.MAX_VIEWS) throw error("Database has too many views.", "LIMIT"); if (index === -1) next.views.push(view); else next.views[index] = view; next.revision++; next.updatedAt = now(); next.updatedBy = actor(args.actor); return { database: publicDatabase(next, false), view: clone(view) }; }); }
   function referenceContext(databases, current) { return { authorizeReference: function (reference) { if (reference.type === "text") return typeof settings.authorizeTextReference === "function" && settings.authorizeTextReference(reference.id) === true; var target = databases.filter(function (item) { return item._id === reference.databaseId; })[0]; return !!(target && target.records.some(function (record) { return record.id === reference.id; })); } }; }
-  function createRecord(args) { return all().then(function (databases) { return mutate(args.databaseId, args, "record", function (next, current) { ensureRevision(args.expectedDatabaseRevision, current.revision, "database"); if (next.records.length >= validation.MAX_RECORDS) throw error("Database reached the record limit.", "LIMIT"); var at = now(); var who = actor(args.actor); var record = { id: newId("rec"), revision: 1, values: validation.normalizeValues(args.values || {}, current.schema, referenceContext(databases, current), null), archivedAt: null, createdAt: at, updatedAt: at, createdBy: who, updatedBy: who }; next.records.push(record); next.recordHistory[record.id] = []; next.revision++; next.updatedAt = at; next.updatedBy = who; return { databaseRevision: next.revision, record: publicRecord(record) }; }); }); }
+  function createRecord(args) { return all().then(function (databases) { return mutate(args.databaseId, args, "record", function (next, current) { ensureRevision(args.expectedDatabaseRevision, current.revision, "database"); if (next.records.length >= validation.MAX_RECORDS) throw error("Database exceeds the " + validation.MAX_RECORDS + " record limit (including archived records).", "LIMIT"); var at = now(); var who = actor(args.actor); var record = { id: newId("rec"), revision: 1, values: validation.normalizeValues(args.values || {}, current.schema, referenceContext(databases, current), null), archivedAt: null, createdAt: at, updatedAt: at, createdBy: who, updatedBy: who }; next.records.push(record); next.recordHistory[record.id] = []; next.revision++; next.updatedAt = at; next.updatedBy = who; return { databaseRevision: next.revision, record: publicRecord(record) }; }); }); }
   function updateRecord(args) { return all().then(function (databases) { return mutate(args.databaseId, args, "record", function (next, current) { var index = next.records.findIndex(function (record) { return record.id === validation.id(args.recordId, "record id"); }); if (index === -1) throw error("Knowledge database record not found.", "NOT_FOUND"); var before = next.records[index]; ensureRevision(args.expectedRevision, before.revision, "record"); if (before.archivedAt) throw error("Knowledge database record is archived.", "ARCHIVED", before.revision); next.recordHistory[before.id] = (next.recordHistory[before.id] || []).concat([{ revision: before.revision, at: now(), actor: actor(args.actor), action: "update", values: before.values }]).slice(-MAX_HISTORY); var record = clone(before); record.values = validation.normalizeValues(args.values || {}, current.schema, referenceContext(databases, current), record.values); record.revision++; record.updatedAt = now(); record.updatedBy = actor(args.actor); next.records[index] = record; next.revision++; next.updatedAt = record.updatedAt; next.updatedBy = record.updatedBy; return { databaseRevision: next.revision, record: publicRecord(record) }; }); }); }
   function archiveRecord(args) { return mutate(args.databaseId, args, "record", function (next) { var index = next.records.findIndex(function (record) { return record.id === validation.id(args.recordId, "record id"); }); if (index === -1) throw error("Knowledge database record not found.", "NOT_FOUND"); var before = next.records[index]; ensureRevision(args.expectedRevision, before.revision, "record"); next.recordHistory[before.id] = (next.recordHistory[before.id] || []).concat([{ revision: before.revision, at: now(), actor: actor(args.actor), action: args.recover === true ? "recover" : "archive", values: before.values, archivedAt: before.archivedAt }]).slice(-MAX_HISTORY); var record = clone(before); record.archivedAt = args.recover === true ? null : now(); record.revision++; record.updatedAt = now(); record.updatedBy = actor(args.actor); next.records[index] = record; next.revision++; next.updatedAt = record.updatedAt; next.updatedBy = record.updatedBy; return { databaseRevision: next.revision, record: publicRecord(record) }; }); }
   function readRecord(args) { return all().then(function (databases) { var item = databases.filter(function (entry) { return entry._id === validation.id(args.databaseId, "database id"); })[0]; if (!item) throw error("Knowledge database not found.", "NOT_FOUND"); var record = item.records.filter(function (entry) { return entry.id === validation.id(args.recordId, "record id"); })[0]; if (!record) throw error("Knowledge database record not found.", "NOT_FOUND"); return { database: publicDatabase(item, false), record: publicRecord(record, referenceStates(item, record, databases, settings)), title: titleValue(item, record), history: clone(item.recordHistory[record.id] || []) }; }); }
   function query(args) { return all().then(function (databases) { var item = databases.filter(function (entry) { return entry._id === validation.id(args.databaseId, "database id"); })[0]; if (!item) throw error("Knowledge database not found.", "NOT_FOUND"); if (item.archivedAt) throw error("Knowledge database is archived.", "ARCHIVED", item.revision); return queryRecords(item, args, databases, settings); }); }
-  function retryProjection(args) { return serialize(args.databaseId, function () { return load(args.databaseId).then(function (item) { return finish(item, { database: publicDatabase(item, false) }, actor(args.actor)); }); }); }
-  return { filename: filename, hasStore: function () { try { return fs.lstatSync(filename).isFile(); } catch (cause) { return false; } }, isReady: function () { return entry.ready === true; }, initialize: open, listCached: listCached, create: create, list: list, read: read, rename: rename, archive: archive, recover: function (args) { return archive(Object.assign({}, args, { recover: true })); }, updateSchema: updateSchema, saveView: saveView, createRecord: createRecord, updateRecord: updateRecord, archiveRecord: archiveRecord, recoverRecord: function (args) { return archiveRecord(Object.assign({}, args, { recover: true })); }, readRecord: readRecord, query: query, retryProjection: retryProjection };
+  function retryProjection(args) { return serialize(args.databaseId, function () { return load(args.databaseId).then(function (item) { guard(args, item, "saving"); return finish(item, { database: publicDatabase(item, false) }, actor(args.actor)).then(function (result) { guard(args, null, "saved"); return result; }); }); }); }
+  var importer = imports.attachKnowledgeDbImport({ clone: clone, error: error, actor: actor, newId: newId, mutationId: mutationId, fingerprint: fingerprint, ensureRevision: ensureRevision, receipt: receipt, remember: remember, serialize: serialize, load: load, all: all, referenceContext: referenceContext, replace: replace, guard: guard, finish: finish });
+  return { readStorageStatus: function () { return typeof storage.diagnostics === "function" ? storage.diagnostics() : Promise.resolve(null); }, importRecords: importer.importRecords, readImportProgress: importer.readImportProgress, hasStore: function () { return storage.hasStore(); }, isReady: function () { return storage.isReady(); }, initialize: function () { return Promise.resolve(storage.initialize()).then(function () {}); }, listCached: listCached, create: create, list: list, read: read, rename: rename, archive: archive, recover: function (args) { return archive(Object.assign({}, args, { recover: true })); }, updateSchema: updateSchema, saveView: saveView, createRecord: createRecord, updateRecord: updateRecord, archiveRecord: archiveRecord, recoverRecord: function (args) { return archiveRecord(Object.assign({}, args, { recover: true })); }, readRecord: readRecord, query: query, retryProjection: retryProjection };
 }
 
 module.exports = { createKnowledgeDbService: createKnowledgeDbService, MAX_HISTORY: MAX_HISTORY, MAX_PAGE: MAX_PAGE, MAX_AGGREGATE_BYTES: MAX_AGGREGATE_BYTES, IDEMPOTENCY_WINDOW_MS: IDEMPOTENCY_WINDOW_MS };

package/lib/knowledge-db-storage-nedb-maintenance.js

@@ -0,0 +1,99 @@
+var fs = require("fs");
+
+var MIN_COMPACTION_BYTES = 1024 * 1024;
+var MAX_WRITE_AMPLIFICATION = 3;
+var MAX_WRITES_WITHOUT_COMPACTION = 64;
+var FAILURE_HEADROOM_BYTES = 4 * 1024 * 1024;
+var FAILURE_AMPLIFICATION = 6;
+
+// Shared by every service instance for this filename. No interval or background work:
+// maintenance runs inside the same I/O gate as writes, reads and failed-write reloads.
+function attachKnowledgeDbNedbMaintenance(ctx) {
+  var entry = ctx.entry;
+  if (!entry.storage) entry.storage = {
+    queue: Promise.resolve(), store: null, cached: [], sizes: new Map(), liveBytes: 0,
+    journalBytes: 0, peakJournalBytes: 0, journalUnknown: false, successfulWrites: 0,
+    writesSinceCompaction: 0, compactions: 0, failedCompactions: 0, recoveries: 0,
+    maintenancePending: false, maintenanceError: null
+  };
+  var state = entry.storage;
+  function enqueue(work) {
+    var next = state.queue.catch(function () {}).then(work);
+    state.queue = next.catch(function () {}); return next;
+  }
+  function size(value) { return Buffer.byteLength(JSON.stringify(value), "utf8") + 1; }
+  function refresh(store) {
+    state.store = store; state.cached = store.getAllData(); state.sizes = new Map(); state.liveBytes = 0;
+    state.cached.forEach(function (value) { var bytes = size(value); state.sizes.set(value._id, bytes); state.liveBytes += bytes; });
+  }
+  function issue(cause) { state.maintenancePending = true; state.maintenanceError = cause.message || String(cause); }
+  async function measure() {
+    try {
+      state.journalBytes = (await fs.promises.stat(ctx.filename)).size; state.journalUnknown = false;
+      state.peakJournalBytes = Math.max(state.peakJournalBytes, state.journalBytes);
+      return true;
+    } catch (cause) { state.journalUnknown = true; issue(cause); return false; }
+  }
+  async function ensure() {
+    var store = await ctx.open();
+    if (state.store !== store) { refresh(store); await measure(); }
+    return store;
+  }
+  async function compact(store) {
+    try {
+      // Supported datastore API also participates in NeDB's own executor.
+      await store.compactDatafileAsync();
+      state.compactions++; state.writesSinceCompaction = 0;
+      if (await measure()) { state.maintenancePending = false; state.maintenanceError = null; }
+    } catch (cause) { state.failedCompactions++; issue(cause); await measure(); }
+  }
+  function due() {
+    return state.journalBytes > Math.max(MIN_COMPACTION_BYTES, MAX_WRITE_AMPLIFICATION * state.liveBytes) ||
+      state.writesSinceCompaction >= MAX_WRITES_WITHOUT_COMPACTION && state.journalBytes - state.liveBytes >= MIN_COMPACTION_BYTES;
+  }
+  function blocked() {
+    return state.maintenancePending && (state.journalUnknown || state.journalBytes > Math.max(FAILURE_HEADROOM_BYTES, FAILURE_AMPLIFICATION * state.liveBytes));
+  }
+  function read(work) { return enqueue(async function () { return work(await ensure()); }); }
+  function write(work, value) {
+    return enqueue(async function () {
+      var store = await ensure(); var attempted = false;
+      if (state.maintenancePending) { attempted = true; await compact(store); }
+      // Repeated maintenance failure cannot allow unbounded journal growth. This
+      // rejection happens before the next canonical write, never after its success.
+      if (blocked()) throw Object.assign(new Error("Knowledge database maintenance must recover before more writes: " + state.maintenanceError), { code: "STORAGE_MAINTENANCE_BLOCKED" });
+      var result;
+      try { result = await work(store); }
+      catch (cause) {
+        // NeDB changes indexes before appending. Hold the shared gate through reload
+        // so another database cannot compact or persist an unsaved in-memory state.
+        try {
+          await store.loadDatabaseAsync(); refresh(store); state.recoveries++; state.writesSinceCompaction = 0;
+          if (await measure()) { state.maintenancePending = false; state.maintenanceError = null; }
+        } catch (recoveryCause) { state.store = null; state.cached = []; issue(recoveryCause); ctx.invalidate(); }
+        throw cause;
+      }
+      if (result && result.numAffected === 0) return result;
+      var bytes = size(value); state.liveBytes += bytes - (state.sizes.get(value._id) || 0); state.sizes.set(value._id, bytes);
+      state.cached = store.getAllData(); state.successfulWrites++; state.writesSinceCompaction++;
+      if (await measure() && !attempted && due()) await compact(store);
+      // A maintenance error never changes a successful canonical write into a failure.
+      return result;
+    });
+  }
+  function status() {
+    return read(async function () {
+      await measure();
+      return { maintenancePending: state.maintenancePending, maintenanceError: state.maintenanceError,
+        liveBytes: state.liveBytes, journalBytes: state.journalBytes, peakJournalBytes: state.peakJournalBytes,
+        successfulWrites: state.successfulWrites, writesSinceCompaction: state.writesSinceCompaction,
+        compactions: state.compactions, failedCompactions: state.failedCompactions, recoveries: state.recoveries };
+    });
+  }
+  return { read: read, write: write, cached: function () { return state.cached; }, readStorageStatus: status };
+}
+
+module.exports = { attachKnowledgeDbNedbMaintenance: attachKnowledgeDbNedbMaintenance,
+  MIN_COMPACTION_BYTES: MIN_COMPACTION_BYTES, MAX_WRITE_AMPLIFICATION: MAX_WRITE_AMPLIFICATION,
+  MAX_WRITES_WITHOUT_COMPACTION: MAX_WRITES_WITHOUT_COMPACTION,
+  FAILURE_HEADROOM_BYTES: FAILURE_HEADROOM_BYTES, FAILURE_AMPLIFICATION: FAILURE_AMPLIFICATION };

package/lib/knowledge-db-storage-nedb.js

@@ -0,0 +1,66 @@
+var fs = require("fs");
+var path = require("path");
+var Datastore = require("@seald-io/nedb");
+var maintenance = require("./knowledge-db-storage-nedb-maintenance");
+var STORE_REGISTRY = new Map();
+
+function clone(value) { return JSON.parse(JSON.stringify(value)); }
+function error(message, code) { return Object.assign(new Error(message), { code: code }); }
+function createKnowledgeDbNedbStorage(options) {
+  var projectDir = path.resolve(options.projectDir); var projectReal = null;
+  var knowledgeDir = path.join(projectDir, "knowledge"); var dataDir = path.join(knowledgeDir, ".clay-db");
+  var filename = path.join(dataDir, "databases.db"); var entry = STORE_REGISTRY.get(filename);
+  if (!entry) { entry = { queues: new Map(), database: null, loading: null, ready: false }; STORE_REGISTRY.set(filename, entry); }
+  function safeDirectory(target, create) {
+    var stat;
+    try { stat = fs.lstatSync(target); }
+    catch (cause) { if (!create || cause.code !== "ENOENT") throw cause; fs.mkdirSync(target, { recursive: true, mode: 0o700 }); stat = fs.lstatSync(target); }
+    if (!stat.isDirectory() || stat.isSymbolicLink()) throw error("Knowledge database path is unsafe.", "UNSAFE_PATH");
+    var real = fs.realpathSync(target);
+    if (real !== projectReal && !real.startsWith(projectReal + path.sep)) throw error("Knowledge database path escapes the Mate project.", "UNSAFE_PATH");
+  }
+  function open() {
+    if (entry.loading) return entry.loading;
+    entry.loading = Promise.resolve().then(function () {
+      projectReal = fs.realpathSync(projectDir); safeDirectory(knowledgeDir, true); safeDirectory(dataDir, true);
+      var stat; try { stat = fs.lstatSync(filename); } catch (cause) { if (cause.code !== "ENOENT") throw cause; }
+      if (stat && (!stat.isFile() || stat.isSymbolicLink())) throw error("Knowledge database file is unsafe.", "UNSAFE_PATH");
+      entry.database = new Datastore({ filename: filename }); return entry.database.loadDatabaseAsync();
+    }).then(function () { return entry.database.ensureIndexAsync({ fieldName: "_id", unique: true }); })
+      .then(function () { entry.ready = true; return entry.database; })
+      .catch(function (cause) { invalidate(); throw cause; });
+    return entry.loading;
+  }
+  function invalidate() { entry.database = null; entry.loading = null; entry.ready = false; }
+  var io = maintenance.attachKnowledgeDbNedbMaintenance({ entry: entry, filename: filename, open: open, invalidate: invalidate });
+  function serialize(scope, work) {
+    var previous = entry.queues.get(scope) || Promise.resolve(); var next = previous.catch(function () {}).then(function () { return work(); });
+    entry.queues.set(scope, next.catch(function () {})); return next;
+  }
+  function insert(snapshot) {
+    var value = clone(snapshot);
+    return io.write(function (store) { return store.insertAsync(value); }, value).then(function () {}, function (cause) {
+      if (cause.errorType === "uniqueViolated") throw error("Knowledge storage identity already exists.", "ALREADY_EXISTS");
+      throw cause;
+    });
+  }
+  function replaceIfRevision(id, revision, snapshot) {
+    var value = clone(snapshot);
+    if (value._id !== id) return Promise.reject(error("Knowledge storage replacement identity must match.", "INVALID_STORAGE_ID"));
+    return io.write(function (store) { return store.updateAsync({ _id: id, revision: revision }, value, {}); }, value)
+      .then(function (result) { return result.numAffected === 1; });
+  }
+  return {
+    contractVersion: 1,
+    initialize: function () { return io.read(function () {}); },
+    hasStore: function () { try { return fs.lstatSync(filename).isFile(); } catch (cause) { return false; } },
+    isReady: function () { return entry.ready === true; },
+    get: function (id) { return io.read(function (store) { return store.findOneAsync({ _id: id }); }); },
+    list: function () { return io.read(function (store) { return store.findAsync({}); }); },
+    getCached: function () { return clone(io.cached()); },
+    insert: insert, replaceIfRevision: replaceIfRevision, serialize: serialize,
+    diagnostics: function () { return io.readStorageStatus().then(function (status) { return Object.assign({ engine: "nedb", automaticCompaction: false }, status); }); }
+  };
+}
+
+module.exports = { createKnowledgeDbNedbStorage: createKnowledgeDbNedbStorage };

package/lib/knowledge-db-storage.js

@@ -0,0 +1,72 @@
+// Version 1 persists opaque JSON aggregate snapshots with a stable _id and revision.
+// _id is the existing Knowledge identity, not a query expression. Engines may map it
+// to their own primary key; aggregate format/limits remain application responsibilities.
+// Each adapter is bound to one server-authorized Mate-project store; get/list cannot
+// broaden that scope. Facades for the same store must share locks and committed cache.
+//
+// initialize() -> Promise<void>; hasStore()/isReady() -> boolean.
+// get(id) -> Promise<snapshot|null>; list() -> Promise<snapshot[]>;
+// getCached() -> snapshot[] (committed, detached, no initialization side effect).
+// insert(snapshot) -> Promise<void> (reject ALREADY_EXISTS; never overwrite).
+// replaceIfRevision(id, revision, snapshot) -> Promise<boolean>: atomic compare and
+// full replacement, false on missing/mismatch without writing. Same-revision writes
+// are allowed for receipts/projection status. Identity must remain unchanged.
+// serialize(scope, work) -> Promise<result>: same-scope callbacks exclude each other
+// across all facades of one physical store. Callback receives no engine objects and
+// may await adapter operations; this is not a multi-aggregate transaction or I/O lock.
+// Engines separately serialize reads/writes/maintenance/recovery as needed. A failed
+// write may have committed durably; restore readable committed state before releasing
+// the I/O gate, or invalidate it. Never turn committed success into maintenance failure.
+// Domain operation receipts resolve ambiguous retries; the adapter does not own them.
+// diagnostics() -> Promise<JSON> is optional, engine-specific and never a native handle.
+
+var METHODS = ["initialize", "hasStore", "isReady", "get", "list", "getCached", "insert", "replaceIfRevision", "serialize"];
+function invalid(message) { return Object.assign(new Error("Invalid Knowledge storage adapter: " + message), { code: "INVALID_STORAGE_ADAPTER" }); }
+function validateAdapter(adapter) {
+  if (!adapter || typeof adapter !== "object" || adapter.contractVersion !== 1) throw invalid("contractVersion must be 1.");
+  METHODS.forEach(function (name) { if (typeof adapter[name] !== "function") throw invalid(name + " must be a function."); });
+  if (adapter.diagnostics !== undefined && typeof adapter.diagnostics !== "function") throw invalid("diagnostics must be a function when supplied.");
+  return adapter;
+}
+function bindAdapter(adapter) {
+  function snapshot(value) {
+    if (!value || Object.getPrototypeOf(value) !== Object.prototype || typeof value._id !== "string" || !Number.isInteger(value.revision)) throw invalid("snapshot must be a plain aggregate with _id and integer revision.");
+    return value;
+  }
+  function snapshots(values) { if (!Array.isArray(values)) throw invalid("list/getCached must return an array."); values.forEach(snapshot); return values; }
+  function call(name, args, check) {
+    var result;
+    try { result = adapter[name].apply(adapter, args); } catch (cause) { return Promise.reject(cause); }
+    if (!result || typeof result.then !== "function") return Promise.reject(invalid(name + " must return a Promise."));
+    return result.then(check);
+  }
+  function flag(name) { var value = adapter[name](); if (typeof value !== "boolean") throw invalid(name + " must return a boolean."); return value; }
+  var bound = {
+    contractVersion: 1,
+    initialize: function () { return call("initialize", [], function () {}); },
+    hasStore: function () { return flag("hasStore"); }, isReady: function () { return flag("isReady"); },
+    get: function (id) { return call("get", [id], function (value) { if (value === null) return null; snapshot(value); if (value._id !== id) throw invalid("get returned a different identity."); return value; }); },
+    list: function () { return call("list", [], snapshots); }, getCached: function () { return snapshots(adapter.getCached()); },
+    insert: function (value) { return call("insert", [value], function (result) { if (result !== undefined) throw invalid("insert must resolve without a native result."); }); },
+    replaceIfRevision: function (id, revision, value) { return call("replaceIfRevision", [id, revision, value], function (result) { if (typeof result !== "boolean") throw invalid("replaceIfRevision must resolve to a boolean."); return result; }); },
+    serialize: function (scope, work) { return call("serialize", [scope, function () { return work(); }], function (result) { return result; }); }
+  };
+  if (typeof adapter.diagnostics === "function") bound.diagnostics = function () {
+    return call("diagnostics", [], function (result) { try { return JSON.parse(JSON.stringify(result)); } catch (cause) { throw invalid("diagnostics must resolve to JSON data."); } });
+  };
+  return bound;
+}
+function createDefaultKnowledgeDbStorage(options) {
+  // Lazy engine loading: injected adapters can run domain code without NeDB installed.
+  return require("./knowledge-db-storage-nedb").createKnowledgeDbNedbStorage(options);
+}
+function createKnowledgeDbStorage(options) {
+  var settings = options || {}; var adapter;
+  if (settings.storageAdapter !== undefined) adapter = settings.storageAdapter;
+  else if (settings.storageFactory !== undefined) {
+    if (typeof settings.storageFactory !== "function") throw invalid("storageFactory must be a synchronous function.");
+    adapter = settings.storageFactory({ projectDir: settings.projectDir });
+  } else adapter = module.exports.createDefaultKnowledgeDbStorage({ projectDir: settings.projectDir });
+  return bindAdapter(validateAdapter(adapter));
+}
+module.exports = { createKnowledgeDbStorage: createKnowledgeDbStorage, createDefaultKnowledgeDbStorage: createDefaultKnowledgeDbStorage, validateAdapter: validateAdapter, invalid: invalid };

package/lib/knowledge-document-index.js

@@ -18,7 +18,8 @@ function createKnowledgeDocumentIndex(options) {
       if (file.size > options.maxDocumentBytes) { errors.push({ name: file.name, code: "TOO_LARGE", error: "Document exceeds the safe read limit." }); continue; }
       if (known && token && known.token === token) {
         if (bytes + known.bytes > MAX_INDEX_BYTES) { errors.push({ name: file.name, code: "INDEX_LIMIT", error: "Workspace Knowledge exceeds the safe index limit." }); continue; }
-        next[key] = known; documents.push(known.document); bytes += known.bytes; continue;
+        var fresh = Object.assign({}, known, { document: Object.assign({}, known.document, file) });
+        next[key] = fresh; documents.push(fresh.document); bytes += known.bytes; continue;
       }
       try { content = options.read(file); } catch (error) { errors.push({ name: file.name, code: error.code || "READ_FAILED", error: error.message }); continue; }
       var size = Buffer.byteLength(content, "utf8");

package/lib/knowledge-file-store.js

@@ -136,7 +136,13 @@ function createKnowledgeFileStore(cwd, options) {
     var listed = list(); var identity = listed.filter(function (entry) { return entry.name === item.name; })[0]; if (!identity) return; ensureMetadata(true);
     var folder = path.join(historyRoot, identity.id); safeDirectory(folder, true);
     var target = path.join(folder, Date.now() + "-" + item.revision + ".md");
-    fs.writeFileSync(target, item.content, { flag: "wx", mode: 0o600 });
+    try { fs.writeFileSync(target, item.content, { flag: "wx", mode: 0o600 }); }
+    catch (error) {
+      // A move and its link rewrite can snapshot the same revision in one millisecond.
+      if (error.code !== "EEXIST") throw error;
+      var stat = fs.lstatSync(target);
+      if (!stat.isFile() || stat.isSymbolicLink() || fs.readFileSync(target, "utf8") !== item.content) throw error;
+    }
   }
   function save(name, content, expectedRevision) {
     var clean = cleanName(name); if (!clean || itemType(clean) !== "text") throw new Error("Only valid Markdown documents can be edited.");

package/lib/knowledge-product-operations.js

@@ -0,0 +1,46 @@
+var validName = require('./knowledge-file-store').validName;
+// Narrow operations over the same document store used by the Knowledge workbench.
+function createKnowledgeProductOperations(ctx) {
+  function find(args, deleted) {
+    var item = args.documentId ? ctx.files.list().concat(deleted ? ctx.files.deleted() : []).find(function (entry) { return entry.id === args.documentId; }) : null;
+    if (args.documentId && !item) throw Object.assign(new Error('Knowledge document not found.'), { code: 'ENOENT' });
+    var name = args.name || item && item.name;
+    if (!name || item && args.name && args.name !== item.name) throw new Error('Choose one exact Knowledge document.');
+    if (item && item.deleted) return item;
+    var current = ctx.files.read(name);
+    if (current.itemType !== 'text') throw new Error('Legacy JSONL sources are read-only.');
+    return current;
+  }
+  function read(args) { var item = find(args); return { documentId: item.id, name: item.name, revision: item.revision, content: item.content }; }
+  function saved(item, who) { return Object.assign({ documentId: item.id, name: item.name, revision: item.revision, persisted: true }, ctx.mirror(who, [item.name])); }
+  function snapshot(op) {
+    if (op.action === 'retry_document_sync' && op.names.some(function (name) { return !validName(name); })) throw new Error('Invalid Knowledge source name.');
+    if (op.action === 'create_document') return ctx.files.list().filter(function (item) { return item.name === op.name; });
+    if (op.action === 'retry_document_sync') return ctx.files.list().filter(function (item) { return op.names.indexOf(item.name) >= 0; });
+    var item = find(op, op.action === 'restore_document');
+    var result = { documentId: item.id, name: item.name, revision: item.revision, deleted: !!item.deleted };
+    if (op.action === 'restore_document') result.version = ctx.files.readHistory(item.id, op.version);
+    if (op.action === 'rename_document') result.documents = ctx.files.list();
+    return result;
+  }
+  function mutate(op, who) {
+    if (op.action === 'create_document') return saved(ctx.files.save(op.name, op.content, null), who);
+    if (op.action === 'retry_document_sync') return Object.assign({ persisted: true }, ctx.mirror(who, op.names));
+    var item = find(op, op.action === 'restore_document');
+    if (op.action === 'update_document') return saved(ctx.files.save(item.name, op.content, op.expectedRevision), who);
+    if (op.action === 'rename_document') return ctx.rename({ from: item.name, name: op.newName, documentId: item.id, expectedRevision: op.expectedRevision }, who);
+    if (op.action === 'delete_document') { ctx.files.remove(item.name, op.expectedRevision); return Object.assign({ documentId: item.id, name: item.name, persisted: true, deleted: true }, ctx.mirror(who, [item.name])); }
+    if (op.action === 'restore_document') return saved(ctx.files.restore(item.id, op.version, item.name, item.deleted ? null : op.expectedRevision), who);
+    throw new Error('Unsupported Knowledge document operation.');
+  }
+  function query(op) {
+    if (op.action === 'list_documents') return { documents: op.deleted ? ctx.files.deleted() : ctx.files.list() };
+    if (op.action === 'read_document') return read(op);
+    var item = find(op, true);
+    if (op.action === 'document_history') return { documentId: item.id, name: item.name, versions: ctx.files.history(item.id) };
+    if (op.action === 'read_document_version') return Object.assign({ documentId: item.id, name: item.name }, ctx.files.readHistory(item.id, op.version));
+    throw new Error('Unsupported Knowledge document query.');
+  }
+  return { query: query, snapshot: snapshot, mutate: mutate };
+}
+module.exports = { createKnowledgeProductOperations: createKnowledgeProductOperations };

package/lib/mate-avatar-catalog.js

@@ -0,0 +1,12 @@
+// Stable catalog identities are the only accepted library references.
+var catalog = require('./public/mate-avatars/catalog.json');
+var ids = new Set(catalog.map(function (entry) { return entry.id; }));
+function valid(id) { return typeof id === 'string' && ids.has(id); }
+function validate(profile, mate) {
+  if (profile !== undefined && (!profile || typeof profile !== 'object' || Array.isArray(profile))) return 'Choose a valid Mate profile.';
+  if (profile && Object.prototype.hasOwnProperty.call(profile, 'avatarCatalogId') && profile.avatarCatalogId !== '' && !valid(profile.avatarCatalogId) && !(profile.avatarCatalogId === 'lead-clay' && mate && mate.builtinKey === 'clay')) {
+    return 'Choose an avatar from the Clay catalog.';
+  }
+  return null;
+}
+module.exports = { valid: valid, validate: validate };

package/lib/mate-avatar-migration.js

@@ -0,0 +1,41 @@
+// Stable v1 migration, run only against the caller's normal Mate registry.
+var catalog = require('./mate-avatar-catalog');
+var managedArtwork = { clay: ['/clay-studio-symbol.png', '/mates/ally.png', '/mate-avatars/lead-clay.png'], ally: ['/mates/ally.png'] };
+function mappedId(mate) {
+  var p = mate.profile || mate;
+  var key = JSON.stringify([mate.id || '', p.avatarStyle || 'imprint', p.avatarSeed || mate.id || p.displayName || mate.name || 'Mate']);
+  var hash = 2166136261;
+  for (var i = 0; i < key.length; i++) hash = Math.imul(hash ^ key.charCodeAt(i), 16777619) >>> 0;
+  var index = hash % 96;
+  return (index < 48 ? 'B' : 'C') + String(index % 48 + 1).padStart(2, '0');
+}
+function hasCustom(mate) {
+  var p = mate.profile || {};
+  var custom = p.avatarCustom || mate.avatarCustom;
+  if (!custom) return false;
+  var managed = managedArtwork[mate.builtinKey] || [];
+  return managed.indexOf(custom) === -1;
+}
+function normalizeMate(mate) {
+  if (!mate || hasCustom(mate)) return false;
+  var before = JSON.stringify(mate.profile || {});
+  var p = Object.assign({}, mate.profile || {});
+  p.avatarCatalogId = mate.builtinKey === 'clay' ? 'lead-clay' : catalog.valid(p.avatarCatalogId) ? p.avatarCatalogId : mappedId(mate);
+  p.avatarStyle = 'catalog';
+  delete p.avatarSeed;
+  if (p.avatarCustom) p.avatarCustom = '';
+  if (mate.builtinKey === 'clay') p.avatarLocked = true;
+  if (before === JSON.stringify(p) && !Object.prototype.hasOwnProperty.call(mate, 'avatarStyle') && !Object.prototype.hasOwnProperty.call(mate, 'avatarSeed') && !Object.prototype.hasOwnProperty.call(mate, 'avatarCustom')) return false;
+  mate.profile = p;
+  delete mate.avatarStyle;
+  delete mate.avatarSeed;
+  delete mate.avatarCustom;
+  return true;
+}
+function migrate(data) {
+  var changed = false;
+  data.mates.forEach(function (mate) { if (normalizeMate(mate)) changed = true; });
+  if (data.avatarCatalogMigrationVersion !== 1) { data.avatarCatalogMigrationVersion = 1; changed = true; }
+  return changed;
+}
+module.exports = { mappedId: mappedId, hasCustom: hasCustom, normalizeMate: normalizeMate, migrate: migrate };