@dxos/echo 0.8.4-main.66e292d → 0.8.4-main.69d29f4

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

@@ -0,0 +1 @@
+{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/Query.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,WAAW,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,KAAK,KAAK,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,KAAK,MAAM,QAAQ,CAAC;AAMrC;;GAEG;AAEH,KAAK,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AAGtC,MAAM,WAAW,KAAK,CAAC,CAAC;IAEtB,QAAQ,EAAE;QAAE,KAAK,EAAE,CAAC,CAAA;KAAE,CAAC;IAEvB,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC;IAEpB;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzC;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,EAC/B,GAAG,EAAE,CAAC,GACL,KAAK,CACN,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GACpB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAChB,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,GAAG,SAAS,GAClC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GACpC,KAAK,CACZ,CAAC;IAEF;;;;;OAKG;IAGH,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACtC,MAAM,EAAE,CAAC,GAAG,MAAM,EAClB,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GACrC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,YAAY,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClC,QAAQ,EAAE,CAAC,GAAG,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClC,QAAQ,EAAE,CAAC,GAAG,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAC/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC;;;OAGG;IACH,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C;;;OAGG;IACH,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;CACnD;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;AAE7B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAsGvE,eAAO,MAAM,EAAE,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,qCAAqC;AACrC,eAAO,MAAM,OAAO,GAAI,KAAK,QAAQ,CAAC,KAAK,KAAG,GAE7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,aAAa,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAG,GAK7F,CAAC;AAEF;;;;GAIG;AAEH,eAAO,MAAM,GAAG,GAAI,GAAG,SAAS,GAAG,EAAE,KAAG,GAUvC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC,CAAC,KAAG,KAAK,CAAC,CAAC,CAMvE,CAAC"}

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

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

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

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

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

@@ -0,0 +1,80 @@
+import { type CleanupFn } from '@dxos/async';
+import type * as Entity from './Entity';
+/**
+ * Individual query result entry.
+ */
+export type Entry<T> = {
+    id: string;
+    /**
+     * May not be present for remote results.
+     */
+    result?: T;
+    match?: {
+        /**
+         * Higher means better match.
+         */
+        rank: number;
+    };
+    /**
+     * Query resolution metadata.
+     */
+    resolution?: {
+        source: 'remote' | 'local' | 'index';
+        /**
+         * Query resolution time in milliseconds.
+         */
+        time: number;
+    };
+};
+/**
+ * Invidual query result entry for a database Entity.
+ */
+export type EntityEntry<T extends Entity.Unknown = Entity.Unknown> = Entry<T>;
+export type RunOptions = {
+    timeout?: number;
+};
+export type SubscriptionOptions = {
+    /**
+     * Fire the callback immediately.
+     */
+    fire?: boolean;
+};
+export interface QueryResult<T> {
+    /**
+     * Currently available results along with their match metadata.
+     */
+    readonly entries: Entry<T>[];
+    /**
+     * Currently available results.
+     */
+    readonly results: T[];
+    /**
+     * Returns all known results.
+     */
+    run(opts?: RunOptions): Promise<T[]>;
+    /**
+     * Returns all known results along with their match metadata.
+     */
+    runEntries(opts?: RunOptions): Promise<Entry<T>[]>;
+    /**
+     * Returns currently available results synchronously.
+     */
+    runSync(): T[];
+    /**
+     * Returns currently available results synchronously along with their match metadata.
+     */
+    runSyncEntries(): Entry<T>[];
+    /**
+     * Returns first result.
+     */
+    first(opts?: RunOptions): Promise<T>;
+    /**
+     * Returns first result if there is one.
+     */
+    firstOrUndefined(opts?: RunOptions): Promise<T | undefined>;
+    /**
+     * Subscribes to changes in query results.
+     */
+    subscribe(callback?: (query: QueryResult<T>) => void, opts?: SubscriptionOptions): CleanupFn;
+}
+//# sourceMappingURL=QueryResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"QueryResult.d.ts","sourceRoot":"","sources":["../../../src/QueryResult.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;IACrB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC;IAEX,KAAK,CAAC,EAAE;QAGN;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF;;OAEG;IAEH,UAAU,CAAC,EAAE;QAEX,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;QAErC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9E,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAGF,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAErC;;OAEG;IACH,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;OAEG;IACH,cAAc,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7B;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErC;;OAEG;IACH,gBAAgB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAE5D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,IAAI,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAC9F"}

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

@@ -1,21 +1,23 @@
+import * as SchemaAST from 'effect/SchemaAST';
 import { Ref as Ref$, type RefResolver } from './internal';
 import type * as Obj from './Obj';
 export type Ref<T> = Ref$<T>;
-export type Any = Ref$<Obj.Any>;
+export type Unknown = Ref$<Obj.Unknown>;
 export declare const Array: Readonly<{
-    targets: <T extends import("./internal").AnyEchoObject>(refs: readonly Ref$<T>[]) => T[];
-    loadAll: <T extends import("./internal").AnyEchoObject>(refs: readonly Ref$<T>[]) => Promise<T[]>;
-    removeById: (refs: Ref$<import("./internal").AnyEchoObject>[], id: import("@dxos/keys").ObjectId) => void;
+    targets: <T extends import("./internal").AnyEntity>(refs: readonly Ref$<T>[]) => T[];
+    loadAll: <T extends import("./internal").AnyEntity>(refs: readonly Ref$<T>[]) => Promise<T[]>;
+    removeById: (refs: Ref$<import("./internal").AnyEntity>[], id: import("@dxos/keys").ObjectId) => void;
 }>;
 /**
  * Extract reference target.
  */
-export type Target<R extends Any> = R extends Ref$<infer T> ? T : never;
+export type Target<R extends Unknown> = R extends Ref$<infer T> ? T : never;
 /**
  * Reference resolver.
  */
 export type Resolver = RefResolver;
-export declare const isRef: (value: unknown) => value is Any;
-export declare const make: <T extends import("./internal").WithId>(object: T) => Ref$<T>;
+export declare const isRef: (value: unknown) => value is Unknown;
+export declare const make: <T extends import("./internal").AnyEntity>(object: T) => Ref$<T>;
 export declare const fromDXN: (dxn: import("@dxos/keys").DXN) => Ref$<any>;
+export declare const isRefType: (ast: SchemaAST.AST) => boolean;
 //# sourceMappingURL=Ref.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/Ref.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,IAAI,IAAI,EAAY,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEhC,eAAO,MAAM,KAAK;;;;EAAW,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,eAAO,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,GAAgB,CAAC;AAElE,eAAO,MAAM,IAAI,+DAAY,CAAC;AAG9B,eAAO,MAAM,OAAO,8CAAe,CAAC"}
+{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/Ref.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,GAAG,IAAI,IAAI,EAAY,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAGrE,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAElC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAExC,eAAO,MAAM,KAAK;;;;EAAW,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,eAAO,MAAM,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,OAAoB,CAAC;AAEtE,eAAO,MAAM,IAAI,kEAAY,CAAC;AAG9B,eAAO,MAAM,OAAO,8CAAe,CAAC;AAGpC,eAAO,MAAM,SAAS,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,OAS9C,CAAC"}

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

@@ -1,36 +1,62 @@
-import * as Schema from 'effect/Schema';
+import type * as Schema from 'effect/Schema';
+import type { ForeignKey } from '@dxos/echo-protocol';
 import { DXN, type ObjectId } from '@dxos/keys';
-import { type Live } from '@dxos/live-object';
+import type * as Database from './Database';
 import * as Entity from './Entity';
-import { type AnyEchoObject, EntityKind, MetaId, type ObjectMeta } from './internal';
-import * as Obj from './Obj';
-import * as Type from './Type';
+import { type ObjectJSON as APIJSON, type AnyEntity, type Comparator as ApiComparator, type Meta as ApiMeta, type ReadonlyMeta as ApiReadonlyMeta, type EntityVersion as ApiVersion, type ChangeCallback, EntityKind, type KindId, MetaId, type Mutable, type ObjectMeta, SnapshotKindId, VersionTypeId, isVersion } from './internal';
+import type * as Obj from './Obj';
+import type * as Type from './Type';
 /**
  * Base type for all ECHO relations.
  * @private
  */
-interface BaseRelation<Source, Target> extends AnyEchoObject, Type.Relation.Endpoints<Source, Target>, Entity.OfKind<EntityKind.Relation> {
+interface BaseRelation<Source, Target> extends AnyEntity, Type.Relation.Endpoints<Source, Target>, Entity.OfKind<EntityKind.Relation> {
 }
 /**
- * Base type for all Relations objects.
+ * Relation with no known properties beyond id, kind, source, and target.
+ * Use this when the relation's schema/properties are not known.
+ *
+ * NOTE: This is a TypeScript type only, not a schema.
+ * To validate that a value is an ECHO relation, use `Relation.isRelation`.
  */
-export interface Any extends BaseRelation<Obj.Any, Obj.Any> {
+export interface Unknown extends BaseRelation<Obj.Unknown, Obj.Unknown> {
 }
-export declare const Any: Type.relation<Schema.Struct<{}>, Type.obj<Schema.Struct<{}>>, Type.obj<Schema.Struct<{}>>>;
 /**
  * Relation type with specific source and target types.
  */
-export type Relation<Source extends Obj.Any, Target extends Obj.Any, Props> = BaseRelation<Source, Target> & Props;
+export type Relation<Source extends Obj.Unknown, Target extends Obj.Unknown, Props> = BaseRelation<Source, Target> & Props;
+/**
+ * Base type for snapshot relations (has SnapshotKindId instead of KindId).
+ */
+interface BaseRelationSnapshot<Source, Target> extends AnyEntity, Type.Relation.Endpoints<Source, Target> {
+    readonly [SnapshotKindId]: EntityKind.Relation;
+    readonly id: ObjectId;
+}
+/**
+ * Immutable snapshot of an ECHO relation.
+ * Branded with SnapshotKindId (not KindId).
+ * Property values are frozen at the time the snapshot was created.
+ * Returned by getSnapshot() and hooks.
+ */
+export type Snapshot<T extends Unknown = Unknown> = Omit<T, KindId> & BaseRelationSnapshot<Obj.Unknown, Obj.Unknown>;
 export declare const Source: unique symbol;
 export type Source = typeof Source;
 export declare const Target: unique symbol;
 export type Target = typeof Target;
-type MakeProps<T extends Any> = {
+/**
+ * Internal props type for relation instance creation.
+ */
+type RelationMakeProps<T extends Unknown> = {
     id?: ObjectId;
     [MetaId]?: ObjectMeta;
     [Source]: T[Source];
     [Target]: T[Target];
 } & Type.Properties<T>;
+/**
+ * Props type for relation creation with a given schema.
+ * Takes a schema type (created with Type.Relation) and extracts the props type.
+ */
+export type MakeProps<S extends Type.Relation.Any> = RelationMakeProps<Schema.Schema.Type<S>>;
 /**
  * Creates new relation.
  * @param schema - Relation schema.
@@ -38,27 +64,218 @@ type MakeProps<T extends Any> = {
  * @param meta - Relation metadata.
  * @returns
  */
-export declare const make: <S extends Type.Relation.Any>(schema: S, props: NoInfer<MakeProps<Schema.Schema.Type<S>>>, meta?: ObjectMeta) => Live<Schema.Schema.Type<S> & Entity.OfKind<typeof Entity.Kind.Relation>>;
-export declare const isRelation: (value: unknown) => value is Any;
+export declare const make: <S extends Type.Relation.Any>(schema: S, props: NoInfer<RelationMakeProps<Schema.Schema.Type<S>>>, meta?: ObjectMeta) => Schema.Schema.Type<S> & Entity.OfKind<typeof Entity.Kind.Relation>;
+/**
+ * Type guard for relations.
+ * Returns true for both reactive relations and relation snapshots.
+ */
+export declare const isRelation: (value: unknown) => value is Unknown;
 /**
  * @returns Relation source DXN.
+ * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getSourceDXN: (value: Any) => DXN;
+export declare const getSourceDXN: (value: Unknown | Snapshot) => DXN;
 /**
  * @returns Relation target DXN.
+ * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getTargetDXN: (value: Any) => DXN;
+export declare const getTargetDXN: (value: Unknown | Snapshot) => DXN;
 /**
  * @returns Relation source.
+ * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getSource: <T extends Any>(relation: T) => Type.Relation.Source<T>;
+export declare const getSource: <T extends Unknown | Snapshot>(relation: T) => Type.Relation.Source<T>;
 /**
  * @returns Relation target.
+ * Accepts both reactive relations and snapshots.
  * @throws If the object is not a relation.
  */
-export declare const getTarget: <T extends Any>(relation: T) => Type.Relation.Target<T>;
-export {};
+export declare const getTarget: <T extends Unknown | Snapshot>(relation: T) => Type.Relation.Target<T>;
+/**
+ * Makes all properties mutable recursively.
+ * Used to provide a mutable view of a relation within `Relation.change`.
+ */
+export type { Mutable };
+/**
+ * Perform mutations on an echo relation within a controlled context.
+ *
+ * All mutations within the callback are batched and trigger a single notification
+ * when the callback completes. Direct mutations outside of `Relation.change` will throw
+ * an error for echo relations.
+ *
+ * @param relation - The echo relation to mutate. Use `Obj.change` for objects.
+ * @param callback - The callback that performs mutations on the relation.
+ *
+ * @example
+ * ```ts
+ * const worksFor = Relation.make(EmployedBy, {
+ *   [Relation.Source]: person,
+ *   [Relation.Target]: company,
+ *   role: 'Engineer',
+ * });
+ *
+ * // Mutate within Relation.change
+ * Relation.change(worksFor, (r) => {
+ *   r.role = 'Senior Engineer';
+ * });
+ * ```
+ *
+ * Note: Only accepts relations. Use `Obj.change` for objects.
+ */
+export declare const change: <T extends Unknown>(relation: T, callback: ChangeCallback<T>) => void;
+/**
+ * Returns an immutable snapshot of a relation.
+ * The snapshot is branded with SnapshotKindId instead of KindId,
+ * making it distinguishable from the reactive relation at the type level.
+ */
+export declare const getSnapshot: <T extends Unknown>(rel: T) => Snapshot<T>;
+/**
+ * Subscribe to relation updates.
+ * The callback is called synchronously when the relation is modified.
+ * Only accepts reactive relations (not snapshots).
+ * @returns Unsubscribe function.
+ */
+export declare const subscribe: (rel: Unknown, callback: () => void) => (() => void);
+/**
+ * Get a deeply nested property from a relation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getValue: (rel: Unknown | Snapshot, path: readonly (string | number)[]) => any;
+/**
+ * Set a deeply nested property on a relation.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const setValue: (rel: Mutable<Unknown>, path: readonly (string | number)[], value: any) => void;
+/**
+ * Get the DXN of the relation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getDXN: (entity: Unknown | Snapshot) => DXN;
+/**
+ * @returns The DXN of the relation's type.
+ */
+export declare const getTypeDXN: (obj: import("./internal").AnyProperties) => DXN | undefined;
+/**
+ * Get the schema of the relation.
+ * Returns the branded ECHO schema used to create the relation.
+ */
+export declare const getSchema: (rel: unknown | undefined) => Type.Entity.Any | undefined;
+/**
+ * @returns The typename of the relation's type.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getTypename: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Get the database the relation belongs to.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getDatabase: (entity: Unknown | Snapshot) => Database.Database | undefined;
+/**
+ * Deeply read-only version of ObjectMeta.
+ */
+export type ReadonlyMeta = ApiReadonlyMeta;
+/**
+ * Mutable meta type returned by `Relation.getMeta` inside a `Relation.change` callback.
+ */
+export type Meta = ApiMeta;
+/**
+ * Get the metadata for a relation.
+ * Returns mutable meta when passed a mutable relation (inside `Relation.change` callback).
+ * Returns read-only meta when passed a regular relation or snapshot.
+ */
+export declare function getMeta(entity: Mutable<Unknown>): Meta;
+export declare function getMeta(entity: Unknown | Snapshot): ReadonlyMeta;
+/**
+ * @returns Foreign keys for the relation from the specified source.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getKeys: (entity: Unknown | Snapshot, source: string) => ForeignKey[];
+/**
+ * Delete all keys from the relation for the specified source.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const deleteKeys: (entity: Mutable<Unknown>, source: string) => void;
+/**
+ * Add a tag to the relation.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const addTag: (entity: Mutable<Unknown>, tag: string) => void;
+/**
+ * Remove a tag from the relation.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const removeTag: (entity: Mutable<Unknown>, tag: string) => void;
+/**
+ * Check if the relation is deleted.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
+/**
+ * Get the label of the relation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getLabel: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Set the label of the relation.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
+/**
+ * Get the description of the relation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
+/**
+ * Set the description of the relation.
+ * Must be called within a `Relation.change` callback.
+ *
+ * NOTE: TypeScript's structural typing allows readonly objects to be passed to `Mutable<T>`
+ * parameters, so there is no compile-time error. Enforcement is runtime-only.
+ */
+export declare const setDescription: (entity: Mutable<Unknown>, description: string) => void;
+/**
+ * JSON representation of a relation.
+ */
+export type JSON = APIJSON;
+/**
+ * Converts relation to its JSON representation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
+/**
+ * Comparator function type for sorting relations.
+ * Accepts both reactive relations and snapshots.
+ */
+export type Comparator = ApiComparator<Unknown | Snapshot>;
+export declare const sortByLabel: Comparator;
+export declare const sortByTypename: Comparator;
+export declare const sort: (...comparators: Comparator[]) => Comparator;
+export { VersionTypeId, isVersion };
+/**
+ * Represent relation version.
+ */
+export type Version = ApiVersion;
+/**
+ * Returns the version of the relation.
+ * Accepts both reactive relations and snapshots.
+ */
+export declare const version: (entity: Unknown | Snapshot) => Version;
 //# sourceMappingURL=Relation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Relation.d.ts","sourceRoot":"","sources":["../../../src/Relation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,OAAO,EAAE,GAAG,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAG9C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAGL,KAAK,aAAa,EAClB,UAAU,EAEV,MAAM,EACN,KAAK,UAAU,EAQhB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;;GAGG;AACH,UAAU,YAAY,CAAC,MAAM,EAAE,MAAM,CACnC,SAAQ,aAAa,EACnB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EACvC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;CAAG;AAEzC;;GAEG;AACH,MAAM,WAAW,GAAI,SAAQ,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC;CAAG;AAE9D,eAAO,MAAM,GAAG,4FAOf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;AAEnH,eAAO,MAAM,MAAM,EAAE,OAAO,MAAgC,CAAC;AAC7D,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,eAAO,MAAM,MAAM,EAAE,OAAO,MAAgC,CAAC;AAC7D,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,KAAK,SAAS,CAAC,CAAC,SAAS,GAAG,IAAI;IAC9B,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;IACtB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;CACrB,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAEvB;;;;;;GAMG;AAGH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,EAC9C,QAAQ,CAAC,EACT,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAChD,OAAO,UAAU,KAChB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAezE,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAUpD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,GAAG,KAAG,GAMzC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,GAAG,KAAG,GAMzC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,GAAG,EAAE,UAAU,CAAC,KAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAM5E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,GAAG,EAAE,UAAU,CAAC,KAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAM5E,CAAC"}
+{"version":3,"file":"Relation.d.ts","sourceRoot":"","sources":["../../../src/Relation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAG7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,GAAG,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EACL,KAAK,UAAU,IAAI,OAAO,EAG1B,KAAK,SAAS,EACd,KAAK,UAAU,IAAI,aAAa,EAChC,KAAK,IAAI,IAAI,OAAO,EACpB,KAAK,YAAY,IAAI,eAAe,EACpC,KAAK,aAAa,IAAI,UAAU,EAChC,KAAK,cAAc,EACnB,UAAU,EAEV,KAAK,MAAM,EACX,MAAM,EACN,KAAK,OAAO,EACZ,KAAK,UAAU,EAKf,cAAc,EACd,aAAa,EAiBb,SAAS,EAYV,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAEpC;;;GAGG;AACH,UAAU,YAAY,CAAC,MAAM,EAAE,MAAM,CACnC,SAAQ,SAAS,EACf,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EACvC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;CAAG;AAEzC;;;;;;GAMG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC;CAAG;AAE1E;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,GAChH,KAAK,CAAC;AAER;;GAEG;AACH,UAAU,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAE,SAAQ,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACvG,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC/C,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;AAErH,eAAO,MAAM,MAAM,EAAE,OAAO,MAAgC,CAAC;AAC7D,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,eAAO,MAAM,MAAM,EAAE,OAAO,MAAgC,CAAC;AAC7D,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC;;GAEG;AACH,KAAK,iBAAiB,CAAC,CAAC,SAAS,OAAO,IAAI;IAC1C,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;IACtB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;CACrB,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9F;;;;;;GAMG;AAGH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,EAC9C,QAAQ,CAAC,EACT,OAAO,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EACxD,OAAO,UAAU,KAChB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAenE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAWpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,OAAO,GAAG,QAAQ,KAAG,GAMxD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,OAAO,GAAG,QAAQ,KAAG,GAMxD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,GAAG,QAAQ,EAAE,UAAU,CAAC,KAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAM3F,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,GAAG,QAAQ,EAAE,UAAU,CAAC,KAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAM3F,CAAC;AAMF;;;GAGG;AACH,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,SAAS,OAAO,EAAE,UAAU,CAAC,EAAE,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,IAEpF,CAAC;AAMF;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAuB,CAAC;AAM3F;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAEzE,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,OAAO,GAAG,QAAQ,EAAE,MAAM,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAG,GAEtF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,IAChF,CAAC;AAMnB;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,GAAsB,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,UAAU,8DAAc,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,SAA6B,CAAC;AAEtG;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAiC,CAAC;AAMpG;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,QAAQ,CAAC,QAAQ,GAAG,SAAiC,CAAC;AAM/G;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;;;GAIG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;AACxD,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;AAKlE;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,EAAE,QAAQ,MAAM,KAAG,UAAU,EAA8B,CAAC;AAE9G;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,MAAM,KAAG,IAAmC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA4B,CAAC;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM,KAAG,IAA+B,CAAC;AAElG;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA6B,CAAC;AAMrF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAA8B,CAAC;AAE9F;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,MAAM,KAAG,IAAgC,CAAC;AAEpG;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,MAAM,GAAG,SAAoC,CAAC;AAE1G;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,MAAM,KAAG,IACzC,CAAC;AAMvC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,IAAuB,CAAC;AAM5E;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,CAAC;AAE3D,eAAO,MAAM,WAAW,EAAE,UAAuC,CAAC;AAClE,eAAO,MAAM,cAAc,EAAE,UAA0C,CAAC;AACxE,eAAO,MAAM,IAAI,GAAI,GAAG,aAAa,UAAU,EAAE,KAAG,UAAiD,CAAC;AAMtG,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,OAAO,GAAG,QAAQ,KAAG,OAA2B,CAAC"}

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

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

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

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

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

@@ -0,0 +1,84 @@
+import type * as Types from 'effect/Types';
+import type * as JsonSchema from './JsonSchema';
+import type * as Key from './Key';
+import type * as QueryResult from './QueryResult';
+import type * as Type from './Type';
+export type Query = {
+    /**
+     * Filter by schema ID.
+     * Schema id is a DXN with `echo` or `type` kind.
+     */
+    id?: string | string[];
+    /**
+     * Id of the backing ECHO object.
+     */
+    backingObjectId?: Key.ObjectId | Key.ObjectId[];
+    /**
+     * One or more typenames to filter by.
+     */
+    typename?: string | string[];
+    /**
+     * [Semver Range](https://docs.npmjs.com/cli/v6/using-npm/semver#ranges) for the schema version.
+     */
+    version?: string;
+    /**
+     * Where to look for the schema.
+     *
+     * Database schema are stored in the database of the current space.
+     * Runtime schema are registered in the runtime.
+     *
+     * @default ['database']
+     */
+    location?: ('database' | 'runtime')[];
+    /**
+     * Include system schemas.
+     * @default false
+     *
+     * The system schema include but are not limited to:
+     *  - dxos.org/type/Schema
+     */
+    includeSystem?: boolean;
+};
+/**
+ * Input for schema registration.
+ * The typename, version and schema mutability metadata is read from the schema annotations.
+ *
+ * Accepts:
+ * - Branded ECHO schemas created with Type.Obj() or Type.Relation()
+ * - JSON schema with typename and version
+ */
+export type RegisterSchemaInput = Type.Entity.Any | {
+    typename: string;
+    version: string;
+    jsonSchema: JsonSchema.JsonSchema;
+    /**
+     * Display name of the schema.
+     */
+    name?: string;
+};
+export type ExtractQueryResult<Query> = Query extends {
+    location: ('database' | 'runtime')[];
+} ? Type.Entity.Any : Type.RuntimeType;
+export interface SchemaRegistry {
+    /**
+     * Checks if the provided schema is registered.
+     */
+    hasSchema(schema: Type.Entity.Any): boolean;
+    /**
+     * Registers the provided schema.
+     *
+     * @returns Mutable runtime instances of schemas that were registered.
+     *
+     * The behavior of this method depends on the state of the database.
+     * The general principle is that the schema will be upserted into the space.
+     * If an equivalent schema with the same name and version already exists, the method does nothing.
+     * If a different schema with the same name and version exists, the method throws an error.
+     * If no schema with the same name and version exists, a new schema will be inserted based on semantic versioning rules.
+     */
+    register(input: RegisterSchemaInput[]): Promise<Type.RuntimeType[]>;
+    /**
+     *
+     */
+    query<Q extends Types.NoExcessProperties<Query, Q>>(query?: Q & Query): QueryResult.QueryResult<ExtractQueryResult<Q>>;
+}
+//# sourceMappingURL=SchemaRegistry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaRegistry.d.ts","sourceRoot":"","sources":["../../../src/SchemaRegistry.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,KAAK,IAAI,MAAM,QAAQ,CAAC;AAGpC,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC;IAEtC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B,IAAI,CAAC,MAAM,CAAC,GAAG,GACf;IACE,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEN,MAAM,MAAM,kBAAkB,CAAC,KAAK,IAAI,KAAK,SAAS;IAAE,QAAQ,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;CAAE,GAC1F,IAAI,CAAC,MAAM,CAAC,GAAG,GACf,IAAI,CAAC,WAAW,CAAC;AAErB,MAAM,WAAW,cAAc;IAC7B;;OAEG;IAEH,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEpE;;OAEG;IACH,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC,CAAC,EAChD,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,GAChB,WAAW,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;CACnD"}

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

@@ -1,14 +1,14 @@
 import * as Schema from 'effect/Schema';
 import * as Obj from './Obj';
 import * as Type from './Type';
-export declare const Tag: Type.obj<Schema.Struct<{
-    label: typeof Schema.String;
-    hue: Schema.optional<typeof Schema.String>;
-}>>;
+export declare const Tag: Type.Obj<{
+    readonly label: string;
+    readonly hue?: string | undefined;
+}, Schema.Struct.Fields>;
 export type Tag = Schema.Schema.Type<typeof Tag>;
 export declare const make: (props: Obj.MakeProps<typeof Tag>) => Obj.Obj<import("./Entity").OfKind<import("./internal").EntityKind.Object> & {
-    label: string;
-    hue?: string | undefined;
+    readonly label: string;
+    readonly hue?: string | undefined;
 }>;
 export type Map = Record<string, Tag>;
 export declare const sortTags: ({ label: a }: Tag, { label: b }: Tag) => number;

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

@@ -1 +1 @@
-{"version":3,"file":"Tag.d.ts","sourceRoot":"","sources":["../../../src/Tag.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B,eAAO,MAAM,GAAG;;;GAUf,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;AAEjD,eAAO,MAAM,IAAI,GAAI,OAAO,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC;;;EAAyB,CAAC;AAG/E,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtC,eAAO,MAAM,QAAQ,GAAI,cAAc,GAAG,EAAE,cAAc,GAAG,WAAuB,CAAC;AAErF,eAAO,MAAM,aAAa,GAAI,MAAM,GAAG,KAAG,GAAG,EAG1B,CAAC;AAEpB,eAAO,MAAM,cAAc,GAAI,MAAM,GAAG,GAAG,SAAS,EAAE,MAAM,MAAM,KAAG,GAAG,GAAG,SAG1E,CAAC"}
+{"version":3,"file":"Tag.d.ts","sourceRoot":"","sources":["../../../src/Tag.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B,eAAO,MAAM,GAAG;;;wBAUf,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;AAEjD,eAAO,MAAM,IAAI,GAAI,OAAO,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC;;;EAAyB,CAAC;AAG/E,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtC,eAAO,MAAM,QAAQ,GAAI,cAAc,GAAG,EAAE,cAAc,GAAG,WAAuB,CAAC;AAErF,eAAO,MAAM,aAAa,GAAI,MAAM,GAAG,KAAG,GAAG,EAG1B,CAAC;AAEpB,eAAO,MAAM,cAAc,GAAI,MAAM,GAAG,GAAG,SAAS,EAAE,MAAM,MAAM,KAAG,GAAG,GAAG,SAG1E,CAAC"}