@dxos/index-core 0.8.4-main.9be5663bfe → 0.8.4-main.bc2380dfbc

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/README.md

@@ -18,4 +18,4 @@ pnpm i @dxos/index-core
 
 Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
 
-License: [MIT](./LICENSE) Copyright 2022 © DXOS
+License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2022 © DXOS

package/dist/lib/neutral/index.mjs

@@ -1,5 +1,6 @@
 // src/index-engine.ts
 import * as Effect5 from "effect/Effect";
+import { ATTR_TYPE as ATTR_TYPE2 } from "@dxos/echo/internal";
 import * as SqlTransaction from "@dxos/sql-sqlite/SqlTransaction";
 
 // src/index-tracker.ts
@@ -88,6 +89,7 @@ var IndexTracker = class {
 // src/indexes/fts-index.ts
 import * as SqlClient3 from "@effect/sql/SqlClient";
 import * as Effect2 from "effect/Effect";
+var SQL_CHUNK_SIZE = 500;
 var escapeFts5Query = (text) => {
   return text.split(/\s+/).filter(Boolean).map((term) => `"${term.replace(/"/g, '""')}"`).join(" ");
 };
@@ -149,6 +151,7 @@ var FtsIndex = class {
   /**
   * Query snapshots by recordIds.
   * Returns the parsed JSON snapshots for queue objects.
+  * RecordIds not present in the FTS index are silently omitted from the result.
   */
   querySnapshotsJSON(recordIds) {
     return Effect2.gen(function* () {
@@ -156,11 +159,21 @@ var FtsIndex = class {
         return [];
       }
       const sql = yield* SqlClient3.SqlClient;
-      const results = yield* sql`SELECT rowid, snapshot FROM ftsIndex WHERE rowid IN ${sql.in(recordIds)}`;
-      return results.map((r) => ({
-        recordId: r.rowid,
-        snapshot: JSON.parse(r.snapshot)
-      }));
+      const chunks = [];
+      for (let i = 0; i < recordIds.length; i += SQL_CHUNK_SIZE) {
+        chunks.push(recordIds.slice(i, i + SQL_CHUNK_SIZE));
+      }
+      const allResults = [];
+      for (const chunk of chunks) {
+        const rows = yield* sql`SELECT rowid, snapshot FROM ftsIndex WHERE rowid IN ${sql.in(chunk)}`;
+        for (const r of rows) {
+          allResults.push({
+            recordId: r.rowid,
+            snapshot: JSON.parse(r.snapshot)
+          });
+        }
+      }
+      return allResults;
     });
   }
   update = Effect2.fn("FtsIndex.update")((objects) => Effect2.gen(function* () {
@@ -196,11 +209,13 @@ var ObjectMeta = Schema2.Struct({
   recordId: Schema2.Number,
   objectId: Schema2.String,
   queueId: Schema2.String,
+  /** Queue subspace namespace (e.g. 'data', 'trace'). Empty string for non-queue objects. */
+  queueNamespace: Schema2.String,
   spaceId: Schema2.String,
   documentId: Schema2.String,
   entityKind: Schema2.String,
   /** The versioned DXN of the type of the object. */
-  typeDxn: Schema2.String,
+  typeDXN: Schema2.String,
   deleted: Schema2.Boolean,
   source: Schema2.NullOr(Schema2.String),
   target: Schema2.NullOr(Schema2.String),
@@ -237,10 +252,11 @@ var ObjectMetaIndex = class {
       recordId INTEGER PRIMARY KEY AUTOINCREMENT,
       objectId TEXT NOT NULL,
       queueId TEXT NOT NULL DEFAULT '',
+      queueNamespace TEXT NOT NULL DEFAULT '',
       spaceId TEXT NOT NULL,
       documentId TEXT NOT NULL DEFAULT '',
       entityKind TEXT NOT NULL,
-      typeDxn TEXT NOT NULL,
+      typeDXN TEXT NOT NULL,
       deleted INTEGER NOT NULL,
       source TEXT,
       target TEXT,
@@ -252,8 +268,9 @@ var ObjectMetaIndex = class {
     yield* Effect3.catchAll(sql`ALTER TABLE objectMeta ADD COLUMN parent TEXT`, () => Effect3.void);
     yield* Effect3.catchAll(sql`ALTER TABLE objectMeta ADD COLUMN createdAt INTEGER`, () => Effect3.void);
     yield* Effect3.catchAll(sql`ALTER TABLE objectMeta ADD COLUMN updatedAt INTEGER`, () => Effect3.void);
+    yield* Effect3.catchAll(sql`ALTER TABLE objectMeta ADD COLUMN queueNamespace TEXT NOT NULL DEFAULT ''`, () => Effect3.void);
     yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_objectId ON objectMeta(spaceId, objectId)`;
-    yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_typeDxn ON objectMeta(spaceId, typeDxn)`;
+    yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_typeDXN ON objectMeta(spaceId, typeDXN)`;
     yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_version ON objectMeta(version)`;
     yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_parent ON objectMeta(spaceId, parent)`;
     yield* sql`CREATE INDEX IF NOT EXISTS idx_object_index_updatedAt ON objectMeta(updatedAt)`;
@@ -261,8 +278,8 @@ var ObjectMetaIndex = class {
   });
   query = Effect3.fn("ObjectMetaIndex.query")((query) => Effect3.gen(function* () {
     const sql = yield* SqlClient5.SqlClient;
-    const parsedType = DXN.tryParse(query.typeDxn)?.asTypeDXN();
-    const rows = parsedType && parsedType.version === void 0 ? yield* sql`SELECT * FROM objectMeta WHERE spaceId = ${query.spaceId} AND (typeDxn = ${query.typeDxn} OR typeDxn LIKE ${_escapeLikePrefix(query.typeDxn)} ESCAPE '\\')` : yield* sql`SELECT * FROM objectMeta WHERE spaceId = ${query.spaceId} AND typeDxn = ${query.typeDxn}`;
+    const parsedType = DXN.tryParse(query.typeDXN)?.asTypeDXN();
+    const rows = parsedType && parsedType.version === void 0 ? yield* sql`SELECT * FROM objectMeta WHERE spaceId = ${query.spaceId} AND (typeDXN = ${query.typeDXN} OR typeDXN LIKE ${_escapeLikePrefix(query.typeDXN)} ESCAPE '\\')` : yield* sql`SELECT * FROM objectMeta WHERE spaceId = ${query.spaceId} AND typeDXN = ${query.typeDXN}`;
     return rows.map((row) => ({
       ...row,
       deleted: !!row.deleted
@@ -298,12 +315,12 @@ var ObjectMetaIndex = class {
     }
     const sql = yield* SqlClient5.SqlClient;
     const sourceCondition = buildSourceCondition(sql, spaceIds, includeAllQueues, queueIds);
-    const typeWhere = sql.or(typeDxns.map((typeDxn) => {
-      const parsedType = DXN.tryParse(typeDxn)?.asTypeDXN();
+    const typeWhere = sql.or(typeDxns.map((typeDXN) => {
+      const parsedType = DXN.tryParse(typeDXN)?.asTypeDXN();
       return parsedType && parsedType.version === void 0 ? sql.or([
-        sql`typeDxn = ${typeDxn}`,
-        sql`typeDxn LIKE ${_escapeLikePrefix(typeDxn)} ESCAPE '\\'`
-      ]) : sql`typeDxn = ${typeDxn}`;
+        sql`typeDXN = ${typeDXN}`,
+        sql`typeDXN LIKE ${_escapeLikePrefix(typeDXN)} ESCAPE '\\'`
+      ]) : sql`typeDXN = ${typeDXN}`;
     }));
     const rows = inverted ? yield* sql`SELECT * FROM objectMeta WHERE ${sourceCondition} AND NOT ${typeWhere}` : yield* sql`SELECT * FROM objectMeta WHERE ${sourceCondition} AND ${typeWhere}`;
     return rows.map((row) => ({
@@ -327,7 +344,7 @@ var ObjectMetaIndex = class {
   update = Effect3.fn("ObjectMetaIndex.update")((objects) => Effect3.gen(function* () {
     const sql = yield* SqlClient5.SqlClient;
     yield* Effect3.forEach(objects, (object) => Effect3.gen(function* () {
-      const { spaceId, queueId, documentId, data } = object;
+      const { spaceId, queueId, queueNamespace, documentId, data } = object;
       const castData = data;
       const objectId = castData.id;
       let existing;
@@ -342,7 +359,7 @@ var ObjectMetaIndex = class {
       const [{ v }] = result;
       const version = (v ?? 0) + 1;
       const entityKind = castData[ATTR_RELATION_SOURCE] ? "relation" : "object";
-      const typeDxn = castData[ATTR_TYPE] ? String(castData[ATTR_TYPE]) : "type";
+      const typeDXN = castData[ATTR_TYPE] ? String(castData[ATTR_TYPE]) : "type";
       const deleted = castData[ATTR_DELETED] ? 1 : 0;
       const source = entityKind === "relation" ? castData[ATTR_RELATION_SOURCE] ?? null : null;
       const target = entityKind === "relation" ? castData[ATTR_RELATION_TARGET] ?? null : null;
@@ -352,8 +369,9 @@ var ObjectMetaIndex = class {
         yield* sql`
                   UPDATE objectMeta SET
                     version = ${version},
+                    queueNamespace = ${queueNamespace ?? ""},
                     entityKind = ${entityKind},
-                    typeDxn = ${typeDxn},
+                    typeDXN = ${typeDXN},
                     deleted = ${deleted},
                     source = ${source},
                     target = ${target},
@@ -364,12 +382,12 @@ var ObjectMetaIndex = class {
       } else {
         yield* sql`
                   INSERT INTO objectMeta (
-                    objectId, queueId, spaceId, documentId, 
-                    entityKind, typeDxn, deleted, source, target, parent, version,
+                    objectId, queueId, queueNamespace, spaceId, documentId,
+                    entityKind, typeDXN, deleted, source, target, parent, version,
                     createdAt, updatedAt
                   ) VALUES (
-                    ${objectId}, ${queueId ?? ""}, ${spaceId}, ${documentId ?? ""}, 
-                    ${entityKind}, ${typeDxn}, ${deleted}, 
+                    ${objectId}, ${queueId ?? ""}, ${queueNamespace ?? ""}, ${spaceId}, ${documentId ?? ""},
+                    ${entityKind}, ${typeDXN}, ${deleted},
                     ${source}, ${target}, ${parent}, ${version},
                     ${sourceTimestamp}, ${sourceTimestamp}
                   )
@@ -460,13 +478,18 @@ var ObjectMetaIndex = class {
   }));
   /**
   * Query children by parent object ids.
+  * Matches both:
+  * - Objects whose `parent` field references one of the given parent ids (standard parent/child hierarchy).
+  * - Queue items whose `queueId` equals one of the parent ids (e.g. items inside a Feed, since a feed's queue
+  *   DXN uses the feed's object id as its queue id — see `Feed.getQueueDxn`).
   */
   queryChildren = Effect3.fn("ObjectMetaIndex.queryChildren")((query) => Effect3.gen(function* () {
     if (query.parentIds.length === 0) {
       return [];
     }
     const sql = yield* SqlClient5.SqlClient;
-    const rows = yield* sql`SELECT * FROM objectMeta WHERE spaceId IN ${sql.in(query.spaceId)} AND parent IN ${sql.in(query.parentIds.map((id) => DXN.fromLocalObjectId(id).toString()))}`;
+    const parentDxns = query.parentIds.map((id) => DXN.fromLocalObjectId(id).toString());
+    const rows = yield* sql`SELECT * FROM objectMeta WHERE ${sql.in("spaceId", query.spaceId)} AND (${sql.in("parent", parentDxns)} OR ${sql.in("queueId", query.parentIds)})`;
     return rows.map((row) => ({
       ...row,
       deleted: !!row.deleted
@@ -495,15 +518,7 @@ var EscapedPropPath = class extends Schema3.String.annotations({
     let current = "";
     for (let i = 0; i < path.length; i++) {
       if (path[i] === "\\") {
-        invariant(i + 1 < path.length && (path[i + 1] === "." || path[i + 1] === "\\"), "Malformed escaping.", {
-          F: __dxlog_file,
-          L: 34,
-          S: this,
-          A: [
-            "i + 1 < path.length && (path[i + 1] === '.' || path[i + 1] === '\\\\')",
-            "'Malformed escaping.'"
-          ]
-        });
+        invariant(i + 1 < path.length && (path[i + 1] === "." || path[i + 1] === "\\"), "Malformed escaping.", { "~LogMeta": "~LogMeta", F: __dxlog_file, L: 25, S: this, A: ["i + 1 < path.length && (path[i + 1] === '.' || path[i + 1] === '\\\\')", "'Malformed escaping.'"] });
         current = current + path[i + 1];
         i++;
       } else if (path[i] === ".") {
@@ -530,7 +545,7 @@ var extractReferences = (data) => {
       }
       refs.push({
         path,
-        targetDxn: dxn.toString()
+        targetDXN: dxn.toString()
       });
     } else if (typeof value === "object" && value !== null && !Array.isArray(value)) {
       for (const [key, v] of Object.entries(value)) {
@@ -553,7 +568,7 @@ var extractReferences = (data) => {
 };
 var ReverseRef = Schema4.Struct({
   recordId: Schema4.Number,
-  targetDxn: Schema4.String,
+  targetDXN: Schema4.String,
   /**
   * Escaped property path within an object.
   *
@@ -570,18 +585,18 @@ var ReverseRefIndex = class {
     const sql = yield* SqlClient7.SqlClient;
     yield* sql`CREATE TABLE IF NOT EXISTS reverseRef (
       recordId INTEGER NOT NULL,
-      targetDxn TEXT NOT NULL,
+      targetDXN TEXT NOT NULL,
       propPath TEXT NOT NULL,
-      PRIMARY KEY (recordId, targetDxn, propPath)
+      PRIMARY KEY (recordId, targetDXN, propPath)
     )`;
-    yield* sql`CREATE INDEX IF NOT EXISTS idx_reverse_ref_target ON reverseRef(targetDxn)`;
+    yield* sql`CREATE INDEX IF NOT EXISTS idx_reverse_ref_target ON reverseRef(targetDXN)`;
   });
   /**
   * Query all references pointing to a target DXN.
   */
-  query = Effect4.fn("ReverseRefIndex.query")(({ targetDxn }) => Effect4.gen(function* () {
+  query = Effect4.fn("ReverseRefIndex.query")(({ targetDXN }) => Effect4.gen(function* () {
     const sql = yield* SqlClient7.SqlClient;
-    const rows = yield* sql`SELECT * FROM reverseRef WHERE targetDxn = ${targetDxn}`;
+    const rows = yield* sql`SELECT * FROM reverseRef WHERE targetDXN = ${targetDXN}`;
     return rows;
   }));
   update = Effect4.fn("ReverseRefIndex.update")((objects) => Effect4.gen(function* () {
@@ -593,7 +608,7 @@ var ReverseRefIndex = class {
       }
       yield* sql`DELETE FROM reverseRef WHERE recordId = ${recordId}`;
       const refs = extractReferences(data);
-      yield* Effect4.forEach(refs, (ref) => sql`INSERT INTO reverseRef (recordId, targetDxn, propPath) VALUES (${recordId}, ${ref.targetDxn}, ${EscapedPropPath.escape(ref.path)})`, {
+      yield* Effect4.forEach(refs, (ref) => sql`INSERT INTO reverseRef (recordId, targetDXN, propPath) VALUES (${recordId}, ${ref.targetDXN}, ${EscapedPropPath.escape(ref.path)})`, {
         discard: true
       });
     }), {
@@ -603,6 +618,33 @@ var ReverseRefIndex = class {
 };
 
 // src/index-engine.ts
+var makeEmptyIndexingResult = () => ({
+  updated: 0,
+  done: true,
+  spaces: /* @__PURE__ */ new Set(),
+  queues: /* @__PURE__ */ new Set(),
+  documents: /* @__PURE__ */ new Set(),
+  types: /* @__PURE__ */ new Set(),
+  objects: /* @__PURE__ */ new Set()
+});
+var accumulateIndexingResult = (acc, objects) => {
+  for (const obj of objects) {
+    acc.spaces.add(obj.spaceId);
+    if (obj.queueId) {
+      acc.queues.add(obj.queueId);
+    }
+    if (obj.documentId) {
+      acc.documents.add(obj.documentId);
+    }
+    const t = obj.data[ATTR_TYPE2];
+    if (t) {
+      acc.types.add(String(t));
+    }
+    if (obj.data.id) {
+      acc.objects.add(obj.data.id);
+    }
+  }
+};
 var IndexEngine = class {
   #tracker;
   #objectMetaIndex;
@@ -669,26 +711,24 @@ var IndexEngine = class {
   }
   update(ctx, dataSource, opts) {
     return Effect5.gen(this, function* () {
-      let updated = 0;
-      let done = true;
-      const { updated: updatedFtsIndex, done: doneFtsIndex } = yield* this.#update(ctx, this.#ftsIndex, dataSource, {
+      const result = makeEmptyIndexingResult();
+      const { updated: updatedFtsIndex, done: doneFtsIndex, objects: ftsObjects } = yield* this.#update(ctx, this.#ftsIndex, dataSource, {
         indexName: "fts5",
         spaceId: opts.spaceId,
         limit: opts.limit
       });
-      updated += updatedFtsIndex;
-      done = done && doneFtsIndex;
-      const { updated: updatedReverseRefIndex, done: doneReverseRefIndex } = yield* this.#update(ctx, this.#reverseRefIndex, dataSource, {
+      result.updated += updatedFtsIndex;
+      result.done = result.done && doneFtsIndex;
+      accumulateIndexingResult(result, ftsObjects);
+      const { updated: updatedReverseRefIndex, done: doneReverseRefIndex, objects: reverseRefObjects } = yield* this.#update(ctx, this.#reverseRefIndex, dataSource, {
         indexName: "reverseRef",
         spaceId: opts.spaceId,
         limit: opts.limit
       });
-      updated += updatedReverseRefIndex;
-      done = done && doneReverseRefIndex;
-      return {
-        updated,
-        done
-      };
+      result.updated += updatedReverseRefIndex;
+      result.done = result.done && doneReverseRefIndex;
+      accumulateIndexingResult(result, reverseRefObjects);
+      return result;
     }).pipe(Effect5.withSpan("IndexEngine.update"));
   }
   /**
@@ -716,7 +756,8 @@ var IndexEngine = class {
         if (objects.length === 0) {
           return {
             updated: 0,
-            done: true
+            done: true,
+            objects: []
           };
         }
         yield* this.#objectMetaIndex.update(objects);
@@ -731,7 +772,8 @@ var IndexEngine = class {
         })));
         return {
           updated: objects.length,
-          done: false
+          done: false,
+          objects
         };
       }));
     }).pipe(Effect5.withSpan("IndexEngine.#update"));