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

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

@@ -0,0 +1,149 @@
+import * as Schema from 'effect/Schema';
+import type * as Types from 'effect/Types';
+import { type ForeignKey, type QueryAST } from '@dxos/echo-protocol';
+import { DXN, ObjectId } from '@dxos/keys';
+import type * as Obj from './Obj';
+import * as Ref from './Ref';
+export interface Filter<T> {
+    '~Filter': {
+        value: Types.Covariant<T>;
+    };
+    ast: QueryAST.Filter;
+}
+export type Props<T> = {
+    [K in keyof T & string]?: Filter<T[K]> | T[K];
+};
+export type Any = Filter<any>;
+export type Type<F extends Any> = F extends Filter<infer T> ? T : never;
+declare class FilterClass implements Any {
+    readonly ast: QueryAST.Filter;
+    private static 'variance';
+    constructor(ast: QueryAST.Filter);
+    '~Filter': {
+        value: Types.Covariant<any>;
+    };
+}
+export declare const is: (value: unknown) => value is Any;
+/** Construct a filter from an ast. */
+export declare const fromAst: (ast: QueryAST.Filter) => Any;
+/**
+ * Filter that matches all objects.
+ */
+export declare const everything: () => FilterClass;
+/**
+ * Filter that matches no objects.
+ */
+export declare const nothing: () => FilterClass;
+export declare const id: (...ids: ObjectId[]) => Any;
+/**
+ * Filter by type.
+ */
+export declare const type: <S extends Schema.Schema.All>(schema: S | string, props?: Props<Schema.Schema.Type<S>>) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Filter by non-qualified typename.
+ */
+export declare const typename: (typename: string) => Any;
+/**
+ * Filter by fully qualified type DXN.
+ */
+export declare const typeDXN: (dxn: DXN) => Any;
+/**
+ * Filter by tag.
+ */
+export declare const tag: (tag: string) => Any;
+/**
+ * Filter by properties.
+ */
+export declare const props: <T>(props: Props<T>) => Filter<T>;
+export type TextSearchOptions = {
+    type?: 'full-text' | 'vector';
+};
+/**
+ * Full-text or vector search.
+ */
+export declare const text: (text: string, options?: TextSearchOptions) => Any;
+/**
+ * Filter by foreign keys.
+ */
+export declare const foreignKeys: <S extends Schema.Schema.All>(schema: S | string, keys: ForeignKey[]) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Predicate for property to be equal to the provided value.
+ */
+export declare const eq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be not equal to the provided value.
+ */
+export declare const neq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than the provided value.
+ */
+export declare const gt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than or equal to the provided value.
+ */
+export declare const gte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than the provided value.
+ */
+export declare const lt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than or equal to the provided value.
+ */
+export declare const lte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be in the provided array.
+ * @param values - Values to check against.
+ */
+declare const in$: <T>(...values: T[]) => Filter<T>;
+export { in$ as in };
+/**
+ * Predicate for an array property to contain the provided value.
+ * @param value - Value to check against.
+ */
+export declare const contains: <T>(value: T) => Filter<readonly T[] | undefined>;
+/**
+ * Predicate for property to be in the provided range.
+ * @param from - Start of the range (inclusive).
+ * @param to - End of the range (exclusive).
+ */
+export declare const between: <T>(from: T, to: T) => Filter<T>;
+type TimeRange = {
+    after?: Date | number;
+    before?: Date | number;
+};
+/**
+ * Filter objects by updatedAt timestamp.
+ */
+export declare const updated: (range: TimeRange) => Any;
+/**
+ * Filter objects by createdAt timestamp.
+ */
+export declare const created: (range: TimeRange) => Any;
+export type ChildOfOptions = {
+    /** Whether to match transitively (grandchildren, etc.). Defaults to true. */
+    transitive?: boolean;
+};
+/**
+ * Filter objects that are children of the specified parent(s).
+ * Accepts ECHO objects, Refs, or arrays of either.
+ * Refs are resolved to DXNs without loading; objects use {@link Obj.getDXN}.
+ * With transitive=true (default), also matches grandchildren and beyond.
+ */
+export declare const childOf: (parents: Obj.Unknown | Ref.Unknown | readonly (Obj.Unknown | Ref.Unknown)[], options?: ChildOfOptions) => Any;
+/**
+ * Negate the filter.
+ */
+export declare const not: <F extends Any>(filter: F) => Filter<Type<F>>;
+/**
+ * Combine filters with a logical AND.
+ */
+export declare const and: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+/**
+ * Combine filters with a logical OR.
+ */
+export declare const or: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+/**
+ * Returns a human-readable string representation of a Filter AST.
+ */
+export declare const pretty: (filter: Any) => string;
+//# sourceMappingURL=Filter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Filter.d.ts","sourceRoot":"","sources":["../../../src/Filter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,MAAM,WAAW,MAAM,CAAC,CAAC;IAEvB,SAAS,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAEzC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;KAEpB,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAE9B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExE,cAAM,WAAY,YAAW,GAAG;aAGF,GAAG,EAAE,QAAQ,CAAC,MAAM;IAFhD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAwC;gBAErC,GAAG,EAAE,QAAQ,CAAC,MAAM;IAEhD,SAAS;;MAAwB;CAClC;AAED,eAAO,MAAM,EAAE,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,sCAAsC;AACtC,eAAO,MAAM,OAAO,GAAI,KAAK,QAAQ,CAAC,MAAM,KAAG,GAE9C,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,UAAU,QAAO,WAM7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAO,WAS1B,CAAC;AAKF,eAAO,MAAM,EAAE,GAAI,GAAG,KAAK,QAAQ,EAAE,KAAG,GAiBvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9C,QAAQ,CAAC,GAAG,MAAM,EAClB,QAAQ,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAmB9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAU,MAAM,KAAG,GAO3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,GAAG,KAAG,GAMlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,KAAK,MAAM,KAAG,GAKjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,CAMlD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAEf,MAAM,MAAM,EACZ,UAAU,iBAAiB,KAC1B,GAMF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACrD,QAAQ,CAAC,GAAG,MAAM,EAClB,MAAM,UAAU,EAAE,KACjB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAQ9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAUpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,GAAG,GAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAG,MAAM,CAAC,CAAC,CAKxC,CAAC;AACF,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;AAErB;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,SAAS,CAKrE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,KAAG,MAAM,CAAC,CAAC,CAMnD,CAAC;AAEF,KAAK,SAAS,GAAG;IAAE,KAAK,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AAkBnE;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,SAAS,KAAG,GAA2C,CAAC;AAEvF;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,SAAS,KAAG,GAA2C,CAAC;AAEvF,MAAM,MAAM,cAAc,GAAG;IAC3B,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAClB,SAAS,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,EAAE,EAC3E,UAAU,cAAc,KACvB,GAaF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,GAAG,EAAE,QAAQ,CAAC,KAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKrG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKpG,CAAC;AAoDF;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,GAAG,KAAG,MAA2C,CAAC"}

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

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

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

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

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

@@ -0,0 +1,4 @@
+import type * as internal from './internal';
+export * from './internal/Format';
+export type Format = internal.TypeFormat;
+//# sourceMappingURL=Format.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Format.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAE5C,cAAc,mBAAmB,CAAC;AAElC,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC"}

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

@@ -0,0 +1,65 @@
+import { type DXN } from '@dxos/keys';
+import type * as Database from './Database';
+import type * as Entity from './Entity';
+import type * as internal from './internal';
+import type * as Key from './Key';
+import type * as Ref from './Ref';
+import type * as SchemaRegistry from './SchemaRegistry';
+/**
+ * Resolution context.
+ * Affects how non-absolute DXNs are resolved.
+ */
+export interface RefResolutionContext {
+    /**
+     * Space that the resolution is happening from.
+     */
+    space?: Key.SpaceId;
+    /**
+     * Queue that the resolution is happening from.
+     * This queue will be searched first, and then the space it belongs to.
+     */
+    queue?: DXN;
+}
+export interface RefResolverOptions {
+    /**
+     * Resolution context.
+     * Affects how non-absolute DXNs are resolved.
+     */
+    context?: RefResolutionContext;
+    /**
+     * Middleware to change the resolved object before returning it.
+     * @deprecated On track to be removed.
+     */
+    middleware?: (obj: internal.AnyProperties) => internal.AnyProperties;
+}
+/**
+ * Manages cross-space database interactions.
+ */
+export interface Hypergraph extends Database.Queryable {
+    get schemaRegistry(): SchemaRegistry.SchemaRegistry;
+    /**
+     * Query objects.
+     */
+    query: Database.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.Ref<T>;
+    /**
+     * @param hostDb Host database for reference resolution.
+     * @param middleware Called with the loaded object. The caller may change the object.
+     * @returns Result of `onLoad`.
+     */
+    createRefResolver(options: RefResolverOptions): Ref.Resolver;
+    /**
+     * Get a database by space ID.
+     * @returns The database for the given space ID, or undefined if not found.
+     */
+    getDatabase(spaceId: Key.SpaceId): Database.Database | undefined;
+}
+//# sourceMappingURL=Hypergraph.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Hypergraph.d.ts","sourceRoot":"","sources":["../../../src/Hypergraph.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,cAAc,MAAM,kBAAkB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,KAAK,QAAQ,CAAC,aAAa,CAAC;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,QAAQ,CAAC,SAAS;IACpD,IAAI,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC;IAEpD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;IAExB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEzE;;;;OAIG;IAEH,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAAC,QAAQ,CAAC;IAE7D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC;CAClE"}

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

@@ -0,0 +1,16 @@
+import type * as Schema from 'effect/Schema';
+import * as jsonSchemaInternal from './internal/JsonSchema';
+/**
+ * Decode JSON Schema to Effect Schema.
+ */
+export declare const toEffectSchema: (root: jsonSchemaInternal.JsonSchemaType, _defs?: jsonSchemaInternal.JsonSchemaType["$defs"]) => Schema.Schema.AnyNoContext;
+/**
+ * Encode Effect Schema to JSON Schema.
+ */
+export declare const toJsonSchema: (schema: Schema.Schema.All, options?: jsonSchemaInternal.JsonSchemaOptions) => import("effect/Types").DeepMutable<jsonSchemaInternal.JsonSchemaType>;
+/**
+ * Serializable JsonSchema type definition.
+ */
+export type JsonSchema = jsonSchemaInternal.JsonSchemaType;
+export declare const JsonSchema: Schema.Schema<jsonSchemaInternal.JsonSchemaType>;
+//# sourceMappingURL=JsonSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonSchema.d.ts","sourceRoot":"","sources":["../../../src/JsonSchema.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,cAAc,6HAAoC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,YAAY,sJAAkC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC,cAAc,CAAC;AAE3D,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,cAAc,CAAqC,CAAC"}

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

@@ -1,2 +1,3 @@
+export { ForeignKey } from '@dxos/echo-protocol';
 export { SpaceId, ObjectId } from '@dxos/keys';
 //# sourceMappingURL=Key.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../src/Key.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../src/Key.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

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

@@ -0,0 +1,57 @@
+import type * as Schema from 'effect/Schema';
+import { type DXN } from '@dxos/keys';
+import type * as Database from './Database';
+import type * as Entity from './Entity';
+type DefineObjectMigrationOptions<From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext> = {
+    from: From;
+    to: To;
+    /**
+     * Pure function that converts the old object data to the new object data.
+     */
+    transform: (from: Schema.Schema.Type<From>, context: ObjectMigrationContext) => Promise<Omit<Schema.Schema.Type<To>, 'id' | Entity.KindId>>;
+    /**
+     * Callback that is called after the object is migrated. Called for every object that is migrated.
+     *
+     * NOTE: Database mutations performed in this callback are not guaranteed to be idempotent.
+     *       If multiple peers run the migration separately, the effects may be applied multiple times.
+     */
+    onMigration: (params: OnMigrateProps<From, To>) => Promise<void>;
+};
+/**
+ * Context passed to object migration callbacks.
+ */
+export type ObjectMigrationContext = {
+    db: Database.Database;
+};
+type OnMigrateProps<From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext> = {
+    before: Schema.Schema.Type<From>;
+    object: Schema.Schema.Type<To>;
+    db: Database.Database;
+};
+/**
+ * Definition of a migration from one object schema version to another.
+ */
+export type ObjectMigration = {
+    fromType: DXN;
+    toType: DXN;
+    fromSchema: Schema.Schema.AnyNoContext;
+    toSchema: Schema.Schema.AnyNoContext;
+    transform: (from: unknown, context: ObjectMigrationContext) => Promise<unknown>;
+    onMigration: (params: OnMigrateProps<any, any>) => Promise<void>;
+};
+/**
+ * Define a migration between two object schemas.
+ *
+ * @example
+ * ```ts
+ * const migration = Migration.define({
+ *   from: ContactV1,
+ *   to: ContactV2,
+ *   transform: async (from) => ({ name: `${from.firstName} ${from.lastName}` }),
+ *   onMigration: async () => {},
+ * });
+ * ```
+ */
+export declare const define: <From extends Schema.Schema.AnyNoContext, To extends Schema.Schema.AnyNoContext>(options: DefineObjectMigrationOptions<From, To>) => ObjectMigration;
+export {};
+//# sourceMappingURL=Migration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Migration.d.ts","sourceRoot":"","sources":["../../../src/Migration.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAGxC,KAAK,4BAA4B,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,IAAI;IAClH,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,EAAE,CAAC;IACP;;OAEG;IAEH,SAAS,EAAE,CACT,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAC9B,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC;CACvB,CAAC;AAEF,KAAK,cAAc,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,IAAI;IACpG,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,GAAG,CAAC;IACd,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IACrC,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAChF,WAAW,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,MAAM,GAAI,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACnG,SAAS,4BAA4B,CAAC,IAAI,EAAE,EAAE,CAAC,KAC9C,eAkBF,CAAC"}