@dxos/echo 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

package/dist/types/src/internal/proxy/proxy-utils.d.ts

@@ -0,0 +1,47 @@
+import { type ReactiveHandler } from './proxy-types';
+export declare const symbolIsProxy: unique symbol;
+/**
+ * Internal api.
+ */
+export declare const isProxy: (value: unknown) => boolean;
+export declare const isValidProxyTarget: (value: any) => value is object;
+/**
+ * @deprecated
+ */
+export declare const getProxySlot: <T extends object>(proxy: any) => ProxyHandlerSlot<T>;
+export declare const getProxyTarget: <T extends object>(proxy: any) => T;
+export declare const getProxyHandler: <T extends object>(proxy: any) => ReactiveHandler<T>;
+/**
+ * Unsafe method to override id for debugging/testing and migration purposes.
+ * @deprecated
+ */
+export declare const dangerouslySetProxyId: <T>(obj: T, id: string) => void;
+/**
+ * Create a reactive proxy object.
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
+ *
+ * @param target Object or array. Passing in array will enable array methods.
+ * @param handler ReactiveHandler instance.
+ */
+export declare const createProxy: <T extends object>(target: T, handler: ReactiveHandler<T>) => T;
+/**
+ * Passed as the handler to the Proxy constructor.
+ * Maintains a mutable slot for the actual handler.
+ */
+declare class ProxyHandlerSlot<T extends object> implements ProxyHandler<T> {
+    readonly target: T;
+    private _handler;
+    /**
+     * @param target Original object.
+     * @param _handler Handles intercepted operations.
+     */
+    constructor(target: T, _handler: ReactiveHandler<T>);
+    get handler(): ReactiveHandler<T>;
+    setHandler(handler: ReactiveHandler<T>): void;
+    /**
+     * Get value.
+     */
+    get(target: T, prop: string | symbol, receiver: any): any;
+}
+export {};
+//# sourceMappingURL=proxy-utils.d.ts.map

package/dist/types/src/internal/proxy/proxy-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy-utils.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/proxy-utils.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,eAAO,MAAM,aAAa,eAAmC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,OAAO,YAAsC,CAAC;AAE7E,eAAO,MAAM,kBAAkB,GAAI,OAAO,GAAG,KAAG,KAAK,IAAI,MASxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,EAAE,OAAO,GAAG,KAAG,gBAAgB,CAAC,CAAC,CAI7E,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,MAAM,EAAE,OAAO,GAAG,KAAG,CAE7D,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,MAAM,EAAE,OAAO,GAAG,KAAG,eAAe,CAAC,CAAC,CAE/E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,MAAM,SAE1D,CAAC;AAEF;;;;;;GAMG;AAGH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,EAAE,QAAQ,CAAC,EAAE,SAAS,eAAe,CAAC,CAAC,CAAC,KAAG,CAatF,CAAC;AAEF;;;GAGG;AACH,cAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IAM/D,QAAQ,CAAC,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,QAAQ;IANlB;;;OAGG;gBAEQ,MAAM,EAAE,CAAC,EACV,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAGtC,IAAI,OAAO,uBAGV;IAGD,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IAI7C;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,GAAG;CA+C1D"}

package/dist/types/src/internal/proxy/reactive-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Extends the native array to make sure that arrays methods are correctly reactive.
+ * Enforces that mutations only happen within Obj.change() context.
+ */
+export declare class ReactiveArray<T> extends Array<T> {
+    static get [Symbol.species](): ArrayConstructor;
+}
+//# sourceMappingURL=reactive-array.d.ts.map

package/dist/types/src/internal/proxy/reactive-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactive-array.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/reactive-array.ts"],"names":[],"mappings":"AAkCA;;;GAGG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAC5C,WAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,qBAEnC;CA6BF"}

package/dist/types/src/internal/proxy/reactive.d.ts

@@ -0,0 +1,39 @@
+import { type RefTypeId } from '../ref/ref';
+/**
+ * Subscribe to changes on a reactive object.
+ * @param obj - The reactive object to subscribe to.
+ * @param callback - Called when the object changes.
+ * @returns Unsubscribe function.
+ */
+export declare const subscribe: (obj: unknown, callback: () => void) => (() => void);
+/**
+ * Deeply removes readonly modifiers from all properties of T.
+ * Inside Obj.change, all properties are fully mutable regardless of schema definition.
+ * Ref types are preserved as-is since they are value-like objects that are replaced, not mutated.
+ * Primitive types (including branded primitives) are preserved as-is.
+ */
+export type Mutable<T> = T extends string | number | boolean | bigint | symbol | null | undefined ? T : T extends {
+    [RefTypeId]: any;
+} ? T : T extends object ? T extends readonly (infer U)[] ? Mutable<U>[] : {
+    -readonly [K in keyof T]: Mutable<T[K]>;
+} : T;
+/**
+ * Callback type for the change function.
+ */
+export type ChangeCallback<T> = (mutableObj: Mutable<T>) => void;
+/**
+ * Perform mutations on a reactive object within a change context.
+ *
+ * If the object has a change handler (via ChangeId), it will be called with the callback.
+ * This allows handlers to implement features like:
+ * - Readonly enforcement (mutations only allowed within change context)
+ * - Batched notifications (single notification for all mutations in the callback)
+ * - Transaction semantics
+ *
+ * If the object doesn't have a change handler, the callback is called directly.
+ *
+ * @param obj - The reactive object to mutate.
+ * @param callback - Callback that receives a mutable view of the object.
+ */
+export declare const change: <T>(obj: T, callback: ChangeCallback<T>) => void;
+//# sourceMappingURL=reactive.d.ts.map

package/dist/types/src/internal/proxy/reactive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactive.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/reactive.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAK5C;;;;;GAKG;AAEH,eAAO,MAAM,SAAS,GAAI,KAAK,OAAO,EAAE,UAAU,MAAM,IAAI,KAAG,CAAC,MAAM,IAAI,CAMzE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAC7F,CAAC,GACD,CAAC,SAAS;IAAE,CAAC,SAAS,CAAC,EAAE,GAAG,CAAA;CAAE,GAC5B,CAAC,GACD,CAAC,SAAS,MAAM,GACd,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC5B,OAAO,CAAC,CAAC,CAAC,EAAE,GACZ;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC7C,CAAC,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEjE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,KAAK,CAAC,EAAE,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,IAS/D,CAAC"}

package/dist/types/src/internal/proxy/schema-validator.d.ts

@@ -0,0 +1,15 @@
+import * as Schema from 'effect/Schema';
+export declare class SchemaValidator {
+    /**
+     * Recursively check that schema specifies constructions we can handle.
+     * Validates there are no ambiguous discriminated union types.
+     */
+    static validateSchema(schema: Schema.Schema.AnyNoContext): void;
+    static hasTypeAnnotation(rootObjectSchema: Schema.Schema.AnyNoContext, property: string, annotation: symbol): boolean;
+    static getPropertySchema(rootObjectSchema: Schema.Schema.AnyNoContext, propertyPath: KeyPath, getProperty?: (path: KeyPath) => any): Schema.Schema.AnyNoContext;
+    static getTargetPropertySchema(target: any, prop: string | symbol): Schema.Schema.AnyNoContext;
+}
+export declare const checkIdNotPresentOnSchema: (schema: Schema.Schema<any, any, any>) => void;
+type KeyPath = readonly (string | number)[];
+export {};
+//# sourceMappingURL=schema-validator.d.ts.map

package/dist/types/src/internal/proxy/schema-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-validator.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/schema-validator.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAUxC,qBAAa,eAAe;IAC1B;;;OAGG;WACW,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI;WAkBxD,iBAAiB,CAC7B,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAC5C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO;WAaI,iBAAiB,CAC7B,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAC5C,YAAY,EAAE,OAAO,EACrB,WAAW,GAAE,CAAC,IAAI,EAAE,OAAO,KAAK,GAAgB,GAC/C,MAAM,CAAC,MAAM,CAAC,YAAY;WAuBf,uBAAuB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY;CAgBtG;AAyID,eAAO,MAAM,yBAAyB,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,SAM7E,CAAC;AAGF,KAAK,OAAO,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC"}

package/dist/types/src/internal/proxy/schema.test.d.ts

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

package/dist/types/src/internal/proxy/schema.test.d.ts.map

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

package/dist/types/src/internal/proxy/symbols.d.ts

@@ -0,0 +1,3 @@
+export declare const EventId: unique symbol;
+export declare const ChangeId: unique symbol;
+//# sourceMappingURL=symbols.d.ts.map

package/dist/types/src/internal/proxy/symbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"symbols.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/symbols.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,OAAO,eAA0C,CAAC;AAC/D,eAAO,MAAM,QAAQ,eAA2C,CAAC"}

package/dist/types/src/internal/proxy/typed-handler.d.ts

@@ -0,0 +1,48 @@
+import * as Schema from 'effect/Schema';
+import { Event } from '@dxos/async';
+import { ParentId, SchemaId, TypeId } from '../types';
+import { type ReactiveHandler } from './proxy-types';
+import { EventId } from './symbols';
+export { getEchoRoot, setMetaOwner } from './ownership';
+type ProxyTarget = {
+    /**
+     * Typename or type DXN.
+     */
+    [TypeId]: string;
+    /**
+     * Schema for the root.
+     */
+    [SchemaId]: Schema.Schema.AnyNoContext;
+    [ParentId]?: any;
+    /**
+     * For modifications.
+     */
+    [EventId]: Event<void>;
+} & ({
+    [key: keyof any]: any;
+} | any[]);
+/**
+ * Typed in-memory reactive store (with Schema).
+ * Reactivity is based on Event subscriptions, not signals.
+ */
+export declare class TypedReactiveHandler implements ReactiveHandler<ProxyTarget> {
+    static readonly instance: ReactiveHandler<any>;
+    readonly _proxyMap: WeakMap<object, any>;
+    private _inSet;
+    private constructor();
+    init(target: ProxyTarget): void;
+    get(target: ProxyTarget, prop: string | symbol, receiver: any): any;
+    set(target: ProxyTarget, prop: string | symbol, value: any, receiver: any): boolean;
+    ownKeys(target: ProxyTarget): ArrayLike<string | symbol>;
+    deleteProperty(target: ProxyTarget, property: string | symbol): boolean;
+    defineProperty(target: ProxyTarget, property: string | symbol, attributes: PropertyDescriptor): boolean;
+    /**
+     * Prepare a value for assignment to a typed object property.
+     * Handles cycle detection, copy-on-assign, array conversion, validation, and ownership.
+     */
+    private _prepareValueForAssignment;
+    private _validateValue;
+    private _inspect;
+}
+export declare const prepareTypedTarget: <T>(target: T, schema: Schema.Schema<T>) => void;
+//# sourceMappingURL=typed-handler.d.ts.map

package/dist/types/src/internal/proxy/typed-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-handler.d.ts","sourceRoot":"","sources":["../../../../../src/internal/proxy/typed-handler.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAMpC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAetD,OAAO,EAAE,KAAK,eAAe,EAAc,MAAM,eAAe,CAAC;AAIjE,OAAO,EAAY,OAAO,EAAE,MAAM,WAAW,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAExD,KAAK,WAAW,GAAG;IACjB;;OAEG;IACH,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IACvC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;IAEjB;;OAEG;IACH,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CACxB,GAAG,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,CAAA;CAAE,GAAG,GAAG,EAAE,CAAC,CAAC;AA+ExC;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,eAAe,CAAC,WAAW,CAAC;IACvE,gBAAuB,QAAQ,EAAE,eAAe,CAAC,GAAG,CAAC,CAA8B;IAEnF,QAAQ,CAAC,SAAS,uBAA8B;IAChD,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO;IAEP,IAAI,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAoD/B,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,GAAG;IA8BnE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO;IAmCnF,OAAO,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;IAIxD,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAkBvE,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,kBAAkB,GAAG,OAAO;IA2BvG;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IAqDlC,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,QAAQ;CAajB;AA8BD,eAAO,MAAM,kBAAkB,GAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAUxE,CAAC"}

package/dist/types/src/internal/proxy/typed-handler.test.d.ts

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

package/dist/types/src/internal/proxy/typed-handler.test.d.ts.map

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

package/dist/types/src/internal/proxy/typed-object.test.d.ts

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

package/dist/types/src/internal/proxy/typed-object.test.d.ts.map

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

package/dist/types/src/internal/ref/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ref';
+export * from './ref-array';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/internal/ref/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/internal/ref/index.ts"],"names":[],"mappings":"AAIA,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC"}

package/dist/types/src/internal/ref/ref-array.d.ts

@@ -0,0 +1,21 @@
+import { type ObjectId } from '@dxos/keys';
+import { type AnyEntity } from '../types';
+import { Ref } from './ref';
+/**
+ * Helper functions for working with arrays of refs.
+ */
+export declare const RefArray: Readonly<{
+    /**
+     * @returns all resolved targets.
+     */
+    targets: <T extends AnyEntity>(refs: readonly Ref<T>[]) => T[];
+    /**
+     * Load all referenced objects.
+     */
+    loadAll: <T extends AnyEntity>(refs: readonly Ref<T>[]) => Promise<T[]>;
+    /**
+     * Removes the ref with the given id.
+     */
+    removeById: (refs: Ref<AnyEntity>[], id: ObjectId) => void;
+}>;
+//# sourceMappingURL=ref-array.d.ts.map

package/dist/types/src/internal/ref/ref-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ref-array.d.ts","sourceRoot":"","sources":["../../../../../src/internal/ref/ref-array.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB;;OAEG;cACO,CAAC,SAAS,SAAS,QAAQ,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,KAAG,CAAC,EAAE;IAI5D;;OAEG;cACO,CAAC,SAAS,SAAS,QAAQ,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,KAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAIrE;;OAEG;uBACgB,GAAG,CAAC,SAAS,CAAC,EAAE,MAAM,QAAQ;EAMjD,CAAC"}

package/dist/types/src/internal/ref/ref.d.ts

@@ -0,0 +1,231 @@
+import * as Equal from 'effect/Equal';
+import * as Hash from 'effect/Hash';
+import * as Pipeable from 'effect/Pipeable';
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import type * as Types from 'effect/Types';
+import { type CustomInspectFunction, inspectCustom } from '@dxos/debug';
+import { EncodedReference } from '@dxos/echo-protocol';
+import { DXN, ObjectId } from '@dxos/keys';
+import { type JsonSchemaType } from '../json-schema';
+import type { AnyEntity, AnyProperties } from '../types';
+/**
+ * The `$id` and `$ref` fields for an ECHO reference schema.
+ */
+export declare const JSON_SCHEMA_ECHO_REF_ID = "/schemas/echo/ref";
+export declare const getSchemaReference: (property: JsonSchemaType) => {
+    typename: string;
+} | undefined;
+export declare const createSchemaReference: (typename: string) => Types.DeepMutable<JsonSchemaType>;
+/**
+ * Runtime type-info for a reference extracted from effect AST.
+ */
+export type RefereneAST = {
+    /**
+     * Typename of linked schema.
+     */
+    typename: string;
+    /**
+     * Version of linked schema.
+     */
+    version: string;
+};
+export declare const getReferenceAst: (ast: SchemaAST.AST) => RefereneAST | undefined;
+export declare const RefTypeId: unique symbol;
+/**
+ * Reference Schema.
+ */
+export interface RefSchema<T extends AnyEntity> extends Schema.SchemaClass<Ref<T>, EncodedReference> {
+}
+/**
+ * Type of the `Ref` function and extra methods attached to it.
+ */
+export interface RefFn {
+    <S extends Schema.Schema.Any>(schema: S): RefSchema<Schema.Schema.Type<S>>;
+    /**
+     * @returns True if the object is a reference.
+     */
+    isRef: (obj: unknown) => obj is Ref<any>;
+    /**
+     * @returns True if the reference points to the given object id.
+     */
+    hasObjectId: (id: ObjectId) => (ref: Ref<any>) => boolean;
+    /**
+     * @returns True if the schema is a reference schema.
+     */
+    isRefSchema: (schema: Schema.Schema<any, any>) => schema is RefSchema<any>;
+    /**
+     * @returns True if the schema AST is a reference schema.
+     */
+    isRefSchemaAST: (ast: SchemaAST.AST) => boolean;
+    /**
+     * Constructs a reference that points to the given object.
+     */
+    make: <T extends AnyEntity>(object: T) => Ref<T>;
+    /**
+     * Constructs a reference that points to the object specified by the provided DXN.
+     */
+    fromDXN: (dxn: DXN) => Ref<any>;
+}
+/**
+ * Schema builder for references.
+ */
+export declare const Ref: RefFn;
+/**
+ * Represents materialized reference to a target.
+ * This is the data type for the fields marked as ref.
+ */
+export interface Ref<T> extends Pipeable.Pipeable {
+    /**
+     * Target object DXN.
+     */
+    get dxn(): DXN;
+    /**
+     * Returns true if the reference has a target available (inlined or resolver set).
+     */
+    get isAvailable(): boolean;
+    /**
+     * @returns The reference target.
+     * May return `undefined` if the object is not loaded in the working set.
+     * Accessing this property, even if it returns `undefined` will trigger the object to be loaded to the working set.
+     */
+    get target(): T | undefined;
+    /**
+     * @returns Promise that will resolves with the target object.
+     * Will load the object from disk if it is not present in the working set.
+     * @throws If the object is not available locally.
+     */
+    load(): Promise<T>;
+    /**
+     * @returns Promise that will resolves with the target object or undefined if the object is not loaded locally.
+     */
+    tryLoad(): Promise<T | undefined>;
+    /**
+     * Do not inline the target object in the reference.
+     * Makes .target unavailable unless the reference is connected to a database context.
+     *
+     * When serialized with toJSON, the difference is between:
+     * `{ "/": "dxn:..." }`
+     * and
+     * `{ "/": "dxn:...", "target": { ... } }`
+     *
+     * Clones the reference object.
+     */
+    noInline(): Ref<T>;
+    /**
+     * Serializes the reference to a JSON object.
+     * The serialization format is compatible with the IPLD-style encoded references.
+     * When a reference has a saved target (i.e. the target or object holding the reference is not in the database),
+     * the target is included in the serialized object.
+     *
+     * Examples:
+     * `{ "/": "dxn:..." }`
+     * `{ "/": "dxn:...", "target": { ... } }`
+     */
+    encode(): EncodedReference;
+    [RefTypeId]: {
+        _T: T;
+    };
+}
+export declare namespace Ref {
+    /**
+     * Target of the reference.
+     */
+    type Target<R> = R extends Ref<infer U> ? U : never;
+}
+/**
+ * `reference` field on the schema object.
+ */
+export type JsonSchemaReferenceInfo = {
+    schema: {
+        $ref: string;
+    };
+    schemaVersion?: string;
+};
+export interface RefResolver {
+    /**
+     * Resolve ref synchronously from the objects in the working set.
+     *
+     * @param dxn
+     * @param load If true the resolver should attempt to load the object from disk.
+     * @param onLoad Callback to call when the object is loaded.
+     */
+    resolveSync(dxn: DXN, load: boolean, onLoad?: () => void): AnyProperties | undefined;
+    /**
+     * Resolver ref asynchronously.
+     */
+    resolve(dxn: DXN): Promise<AnyProperties | undefined>;
+    resolveSchema(dxn: DXN): Promise<Schema.Schema.AnyNoContext | undefined>;
+}
+export declare class RefImpl<T> implements Ref<T> {
+    #private;
+    constructor(dxn: DXN, target?: T);
+    /**
+     * @inheritdoc
+     */
+    get dxn(): DXN;
+    /**
+     * @inheritdoc
+     */
+    get isAvailable(): boolean;
+    /**
+     * @inheritdoc
+     */
+    get target(): T | undefined;
+    /**
+     * @inheritdoc
+     */
+    load(): Promise<T>;
+    /**
+     * @inheritdoc
+     */
+    tryLoad(): Promise<T | undefined>;
+    /**
+     * Do not inline the target object in the reference.
+     * Makes .target unavailable unless the reference is connected to a database context.
+     * Clones the reference object.
+     */
+    noInline(): RefImpl<T>;
+    encode(): EncodedReference;
+    /**
+     * Serializes the reference to a JSON object.
+     * The serialization format is compatible with the IPLD-style encoded references.
+     * When a reference has a saved target (i.e. the target or object holding the reference is not in the database),
+     * the target is included in the serialized object.
+     */
+    toJSON(): EncodedReference;
+    toString(): string;
+    [inspectCustom]: CustomInspectFunction;
+    [RefTypeId]: {
+        _T: any;
+    };
+    /**
+     * Effect Hash trait. Required for MutableHashMap-based caches (e.g., Atom.family)
+     * to deduplicate Ref instances that point to the same object.
+     * ECHO proxies return new RefImpl instances on every property access,
+     * so without this, each access would create a separate cache entry.
+     */
+    [Hash.symbol](): number;
+    /** Effect Equal trait. See {@link Hash.symbol} for rationale. */
+    [Equal.symbol](that: Equal.Equal): boolean;
+    pipe(): unknown;
+}
+/**
+ * Internal API for setting the reference resolver.
+ */
+export declare const setRefResolver: (ref: Ref<any>, resolver: RefResolver) => void;
+/**
+ * Internal API for getting the saved target on a reference.
+ */
+export declare const getRefSavedTarget: (ref: Ref<any>) => AnyProperties | undefined;
+export declare const refFromEncodedReference: (encodedReference: EncodedReference, resolver?: RefResolver) => Ref<any>;
+export declare class StaticRefResolver implements RefResolver {
+    objects: Map<string, AnyProperties>;
+    schemas: Map<DXN.String, Schema.Schema.AnyNoContext>;
+    addObject(obj: AnyProperties): this;
+    addSchema(schema: Schema.Schema.AnyNoContext): this;
+    resolveSync(dxn: DXN, _load: boolean, _onLoad?: () => void): AnyProperties | undefined;
+    resolve(dxn: DXN): Promise<AnyProperties | undefined>;
+    resolveSchema(dxn: DXN): Promise<Schema.Schema.AnyNoContext | undefined>;
+}
+//# sourceMappingURL=ref.d.ts.map

package/dist/types/src/internal/ref/ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ref.d.ts","sourceRoot":"","sources":["../../../../../src/internal/ref/ref.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AAGpC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,KAAK,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAI3C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,uBAAuB,sBAAsB,CAAC;AAE3D,eAAO,MAAM,kBAAkB,GAAI,UAAU,cAAc,KAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,SAKpF,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,UAAU,MAAM,KAAG,KAAK,CAAC,WAAW,CAAC,cAAc,CASxF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,KAAK,SAAS,CAAC,GAAG,KAAG,WAAW,GAAG,SAQlE,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,OAAO,MAA0C,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,SAAS,CAAE,SAAQ,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC;CAAG;AAEvG;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3E;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAEzC;;OAEG;IACH,WAAW,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC;IAE1D;;OAEG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAE3E;;OAEG;IACH,cAAc,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,OAAO,CAAC;IAEhD;;OAEG;IAEH,IAAI,EAAE,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjD;;OAEG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,KAQjB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ,CAAC,QAAQ;IAC/C;;OAEG;IACH,IAAI,GAAG,IAAI,GAAG,CAAC;IAEf;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAAC;IAE3B;;;;OAIG;IACH,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAEnB;;OAEG;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAElC;;;;;;;;;;OAUG;IACH,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IAEnB;;;;;;;;;OASG;IACH,MAAM,IAAI,gBAAgB,CAAC;IAE3B,CAAC,SAAS,CAAC,EAAE;QACX,EAAE,EAAE,CAAC,CAAC;KACP,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B;;OAEG;IACH,KAAY,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;CAC5D;AAiCD;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAwFF,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,IAAI,GAAG,aAAa,GAAG,SAAS,CAAC;IAErF;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAGtD,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;CAC1E;AAED,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,GAAG,CAAC,CAAC,CAAC;;gBAkB3B,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;IAKhC;;OAEG;IACH,IAAI,GAAG,IAAI,GAAG,CAEb;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAO1B;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;IAYxB;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAQvC;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC;IAMtB,MAAM,IAAI,gBAAgB;IAO1B;;;;;OAKG;IACH,MAAM,IAAI,gBAAgB;IAI1B,QAAQ,IAAI,MAAM;IAQlB,CAAC,aAAa,CAAC,EAAE,qBAAqB,CAEpC;IAEF,CAAC,SAAS,CAAC;;MAAe;IAE1B;;;;;OAKG;IACH,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,MAAM;IAIvB,iEAAiE;IACjE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,GAAG,OAAO;IAoB1C,IAAI;CAIL;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,GAAG,CAAC,GAAG,CAAC,EAAE,UAAU,WAAW,SAGlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,KAAK,GAAG,CAAC,GAAG,CAAC,KAAG,aAAa,GAAG,SAGjE,CAAC;AAOF,eAAO,MAAM,uBAAuB,GAAI,kBAAkB,gBAAgB,EAAE,WAAW,WAAW,KAAG,GAAG,CAAC,GAAG,CAU3G,CAAC;AAEF,qBAAa,iBAAkB,YAAW,WAAW;IAC5C,OAAO,6BAAsC;IAC7C,OAAO,8CAAqD;IAEnE,SAAS,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAKnC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI;IAOnD,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,aAAa,GAAG,SAAS;IAShF,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IASrD,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC;CAG/E"}

package/dist/types/src/internal/ref/ref.test.d.ts

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

package/dist/types/src/internal/ref/ref.test.d.ts.map

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

package/dist/types/src/internal/schema/compose.d.ts

@@ -0,0 +1,7 @@
+import type * as Types from 'effect/Types';
+import { type JsonSchemaType } from '../json-schema';
+/**
+ * Creates a composite schema from the source and projection schemas.
+ */
+export declare const composeSchema: (source: Types.Mutable<JsonSchemaType>, target: Types.Mutable<JsonSchemaType>) => Types.Mutable<JsonSchemaType>;
+//# sourceMappingURL=compose.d.ts.map

package/dist/types/src/internal/schema/compose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../../../../../src/internal/schema/compose.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAI3C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD;;GAEG;AAGH,eAAO,MAAM,aAAa,GACxB,QAAQ,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EACrC,QAAQ,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,KACpC,KAAK,CAAC,OAAO,CAAC,cAAc,CAsB9B,CAAC"}

package/dist/types/src/internal/schema/compose.test.d.ts

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

package/dist/types/src/internal/schema/compose.test.d.ts.map

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