@dxos/echo 0.8.4-main.fffef41 → 0.8.4-staging.ac66bdf99f

package/dist/lib/neutral/testing/index.mjs

@@ -0,0 +1,375 @@
+import "../chunk-4OIBYSXE.mjs";
+import "../chunk-BNCCGLJN.mjs";
+import "../chunk-YAHXAYOW.mjs";
+import "../chunk-UI6MWK5W.mjs";
+import "../chunk-ANHVGJI4.mjs";
+import "../chunk-WAK4DMFV.mjs";
+import "../chunk-YS6Q3XAD.mjs";
+import "../chunk-GZQTCRJB.mjs";
+import "../chunk-HBUZJNZO.mjs";
+import "../chunk-7RO7CPBZ.mjs";
+import "../chunk-OMUPQMLR.mjs";
+import "../chunk-EAMSSLZC.mjs";
+import "../chunk-TU3GW67D.mjs";
+import {
+  Type_exports,
+  object,
+  relation
+} from "../chunk-ROG4RXXL.mjs";
+import "../chunk-V36VO5SS.mjs";
+import {
+  Unknown
+} from "../chunk-B4BASU6W.mjs";
+import {
+  Ref
+} from "../chunk-BVOFLCVF.mjs";
+import "../chunk-T6W2LEZU.mjs";
+import {
+  EchoSchema,
+  PersistentSchema,
+  makeObject,
+  subscribe
+} from "../chunk-MOR5ERFM.mjs";
+import "../chunk-OS35K56T.mjs";
+import {
+  toJsonSchema
+} from "../chunk-JUXPFOEI.mjs";
+import "../chunk-DQYLD2RB.mjs";
+import "../chunk-G3IQMKF7.mjs";
+import "../chunk-4P3IXBLT.mjs";
+import "../chunk-PHU22NLC.mjs";
+import {
+  getSchemaTypename
+} from "../chunk-2KHZ36F5.mjs";
+import "../chunk-TBKX6JQO.mjs";
+import "../chunk-UBEZSGXY.mjs";
+import "../chunk-J5LGTIGS.mjs";
+
+// src/testing/test-data.ts
+import { DatabaseDirectory, ObjectStructure } from "@dxos/echo-protocol";
+import { DXN, ObjectId, PublicKey } from "@dxos/keys";
+
+// src/testing/test-schema.ts
+import * as Schema from "effect/Schema";
+(function(TestSchema2) {
+  TestSchema2.Expando = Schema.Struct({}, {
+    key: Schema.String,
+    value: Schema.Any
+  }).pipe(object({
+    typename: "com.example.type.expando",
+    version: "0.1.0"
+  }));
+  const Nested = Schema.Struct({
+    field: Schema.String
+  });
+  class TestClass {
+    field = "value";
+    toJSON() {
+      return {
+        field: this.field
+      };
+    }
+  }
+  TestSchema2.TestClass = TestClass;
+  TestSchema2.ExampleSchema = Schema.Struct({
+    string: Schema.String,
+    number: Schema.Number,
+    boolean: Schema.Boolean,
+    null: Schema.Null,
+    undefined: Schema.Undefined,
+    stringArray: Schema.Array(Schema.String),
+    twoDimNumberArray: Schema.Array(Schema.Array(Schema.Number)),
+    nested: Nested,
+    nestedArray: Schema.Array(Nested),
+    nestedNullableArray: Schema.Array(Schema.Union(Nested, Schema.Null)),
+    reference: Schema.suspend(() => Ref(TestSchema2.Example)),
+    referenceArray: Schema.Array(Schema.suspend(() => Ref(TestSchema2.Example))),
+    classInstance: Schema.instanceOf(TestClass),
+    other: Schema.Any
+  }).pipe(Schema.partial);
+  TestSchema2.Example = TestSchema2.ExampleSchema.pipe(object({
+    typename: "com.example.type.example",
+    version: "0.1.0"
+  }));
+  TestSchema2.MessageStruct = Schema.Struct({
+    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).
+    // TODO(burdon): Support defaults (update create and create).
+    timestamp: Schema.String.pipe(Schema.propertySignature, Schema.withConstructorDefault(() => (/* @__PURE__ */ new Date()).toISOString()))
+  });
+  TestSchema2.Message = TestSchema2.MessageStruct.pipe(object({
+    typename: "com.example.type.message",
+    version: "0.1.0"
+  }));
+  TestSchema2.Organization = Schema.Struct({
+    name: Schema.String,
+    properties: Schema.optional(Schema.Record({
+      key: Schema.String,
+      value: Schema.String
+    }))
+  }).pipe(object({
+    typename: "com.example.type.organization",
+    version: "0.1.0"
+  }));
+  TestSchema2.Person = Schema.Struct({
+    name: Schema.String,
+    username: Schema.String,
+    email: Schema.String,
+    age: Schema.Number.pipe(Schema.optional),
+    tasks: Schema.Array(Schema.suspend(() => Ref(TestSchema2.Task))),
+    employer: Schema.optional(Ref(TestSchema2.Organization)),
+    address: Schema.Struct({
+      city: Schema.optional(Schema.String),
+      state: Schema.optional(Schema.String),
+      zip: Schema.optional(Schema.String),
+      coordinates: Schema.Struct({
+        lat: Schema.optional(Schema.Number),
+        lng: Schema.optional(Schema.Number)
+      })
+    }),
+    fields: Schema.Struct({
+      label: Schema.String,
+      value: Schema.String
+    }).pipe(Schema.Array, Schema.optional)
+  }).pipe(Schema.partial, object({
+    typename: "com.example.type.person",
+    version: "0.1.0"
+  }));
+  TestSchema2.Task = Schema.Struct({
+    title: Schema.optional(Schema.String),
+    deadline: Schema.optional(Schema.String),
+    completed: Schema.optional(Schema.Boolean),
+    assignee: Schema.optional(Ref(TestSchema2.Person)),
+    previous: Schema.optional(Schema.suspend(() => Ref(TestSchema2.Task))),
+    subTasks: Schema.optional(Schema.Array(Schema.suspend(() => Ref(TestSchema2.Task)))),
+    description: Schema.optional(Schema.String)
+  }).pipe(Schema.partial, object({
+    typename: "com.example.type.task",
+    version: "0.1.0"
+  }));
+  TestSchema2.HasManager = Schema.Struct({}).pipe(relation({
+    typename: "com.example.type.has-manager",
+    version: "0.1.0",
+    source: TestSchema2.Person,
+    target: TestSchema2.Person
+  }));
+  TestSchema2.EmployedBy = Schema.Struct({
+    role: Schema.String,
+    since: Schema.optional(Schema.String)
+  }).pipe(relation({
+    typename: "com.example.type.employed-by",
+    version: "0.1.0",
+    source: TestSchema2.Person,
+    target: TestSchema2.Organization
+  }));
+  (function(RecordType) {
+    RecordType[RecordType["UNDEFINED"] = 0] = "UNDEFINED";
+    RecordType[RecordType["PERSONAL"] = 1] = "PERSONAL";
+    RecordType[RecordType["WORK"] = 2] = "WORK";
+  })(TestSchema2.RecordType || (TestSchema2.RecordType = {}));
+  TestSchema2.Container = Schema.Struct({
+    objects: Schema.Array(Ref(Unknown)),
+    records: Schema.Array(Schema.partial(Schema.Struct({
+      title: Schema.String,
+      description: Schema.String,
+      contacts: Schema.Array(Ref(TestSchema2.Person)),
+      type: Schema.Enums(TestSchema2.RecordType)
+    })))
+  }).pipe(Schema.partial, object({
+    typename: "com.example.type.container",
+    version: "0.1.0"
+  }));
+})(TestSchema || (TestSchema = {}));
+var TestSchema;
+
+// src/testing/test-data.ts
+var spaceKey = PublicKey.random();
+var PEOPLE = {
+  alice: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Person).toString(),
+        data: {
+          name: "Alice"
+        }
+      })
+    }
+  }),
+  bob: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Person).toString(),
+        data: {
+          name: "Bob"
+        }
+      })
+    }
+  })
+};
+var ORGS = {
+  dxos: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Organization).toString(),
+        data: {
+          name: "DXOS",
+          founded: "2023"
+        }
+      })
+    }
+  }),
+  cyberdyne: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Organization).toString(),
+        data: {
+          name: "Cyberdyne Systems",
+          founded: "1984"
+        }
+      })
+    }
+  })
+};
+var WORKS_FOR = {
+  fredWorksForCyberdyne: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeRelation({
+        type: Type_exports.getDXN(TestSchema.EmployedBy).toString(),
+        source: {
+          "/": DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects)[0]).toString()
+        },
+        target: {
+          "/": DXN.fromLocalObjectId(Object.keys(ORGS.cyberdyne.objects)[0]).toString()
+        },
+        data: {
+          since: "2020",
+          position: "Engineer"
+        }
+      })
+    }
+  }),
+  aliceWorksForAperture: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeRelation({
+        type: Type_exports.getDXN(TestSchema.EmployedBy).toString(),
+        source: {
+          "/": DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects)[0]).toString()
+        },
+        target: {
+          "/": DXN.fromLocalObjectId(Object.keys(ORGS.dxos.objects)[0]).toString()
+        },
+        data: {
+          since: "2018",
+          position: "Research Scientist"
+        }
+      })
+    }
+  })
+};
+var TASKS = {
+  task1: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Task).toString(),
+        data: {
+          title: "Complete project documentation",
+          description: "Write comprehensive documentation for the new system",
+          status: "in-progress",
+          dueDate: "2023-12-31",
+          assignee: {
+            "/": DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects)[0]).toString()
+          }
+        }
+      })
+    }
+  }),
+  task2: DatabaseDirectory.make({
+    spaceKey: spaceKey.toHex(),
+    objects: {
+      [ObjectId.random()]: ObjectStructure.makeObject({
+        type: Type_exports.getDXN(TestSchema.Task).toString(),
+        data: {
+          title: "Run experiments",
+          description: "Conduct series of experiments on the portal device",
+          status: "pending",
+          dueDate: "2023-11-15",
+          assignee: {
+            "/": DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects)[0]).toString()
+          }
+        }
+      })
+    }
+  })
+};
+
+// src/testing/util.ts
+import { assertArgument } from "@dxos/invariant";
+import { deepMapValues } from "@dxos/util";
+var createEchoSchema = (schema, version = "0.1.0") => {
+  const jsonSchema = toJsonSchema(schema);
+  const typename = getSchemaTypename(schema);
+  assertArgument(typename, "typename", "Schema does not have a typename.");
+  const echoSchema = new EchoSchema(makeObject(PersistentSchema, {
+    typename,
+    version,
+    jsonSchema
+  }));
+  subscribe(echoSchema.persistentSchema, () => {
+    echoSchema._invalidate();
+  });
+  return echoSchema;
+};
+var prepareAstForCompare = (obj) => deepMapValues(obj, (value, recurse) => {
+  if (typeof value === "function") {
+    return null;
+  }
+  if (value instanceof RegExp) {
+    return value;
+  }
+  if (typeof value === "object") {
+    const clone = {
+      ...value
+    };
+    for (const sym of Object.getOwnPropertySymbols(clone)) {
+      clone[sym.toString()] = clone[sym];
+      delete clone[sym];
+    }
+    return recurse(clone);
+  }
+  return recurse(value);
+});
+var updateCounter = (...objects) => {
+  let updateCount = 0;
+  const unsubscribes = objects.map((obj) => subscribe(obj, () => {
+    updateCount++;
+  }));
+  const unsubscribeAll = () => {
+    for (const unsub of unsubscribes) {
+      unsub();
+    }
+  };
+  return {
+    // https://github.com/tc39/proposal-explicit-resource-management
+    [Symbol.dispose]: unsubscribeAll,
+    get count() {
+      return updateCount;
+    }
+  };
+};
+export {
+  ORGS,
+  PEOPLE,
+  TASKS,
+  TestSchema,
+  WORKS_FOR,
+  createEchoSchema,
+  prepareAstForCompare,
+  updateCounter
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/neutral/testing/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/testing/test-data.ts", "../../../../src/testing/test-schema.ts", "../../../../src/testing/util.ts"],
+  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { DatabaseDirectory, ObjectStructure } from '@dxos/echo-protocol';\nimport { DXN, ObjectId, PublicKey } from '@dxos/keys';\n\nimport { Type } from '../index';\nimport { TestSchema } from './test-schema';\n\nconst spaceKey = PublicKey.random();\n\n// TODO(burdon): Use Obj.make.\n\nexport const PEOPLE = {\n  alice: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Person)!.toString(),\n        data: {\n          name: 'Alice',\n        },\n      }),\n    },\n  }),\n  bob: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Person)!.toString(),\n        data: {\n          name: 'Bob',\n        },\n      }),\n    },\n  }),\n};\n\nexport const ORGS = {\n  dxos: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Organization)!.toString(),\n        data: {\n          name: 'DXOS',\n          founded: '2023',\n        },\n      }),\n    },\n  }),\n  cyberdyne: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Organization)!.toString(),\n        data: {\n          name: 'Cyberdyne Systems',\n          founded: '1984',\n        },\n      }),\n    },\n  }),\n};\n\nexport const WORKS_FOR = {\n  fredWorksForCyberdyne: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeRelation({\n        type: Type.getDXN(TestSchema.EmployedBy)!.toString(),\n        source: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects!)[0]).toString() },\n        target: { '/': DXN.fromLocalObjectId(Object.keys(ORGS.cyberdyne.objects!)[0]).toString() },\n        data: {\n          since: '2020',\n          position: 'Engineer',\n        },\n      }),\n    },\n  }),\n  aliceWorksForAperture: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeRelation({\n        type: Type.getDXN(TestSchema.EmployedBy)!.toString(),\n        source: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects!)[0]).toString() },\n        target: { '/': DXN.fromLocalObjectId(Object.keys(ORGS.dxos.objects!)[0]).toString() },\n        data: {\n          since: '2018',\n          position: 'Research Scientist',\n        },\n      }),\n    },\n  }),\n};\n\nexport const TASKS = {\n  task1: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Task)!.toString(),\n        data: {\n          title: 'Complete project documentation',\n          description: 'Write comprehensive documentation for the new system',\n          status: 'in-progress',\n          dueDate: '2023-12-31',\n          assignee: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects!)[0]).toString() },\n        },\n      }),\n    },\n  }),\n  task2: DatabaseDirectory.make({\n    spaceKey: spaceKey.toHex(),\n    objects: {\n      [ObjectId.random()]: ObjectStructure.makeObject({\n        type: Type.getDXN(TestSchema.Task)!.toString(),\n        data: {\n          title: 'Run experiments',\n          description: 'Conduct series of experiments on the portal device',\n          status: 'pending',\n          dueDate: '2023-11-15',\n          assignee: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects!)[0]).toString() },\n        },\n      }),\n    },\n  }),\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport * as Obj from '../Obj';\nimport * as Ref from '../Ref';\nimport * as Type from '../Type';\n\nexport namespace TestSchema {\n  //\n  // Expando\n  //\n\n  /**\n   * Expando object is an object with an arbitrary set of properties.\n   * This is the test variant with example.com namespace.\n   */\n  export const Expando = Schema.Struct({}, { key: Schema.String, value: Schema.Any }).pipe(\n    Type.object({\n      typename: 'com.example.type.expando',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Expando extends Schema.Schema.Type<typeof Expando> {}\n\n  //\n  // Example\n  //\n\n  const Nested = Schema.Struct({\n    field: Schema.String,\n  });\n\n  export class TestClass {\n    field = 'value';\n    toJSON() {\n      return { field: this.field };\n    }\n  }\n\n  /** @deprecated Use another test schema or create a specific local test schema. */\n  export const ExampleSchema = Schema.Struct({\n    string: Schema.String,\n    number: Schema.Number,\n    boolean: Schema.Boolean,\n    null: Schema.Null,\n    undefined: Schema.Undefined,\n    stringArray: Schema.Array(Schema.String),\n    twoDimNumberArray: Schema.Array(Schema.Array(Schema.Number)),\n    nested: Nested,\n    nestedArray: Schema.Array(Nested),\n    nestedNullableArray: Schema.Array(Schema.Union(Nested, Schema.Null)),\n    reference: Schema.suspend((): Ref.RefSchema<Example> => Ref.Ref(Example)),\n    referenceArray: Schema.Array(Schema.suspend((): Ref.RefSchema<Example> => Ref.Ref(Example))),\n    classInstance: Schema.instanceOf(TestClass),\n    other: Schema.Any,\n  }).pipe(Schema.partial);\n\n  /** @deprecated Use another test schema or create a specific local test schema. */\n  export interface ExampleSchema extends Schema.Schema.Type<typeof ExampleSchema> {}\n\n  /** @deprecated Use another test schema or create a specific local test schema. */\n  export const Example = ExampleSchema.pipe(\n    Type.object({\n      typename: 'com.example.type.example',\n      version: '0.1.0',\n    }),\n  );\n\n  /** @deprecated Use another test schema or create a specific local test schema. */\n  export interface Example extends Schema.Schema.Type<typeof Example> {}\n\n  //\n  // Message\n  //\n\n  // TODO(burdon): Support defaults directly on Type: `make` is erased by `pipe(Type.Obj)`.\n  export const MessageStruct = Schema.Struct({\n    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).\n    // TODO(burdon): Support defaults (update create and create).\n    timestamp: Schema.String.pipe(\n      Schema.propertySignature,\n      Schema.withConstructorDefault(() => new Date().toISOString()),\n    ),\n  });\n\n  export const Message = MessageStruct.pipe(\n    Type.object({\n      typename: 'com.example.type.message',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Message extends Schema.Schema.Type<typeof Message> {}\n\n  //\n  // Organization\n  //\n\n  export const Organization = Schema.Struct({\n    name: Schema.String,\n    properties: Schema.optional(\n      Schema.Record({\n        key: Schema.String,\n        value: Schema.String,\n      }),\n    ),\n  }).pipe(\n    Type.object({\n      typename: 'com.example.type.organization',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Organization extends Schema.Schema.Type<typeof Organization> {}\n\n  //\n  // Person\n  //\n\n  export const Person = Schema.Struct({\n    name: Schema.String,\n    username: Schema.String,\n    email: Schema.String,\n    age: Schema.Number.pipe(Schema.optional),\n    tasks: Schema.Array(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task))),\n    employer: Schema.optional(Ref.Ref(Organization)),\n    address: Schema.Struct({\n      city: Schema.optional(Schema.String),\n      state: Schema.optional(Schema.String),\n      zip: Schema.optional(Schema.String),\n      coordinates: Schema.Struct({\n        lat: Schema.optional(Schema.Number),\n        lng: Schema.optional(Schema.Number),\n      }),\n    }),\n    fields: Schema.Struct({\n      label: Schema.String,\n      value: Schema.String,\n    }).pipe(Schema.Array, Schema.optional),\n  }).pipe(\n    Schema.partial,\n    Type.object({\n      typename: 'com.example.type.person',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Person extends Schema.Schema.Type<typeof Person> {}\n\n  //\n  // Task\n  //\n\n  export const Task = Schema.Struct({\n    title: Schema.optional(Schema.String),\n    deadline: Schema.optional(Schema.String),\n    completed: Schema.optional(Schema.Boolean),\n    assignee: Schema.optional(Ref.Ref(Person)),\n    previous: Schema.optional(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task))),\n    subTasks: Schema.optional(Schema.Array(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task)))),\n    description: Schema.optional(Schema.String),\n  }).pipe(\n    Schema.partial,\n    Type.object({\n      typename: 'com.example.type.task',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Task extends Schema.Schema.Type<typeof Task> {}\n\n  //\n  // HasManager\n  //\n\n  export const HasManager = Schema.Struct({}).pipe(\n    Type.relation({\n      typename: 'com.example.type.has-manager',\n      version: '0.1.0',\n      source: Person,\n      target: Person,\n    }),\n  );\n\n  export interface HasManager extends Schema.Schema.Type<typeof HasManager> {}\n\n  //\n  // EmployedBy\n  //\n\n  export const EmployedBy = Schema.Struct({\n    role: Schema.String,\n    since: Schema.optional(Schema.String),\n  }).pipe(\n    Type.relation({\n      typename: 'com.example.type.employed-by',\n      version: '0.1.0',\n      source: Person,\n      target: Organization,\n    }),\n  );\n\n  export interface EmployedBy extends Schema.Schema.Type<typeof EmployedBy> {}\n\n  //\n  // RecordType\n  //\n\n  export enum RecordType {\n    UNDEFINED = 0,\n    PERSONAL = 1,\n    WORK = 2,\n  }\n\n  export const Container = Schema.Struct({\n    objects: Schema.Array(Ref.Ref(Obj.Unknown)),\n    records: Schema.Array(\n      Schema.partial(\n        Schema.Struct({\n          title: Schema.String,\n          description: Schema.String,\n          contacts: Schema.Array(Ref.Ref(Person)),\n          type: Schema.Enums(RecordType),\n        }),\n      ),\n    ),\n  }).pipe(\n    Schema.partial,\n    Type.object({\n      typename: 'com.example.type.container',\n      version: '0.1.0',\n    }),\n  );\n\n  export interface Container extends Schema.Schema.Type<typeof Container> {}\n}\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport type * as Schema from 'effect/Schema';\nimport type * as SchemaAST from 'effect/SchemaAST';\n\nimport { assertArgument } from '@dxos/invariant';\nimport { deepMapValues } from '@dxos/util';\n\nimport { EchoSchema, PersistentSchema, getSchemaTypename, makeObject, subscribe, toJsonSchema } from '../internal';\n\n/**\n * Create a reactive mutable schema that updates when the JSON schema is updated.\n */\n// TODO(dmaretskyi): Should be replaced by registration of typed object.\nexport const createEchoSchema = (schema: Schema.Schema.AnyNoContext, version = '0.1.0'): EchoSchema => {\n  const jsonSchema = toJsonSchema(schema);\n  const typename = getSchemaTypename(schema);\n  assertArgument(typename, 'typename', 'Schema does not have a typename.');\n  const echoSchema = new EchoSchema(makeObject(PersistentSchema, { typename, version, jsonSchema }));\n\n  // TODO(burdon): Unsubscribe is never called.\n  subscribe(echoSchema.persistentSchema, () => {\n    echoSchema._invalidate();\n  });\n\n  return echoSchema;\n};\n\n/**\n * Converts AST to a format that can be compared with test matchers.\n */\nexport const prepareAstForCompare = (obj: SchemaAST.AST): any =>\n  deepMapValues(obj, (value: any, recurse: any) => {\n    if (typeof value === 'function') {\n      return null;\n    }\n\n    if (value instanceof RegExp) {\n      return value;\n    }\n\n    // Convert symbols to strings.\n    if (typeof value === 'object') {\n      const clone = { ...value };\n      for (const sym of Object.getOwnPropertySymbols(clone as any)) {\n        clone[sym.toString()] = clone[sym];\n        delete clone[sym];\n      }\n\n      return recurse(clone);\n    }\n\n    return recurse(value);\n  });\n\n/**\n * Creates an update counter that tracks changes to reactive objects.\n * @param objects - Reactive objects to subscribe to.\n * @returns An object with a count property and Symbol.dispose for cleanup.\n */\nexport const updateCounter = (...objects: object[]) => {\n  let updateCount = 0;\n\n  const unsubscribes = objects.map((obj) =>\n    subscribe(obj, () => {\n      updateCount++;\n    }),\n  );\n\n  const unsubscribeAll = () => {\n    for (const unsub of unsubscribes) {\n      unsub();\n    }\n  };\n\n  return {\n    // https://github.com/tc39/proposal-explicit-resource-management\n    [Symbol.dispose]: unsubscribeAll,\n    get count() {\n      return updateCount;\n    },\n  };\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,SAASA,mBAAmBC,uBAAuB;AACnD,SAASC,KAAKC,UAAUC,iBAAiB;;;ACDzC,YAAYC,YAAY;UAMPC,aAAAA;cASFC,UAAiBC,cAAO,CAAC,GAAG;IAAEC,KAAYC;IAAQC,OAAcC;EAAI,CAAA,EAAGC,KAC7EC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;AASF,QAAMC,SAAgBT,cAAO;IAC3BU,OAAcR;EAChB,CAAA;EAEO,MAAMS,UAAAA;IACXD,QAAQ;IACRE,SAAS;AACP,aAAO;QAAEF,OAAO,KAAKA;MAAM;IAC7B;EACF;cALaC,YAAAA;cAQAE,gBAAuBb,cAAO;IACzCc,QAAeZ;IACfa,QAAeC;IACfC,SAAgBC;IAChBC,MAAaC;IACbC,WAAkBC;IAClBC,aAAoBC,aAAatB,aAAM;IACvCuB,mBAA0BD,aAAaA,aAAaR,aAAM,CAAA;IAC1DU,QAAQjB;IACRkB,aAAoBH,aAAMf,MAAAA;IAC1BmB,qBAA4BJ,aAAaK,aAAMpB,QAAeW,WAAI,CAAA;IAClEU,WAAkBC,eAAQ,MAAkCC,IAAGlC,YAACmC,OAAAA,CAAAA;IAChEC,gBAAuBV,aAAaO,eAAQ,MAAkCC,IAAGlC,YAACmC,OAAAA,CAAAA,CAAAA;IAClFE,eAAsBC,kBAAWzB,SAAAA;IACjC0B,OAAcjC;EAChB,CAAA,EAAGC,KAAYiC,cAAO;cAMTL,UAAUpB,YAAAA,cAAcR,KAC9BC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;cAWW+B,gBAAuBvC,cAAO;;;IAGzCwC,WAAkBtC,cAAOG,KAChBoC,0BACAC,8BAAuB,OAAM,oBAAIC,KAAAA,GAAOC,YAAW,CAAA,CAAA;EAE9D,CAAA;cAEaC,UAAUN,YAAAA,cAAclC,KAC9BC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;cASWsC,eAAsB9C,cAAO;IACxC+C,MAAa7C;IACb8C,YAAmBC,gBACVC,cAAO;MACZjD,KAAYC;MACZC,OAAcD;IAChB,CAAA,CAAA;EAEJ,CAAA,EAAGG,KACIC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;cASW2C,SAAgBnD,cAAO;IAClC+C,MAAa7C;IACbkD,UAAiBlD;IACjBmD,OAAcnD;IACdoD,KAAYtC,cAAOX,KAAY4C,eAAQ;IACvCM,OAAc/B,aAAaO,eAAQ,MAA+BC,IAAGlC,YAAC0D,IAAAA,CAAAA,CAAAA;IACtEC,UAAiBR,gBAAajB,IAAGlC,YAACgD,YAAAA,CAAAA;IAClCY,SAAgB1D,cAAO;MACrB2D,MAAaV,gBAAgB/C,aAAM;MACnC0D,OAAcX,gBAAgB/C,aAAM;MACpC2D,KAAYZ,gBAAgB/C,aAAM;MAClC4D,aAAoB9D,cAAO;QACzB+D,KAAYd,gBAAgBjC,aAAM;QAClCgD,KAAYf,gBAAgBjC,aAAM;MACpC,CAAA;IACF,CAAA;IACAiD,QAAejE,cAAO;MACpBkE,OAAchE;MACdC,OAAcD;IAChB,CAAA,EAAGG,KAAYmB,cAAcyB,eAAQ;EACvC,CAAA,EAAG5C,KACMiC,gBACFhC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;cASWgD,OAAcxD,cAAO;IAChCmE,OAAclB,gBAAgB/C,aAAM;IACpCkE,UAAiBnB,gBAAgB/C,aAAM;IACvCmE,WAAkBpB,gBAAgB/B,cAAO;IACzCoD,UAAiBrB,gBAAajB,IAAGlC,YAACqD,MAAAA,CAAAA;IAClCoB,UAAiBtB,gBAAgBlB,eAAQ,MAA+BC,IAAGlC,YAAC0D,IAAAA,CAAAA,CAAAA;IAC5EgB,UAAiBvB,gBAAgBzB,aAAaO,eAAQ,MAA+BC,IAAGlC,YAAC0D,IAAAA,CAAAA,CAAAA,CAAAA;IACzFiB,aAAoBxB,gBAAgB/C,aAAM;EAC5C,CAAA,EAAGG,KACMiC,gBACFhC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;cASWkE,aAAoB1E,cAAO,CAAC,CAAA,EAAGK,KACrCsE,SAAS;IACZpE,UAAU;IACVC,SAAS;IACToE,QAAM9E,YAAEqD;IACR0B,QAAM/E,YAAEqD;EACV,CAAA,CAAA;cASW2B,aAAoB9E,cAAO;IACtC+E,MAAa7E;IACb8E,OAAc/B,gBAAgB/C,aAAM;EACtC,CAAA,EAAGG,KACIsE,SAAS;IACZpE,UAAU;IACVC,SAAS;IACToE,QAAM9E,YAAEqD;IACR0B,QAAM/E,YAAEgD;EACV,CAAA,CAAA;YASUmC,YAAAA;;;;iBAAAA,eAAAA,YAAAA,aAAAA,CAAAA,EAAAA;cAMCC,YAAmBlF,cAAO;IACrCmF,SAAgB3D,aAAUQ,IAAQoD,OAAO,CAAA;IACzCC,SAAgB7D,aACPc,eACEtC,cAAO;MACZmE,OAAcjE;MACduE,aAAoBvE;MACpBoF,UAAiB9D,aAAUQ,IAAGlC,YAACqD,MAAAA,CAAAA;MAC/BoC,MAAaC,aAAK1F,YAACmF,UAAAA;IACrB,CAAA,CAAA,CAAA;EAGN,CAAA,EAAG5E,KACMiC,gBACFhC,OAAO;IACVC,UAAU;IACVC,SAAS;EACX,CAAA,CAAA;AAIJ,GArOiBV,eAAAA,aAAAA,CAAAA,EAAAA;;;;ADAjB,IAAM2F,WAAWC,UAAUC,OAAM;AAI1B,IAAMC,SAAS;EACpBC,OAAOC,kBAAkBC,KAAK;IAC5BN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAWC,MAAM,EAAGC,SAAQ;QAC9CC,MAAM;UACJC,MAAM;QACR;MACF,CAAA;IACF;EACF,CAAA;EACAC,KAAKf,kBAAkBC,KAAK;IAC1BN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAWC,MAAM,EAAGC,SAAQ;QAC9CC,MAAM;UACJC,MAAM;QACR;MACF,CAAA;IACF;EACF,CAAA;AACF;AAEO,IAAME,OAAO;EAClBC,MAAMjB,kBAAkBC,KAAK;IAC3BN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAWQ,YAAY,EAAGN,SAAQ;QACpDC,MAAM;UACJC,MAAM;UACNK,SAAS;QACX;MACF,CAAA;IACF;EACF,CAAA;EACAC,WAAWpB,kBAAkBC,KAAK;IAChCN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAWQ,YAAY,EAAGN,SAAQ;QACpDC,MAAM;UACJC,MAAM;UACNK,SAAS;QACX;MACF,CAAA;IACF;EACF,CAAA;AACF;AAEO,IAAME,YAAY;EACvBC,uBAAuBtB,kBAAkBC,KAAK;IAC5CN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBkB,aAAa;QAChDhB,MAAMC,aAAKC,OAAOC,WAAWc,UAAU,EAAGZ,SAAQ;QAClDa,QAAQ;UAAE,KAAKC,IAAIC,kBAAkBC,OAAOC,KAAK/B,OAAOiB,IAAIZ,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;QAAG;QACrFkB,QAAQ;UAAE,KAAKJ,IAAIC,kBAAkBC,OAAOC,KAAKb,KAAKI,UAAUjB,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;QAAG;QACzFC,MAAM;UACJkB,OAAO;UACPC,UAAU;QACZ;MACF,CAAA;IACF;EACF,CAAA;EACAC,uBAAuBjC,kBAAkBC,KAAK;IAC5CN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBkB,aAAa;QAChDhB,MAAMC,aAAKC,OAAOC,WAAWc,UAAU,EAAGZ,SAAQ;QAClDa,QAAQ;UAAE,KAAKC,IAAIC,kBAAkBC,OAAOC,KAAK/B,OAAOC,MAAMI,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;QAAG;QACvFkB,QAAQ;UAAE,KAAKJ,IAAIC,kBAAkBC,OAAOC,KAAKb,KAAKC,KAAKd,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;QAAG;QACpFC,MAAM;UACJkB,OAAO;UACPC,UAAU;QACZ;MACF,CAAA;IACF;EACF,CAAA;AACF;AAEO,IAAME,QAAQ;EACnBC,OAAOnC,kBAAkBC,KAAK;IAC5BN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAW0B,IAAI,EAAGxB,SAAQ;QAC5CC,MAAM;UACJwB,OAAO;UACPC,aAAa;UACbC,QAAQ;UACRC,SAAS;UACTC,UAAU;YAAE,KAAKf,IAAIC,kBAAkBC,OAAOC,KAAK/B,OAAOiB,IAAIZ,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;UAAG;QACzF;MACF,CAAA;IACF;EACF,CAAA;EACA8B,OAAO1C,kBAAkBC,KAAK;IAC5BN,UAAUA,SAASO,MAAK;IACxBC,SAAS;MACP,CAACC,SAASP,OAAM,CAAA,GAAKQ,gBAAgBC,WAAW;QAC9CC,MAAMC,aAAKC,OAAOC,WAAW0B,IAAI,EAAGxB,SAAQ;QAC5CC,MAAM;UACJwB,OAAO;UACPC,aAAa;UACbC,QAAQ;UACRC,SAAS;UACTC,UAAU;YAAE,KAAKf,IAAIC,kBAAkBC,OAAOC,KAAK/B,OAAOC,MAAMI,OAAO,EAAG,CAAA,CAAE,EAAES,SAAQ;UAAG;QAC3F;MACF,CAAA;IACF;EACF,CAAA;AACF;;;AEzHA,SAAS+B,sBAAsB;AAC/B,SAASC,qBAAqB;AAQvB,IAAMC,mBAAmB,CAACC,QAAoCC,UAAU,YAAO;AACpF,QAAMC,aAAaC,aAAaH,MAAAA;AAChC,QAAMI,WAAWC,kBAAkBL,MAAAA;AACnCM,iBAAeF,UAAU,YAAY,kCAAA;AACrC,QAAMG,aAAa,IAAIC,WAAWC,WAAWC,kBAAkB;IAAEN;IAAUH;IAASC;EAAW,CAAA,CAAA;AAG/FS,YAAUJ,WAAWK,kBAAkB,MAAA;AACrCL,eAAWM,YAAW;EACxB,CAAA;AAEA,SAAON;AACT;AAKO,IAAMO,uBAAuB,CAACC,QACnCC,cAAcD,KAAK,CAACE,OAAYC,YAAAA;AAC9B,MAAI,OAAOD,UAAU,YAAY;AAC/B,WAAO;EACT;AAEA,MAAIA,iBAAiBE,QAAQ;AAC3B,WAAOF;EACT;AAGA,MAAI,OAAOA,UAAU,UAAU;AAC7B,UAAMG,QAAQ;MAAE,GAAGH;IAAM;AACzB,eAAWI,OAAOC,OAAOC,sBAAsBH,KAAAA,GAAe;AAC5DA,YAAMC,IAAIG,SAAQ,CAAA,IAAMJ,MAAMC,GAAAA;AAC9B,aAAOD,MAAMC,GAAAA;IACf;AAEA,WAAOH,QAAQE,KAAAA;EACjB;AAEA,SAAOF,QAAQD,KAAAA;AACjB,CAAA;AAOK,IAAMQ,gBAAgB,IAAIC,YAAAA;AAC/B,MAAIC,cAAc;AAElB,QAAMC,eAAeF,QAAQG,IAAI,CAACd,QAChCJ,UAAUI,KAAK,MAAA;AACbY;EACF,CAAA,CAAA;AAGF,QAAMG,iBAAiB,MAAA;AACrB,eAAWC,SAASH,cAAc;AAChCG,YAAAA;IACF;EACF;AAEA,SAAO;;IAEL,CAACC,OAAOC,OAAO,GAAGH;IAClB,IAAII,QAAQ;AACV,aAAOP;IACT;EACF;AACF;",
+  "names": ["DatabaseDirectory", "ObjectStructure", "DXN", "ObjectId", "PublicKey", "Schema", "TestSchema", "Expando", "Struct", "key", "String", "value", "Any", "pipe", "object", "typename", "version", "Nested", "field", "TestClass", "toJSON", "ExampleSchema", "string", "number", "Number", "boolean", "Boolean", "null", "Null", "undefined", "Undefined", "stringArray", "Array", "twoDimNumberArray", "nested", "nestedArray", "nestedNullableArray", "Union", "reference", "suspend", "Ref", "Example", "referenceArray", "classInstance", "instanceOf", "other", "partial", "MessageStruct", "timestamp", "propertySignature", "withConstructorDefault", "Date", "toISOString", "Message", "Organization", "name", "properties", "optional", "Record", "Person", "username", "email", "age", "tasks", "Task", "employer", "address", "city", "state", "zip", "coordinates", "lat", "lng", "fields", "label", "title", "deadline", "completed", "assignee", "previous", "subTasks", "description", "HasManager", "relation", "source", "target", "EmployedBy", "role", "since", "RecordType", "Container", "objects", "Unknown", "records", "contacts", "type", "Enums", "spaceKey", "PublicKey", "random", "PEOPLE", "alice", "DatabaseDirectory", "make", "toHex", "objects", "ObjectId", "ObjectStructure", "makeObject", "type", "Type", "getDXN", "TestSchema", "Person", "toString", "data", "name", "bob", "ORGS", "dxos", "Organization", "founded", "cyberdyne", "WORKS_FOR", "fredWorksForCyberdyne", "makeRelation", "EmployedBy", "source", "DXN", "fromLocalObjectId", "Object", "keys", "target", "since", "position", "aliceWorksForAperture", "TASKS", "task1", "Task", "title", "description", "status", "dueDate", "assignee", "task2", "assertArgument", "deepMapValues", "createEchoSchema", "schema", "version", "jsonSchema", "toJsonSchema", "typename", "getSchemaTypename", "assertArgument", "echoSchema", "EchoSchema", "makeObject", "PersistentSchema", "subscribe", "persistentSchema", "_invalidate", "prepareAstForCompare", "obj", "deepMapValues", "value", "recurse", "RegExp", "clone", "sym", "Object", "getOwnPropertySymbols", "toString", "updateCounter", "objects", "updateCount", "unsubscribes", "map", "unsubscribeAll", "unsub", "Symbol", "dispose", "count"]
+}

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

@@ -0,0 +1,24 @@
+export { DescriptionAnnotation, FormInputAnnotation, GeneratorAnnotation, LabelAnnotation, ReferenceAnnotation, SystemTypeAnnotation, TypeAnnotation, getDescriptionWithSchema, getLabelWithSchema, getTypeAnnotation, setDescriptionWithSchema, setLabelWithSchema, IconAnnotation, } from './internal/Annotation';
+import type * as Schema from 'effect/Schema';
+import * as internalAnnotations from './internal/Annotation';
+interface MakeProps<T> {
+    id: string;
+    schema: Schema.Schema<T, any, never>;
+}
+/**
+ * Create a new schema annotation.
+ * Annotation can be assigned both to fields and to the schema itself.
+ * Annotation is serialized with the schema.
+ *
+ * @example
+ * ```ts
+ * const ColorAnnotation = Annotation.make({
+ *   id: 'org.dxos.annotation.color',
+ *   schema: Schema.String,
+ * });
+ *
+ * const schema = Schema.String.annotations(ColorAnnotation.set('red'));
+ * ```
+ */
+export declare const make: <T>(props: MakeProps<T>) => internalAnnotations.AnnotationHelper<T>;
+//# sourceMappingURL=Annotation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Annotation.d.ts","sourceRoot":"","sources":["../../../src/Annotation.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,cAAc,EACd,wBAAwB,EACxB,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,kBAAkB,EAClB,cAAc,GACf,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,mBAAmB,MAAM,uBAAuB,CAAC;AAE7D,UAAU,SAAS,CAAC,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;CACtC;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAC7C,CAAC"}

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

@@ -0,0 +1,16 @@
+import * as Schema from 'effect/Schema';
+import * as internal from './internal';
+import * as Obj from './Obj';
+import * as Type from './Type';
+/**
+ * A an ordered set of objects.
+ */
+export declare const Collection: Type.Obj<{
+    readonly name?: string | undefined;
+    readonly objects: readonly internal.Ref<import("./Entity").OfKind<internal.EntityKind.Object> & Obj.Unknown>[];
+}, Schema.Struct.Fields>;
+export interface Collection extends Schema.Schema.Type<typeof Collection> {
+}
+export declare const make: (props?: Partial<Obj.MakeProps<typeof Collection>>) => Collection;
+export declare const isCollection: (value: unknown) => value is Collection;
+//# sourceMappingURL=Collection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../../../src/Collection.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,UAAU;;;wBAYtB,CAAC;AAEF,MAAM,WAAW,UAAW,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAE5E,eAAO,MAAM,IAAI,GAAI,QAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,UAAU,CAAC,CAAM,KAAG,UAC5B,CAAC;AAElD,eAAO,MAAM,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,UAAuC,CAAC"}

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

@@ -0,0 +1,201 @@
+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 type * as Types from 'effect/Types';
+import { DXN, type SpaceId } from '@dxos/keys';
+import type * as Entity from './Entity';
+import * as Err from './Err';
+import type * as Filter from './Filter';
+import type * as Hypergraph from './Hypergraph';
+import { type AnyProperties } from './internal/common/types';
+import type { Ref } from './internal/Ref/ref';
+import type * as Obj from './Obj';
+import type * as Query from './Query';
+import type * as QueryResult from './QueryResult';
+import type * as SchemaRegistry from './SchemaRegistry';
+import type * as Type from './Type';
+/**
+ * `query` API function declaration.
+ */
+export interface QueryFn {
+    <Q extends Query.Any>(query: Q): QueryResult.QueryResult<Query.Type<Q>>;
+    <F extends Filter.Any>(filter: F): QueryResult.QueryResult<Filter.Type<F>>;
+}
+/**
+ * Common interface for Database and Queue.
+ */
+export interface Queryable {
+    query: QueryFn;
+}
+export type GetObjectByIdOptions = {
+    deleted?: boolean;
+};
+export type ObjectPlacement = 'root-doc' | 'linked-doc';
+export type AddOptions = {
+    /**
+     * Where to place the object in the Automerge document tree.
+     * Root document is always loaded with the space.
+     * Linked documents are loaded lazily.
+     * Placing large number of objects in the root document may slow down the initial load.
+     *
+     * @default 'linked-doc'
+     */
+    placeIn?: ObjectPlacement;
+};
+export type FlushOptions = {
+    /**
+     * Write any pending changes to disk.
+     * @default true
+     */
+    disk?: boolean;
+    /**
+     * Wait for pending index updates.
+     * @default true
+     */
+    indexes?: boolean;
+    /**
+     * Flush pending updates to objects and queries.
+     * @default false
+     */
+    updates?: boolean;
+};
+/**
+ * Identifier denoting an ECHO Database.
+ */
+export declare const TypeId: unique symbol;
+export type TypeId = typeof TypeId;
+/**
+ * ECHO Database interface.
+ */
+export interface Database extends Queryable {
+    readonly [TypeId]: TypeId;
+    get spaceId(): SpaceId;
+    get schemaRegistry(): SchemaRegistry.SchemaRegistry;
+    get graph(): Hypergraph.Hypergraph;
+    toJSON(): object;
+    /**
+     * Return object by local ID.
+     */
+    getObjectById<T extends Obj.Unknown = Obj.OfShape<AnyProperties>>(id: string, opts?: GetObjectByIdOptions): T | undefined;
+    /**
+     * Query objects.
+     */
+    query: QueryFn;
+    /**
+     * Creates a reference to an existing object in the database.
+     *
+     * NOTE: The reference may be dangling if the object is not present in the database.
+     * NOTE: Difference from `Ref.fromDXN`
+     * `Ref.fromDXN(dxn)` returns an unhydrated reference. The `.load` and `.target` APIs will not work.
+     * `db.makeRef(dxn)` is preferable in cases with access to the database.
+     */
+    makeRef<T extends Entity.Unknown = Entity.Unknown>(dxn: DXN): Ref<T>;
+    /**
+     * Adds object to the database.
+     */
+    add<T extends Entity.Unknown = Entity.Unknown>(obj: T, opts?: AddOptions): T;
+    /**
+     * Removes object from the database.
+     */
+    remove(obj: Entity.Unknown): void;
+    /**
+     * Wait for all pending changes to be saved to disk.
+     * Optionaly waits for changes to be propagated to indexes and event handlers.
+     */
+    flush(opts?: FlushOptions): Promise<void>;
+}
+export declare const isDatabase: (obj: unknown) => obj is Database;
+export declare const Database: Schema.Schema<Database>;
+declare const Service_base: Context.TagClass<Service, "@dxos/echo/Database/Service", {
+    readonly db: Database;
+}>;
+/**
+ * Effect service tag for Database dependency injection.
+ */
+export declare class Service extends Service_base {
+}
+/**
+ * Layer that provides a Database service that throws when accessed.
+ * Useful as a default layer when no database is available.
+ */
+export declare const notAvailable: Layer.Layer<Service, never, never>;
+/**
+ * Creates a Database service instance from a Database.
+ */
+export declare const makeService: (db: Database) => Context.Tag.Service<Service>;
+/**
+ * Creates a Layer that provides the Database service.
+ */
+export declare const layer: (db: Database) => Layer.Layer<Service>;
+/**
+ * Returns the space ID of the database.
+ */
+export declare const spaceId: Effect.Effect<SpaceId, never, Service>;
+/**
+ * Resolves an object by its DXN.
+ */
+export declare const resolve: {
+    (ref: DXN | Ref<any>): Effect.Effect<Entity.Unknown, never, Service>;
+    <S extends Type.AnyEntity>(ref: DXN | Ref<any>, schema: S): Effect.Effect<Schema.Schema.Type<S>, Err.ObjectNotFoundError, Service>;
+};
+/**
+ * Loads an object reference.
+ */
+export declare const load: <T>(ref: Ref<T>) => Effect.Effect<T, Err.ObjectNotFoundError, never>;
+/**
+ * Loads an object reference option.
+ */
+export declare const loadOption: <T>(ref: Ref<T>) => Effect.Effect<Option.Option<T>, never, never>;
+/**
+ * Adds an object to the database.
+ * @see {@link Database.add}
+ */
+export declare const add: <T extends Entity.Unknown>(obj: T) => Effect.Effect<T, never, Service>;
+/**
+ * Removes an object from the database.
+ * @see {@link Database.remove}
+ */
+export declare const remove: <T extends Entity.Unknown>(obj: T) => Effect.Effect<void, never, Service>;
+/**
+ * Flushes pending changes to disk.
+ * @see {@link Database.flush}
+ */
+export declare const flush: (opts?: FlushOptions) => Effect.Effect<void, never, Service>;
+/**
+ * Creates a `QueryResult` object that can be subscribed to.
+ */
+export declare const query: {
+    <Q extends Query.Any>(query: Q): Effect.Effect<QueryResult.QueryResult<Query.Type<Q>>, never, Service>;
+    <F extends Filter.Any>(filter: F): Effect.Effect<QueryResult.QueryResult<Filter.Type<F>>, never, Service>;
+};
+/**
+ * Executes the query once and returns the results.
+ */
+export declare const runQuery: {
+    <Q extends Query.Any>(query: Q): Effect.Effect<Query.Type<Q>[], never, Service>;
+    <F extends Filter.Any>(filter: F): Effect.Effect<Filter.Type<F>[], never, Service>;
+};
+/**
+ * Executes the query once and returns the first result as or None.
+ */
+export declare const runQueryFirst: {
+    <Q extends Query.Any>(query: Q): Effect.Effect<Option.Option<Query.Type<Q>>, never, Service>;
+    <F extends Filter.Any>(filter: F): Effect.Effect<Option.Option<Filter.Type<F>>, never, Service>;
+};
+/**
+ * Persists schemas in the database so they replicate to other clients.
+ * @see {@link SchemaRegistry.SchemaRegistry.register}
+ */
+export declare const registerSchema: (input: SchemaRegistry.RegisterSchemaInput[]) => Effect.Effect<Type.RuntimeType[], never, Service>;
+/**
+ * Creates a schema query result that can be subscribed to.
+ */
+export declare const schemaQuery: <Q extends Types.NoExcessProperties<SchemaRegistry.Query, Q>>(schemaQueryOptions?: Q & SchemaRegistry.Query) => Effect.Effect<QueryResult.QueryResult<SchemaRegistry.ExtractQueryResult<Q>>, never, Service>;
+/**
+ * Executes a schema query once and returns the results.
+ */
+export declare const runSchemaQuery: <Q extends Types.NoExcessProperties<SchemaRegistry.Query, Q>>(schemaQueryOptions?: Q & SchemaRegistry.Query) => Effect.Effect<SchemaRegistry.ExtractQueryResult<Q>[], never, Service>;
+export {};
+//# sourceMappingURL=Database.d.ts.map