@dxos/echo 0.8.4-main.40e3dcdf1b → 0.8.4-main.43cb759274

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

@@ -1,6 +1,51 @@
-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';
+export { DescriptionAnnotation, FormInputAnnotation, FormInlineAnnotation, GeneratorAnnotation, LabelAnnotation, ReferenceAnnotation, HiddenAnnotation, TypeAnnotation, getDescriptionWithSchema, getLabelWithSchema, getTypeAnnotation, setDescriptionWithSchema, setLabelWithSchema, IconAnnotation, IconFromRefAnnotation, } from './internal/Annotation';
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import * as Types from 'effect/Types';
+import * as Entity from './Entity';
+export declare const TypeId: '~@dxos/echo/Annotation';
+export type TypeId = typeof TypeId;
+/**
+ * Annotation is a typed property that can be assigned to a schema or an entity instance.
+ */
+export interface Annotation<T> {
+    [TypeId]: {
+        _Type: T;
+    };
+    /**
+     * Unique fully-qualified identifier for the annotation.
+     * @example "org.dxos.annotation.color"
+     */
+    readonly key: Key;
+    /**
+     * Schema of the annotation value.
+     */
+    readonly schema: Schema.Schema<T, unknown, never>;
+    /**
+     * Get the annotation value from an Effect schema.
+     *
+     * Only accepts `Schema.Schema.Any` — to read an annotation off a `Type.Type`
+     * entity, unwrap it first with `Type.getSchema(entity)`. This keeps the
+     * annotation pipeline single-shaped and forces annotations to live on the
+     * source schema, not on the post-construction Type entity.
+     */
+    get: (schema: Schema.Schema.Any) => Option.Option<T>;
+    /**
+     * Get the annotation value from the AST.
+     */
+    getFromAst: (ast: SchemaAST.AST) => Option.Option<T>;
+    /**
+     * Set the annotation on an Effect schema.
+     *
+     * Only accepts `Schema.Schema.Any` — annotations must be applied to the
+     * source schema BEFORE wrapping it with `Type.makeObject` / `Type.makeRelation`.
+     * In a pipe, place every `Annotation.X.set(...)` before the `Type.make...` step.
+     */
+    set: (value: T) => <S extends Schema.Schema.Any>(schema: S) => S;
+}
+export declare const Key: Schema.brand<typeof Schema.String, "~@dxos/echo/AnnotationKey">;
+export type Key = Schema.Schema.Type<typeof Key>;
 interface MakeProps<T> {
     id: string;
     schema: Schema.Schema<T, any, never>;
@@ -20,5 +65,64 @@ interface MakeProps<T> {
  * const schema = Schema.String.annotations(ColorAnnotation.set('red'));
  * ```
  */
-export declare const make: <T>(props: MakeProps<T>) => internalAnnotations.AnnotationHelper<T>;
+export declare const make: <T>(props: MakeProps<T>) => Annotation<T>;
+/**
+ * Get the value of an annotation from an entity instance or snapshot.
+ * For schema-level reads use the annotation instance method (e.g. `ColorAnnotation.get(schema)`).
+ * For getting an annotation value from a dictionary, use `getDictionary`.
+ */
+export declare const get: {
+    <T>(annotation: Annotation<T>): (target: Entity.Unknown | Entity.Snapshot) => Option.Option<T>;
+    <T>(target: Entity.Unknown | Entity.Snapshot, annotation: Annotation<T>): Option.Option<T>;
+};
+/**
+ * Set the value of an annotation on an entity instance.
+ * For schema-level writes use the annotation instance method (e.g. `ColorAnnotation.set('red')`).
+ * For setting an annotation value on a dictionary, use `setDictionary`.
+ */
+export declare const set: {
+    <T>(annotation: Annotation<T>, value: T): (target: Entity.Mutable<Entity.Unknown>) => void;
+    <T>(target: Entity.Mutable<Entity.Unknown>, annotation: Annotation<T>, value: T): void;
+};
+export declare const getFromAst: {
+    <T>(annotation: Annotation<T>): (ast: SchemaAST.AST) => Option.Option<T>;
+    <T>(ast: SchemaAST.AST, annotation: Annotation<T>): Option.Option<T>;
+};
+/**
+ * Set of annotation values.
+ *
+ * Can be used inside an object/relation schema:
+ *
+ * ```ts
+ * const Person = Schema.Struct({
+ *   name: Schema.String,
+ *   extensions: Annotation.Dictionary,
+ * });
+ * ```
+ */
+export declare const Dictionary: Schema.Record$<Schema.brand<typeof Schema.String, "~@dxos/echo/AnnotationKey">, typeof Schema.Unknown>;
+export interface Dictionary extends Schema.Schema.Type<typeof Dictionary> {
+}
+/**
+ * Get the value of an annotation from a Dictionary.
+ */
+export declare const getDictionary: {
+    <T>(annotation: Annotation<T>): (values: Dictionary) => Option.Option<T>;
+    <T>(values: Dictionary, annotation: Annotation<T>): Option.Option<T>;
+};
+/**
+ * Set the value of an annotation in a Dictionary.
+ *
+ * Can also be used within Obj.update callback:
+ *
+ * ```ts
+ * Obj.update(obj, (obj) => {
+ *   Annotation.setDictionary(obj.annotations, ColorAnnotation, 'red');
+ * });
+ * ```
+ */
+export declare const setDictionary: {
+    <T>(annotation: Annotation<T>, value: T): (values: Dictionary) => void;
+    <T>(values: Types.Mutable<Dictionary>, annotation: Annotation<T>, value: T): void;
+};
 //# sourceMappingURL=Annotation.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"Annotation.d.ts","sourceRoot":"","sources":["../../../src/Annotation.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,GACtB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAGnC,eAAO,MAAM,MAAM,EAAG,wBAAiC,CAAC;AACxD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAMnC;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,CAAC,MAAM,CAAC,EAAE;QACR,KAAK,EAAE,CAAC,CAAC;KACV,CAAC;IAGF;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrD;;OAEG;IACH,UAAU,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrD;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;CAClE;AAED,eAAO,MAAM,GAAG,iEAA0B,CAAC;AAC3C,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;AAEjD,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,UAAU,CAAC,CAAC,CAA0C,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAM3F,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAC3F,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAMvF,CAAC;AAEH,eAAO,MAAM,UAAU,EAAE;IACvB,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAMrE,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,wGAAiC,CAAC;AACzD,MAAM,WAAW,UAAW,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAE5E;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAMrE,CAAC;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IACvE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAMlF,CAAC"}

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

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

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

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

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

@@ -7,10 +7,9 @@ import * as Type from './Type';
  */
 export declare const Collection: Type.Obj<{
     readonly name?: string | undefined;
-    readonly objects: readonly internal.Ref<import("./Entity").OfKind<internal.EntityKind.Object> & Obj.Unknown>[];
+    readonly objects: readonly internal.Ref<Obj.Unknown>[];
 }, Schema.Struct.Fields>;
-export interface Collection extends Schema.Schema.Type<typeof Collection> {
-}
+export type Collection = Type.InstanceType<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

@@ -1 +1 @@
-{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../../../src/Collection.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,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;;;wBAQtB,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"}
+{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../../../src/Collection.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAKxC,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;;;wBAMtB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,UAAU,CAAC,CAAC;AAE9D,eAAO,MAAM,IAAI,WAAW,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,UAAU,CAAC,CAAC,KAAQ,UAC5B,CAAC;AAElD,eAAO,MAAM,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,UAAuC,CAAC"}

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

@@ -3,18 +3,17 @@ 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 SpaceId, type URI } 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, EntityKind, KindId } from './internal/common/types';
 import type { Ref } from './internal/Ref/ref';
-import { type AnyProperties } from './internal/common/types';
 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 Registry from './Registry';
 import type * as Type from './Type';
 /**
  * `query` API function declaration.
@@ -24,7 +23,7 @@ export interface QueryFn {
     <F extends Filter.Any>(filter: F): QueryResult.QueryResult<Filter.Type<F>>;
 }
 /**
- * Common interface for Database and Queue.
+ * Common interface for Database, Feed, and Hypergraph.
  */
 export interface Queryable {
     query: QueryFn;
@@ -44,6 +43,17 @@ export type AddOptions = {
      */
     placeIn?: ObjectPlacement;
 };
+/**
+ * Rejects Type entities from {@link Database.add} at compile time via their `[KindId]` brand. Used
+ * as `T & RejectTypeEntity<T>` to preserve inference of `T`. Bounding `add` on
+ * `Obj.Unknown | Relation.Unknown` instead would reject broadly-typed instance adds (e.g.
+ * `Entity.Any`, `Obj.OfShape<T>`), forcing casts repo-wide.
+ */
+export type RejectTypeEntity<T> = T extends {
+    readonly [KindId]: EntityKind.Type;
+} ? {
+    __error: 'Type entities must be persisted via db.addType(), not db.add().';
+} : T;
 export type FlushOptions = {
     /**
      * Write any pending changes to disk.
@@ -72,8 +82,13 @@ export type TypeId = typeof TypeId;
 export interface Database extends Queryable {
     readonly [TypeId]: TypeId;
     get spaceId(): SpaceId;
-    get schemaRegistry(): SchemaRegistry.SchemaRegistry;
     get graph(): Hypergraph.Hypergraph;
+    /**
+     * Registry for this database. Delegates type lookups to the shared hypergraph registry.
+     * To persist a schema so it replicates to other clients, add the type entity with
+     * {@link addType} (e.g. `await db.addType(Type.makeObjectFromJsonSchema(...))`).
+     */
+    readonly registry: Registry.Registry;
     toJSON(): object;
     /**
      * Return object by local ID.
@@ -87,15 +102,26 @@ export interface Database extends Queryable {
      * 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.
+     * NOTE: Difference from `Ref.fromURI`
+     * `Ref.fromURI(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>;
+    makeRef<T extends Entity.Unknown = Entity.Unknown>(uri: URI.URI): Ref<T>;
     /**
-     * Adds object to the database.
+     * Adds an object or relation to the database.
+     *
+     * Only Object and Relation entities are accepted. To persist a Type definition use
+     * {@link addType} — passing a Type entity is rejected at compile time (and at runtime).
      */
-    add<T extends Entity.Unknown = Entity.Unknown>(obj: T, opts?: AddOptions): T;
+    add<T extends Entity.Unknown = Entity.Unknown>(obj: T & RejectTypeEntity<T>, opts?: AddOptions): T;
+    /**
+     * Persists a Type definition (clones/forks the entity) so it replicates to other peers.
+     *
+     * Runs a conflict query first: if a type with the same typename + version already exists in
+     * this space, the existing persisted entity is returned and no duplicate is created. This is
+     * the only supported way to add Type entities — {@link add} rejects them.
+     */
+    addType<T extends Type.AnyEntity>(type: T): Promise<T>;
     /**
      * Removes object from the database.
      */
@@ -137,22 +163,27 @@ 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>;
+    (ref: URI.URI | Ref<any>): Effect.Effect<Entity.Unknown, never, Service>;
+    <S extends Type.AnyEntity>(ref: URI.URI | Ref<any>, schema: S): Effect.Effect<Type.InstanceType<S>, Err.EntityNotFoundError, Service>;
 };
 /**
  * Loads an object reference.
  */
-export declare const load: <T>(ref: Ref<T>) => Effect.Effect<T, Err.ObjectNotFoundError, never>;
+export declare const load: <T>(ref: Ref<T>) => Effect.Effect<T, Err.EntityNotFoundError, 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.
+ * Adds an object or relation to the database.
  * @see {@link Database.add}
  */
-export declare const add: <T extends Entity.Unknown>(obj: T) => Effect.Effect<T, never, Service>;
+export declare const add: <T extends Entity.Unknown>(obj: T & RejectTypeEntity<T>) => Effect.Effect<T, never, Service>;
+/**
+ * Persists a Type definition to the database.
+ * @see {@link Database.addType}
+ */
+export declare const addType: <T extends Type.AnyEntity>(type: T) => Effect.Effect<T, never, Service>;
 /**
  * Removes an object from the database.
  * @see {@link Database.remove}
@@ -167,23 +198,24 @@ export declare const flush: (opts?: FlushOptions) => Effect.Effect<void, never,
  * 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>;
+    <Q extends Query.Any>(query: Q): QueryResult.QueryResultEffect<Query.Type<Q>, never, Service>;
+    <F extends Filter.Any>(filter: F): QueryResult.QueryResultEffect<Filter.Type<F>, never, Service>;
 };
 /**
  * Executes the query once and returns the results.
+ * @deprecated Use `yield* query(...).run` instead.
  */
 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>;
 };
 /**
- * Creates a schema query result that can be subscribed to.
+ * Executes the query once and returns the first result as or None.
+ * @deprecated Use `yield* query(...).first` instead.
  */
-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 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>;
+};
 export {};
 //# sourceMappingURL=Database.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Database.d.ts","sourceRoot":"","sources":["../../../src/Database.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAI3C,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAEhD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AAEH,MAAM,WAAW,OAAO;IACtB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,eAAoC,CAAC;AACxD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,IAAI,OAAO,IAAI,OAAO,CAAC;IAGvB,IAAI,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC;IAEpD,IAAI,KAAK,IAAI,UAAU,CAAC,UAAU,CAAC;IAEnC,MAAM,IAAI,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,EAC9D,EAAE,EAAE,MAAM,EACV,IAAI,CAAC,EAAE,oBAAoB,GAC1B,CAAC,GAAG,SAAS,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAErE;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC;IAE7E;;OAEG;IAEH,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,eAAO,MAAM,UAAU,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,QAEhD,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAgE,CAAC;;iBAQ7F,QAAQ;;AANzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,YAK1B;CAAG;AAEN;;;GAGG;AACH,eAAO,MAAM,YAAY,oCAIvB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,QAAQ,KAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAMrE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,IAAI,QAAQ,KAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,wCAGlB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE;IAEpB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAErE,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EACvB,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,EACnB,MAAM,EAAE,CAAC,GACR,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;CAuBhE,CAAC;AAEb;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAMpF,CAAC;AAEH;;GAEG;AAEH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAIvF,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CACnC,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CACtC,CAAC;AAEvD;;;GAGG;AACH,eAAO,MAAM,KAAK,GAAI,OAAO,YAAY,wCACgD,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAKzG,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAEgC,CAAC;AAEtH;;GAEG;AAEH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,EACrF,qBAAqB,CAAC,GAAG,cAAc,CAAC,KAAK,KAC5C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAI3F,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,EACxF,qBAAqB,CAAC,GAAG,cAAc,CAAC,KAAK,KAC5C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAGpE,CAAC"}
+{"version":3,"file":"Database.d.ts","sourceRoot":"","sources":["../../../src/Database.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,KAAK,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAIjF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AAEH,MAAM,WAAW,OAAO;IACtB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,IAAI,CAAA;CAAE,GAC9E;IAAE,OAAO,EAAE,iEAAiE,CAAA;CAAE,GAC9E,CAAC,CAAC;AAEN,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,eAAoC,CAAC;AACxD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,IAAI,OAAO,IAAI,OAAO,CAAC;IAEvB,IAAI,KAAK,IAAI,UAAU,CAAC,UAAU,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAErC,MAAM,IAAI,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,EAC9D,EAAE,EAAE,MAAM,EACV,IAAI,CAAC,EAAE,oBAAoB,GAC1B,CAAC,GAAG,SAAS,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAEzE;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC;IAEnG;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEvD;;OAEG;IAEH,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,eAAO,MAAM,UAAU,QAAS,OAAO,KAAG,GAAG,IAAI,QAEhD,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAgE,CAAC;;iBAQ7F,QAAQ;;AANzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,YAK1B;CAAG;AAEN;;;GAGG;AACH,eAAO,MAAM,YAAY,oCAIvB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW,OAAQ,QAAQ,KAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAMrE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,OAAQ,QAAQ,KAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,wCAGlB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE;IAEpB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAEzE,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EACvB,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,EACvB,MAAM,EAAE,CAAC,GACR,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;CAyBrB,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAQrF,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAMvF,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,CAAC,OAAO,OAAO,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAChB,CAAC;AAE7F;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,IAAI,CAAC,SAAS,QAAQ,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAGxF,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,OAAO,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CACG,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,KAAK,UAAW,YAAY,wCAGtC,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAMhG,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAKlF,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;CAO/F,CAAC"}

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

@@ -4,15 +4,26 @@ import * as Feed from './Feed';
 import * as Obj from './Obj';
 import * as View from './View';
 /**
- * Abstart set of objects, represented by a view, feed, or collection.
+ * Abstract set of objects, represented by a view, feed, or collection.
+ * Schema-level union of the underlying type entities (rebuilt via
+ * `Type.getSchema`) so this can still be consumed by Schema-side APIs such
+ * as `Filter.type(...)` on a union.
  */
-export declare const Dataset: Schema.Union<[import("./Type").Obj<{
+export type Dataset = Feed.Feed | Collection.Collection | View.View;
+export declare const Dataset: Schema.Union<[Schema.Schema<{
+    readonly name?: string | undefined;
     readonly kind?: string | undefined;
+    readonly namespace?: "data" | "trace" | undefined;
+} & import("./Entity").OfKind<import("./internal").EntityKind.Object>, {
     readonly name?: string | undefined;
-}, Schema.Struct.Fields>, import("./Type").Obj<{
+    readonly kind?: string | undefined;
+    readonly namespace?: "data" | "trace" | undefined;
+} & import("./Entity").OfKind<import("./internal").EntityKind.Object>, never>, Schema.Schema<{
     readonly name?: string | undefined;
-    readonly objects: readonly import("./internal").Ref<import("./Entity").OfKind<import("./internal").EntityKind.Object> & Obj.Unknown>[];
-}, Schema.Struct.Fields>, import("./Type").Obj<View.View, Schema.Struct.Fields>]>;
-export type Dataset = Feed.Feed | Collection.Collection | View.View;
+    readonly objects: readonly import("./internal").Ref<Obj.Unknown>[];
+} & import("./Entity").OfKind<import("./internal").EntityKind.Object>, {
+    readonly name?: string | undefined;
+    readonly objects: readonly import("./internal").Ref<Obj.Unknown>[];
+} & import("./Entity").OfKind<import("./internal").EntityKind.Object>, never>, Schema.Schema<View.View & import("./Entity").OfKind<import("./internal").EntityKind.Object>, View.View & import("./Entity").OfKind<import("./internal").EntityKind.Object>, never>]>;
 export declare const isDataset: (value: unknown) => value is Dataset;
 //# sourceMappingURL=Dataset.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/Dataset.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,OAAO;;;;;;iFAA4D,CAAC;AACjF,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;AAEpE,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAIpD,CAAC"}
+{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/Dataset.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;AACpE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;mQAInB,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAIpD,CAAC"}

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

@@ -1,28 +1,32 @@
+import * as Schema from 'effect/Schema';
 import type { ForeignKey } from '@dxos/echo-protocol';
-import type { DXN, ObjectId } from '@dxos/keys';
+import type { EntityId, URI } from '@dxos/keys';
 import * as internal from './internal';
+import type * as Ref from './Ref';
 import type * as Relation from './Relation';
+import type * as Tag from './Tag';
+import * as Type from './Type';
 export declare const KindId: "~@dxos/echo/Kind";
 export type KindId = typeof internal.KindId;
 export declare const SnapshotKindId: "~@dxos/echo/SnapshotKind";
 export type SnapshotKindId = typeof internal.SnapshotKindId;
 export declare const Kind: typeof internal.EntityKind;
 export type Kind = internal.EntityKind;
-export declare const KindSchema: import("effect/Schema").Enums<typeof internal.EntityKind>;
+export declare const KindSchema: Schema.Enums<typeof internal.EntityKind>;
 /**
  * Assigns a kind to an Object or Relation instance.
  * NOTE: Needed to make `isRelation` and `isObject` checks work.
  */
 export interface OfKind<K extends Kind> {
     readonly [KindId]: K;
-    readonly id: ObjectId;
+    readonly id: EntityId;
 }
 /**
  * Assigns a snapshot kind to an Object or Relation snapshot.
  */
 export interface SnapshotOfKind<K extends Kind> {
     readonly [SnapshotKindId]: K;
-    readonly id: ObjectId;
+    readonly id: EntityId;
 }
 /**
  * Obj or Relation with a specific set of properties.
@@ -33,6 +37,22 @@ export type Entity<Props> = OfKind<Kind> & Props;
  */
 export interface Unknown extends OfKind<Kind> {
 }
+/**
+ * Effect Schema for any ECHO entity (object or relation).
+ *
+ * Kind-agnostic counterpart to `Obj.Unknown` / `Relation.Unknown` — validates
+ * the structural shape (id + properties) without constraining `[KindId]`. Used
+ * in operation input schemas that accept any entity flavour (e.g.
+ * `Schema.Array(Entity.Unknown)`).
+ *
+ * The cast bridges the runtime structural schema to the branded `Unknown` type:
+ * `[KindId]` is a symbol brand that can't be expressed in a runtime `Struct`,
+ * so the entity guarantee is carried at the type level only (same approach as
+ * `Obj.Unknown` / `Relation.Unknown`). Unlike those, this is kind-agnostic so it
+ * isn't an `UnknownTypeSchema<_, K>` (there's no single `K`) and carries no
+ * `TypeAnnotation`.
+ */
+export declare const Unknown: Schema.Schema<Unknown>;
 /**
  * Snapshot of an Obj or Relation.
  * Branded with SnapshotKindId instead of KindId.
@@ -60,12 +80,29 @@ export type Properties<T> = Omit<T, 'id' | KindId | Relation.Source | Relation.T
  * Returns `false` for snapshots.
  */
 export declare const isEntity: (value: unknown) => value is Unknown;
+/**
+ * Test if a value is an instance of a given object or relation type.
+ *
+ * Kind-agnostic counterpart to `Obj.instanceOf` / `Relation.instanceOf` —
+ * use this when the caller's input type is `Type.AnyObj | Type.AnyRelation`.
+ *
+ * @example
+ * ```ts
+ * // Caller doesn't know whether `type` is object- or relation-kind.
+ * const matches = <T extends Type.AnyObj | Type.AnyRelation>(type: T, value: unknown) =>
+ *   Entity.instanceOf(type, value);
+ * ```
+ */
+export declare const instanceOf: {
+    <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Type.InstanceType<S>;
+    <S extends Type.AnyEntity>(schema: S, value: unknown): value is Type.InstanceType<S>;
+};
 /**
  * Check if a value is an ECHO entity snapshot.
  * Returns `false` for entities.
  */
 export declare const isSnapshot: (value: unknown) => value is Snapshot;
-export declare const getKind: (schema: import("effect/Schema").Schema.All) => internal.EntityKind | undefined;
+export declare const getKind: (schema: Schema.Schema.All) => internal.EntityKind | undefined;
 /**
  * Property that accesses metadata for an entity.
  */
@@ -79,17 +116,42 @@ export type Meta = typeof Meta;
  */
 export type JSON = internal.ObjectJSON;
 /**
- * Get the DXN of an entity (object or relation).
+ * Any value the read accessors operate on: a reactive entity or a snapshot.
+ * Type entities (`Type.AnyEntity`) are also accepted — they're first-class
+ * entities, and `Unknown`'s kind-agnostic brand already subsumes them.
  */
-export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
+export type AnyInput = Unknown | Snapshot;
 /**
- * Get the DXN of an entity's type.
+ * Get the canonical URI of an entity (object, relation, or type). Returns `URI.URI` —
+ * an `EID` for object/relation instances and persisted types, or a typename
+ * `DXN` for static type entities; narrow with `EID.parse(uri)` or
+ * `DXN.tryMake(uri)` at the point of use.
  */
-export declare const getTypeDXN: (obj: internal.AnyProperties) => DXN | undefined;
+export declare const getURI: (entity: AnyInput) => URI.URI;
 /**
- * Get the typename of an entity's type.
+ * Get the DXN of an entity's type. For object/relation instances this is the URI
+ * of the type they were created from; for a type entity it is the URI of the
+ * meta-type ({@link Type.Type}, `dxn:org.dxos.type.schema:0.1.0`).
  */
-export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
+export declare const getTypeURI: (entity: AnyInput) => URI.URI | undefined;
+/**
+ * Get the type entity (`Type.AnyEntity`) the instance was created from.
+ *
+ * Returns `undefined` when the entity's type isn't registered in this runtime
+ * (e.g. a freshly deserialized snapshot whose type entity hasn't been wired
+ * up yet, or an entity loaded from storage before its schema is known). To
+ * get the Effect Schema from the returned entity, use `Type.getSchema(...)`.
+ *
+ * For a type entity, returns the meta-type {@link Type.Type} (a type entity's
+ * type is "Type").
+ */
+export declare const getType: (entity: AnyInput) => Type.AnyEntity | undefined;
+/**
+ * Get the typename of an entity's type. For object/relation instances this is the
+ * typename of the type they were created from; for a type entity it is the type's
+ * own typename (e.g. `com.example.type.person`).
+ */
+export declare const getTypename: (entity: AnyInput) => string | undefined;
 /**
  * Get the database an entity belongs to.
  */
@@ -99,7 +161,7 @@ export declare const getDatabase: (entity: Unknown | Snapshot) => any | undefine
  * Returns mutable meta when passed a mutable entity (inside change callback).
  * Returns read-only meta when passed a regular entity or snapshot.
  */
-export declare function getMeta(entity: Mutable<Unknown>): internal.ObjectMeta;
+export declare function getMeta(entity: Mutable<Unknown>): internal.EntityMeta;
 export declare function getMeta(entity: Unknown | Snapshot): internal.ReadonlyMeta;
 /**
  * Get foreign keys for an entity from the specified source.
@@ -111,12 +173,26 @@ export declare const getKeys: (entity: Unknown | Snapshot, source: string) => Fo
 export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
 /**
  * Get the label of an entity.
+ *
+ * @param options.fallback `'typename'` returns the entity's typename when no
+ *   label is set (e.g. `org.dxos.type.table`).
+ */
+export declare const getLabel: (entity: Unknown | Snapshot, options?: internal.GetLabelOptions) => string | undefined;
+/**
+ * Set the label of an entity.
+ * Must be called within an `Entity.update` / `Obj.update` / `Relation.update` callback.
  */
-export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
+export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
 /**
  * Get the description of an entity.
  */
 export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the icon annotation for an entity (object or relation), resolved via its type-level
+ * `IconAnnotation`. Returns the full `{ icon, hue }` annotation so callers can use both
+ * the phosphor icon name and the suggested colour.
+ */
+export declare const getIcon: (entity: Unknown | Snapshot) => internal.IconAnnotation | undefined;
 /**
  * Convert an entity to its JSON representation.
  */
@@ -127,14 +203,14 @@ export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
  */
 export declare const subscribe: (entity: Unknown, callback: () => void) => (() => void);
 /**
- * Used to provide a mutable view of an entity within `Entity.change`.
+ * Used to provide a mutable view of an entity within `Entity.update`.
  */
 export type Mutable<T> = internal.Mutable<T>;
 /**
  * Perform mutations on an entity (object or relation) within a change context.
  *
  * Entities are read-only by default. Mutations are batched and notifications fire
- * when the callback completes. Direct mutations outside of `Entity.change` will throw
+ * when the callback completes. Direct mutations outside of `Entity.update` will throw
  * at runtime.
  *
  * @param entity - The echo entity (object or relation) to mutate.
@@ -142,27 +218,27 @@ export type Mutable<T> = internal.Mutable<T>;
  *
  * @example
  * ```typescript
- * // Mutate within Entity.change
- * Entity.change(entity, (e) => {
- *   e.name = 'Updated';
- *   e.count = 42;
+ * // Mutate within Entity.update
+ * Entity.update(entity, (obj) => {
+ *   obj.name = 'Updated';
+ *   obj.count = 42;
  * });
  *
  * // Direct mutation throws
- * entity.name = 'Bob'; // Error: Cannot modify outside Entity.change()
+ * entity.name = 'Bob'; // Error: Cannot modify outside Entity.update()
  * ```
  *
- * Note: For type-specific operations, prefer `Obj.change` or `Relation.change`.
+ * Note: For type-specific operations, prefer `Obj.update` or `Relation.update`.
  */
-export declare const change: <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>) => void;
+export declare const update: <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>) => void;
 /**
  * Add a tag to an entity.
- * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
  */
-export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
+export declare const addTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
 /**
  * Remove a tag from an entity.
- * Must be called within an `Entity.change`, `Obj.change`, or `Relation.change` callback.
+ * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
  */
-export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
+export declare const removeTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
 //# sourceMappingURL=Entity.d.ts.map