@dxos/echo 0.8.4-main.84f28bd → 0.8.4-main.937b3ca

package/dist/lib/browser/chunk-7STIBCP7.mjs

@@ -0,0 +1,133 @@
+import "@dxos/node-std/globals";
+import {
+  isInstanceOf
+} from "./chunk-RK4Z4JUZ.mjs";
+import {
+  ObjectNotFoundError
+} from "./chunk-CJ5YELTO.mjs";
+import {
+  __export
+} from "./chunk-CGS2ULMK.mjs";
+
+// src/Database.ts
+var Database_exports = {};
+__export(Database_exports, {
+  Database: () => Database,
+  Service: () => Service,
+  TypeId: () => TypeId,
+  isDatabase: () => isDatabase
+});
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import { promiseWithCauseCapture } from "@dxos/effect";
+import { invariant } from "@dxos/invariant";
+import { DXN } from "@dxos/keys";
+var __dxlog_file = "/__w/dxos/dxos/packages/core/echo/echo/src/Database.ts";
+var TypeId = Symbol.for("@dxos/echo/Database");
+var isDatabase = (obj) => {
+  return obj ? typeof obj === "object" && TypeId in obj && obj[TypeId] === TypeId : false;
+};
+var Database = Schema.Any.pipe(Schema.filter((space) => isDatabase(space)));
+var Service = class _Service extends Context.Tag("@dxos/echo/Database/Service")() {
+  static notAvailable = Layer.succeed(_Service, {
+    get db() {
+      throw new Error("Database not available");
+    }
+  });
+  static make = (db) => {
+    return {
+      get db() {
+        return db;
+      }
+    };
+  };
+  static layer = (db) => {
+    return Layer.succeed(_Service, _Service.make(db));
+  };
+  // TODO(dmaretskyi): Move all those to the top-level API of Database.ts module.
+  /**
+  * Returns the space ID of the database.
+  */
+  static spaceId = Effect.gen(function* () {
+    const { db } = yield* _Service;
+    return db.spaceId;
+  });
+  /**
+  * Resolves an object by its DXN.
+  */
+  static resolve = (ref, schema) => Effect.gen(function* () {
+    const { db } = yield* _Service;
+    const dxn = ref instanceof DXN ? ref : ref.dxn;
+    const object = yield* promiseWithCauseCapture(() => db.graph.createRefResolver({
+      context: {
+        space: db.spaceId
+      }
+    }).resolve(dxn));
+    if (!object) {
+      return yield* Effect.fail(new ObjectNotFoundError(dxn));
+    }
+    invariant(!schema || isInstanceOf(schema, object), "Object type mismatch.", {
+      F: __dxlog_file,
+      L: 254,
+      S: this,
+      A: [
+        "!schema || isInstanceOf(schema, object)",
+        "'Object type mismatch.'"
+      ]
+    });
+    return object;
+  });
+  /**
+  * Loads an object reference.
+  */
+  static load = Effect.fn(function* (ref) {
+    const object = yield* promiseWithCauseCapture(() => ref.tryLoad());
+    if (!object) {
+      return yield* Effect.fail(new ObjectNotFoundError(ref.dxn));
+    }
+    return object;
+  });
+  /**
+  * Loads an object reference option.
+  */
+  // TODO(dmaretskyi): Do we need this -- you can just use `Effect.catchTag` in calling code instead.
+  static loadOption = Effect.fn(function* (ref) {
+    const object = yield* _Service.load(ref).pipe(Effect.catchTag("ObjectNotFoundError", () => Effect.succeed(void 0)));
+    return Option.fromNullable(object);
+  });
+  /**
+  * @link EchoDatabase.add
+  */
+  static add = (obj) => _Service.pipe(Effect.map(({ db }) => db.add(obj)));
+  /**
+  * @link EchoDatabase.remove
+  */
+  static remove = (obj) => _Service.pipe(Effect.map(({ db }) => db.remove(obj)));
+  /**
+  * @link EchoDatabase.flush
+  */
+  static flush = (opts) => _Service.pipe(Effect.flatMap(({ db }) => promiseWithCauseCapture(() => db.flush(opts))));
+  /**
+  * Creates a `QueryResult` object that can be subscribed to.
+  */
+  static query = (queryOrFilter) => _Service.pipe(Effect.map(({ db }) => db.query(queryOrFilter)), Effect.withSpan("Service.query"));
+  /**
+  * Executes the query once and returns the results.
+  */
+  static runQuery = (queryOrFilter) => _Service.query(queryOrFilter).pipe(Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())));
+  // TODO(dmaretskyi): Change API to `yield* Service.querySchema(...).first` and `yield* Service.querySchema(...).schema`.
+  static schemaQuery = (query) => _Service.pipe(Effect.map(({ db }) => db.schemaRegistry.query(query)), Effect.withSpan("Service.schemaQuery"));
+  static runSchemaQuery = (query) => _Service.schemaQuery(query).pipe(Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())));
+};
+
+export {
+  TypeId,
+  isDatabase,
+  Database,
+  Service,
+  Database_exports
+};
+//# sourceMappingURL=chunk-7STIBCP7.mjs.map

package/dist/lib/browser/chunk-7STIBCP7.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/Database.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Context from 'effect/Context';\nimport * as Effect from 'effect/Effect';\nimport * as Layer from 'effect/Layer';\nimport * as Option from 'effect/Option';\nimport * as Schema from 'effect/Schema';\nimport type * as Types from 'effect/Types';\n\nimport { type QueryAST } from '@dxos/echo-protocol';\nimport { promiseWithCauseCapture } from '@dxos/effect';\nimport { invariant } from '@dxos/invariant';\nimport { DXN, type PublicKey, type SpaceId } from '@dxos/keys';\nimport { type QueryOptions as QueryOptionsProto } from '@dxos/protocols/proto/dxos/echo/filter';\n\nimport type * as Entity from './Entity';\nimport * as Err from './Err';\nimport type * as Filter from './Filter';\nimport type * as Hypergraph from './Hypergraph';\nimport { isInstanceOf } from './internal/annotations';\nimport type { Ref } from './internal/ref/ref';\nimport { type AnyProperties } from './internal/types';\nimport type * as Obj from './Obj';\nimport type * as Query from './Query';\nimport type * as QueryResult from './QueryResult';\nimport type * as SchemaRegistry from './SchemaRegistry';\nimport type * as Type from './Type';\n\n/**\n * @deprecated Use `QueryAST.QueryOptions` instead.\n */\nexport type QueryOptions = {\n  /**\n   * @deprecated Use `spaceIds` instead.\n   */\n  spaces?: PublicKey[];\n\n  /**\n   * Query only in specific spaces.\n   */\n  // TODO(dmaretskyi): Change this to SpaceId.\n  spaceIds?: string[];\n\n  /**\n   * Return only the first `limit` results.\n   */\n  limit?: number;\n\n  /**\n   * Query only local spaces, or remote on agent.\n   * @default `QueryOptions.DataLocation.LOCAL`\n   *\n   * Options:\n   *   - proto3_optional = true\n   */\n  // TODO(burdon): Remove?\n  dataLocation?: QueryOptionsProto.DataLocation;\n};\n\n/**\n * `query` API function declaration.\n */\n// TODO(burdon): Reconcile Query and Filter (should only have one root type).\n// TODO(dmaretskyi): Remove query options.\nexport interface QueryFn {\n  <Q extends Query.Any>(\n    query: Q,\n    options?: (QueryAST.QueryOptions & QueryOptions) | undefined,\n  ): QueryResult.QueryResult<Query.Type<Q>>;\n\n  <F extends Filter.Any>(\n    filter: F,\n    options?: (QueryAST.QueryOptions & QueryOptions) | undefined,\n  ): QueryResult.QueryResult<Filter.Type<F>>;\n}\n\n/**\n * Common interface for Database and Queue.\n */\nexport interface Queryable {\n  query: QueryFn;\n}\n\nexport type GetObjectByIdOptions = {\n  deleted?: boolean;\n};\n\nexport type ObjectPlacement = 'root-doc' | 'linked-doc';\n\nexport type AddOptions = {\n  /**\n   * Where to place the object in the Automerge document tree.\n   * Root document is always loaded with the space.\n   * Linked documents are loaded lazily.\n   * Placing large number of objects in the root document may slow down the initial load.\n   *\n   * @default 'linked-doc'\n   */\n  placeIn?: ObjectPlacement;\n};\n\nexport type FlushOptions = {\n  /**\n   * Write any pending changes to disk.\n   * @default true\n   */\n  disk?: boolean;\n\n  /**\n   * Wait for pending index updates.\n   * @default false\n   */\n  indexes?: boolean;\n\n  /**\n   * Flush pending updates to objects and queries.\n   * @default false\n   */\n  updates?: boolean;\n};\n\n/**\n * Identifier denoting an ECHO Database.\n */\nexport const TypeId = Symbol.for('@dxos/echo/Database');\nexport type TypeId = typeof TypeId;\n\n/**\n * ECHO Database interface.\n */\nexport interface Database extends Queryable {\n  readonly [TypeId]: TypeId;\n\n  get spaceId(): SpaceId;\n\n  // TODO(burdon): Can we move this into graph?\n  get schemaRegistry(): SchemaRegistry.SchemaRegistry;\n\n  get graph(): Hypergraph.Hypergraph;\n\n  toJSON(): object;\n\n  /**\n   * Return object by local ID.\n   */\n  getObjectById<T extends Obj.Unknown = Obj.Obj<AnyProperties>>(id: string, opts?: GetObjectByIdOptions): T | undefined;\n\n  /**\n   * Query objects.\n   */\n  query: QueryFn;\n\n  /**\n   * Creates a reference to an existing object in the database.\n   *\n   * NOTE: The reference may be dangling if the object is not present in the database.\n   * NOTE: Difference from `Ref.fromDXN`\n   * `Ref.fromDXN(dxn)` returns an unhydrated reference. The `.load` and `.target` APIs will not work.\n   * `db.makeRef(dxn)` is preferable in cases with access to the database.\n   */\n  makeRef<T extends Entity.Unknown = Entity.Unknown>(dxn: DXN): Ref<T>;\n\n  /**\n   * Adds object to the database.\n   */\n  add<T extends Entity.Unknown = Entity.Unknown>(obj: T, opts?: AddOptions): T;\n\n  /**\n   * Removes object from the database.\n   */\n  // TODO(burdon): Return true if removed (currently throws if not present).\n  remove(obj: Entity.Unknown): void;\n\n  /**\n   * Wait for all pending changes to be saved to disk.\n   * Optionaly waits for changes to be propagated to indexes and event handlers.\n   */\n  flush(opts?: FlushOptions): Promise<void>;\n}\n\nexport const isDatabase = (obj: unknown): obj is Database => {\n  return obj ? typeof obj === 'object' && TypeId in obj && obj[TypeId] === TypeId : false;\n};\n\nexport const Database: Schema.Schema<Database> = Schema.Any.pipe(Schema.filter((space) => isDatabase(space)));\n\nexport class Service extends Context.Tag('@dxos/echo/Database/Service')<\n  Service,\n  {\n    readonly db: Database;\n  }\n>() {\n  static notAvailable = Layer.succeed(Service, {\n    get db(): Database {\n      throw new Error('Database not available');\n    },\n  });\n\n  static make = (db: Database): Context.Tag.Service<Service> => {\n    return {\n      get db() {\n        return db;\n      },\n    };\n  };\n\n  static layer = (db: Database): Layer.Layer<Service> => {\n    return Layer.succeed(Service, Service.make(db));\n  };\n\n  // TODO(dmaretskyi): Move all those to the top-level API of Database.ts module.\n\n  /**\n   * Returns the space ID of the database.\n   */\n  static spaceId = Effect.gen(function* () {\n    const { db } = yield* Service;\n    return db.spaceId;\n  });\n\n  /**\n   * Resolves an object by its DXN.\n   */\n  static resolve: {\n    // No type check.\n    (ref: DXN | Ref<any>): Effect.Effect<Entity.Unknown, never, Service>;\n    // Check matches schema.\n    <S extends Type.Entity.Any>(\n      ref: DXN | Ref<any>,\n      schema: S,\n    ): Effect.Effect<Schema.Schema.Type<S>, Err.ObjectNotFoundError, Service>;\n  } = (<S extends Type.Entity.Any>(\n    ref: DXN | Ref<any>,\n    schema?: S,\n  ): Effect.Effect<Schema.Schema.Type<S>, Err.ObjectNotFoundError, Service> =>\n    Effect.gen(function* () {\n      const { db } = yield* Service;\n      const dxn = ref instanceof DXN ? ref : ref.dxn;\n      const object = yield* promiseWithCauseCapture(() =>\n        db.graph\n          .createRefResolver({\n            context: {\n              space: db.spaceId,\n            },\n          })\n          .resolve(dxn),\n      );\n\n      if (!object) {\n        return yield* Effect.fail(new Err.ObjectNotFoundError(dxn));\n      }\n      invariant(!schema || isInstanceOf(schema, object), 'Object type mismatch.');\n      return object as any;\n    })) as any;\n\n  /**\n   * Loads an object reference.\n   */\n  static load: <T>(ref: Ref<T>) => Effect.Effect<T, Err.ObjectNotFoundError, never> = Effect.fn(function* (ref) {\n    const object = yield* promiseWithCauseCapture(() => ref.tryLoad());\n    if (!object) {\n      return yield* Effect.fail(new Err.ObjectNotFoundError(ref.dxn));\n    }\n    return object;\n  });\n\n  /**\n   * Loads an object reference option.\n   */\n  // TODO(dmaretskyi): Do we need this -- you can just use `Effect.catchTag` in calling code instead.\n  static loadOption: <T>(ref: Ref<T>) => Effect.Effect<Option.Option<T>, never, never> = Effect.fn(function* (ref) {\n    const object = yield* Service.load(ref).pipe(\n      Effect.catchTag('ObjectNotFoundError', () => Effect.succeed(undefined)),\n    );\n\n    return Option.fromNullable(object);\n  });\n\n  /**\n   * @link EchoDatabase.add\n   */\n  static add = <T extends Entity.Unknown>(obj: T): Effect.Effect<T, never, Service> =>\n    Service.pipe(Effect.map(({ db }) => db.add(obj)));\n\n  /**\n   * @link EchoDatabase.remove\n   */\n  static remove = <T extends Entity.Unknown>(obj: T): Effect.Effect<void, never, Service> =>\n    Service.pipe(Effect.map(({ db }) => db.remove(obj)));\n\n  /**\n   * @link EchoDatabase.flush\n   */\n  static flush = (opts?: FlushOptions) =>\n    Service.pipe(Effect.flatMap(({ db }) => promiseWithCauseCapture(() => db.flush(opts))));\n\n  /**\n   * Creates a `QueryResult` object that can be subscribed to.\n   */\n  static query: {\n    <Q extends Query.Any>(query: Q): Effect.Effect<QueryResult.QueryResult<Query.Type<Q>>, never, Service>;\n    <F extends Filter.Any>(filter: F): Effect.Effect<QueryResult.QueryResult<Filter.Type<F>>, never, Service>;\n  } = (queryOrFilter: Query.Any | Filter.Any) =>\n    Service.pipe(\n      Effect.map(({ db }) => db.query(queryOrFilter as any) as QueryResult.QueryResult<any>),\n      Effect.withSpan('Service.query'),\n    );\n\n  /**\n   * Executes the query once and returns the results.\n   */\n  static runQuery: {\n    <Q extends Query.Any>(query: Q): Effect.Effect<Query.Type<Q>[], never, Service>;\n    <F extends Filter.Any>(filter: F): Effect.Effect<Filter.Type<F>[], never, Service>;\n  } = (queryOrFilter: Query.Any | Filter.Any) =>\n    Service.query(queryOrFilter as any).pipe(\n      Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())),\n    );\n\n  // TODO(dmaretskyi): Change API to `yield* Service.querySchema(...).first` and `yield* Service.querySchema(...).schema`.\n\n  static schemaQuery = <Q extends Types.NoExcessProperties<SchemaRegistry.Query, Q>>(\n    query?: Q & SchemaRegistry.Query,\n  ): Effect.Effect<QueryResult.QueryResult<SchemaRegistry.ExtractQueryResult<Q>>, never, Service> =>\n    Service.pipe(\n      Effect.map(({ db }) => db.schemaRegistry.query(query)),\n      Effect.withSpan('Service.schemaQuery'),\n    );\n\n  static runSchemaQuery = <Q extends Types.NoExcessProperties<SchemaRegistry.Query, Q>>(\n    query?: Q & SchemaRegistry.Query,\n  ): Effect.Effect<SchemaRegistry.ExtractQueryResult<Q>[], never, Service> =>\n    Service.schemaQuery(query).pipe(Effect.flatMap((queryResult) => promiseWithCauseCapture(() => queryResult.run())));\n}\n"],
+  "mappings": ";;;;;;;;;;;;AAAA;;;;;;;AAIA,YAAYA,aAAa;AACzB,YAAYC,YAAY;AACxB,YAAYC,WAAW;AACvB,YAAYC,YAAY;AACxB,YAAYC,YAAY;AAIxB,SAASC,+BAA+B;AACxC,SAASC,iBAAiB;AAC1B,SAASC,WAAyC;;AAgH3C,IAAMC,SAASC,OAAOC,IAAI,qBAAA;AAwD1B,IAAMC,aAAa,CAACC,QAAAA;AACzB,SAAOA,MAAM,OAAOA,QAAQ,YAAYJ,UAAUI,OAAOA,IAAIJ,MAAAA,MAAYA,SAAS;AACpF;AAEO,IAAMK,WAA2CC,WAAIC,KAAYC,cAAO,CAACC,UAAUN,WAAWM,KAAAA,CAAAA,CAAAA;AAE9F,IAAMC,UAAN,MAAMA,iBAAwBC,YAAI,6BAAA,EAAA,EAAA;EAMvC,OAAOC,eAAqBC,cAAQH,UAAS;IAC3C,IAAII,KAAe;AACjB,YAAM,IAAIC,MAAM,wBAAA;IAClB;EACF,CAAA;EAEA,OAAOC,OAAO,CAACF,OAAAA;AACb,WAAO;MACL,IAAIA,KAAK;AACP,eAAOA;MACT;IACF;EACF;EAEA,OAAOG,QAAQ,CAACH,OAAAA;AACd,WAAaD,cAAQH,UAASA,SAAQM,KAAKF,EAAAA,CAAAA;EAC7C;;;;;EAOA,OAAOI,UAAiBC,WAAI,aAAA;AAC1B,UAAM,EAAEL,GAAE,IAAK,OAAOJ;AACtB,WAAOI,GAAGI;EACZ,CAAA;;;;EAKA,OAAOE,UAQF,CACHC,KACAC,WAEOH,WAAI,aAAA;AACT,UAAM,EAAEL,GAAE,IAAK,OAAOJ;AACtB,UAAMa,MAAMF,eAAeG,MAAMH,MAAMA,IAAIE;AAC3C,UAAME,SAAS,OAAOC,wBAAwB,MAC5CZ,GAAGa,MACAC,kBAAkB;MACjBC,SAAS;QACPpB,OAAOK,GAAGI;MACZ;IACF,CAAA,EACCE,QAAQG,GAAAA,CAAAA;AAGb,QAAI,CAACE,QAAQ;AACX,aAAO,OAAcK,YAAK,IAAQC,oBAAoBR,GAAAA,CAAAA;IACxD;AACAS,cAAU,CAACV,UAAUW,aAAaX,QAAQG,MAAAA,GAAS,yBAAA;;;;;;;;;AACnD,WAAOA;EACT,CAAA;;;;EAKF,OAAOS,OAAoFC,UAAG,WAAWd,KAAG;AAC1G,UAAMI,SAAS,OAAOC,wBAAwB,MAAML,IAAIe,QAAO,CAAA;AAC/D,QAAI,CAACX,QAAQ;AACX,aAAO,OAAcK,YAAK,IAAQC,oBAAoBV,IAAIE,GAAG,CAAA;IAC/D;AACA,WAAOE;EACT,CAAA;;;;;EAMA,OAAOY,aAAuFF,UAAG,WAAWd,KAAG;AAC7G,UAAMI,SAAS,OAAOf,SAAQwB,KAAKb,GAAAA,EAAKd,KAC/B+B,gBAAS,uBAAuB,MAAazB,eAAQ0B,MAAAA,CAAAA,CAAAA;AAG9D,WAAcC,oBAAaf,MAAAA;EAC7B,CAAA;;;;EAKA,OAAOgB,MAAM,CAA2BrC,QACtCM,SAAQH,KAAYmC,WAAI,CAAC,EAAE5B,GAAE,MAAOA,GAAG2B,IAAIrC,GAAAA,CAAAA,CAAAA;;;;EAK7C,OAAOuC,SAAS,CAA2BvC,QACzCM,SAAQH,KAAYmC,WAAI,CAAC,EAAE5B,GAAE,MAAOA,GAAG6B,OAAOvC,GAAAA,CAAAA,CAAAA;;;;EAKhD,OAAOwC,QAAQ,CAACC,SACdnC,SAAQH,KAAYuC,eAAQ,CAAC,EAAEhC,GAAE,MAAOY,wBAAwB,MAAMZ,GAAG8B,MAAMC,IAAAA,CAAAA,CAAAA,CAAAA;;;;EAKjF,OAAOE,QAGH,CAACC,kBACHtC,SAAQH,KACCmC,WAAI,CAAC,EAAE5B,GAAE,MAAOA,GAAGiC,MAAMC,aAAAA,CAAAA,GACzBC,gBAAS,eAAA,CAAA;;;;EAMpB,OAAOC,WAGH,CAACF,kBACHtC,SAAQqC,MAAMC,aAAAA,EAAsBzC,KAC3BuC,eAAQ,CAACK,gBAAgBzB,wBAAwB,MAAMyB,YAAYC,IAAG,CAAA,CAAA,CAAA;;EAKjF,OAAOC,cAAc,CACnBN,UAEArC,SAAQH,KACCmC,WAAI,CAAC,EAAE5B,GAAE,MAAOA,GAAGwC,eAAeP,MAAMA,KAAAA,CAAAA,GACxCE,gBAAS,qBAAA,CAAA;EAGpB,OAAOM,iBAAiB,CACtBR,UAEArC,SAAQ2C,YAAYN,KAAAA,EAAOxC,KAAYuC,eAAQ,CAACK,gBAAgBzB,wBAAwB,MAAMyB,YAAYC,IAAG,CAAA,CAAA,CAAA;AACjH;",
+  "names": ["Context", "Effect", "Layer", "Option", "Schema", "promiseWithCauseCapture", "invariant", "DXN", "TypeId", "Symbol", "for", "isDatabase", "obj", "Database", "Any", "pipe", "filter", "space", "Service", "Tag", "notAvailable", "succeed", "db", "Error", "make", "layer", "spaceId", "gen", "resolve", "ref", "schema", "dxn", "DXN", "object", "promiseWithCauseCapture", "graph", "createRefResolver", "context", "fail", "ObjectNotFoundError", "invariant", "isInstanceOf", "load", "fn", "tryLoad", "loadOption", "catchTag", "undefined", "fromNullable", "add", "map", "remove", "flush", "opts", "flatMap", "query", "queryOrFilter", "withSpan", "runQuery", "queryResult", "run", "schemaQuery", "schemaRegistry", "runSchemaQuery"]
+}