@dxos/index-core 0.0.0 → 0.8.4-main.03d5cd7b56

package/dist/types/src/indexes/object-meta-index.d.ts

@@ -0,0 +1,94 @@
+import * as SqlClient from '@effect/sql/SqlClient';
+import type * as SqlError from '@effect/sql/SqlError';
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+import { type ObjectId, type SpaceId } from '@dxos/keys';
+import type { IndexerObject } from './interface';
+import type { Index } from './interface';
+export declare const ObjectMeta: Schema.Struct<{
+    recordId: typeof Schema.Number;
+    objectId: typeof Schema.String;
+    queueId: typeof Schema.String;
+    /** Queue subspace namespace (e.g. 'data', 'trace'). Empty string for non-queue objects. */
+    queueNamespace: typeof Schema.String;
+    spaceId: typeof Schema.String;
+    documentId: typeof Schema.String;
+    entityKind: typeof Schema.String;
+    /** The versioned DXN of the type of the object. */
+    typeDxn: typeof Schema.String;
+    deleted: typeof Schema.Boolean;
+    source: Schema.NullOr<typeof Schema.String>;
+    target: Schema.NullOr<typeof Schema.String>;
+    /** Parent object id (nullable). */
+    parent: Schema.NullOr<typeof Schema.String>;
+    /** Monotonically increasing sequence number assigned on insert/update for tracking indexing order. */
+    version: typeof Schema.Number;
+    /** Unix ms timestamp when the object was first indexed. */
+    createdAt: Schema.NullOr<typeof Schema.Number>;
+    /** Unix ms timestamp when the object was last re-indexed. */
+    updatedAt: Schema.NullOr<typeof Schema.Number>;
+}>;
+export interface ObjectMeta extends Schema.Schema.Type<typeof ObjectMeta> {
+}
+export declare class ObjectMetaIndex implements Index {
+    migrate: () => Effect.Effect<void, SqlError.SqlError, SqlClient.SqlClient>;
+    query: (query: Pick<ObjectMeta, "spaceId" | "typeDxn">) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    queryAll: (query: {
+        spaceIds: readonly ObjectMeta['spaceId'][];
+        includeAllQueues?: boolean;
+        queueIds?: readonly string[] | null;
+    }) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    queryTypes: (args_0: {
+        spaceIds: readonly ObjectMeta['spaceId'][];
+        typeDxns: readonly ObjectMeta['typeDxn'][];
+        inverted?: boolean;
+        includeAllQueues?: boolean;
+        queueIds?: readonly string[] | null;
+    }) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    queryRelations: (args_0: {
+        endpoint: 'source' | 'target';
+        anchorDxns: readonly string[];
+    }) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    update: (objects: IndexerObject[]) => Effect.Effect<void, SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * Look up `recordIds` for objects that are already stored in the ObjectMetaIndex.
+     * Mutates the objects in place.
+     */
+    lookupRecordIds: (objects: IndexerObject[]) => Effect.Effect<void, SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * Look up object metadata by recordIds.
+     */
+    lookupByRecordIds: (recordIds: number[]) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * Look up object metadata by objectId, spaceId, and queueId.
+     */
+    lookupByObjectId: (query: {
+        objectId: string;
+        spaceId: string;
+        queueId: string;
+    }) => Effect.Effect<ObjectMeta | null, SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * Query objects by timestamp range.
+     */
+    queryByTimeRange: (query: {
+        spaceIds: readonly string[];
+        updatedAfter?: number;
+        updatedBefore?: number;
+        createdAfter?: number;
+        createdBefore?: number;
+        includeAllQueues?: boolean;
+        queueIds?: readonly string[] | null;
+    }) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * 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: (query: {
+        spaceId: SpaceId[];
+        parentIds: ObjectId[];
+    }) => Effect.Effect<readonly ObjectMeta[], SqlError.SqlError, SqlClient.SqlClient>;
+}
+//# sourceMappingURL=object-meta-index.d.ts.map

package/dist/types/src/indexes/object-meta-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-meta-index.d.ts","sourceRoot":"","sources":["../../../../src/indexes/object-meta-index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AAEtD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAO,KAAK,QAAQ,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAE9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAUzC,eAAO,MAAM,UAAU;;;;IAIrB,2FAA2F;;;;;IAK3F,mDAAmD;;;;;IAKnD,mCAAmC;;IAEnC,sGAAsG;;IAEtG,2DAA2D;;IAE3D,6DAA6D;;EAE7D,CAAC;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAiC5E,qBAAa,eAAgB,YAAW,KAAK;IAC3C,OAAO,oEAsCJ;IAEH,KAAK,mIAoBH;IAEF,QAAQ;kBAEM,SAAS,UAAU,CAAC,SAAS,CAAC,EAAE;2BACvB,OAAO;mBACf,SAAS,MAAM,EAAE,GAAG,IAAI;uFAoBrC;IAEF,UAAU;kBAQI,SAAS,UAAU,CAAC,SAAS,CAAC,EAAE;kBAChC,SAAS,UAAU,CAAC,SAAS,CAAC,EAAE;mBAC/B,OAAO;2BACC,OAAO;mBACf,SAAS,MAAM,EAAE,GAAG,IAAI;uFAsCrC;IAEF,cAAc;kBAKA,QAAQ,GAAG,QAAQ;oBACjB,SAAS,MAAM,EAAE;uFAiB/B;IAGF,MAAM,4FA+EJ;IAEF;;;OAGG;IACH,eAAe,4FA+Bb;IAEF;;OAEG;IACH,iBAAiB,wGAef;IAEF;;OAEG;IACH,gBAAgB;kBAEF,MAAM;iBACP,MAAM;iBACN,MAAM;mFAgBjB;IAEF;;OAEG;IACH,gBAAgB;kBAEF,SAAS,MAAM,EAAE;uBACZ,MAAM;wBACL,MAAM;uBACP,MAAM;wBACL,MAAM;2BACH,OAAO;mBACf,SAAS,MAAM,EAAE,GAAG,IAAI;uFAuCrC;IAEF;;;;;;OAMG;IACH,aAAa;iBAEA,OAAO,EAAE;mBACP,QAAQ,EAAE;uFAiBvB;CACH"}

package/dist/types/src/indexes/object-meta-index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=object-meta-index.test.d.ts.map

package/dist/types/src/indexes/object-meta-index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-meta-index.test.d.ts","sourceRoot":"","sources":["../../../../src/indexes/object-meta-index.test.ts"],"names":[],"mappings":""}

package/dist/types/src/indexes/reverse-ref-index.d.ts

@@ -0,0 +1,37 @@
+import * as SqlClient from '@effect/sql/SqlClient';
+import type * as SqlError from '@effect/sql/SqlError';
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+import type { Index, IndexerObject } from './interface';
+export declare const ReverseRef: Schema.Struct<{
+    recordId: typeof Schema.Number;
+    targetDxn: typeof Schema.String;
+    /**
+     * Escaped property path within an object.
+     *
+     * Escaping rules:
+     *
+     * - '.' -> '\.'
+     * - '\' -> '\\'
+     * - contact with .
+     */
+    propPath: typeof Schema.String;
+}>;
+export interface ReverseRef extends Schema.Schema.Type<typeof ReverseRef> {
+}
+export interface ReverseRefQuery {
+    targetDxn: string;
+}
+/**
+ * Indexes reverse references - tracks which objects reference which targets.
+ * Only indexes references, not relations.
+ */
+export declare class ReverseRefIndex implements Index {
+    migrate: () => Effect.Effect<void, SqlError.SqlError, SqlClient.SqlClient>;
+    /**
+     * Query all references pointing to a target DXN.
+     */
+    query: (args_0: ReverseRefQuery) => Effect.Effect<readonly ReverseRef[], SqlError.SqlError, SqlClient.SqlClient>;
+    update: (objects: IndexerObject[]) => Effect.Effect<void, SqlError.SqlError, SqlClient.SqlClient>;
+}
+//# sourceMappingURL=reverse-ref-index.d.ts.map

package/dist/types/src/indexes/reverse-ref-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reverse-ref-index.d.ts","sourceRoot":"","sources":["../../../../src/indexes/reverse-ref-index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAKxC,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AA6BxD,eAAO,MAAM,UAAU;;;IAGrB;;;;;;;;OAQG;;EAEH,CAAC;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAE5E,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;CAEnB;AAED;;;GAGG;AACH,qBAAa,eAAgB,YAAW,KAAK;IAC3C,OAAO,oEAWJ;IAEH;;OAEG;IACH,KAAK,4GAQH;IAEF,MAAM,4FA+BJ;CACH"}

package/dist/types/src/indexes/reverse-ref-index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=reverse-ref-index.test.d.ts.map

package/dist/types/src/indexes/reverse-ref-index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reverse-ref-index.test.d.ts","sourceRoot":"","sources":["../../../../src/indexes/reverse-ref-index.test.ts"],"names":[],"mappings":""}

package/dist/types/src/utils.d.ts

@@ -0,0 +1,17 @@
+import * as Schema from 'effect/Schema';
+export type ObjectPropPath = string[];
+/**
+ * Escaped property path within an object.
+ *
+ * Escaping rules:
+ *
+ * - '.' -> '\.'
+ * - '\' -> '\\'
+ * - contact with .
+ */
+export declare const EscapedPropPath: Schema.SchemaClass<string, string> & {
+    escape: (path: ObjectPropPath) => EscapedPropPath;
+    unescape: (path: EscapedPropPath) => ObjectPropPath;
+};
+export type EscapedPropPath = Schema.Schema.Type<typeof EscapedPropPath>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,MAAM,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC;AAEtC;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACjE,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,eAAe,CAAC;IAClD,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,cAAc,CAAC;CA0BrD,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC"}