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

package/dist/types/src/internal/schema/echo-schema.d.ts

@@ -0,0 +1,181 @@
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import { type ObjectId } from '@dxos/keys';
+import type * as Type from '../../Type';
+import { type SchemaMeta, SchemaMetaSymbol } from '../annotations';
+import { type JsonSchemaType } from '../json-schema';
+import { type TypedObject, type TypedObjectPrototype } from '../object';
+import { EntityKind, SchemaKindId } from '../types';
+import { PersistentSchema } from './persistent-schema';
+/**
+ * Base schema type.
+ */
+export interface BaseSchema<A = any, I = any> extends TypedObject<A, I> {
+    get readonly(): boolean;
+    get mutable(): EchoSchema<A, I>;
+    get snapshot(): Schema.Schema<A, I>;
+    get jsonSchema(): JsonSchemaType;
+}
+/**
+ * Immutable schema type.
+ * @deprecated Use `Schema.Schema.AnyNoContext` instead.
+ */
+export declare class ImmutableSchema<A = any, I = any> implements BaseSchema<A, I> {
+    private readonly _schema;
+    private readonly _objectAnnotation;
+    constructor(_schema: Schema.Schema<A, I>);
+    get [Schema.TypeId](): {
+        _A: (_: any) => any;
+        _I: (_: any) => any;
+        _R: (_: never) => never;
+    };
+    get Type(): A;
+    get Encoded(): I;
+    get Context(): never;
+    get ast(): SchemaAST.AST;
+    get annotations(): (annotations: Schema.Annotations.GenericSchema<A>) => Schema.Schema<A, I, never>;
+    get pipe(): {
+        <A_1>(this: A_1): A_1;
+        <A_1, B = never>(this: A_1, ab: (_: A_1) => B): B;
+        <A_1, B = never, C = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C): C;
+        <A_1, B = never, C = never, D = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D): D;
+        <A_1, B = never, C = never, D = never, E = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E): E;
+        <A_1, B = never, C = never, D = never, E = never, F = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F): F;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G): G;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H): H;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1): I_1;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J): J;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K): K;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L): L;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M): M;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N): N;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O): O;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P): P;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q): Q;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never, R = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q, qr: (_: Q) => R): R;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never, R = never, S = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q, qr: (_: Q) => R, rs: (_: R) => S): S;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never, R = never, S = never, T = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q, qr: (_: Q) => R, rs: (_: R) => S, st: (_: S) => T): T;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never, R = never, S = never, T = never, U = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q, qr: (_: Q) => R, rs: (_: R) => S, st: (_: S) => T, tu: (_: T) => U): U;
+        <A_1, B = never, C = never, D = never, E = never, F = never, G = never, H = never, I_1 = never, J = never, K = never, L = never, M = never, N = never, O = never, P = never, Q = never, R = never, S = never, T = never, U = never>(this: A_1, ab: (_: A_1) => B, bc: (_: B) => C, cd: (_: C) => D, de: (_: D) => E, ef: (_: E) => F, fg: (_: F) => G, gh: (_: G) => H, hi: (_: H) => I_1, ij: (_: I_1) => J, jk: (_: J) => K, kl: (_: K) => L, lm: (_: L) => M, mn: (_: M) => N, no: (_: N) => O, op: (_: O) => P, pq: (_: P) => Q, qr: (_: Q) => R, rs: (_: R) => S, st: (_: S) => T, tu: (_: T) => U): U;
+    };
+    get kind(): EntityKind;
+    get typename(): string;
+    get version(): string;
+    get readonly(): boolean;
+    get snapshot(): Schema.Schema.AnyNoContext;
+    get jsonSchema(): JsonSchemaType;
+    get mutable(): EchoSchema;
+}
+export declare const isMutable: (schema: Schema.Schema.AnyNoContext) => schema is EchoSchema;
+declare const EchoSchema_base: TypedObjectPrototype<any, any>;
+/**
+ * Represents a schema that is persisted in the ECHO database.
+ * Schema can me mutable or readonly (specified by the {@link EchoSchema.readonly} field).
+ *
+ * Schema that can be modified at runtime via the API.
+ * Is an instance of effect-schema (`Schema.Schema.AnyNoContext`) so it can be used in the same way as a regular schema.
+ * IMPORTANT: The schema AST will change reactively when the schema is updated, including synced updates from remote peers.
+ *
+ * The class constructor is a schema instance itself, and can be used in the echo object definitions:
+ *
+ * @example
+ * ```ts
+ * export class TableType extends Schema.Struct({...}).pipe(Type.object({ typename: 'example.org/type/Table', version: '0.1.0' })){
+ *   title: Schema.String,
+ *   schema: Schema.optional(ref(EchoSchema)),
+ *   props: Schema.mutable(S.Array(TablePropSchema)),
+ * }) {}
+ * ```
+ *
+ * The ECHO API will translate any references to PersistentSchema objects to be resolved as EchoSchema objects.
+ */
+export declare class EchoSchema<A = any, I = any> extends EchoSchema_base implements BaseSchema<A, I> {
+    private readonly _persistentSchema;
+    private _schema;
+    private _isDirty;
+    /**
+     * Schema kind key that marks this as an ECHO schema.
+     * Makes EchoSchema satisfy the Type.AnyObj type.
+     */
+    readonly [SchemaKindId]: EntityKind.Object;
+    constructor(_persistentSchema: PersistentSchema);
+    get [Schema.TypeId](): {
+        _A: (_: any) => any;
+        _I: (_: any) => any;
+        _R: (_: never) => never;
+    };
+    get Type(): A;
+    get Encoded(): I;
+    get Context(): never;
+    get ast(): SchemaAST.AST;
+    get annotations(): (annotations: Schema.Annotations.GenericSchema<any>) => Schema.Schema<any, any, never>;
+    get pipe(): Schema.Schema.AnyNoContext['pipe'];
+    get kind(): EntityKind.Object;
+    get typename(): string;
+    get version(): string;
+    get readonly(): boolean;
+    /**
+     * Returns an immutable schema snapshot of the current state of the schema.
+     */
+    get snapshot(): Schema.Schema.AnyNoContext;
+    /**
+     * Returns the JSON schema for the schema.
+     */
+    get jsonSchema(): JsonSchemaType;
+    /**
+     * Returns a mutable schema.
+     */
+    get mutable(): EchoSchema;
+    /**
+     * Id of the ECHO object containing the schema.
+     */
+    get id(): ObjectId;
+    /**
+     * Short name of the schema.
+     */
+    get name(): string | undefined;
+    get [SchemaMetaSymbol](): SchemaMeta;
+    /**
+     * Reference to the underlying persistent schema object.
+     */
+    get persistentSchema(): Type.PersistentType;
+    getProperties(): SchemaAST.PropertySignature[];
+    /**
+     * @throws Error if the schema is readonly.
+     */
+    updateTypename(typename: string): void;
+    /**
+     * @throws Error if the schema is readonly.
+     */
+    addFields(fields: Schema.Struct.Fields): void;
+    /**
+     * @throws Error if the schema is readonly.
+     */
+    updateFields(fields: Schema.Struct.Fields): void;
+    /**
+     * @throws Error if the schema is readonly.
+     */
+    updateFieldPropertyName({ before, after }: {
+        before: PropertyKey;
+        after: PropertyKey;
+    }): void;
+    /**
+     * @throws Error if the schema is readonly.
+     */
+    removeFields(fieldNames: string[]): void;
+    /**
+     * Wrapper for Obj.change that handles the change context for the persistent schema.
+     */
+    private _change;
+    /**
+     * Called by DatabaseSchemaRegistry on update.
+     */
+    _invalidate(): void;
+    /**
+     * Rebuilds this schema if it is dirty.
+     */
+    _rebuild(): void;
+    _getSchema(): Schema.Schema.AnyNoContext;
+}
+export {};
+//# sourceMappingURL=echo-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"echo-schema.d.ts","sourceRoot":"","sources":["../../../../../src/internal/schema/echo-schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,KAAK,UAAU,EAAE,gBAAgB,EAA0C,MAAM,gBAAgB,CAAC;AAC3G,OAAO,EAAE,KAAK,cAAc,EAAgC,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,oBAAoB,EAAe,MAAM,WAAW,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AASpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;GAEG;AAEH,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAErE,IAAI,QAAQ,IAAI,OAAO,CAAC;IAExB,IAAI,OAAO,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,IAAI,UAAU,IAAI,cAAc,CAAC;CAClC;AAED;;;GAGG;AAEH,qBAAa,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,YAAW,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IAE5D,OAAO,CAAC,QAAQ,CAAC,OAAO;IADpC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAiB;gBACtB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;IASzD,IAAW,CAAC,MAAM,CAAC,MAAM,CAAC;gBA4GlB,GAAG;gBACH,GAAG;gBACH,KAAK;MA5GZ;IAED,IAAW,IAAI,MAEd;IAED,IAAW,OAAO,MAEjB;IAED,IAAW,OAAO,UAEjB;IAED,IAAW,GAAG,IAAI,SAAS,CAAC,GAAG,CAE9B;IAED,IAAW,WAAW,qFAErB;IAED,IAAW,IAAI;;;;;;;;;;;;;;;;;;;;;;;MAEd;IAMD,IAAI,IAAI,IAAI,UAAU,CAErB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAMD,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAEzC;IAGD,IAAI,UAAU,IAAI,cAAc,CAE/B;IAED,IAAI,OAAO,IAAI,UAAU,CAExB;CACF;AAsCD,eAAO,MAAM,SAAS,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,KAAG,MAAM,IAAI,UAExE,CAAC;;AASF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,eAAwB,YAAW,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IAUvF,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAT9C,OAAO,CAAC,OAAO,CAAyC;IACxD,OAAO,CAAC,QAAQ,CAAQ;IAExB;;;OAGG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC,MAAM,CAAqB;gBAElC,iBAAiB,EAAE,gBAAgB;IAQhE,IAAW,CAAC,MAAM,CAAC,MAAM,CAAC;gBA5ClB,GAAG;gBACH,GAAG;gBACH,KAAK;MA4CZ;IAED,IAAW,IAAI,IACoB,CAAC,CACnC;IAED,IAAW,OAAO,IACiB,CAAC,CACnC;IAED,IAAW,OAAO,UAGjB;IAED,IAAW,GAAG,kBAGb;IAED,IAAW,WAAW,2FAGrB;IAED,IAAW,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAGpD;IAMD,IAAW,IAAI,IAAI,UAAU,CAAC,MAAM,CAGnC;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAEhD;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,cAAc,CAEtC;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,UAAU,CAG/B;IAMD;;OAEG;IACH,IAAW,EAAE,IAAI,QAAQ,CAExB;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAW,CAAC,gBAAgB,CAAC,IAAI,UAAU,CAE1C;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,IAAI,CAAC,cAAc,CAEjD;IAEM,aAAa,IAAI,SAAS,CAAC,iBAAiB,EAAE;IAYrD;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQ7C;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI;IAOpD;;OAEG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI;IAOvD;;OAEG;IACI,uBAAuB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;QAAE,MAAM,EAAE,WAAW,CAAC;QAAC,KAAK,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI;IAOpG;;OAEG;IACI,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAO/C;;OAEG;IACH,OAAO,CAAC,OAAO;IAaf;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAOhB,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY;CAIzC"}

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

@@ -0,0 +1,4 @@
+export * from './echo-schema';
+export * from './manipulation';
+export * from './persistent-schema';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/internal/schema/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

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

@@ -0,0 +1,10 @@
+import * as Schema from 'effect/Schema';
+export declare const addFieldsToSchema: (schema: Schema.Schema.AnyNoContext, fields: Schema.Struct.Fields) => Schema.Schema.AnyNoContext;
+export declare const updateFieldsInSchema: (schema: Schema.Schema.AnyNoContext, fields: Schema.Struct.Fields) => Schema.Schema.AnyNoContext;
+export declare const removeFieldsFromSchema: (schema: Schema.Schema.AnyNoContext, fieldNames: string[]) => Schema.Schema.AnyNoContext;
+export declare const updateFieldNameInSchema: (schema: Schema.Schema.AnyNoContext, { before, after }: {
+    before: PropertyKey;
+    after: PropertyKey;
+}) => Schema.Schema.AnyNoContext;
+export declare const setTypenameInSchema: (schema: Schema.Schema.AnyNoContext, typename: string) => Schema.Schema.AnyNoContext;
+//# sourceMappingURL=manipulation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manipulation.d.ts","sourceRoot":"","sources":["../../../../../src/internal/schema/manipulation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AASxC,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,QAAQ,MAAM,CAAC,MAAM,CAAC,MAAM,KAC3B,MAAM,CAAC,MAAM,CAAC,YAKhB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,QAAQ,MAAM,CAAC,MAAM,CAAC,MAAM,KAC3B,MAAM,CAAC,MAAM,CAAC,YAgBhB,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,YAAY,MAAM,EAAE,KACnB,MAAM,CAAC,MAAM,CAAC,YAEhB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAClC,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,mBAAmB;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAE,KAC7D,MAAM,CAAC,MAAM,CAAC,YAehB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,UAAU,MAAM,KACf,MAAM,CAAC,MAAM,CAAC,YAiBhB,CAAC"}

package/dist/types/src/internal/schema/persistent-schema.d.ts

@@ -0,0 +1,20 @@
+import * as Schema from 'effect/Schema';
+import { EchoObjectSchema } from '../entities';
+import { JsonSchemaType } from '../json-schema';
+/**
+ * Persistent representation of a schema.
+ */
+export declare const PersistentSchema: EchoObjectSchema<Schema.Struct<{
+    name: Schema.optional<typeof Schema.String>;
+    typename: Schema.refine<string, typeof Schema.String>;
+    version: Schema.refine<string, typeof Schema.String>;
+    jsonSchema: Schema.Schema<JsonSchemaType, JsonSchemaType, never>;
+}>, Readonly<{
+    name: Schema.optional<typeof Schema.String>;
+    typename: Schema.refine<string, typeof Schema.String>;
+    version: Schema.refine<string, typeof Schema.String>;
+    jsonSchema: Schema.Schema<JsonSchemaType, JsonSchemaType, never>;
+}>>;
+export interface PersistentSchema extends Schema.Schema.Type<typeof PersistentSchema> {
+}
+//# sourceMappingURL=persistent-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"persistent-schema.d.ts","sourceRoot":"","sources":["../../../../../src/internal/schema/persistent-schema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAIxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;GAEG;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;GAe5B,CAAC;AAEF,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG"}

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

@@ -0,0 +1,27 @@
+import * as Schema from 'effect/Schema';
+import { type ObjectId } from '@dxos/keys';
+import { type ATTR_META, type ObjectMeta } from './meta';
+/**
+ * Base type for all data objects (reactive, ECHO, and other raw objects).
+ * NOTE: This describes the base type for all database objects.
+ * It is stricter than `T extends {}` or `T extends object`.
+ */
+export type AnyProperties = Record<string, any>;
+/**
+ * Canonical type for all ECHO entities (objects and relations).
+ * @depreacted Remove, use Entity.Unknown instead.
+ */
+export interface AnyEntity {
+    readonly id: ObjectId;
+}
+export type ExcludeId<T extends AnyProperties> = Omit<T, 'id'>;
+export type PropertyKey<T extends AnyProperties> = Extract<keyof ExcludeId<T>, string>;
+type WithMeta = {
+    [ATTR_META]?: ObjectMeta;
+};
+/**
+ * The raw object should not include the ECHO id, but may include metadata.
+ */
+export declare const RawObject: <S extends Schema.Schema.AnyNoContext>(schema: S) => Schema.Schema<ExcludeId<Schema.Schema.Type<S>> & WithMeta, Schema.Schema.Encoded<S>>;
+export {};
+//# sourceMappingURL=base.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/base.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEzD;;;;GAIG;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEhD;;;GAGG;AAEH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,aAAa,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAE/D,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,aAAa,IAAI,OAAO,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAGvF,KAAK,QAAQ,GAAG;IAAE,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAA;CAAE,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAC5D,QAAQ,CAAC,KACR,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAErF,CAAC"}

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

@@ -0,0 +1,37 @@
+import * as Schema from 'effect/Schema';
+/**
+ * String key used to identify the kind of an entity instance (object or relation).
+ */
+export declare const KindId: "~@dxos/echo/Kind";
+export type KindId = typeof KindId;
+/**
+ * String key used to identify the kind of a schema (object schema or relation schema).
+ * Parallels KindId which identifies instance kinds.
+ */
+export declare const SchemaKindId: "~@dxos/echo/SchemaKind";
+export type SchemaKindId = typeof SchemaKindId;
+/**
+ * String key used to brand snapshot types.
+ * Snapshots have SnapshotKindId instead of KindId, making them
+ * distinguishable from reactive objects at the type level.
+ */
+export declare const SnapshotKindId: "~@dxos/echo/SnapshotKind";
+export type SnapshotKindId = typeof SnapshotKindId;
+/**
+ * Kinds of entities stored in ECHO: objects and relations.
+ */
+export declare enum EntityKind {
+    Object = "object",
+    Relation = "relation"
+}
+export declare const EntityKindSchema: Schema.Enums<typeof EntityKind>;
+/**
+ * Typename for generic object references (Type.Obj / Ref.Ref(Obj.Unknown)).
+ * Used when referencing any object without a specific schema.
+ */
+export declare const ANY_OBJECT_TYPENAME = "dxos.org/schema/AnyObject";
+/**
+ * Version for generic object references.
+ */
+export declare const ANY_OBJECT_VERSION = "0.0.0";
+//# sourceMappingURL=entity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AASxC;;GAEG;AACH,eAAO,MAAM,MAAM,EAAG,kBAA2B,CAAC;AAClD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAG,wBAAiC,CAAC;AAC9D,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAG,0BAAmC,CAAC;AAClE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC;AAEnD;;GAEG;AACH,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,eAAO,MAAM,gBAAgB,iCAA2B,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,8BAA8B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,kBAAkB,UAAU,CAAC"}

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

@@ -0,0 +1,6 @@
+export * from './base';
+export * from './entity';
+export * from './meta';
+export * from './typename';
+export * from './version';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

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

@@ -0,0 +1,33 @@
+import * as Schema from 'effect/Schema';
+import { ForeignKey } from '@dxos/echo-protocol';
+import { type Comparator } from '@dxos/util';
+import type * as Entity from '../../Entity';
+import { type AnyProperties } from './base';
+/**
+ * Property name for meta when object is serialized to JSON.
+ */
+export declare const ATTR_META = "@meta";
+/**
+ * Metadata section.
+ */
+export declare const MetaId: Entity.Meta;
+export declare const ObjectMetaSchema: Schema.Struct<{
+    keys: Schema.Array$<Schema.Schema<{
+        readonly id: string;
+        readonly source: string;
+    }, {
+        readonly id: string;
+        readonly source: string;
+    }, never>>;
+    /**
+     * A set of tags.
+     * Tags are arbitrary application-defined strings.
+     * ECHO makes no assumptions about the tag structure.
+     */
+    tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+}>;
+export type ObjectMeta = Schema.Schema.Type<typeof ObjectMetaSchema>;
+export declare const foreignKey: (source: string, id: string) => ForeignKey;
+export declare const foreignKeyEquals: (a: ForeignKey, b: ForeignKey) => boolean;
+export declare const compareForeignKeys: Comparator<AnyProperties>;
+//# sourceMappingURL=meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/meta.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,KAAK,UAAU,EAAgB,MAAM,YAAY,CAAC;AAE3D,OAAO,KAAK,KAAK,MAAM,MAAM,cAAc,CAAC;AAE5C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,IAA2C,CAAC;AAOxE,eAAO,MAAM,gBAAgB;;;;;;;;IAG3B;;;;OAIG;;EAKH,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAmBrE,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,EAAE,IAAI,MAAM,KAAG,UAA8B,CAAC;AACvF,eAAO,MAAM,gBAAgB,GAAI,GAAG,UAAU,EAAE,GAAG,UAAU,YAA2C,CAAC;AAGzG,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,aAAa,CACoB,CAAC"}

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

@@ -0,0 +1,21 @@
+/**
+ * Property name for typename when object is serialized to JSON.
+ */
+export declare const ATTR_TYPE = "@type";
+/**
+ * DXN to the object type.
+ */
+export declare const TypeId: unique symbol;
+/**
+ * Reference to the object schema.
+ */
+export declare const SchemaId: unique symbol;
+/**
+ * Property name for parent when object is serialized to JSON.
+ */
+export declare const ATTR_PARENT = "@parent";
+/**
+ * Reference to the object parent.
+ */
+export declare const ParentId: unique symbol;
+//# sourceMappingURL=typename.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typename.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/typename.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,MAAM,eAAgC,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAkC,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAkC,CAAC"}

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

@@ -0,0 +1,15 @@
+/**
+ * Version type identifier.
+ */
+export declare const VersionTypeId: "~@dxos/echo/VersionTypeId";
+export type VersionTypeId = typeof VersionTypeId;
+/**
+ * Represents the object version.
+ * May be backed by Automerge.
+ * Objects with no history are not versioned.
+ */
+export interface Version {
+    [VersionTypeId]: {};
+    automergeHeads?: string[];
+}
+//# sourceMappingURL=version.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../../../src/internal/types/version.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,aAAa,EAAG,2BAAoC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B"}

package/dist/types/src/{test → testing}/api.test.d.ts.map

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

package/dist/types/src/testing/index.d.ts

@@ -1,2 +1,4 @@
-export * from './types';
+export * from './test-data';
+export * from './test-schema';
+export * from './util';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/testing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC"}

package/dist/types/src/testing/test-data.d.ts

@@ -0,0 +1,18 @@
+import { DatabaseDirectory } from '@dxos/echo-protocol';
+export declare const PEOPLE: {
+    alice: DatabaseDirectory;
+    bob: DatabaseDirectory;
+};
+export declare const ORGS: {
+    dxos: DatabaseDirectory;
+    cyberdyne: DatabaseDirectory;
+};
+export declare const WORKS_FOR: {
+    fredWorksForCyberdyne: DatabaseDirectory;
+    aliceWorksForAperture: DatabaseDirectory;
+};
+export declare const TASKS: {
+    task1: DatabaseDirectory;
+    task2: DatabaseDirectory;
+};
+//# sourceMappingURL=test-data.d.ts.map

package/dist/types/src/testing/test-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-data.d.ts","sourceRoot":"","sources":["../../../../src/testing/test-data.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAmB,MAAM,qBAAqB,CAAC;AAWzE,eAAO,MAAM,MAAM;;;CAuBlB,CAAC;AAEF,eAAO,MAAM,IAAI;;;CAyBhB,CAAC;AAEF,eAAO,MAAM,SAAS;;;CA6BrB,CAAC;AAEF,eAAO,MAAM,KAAK;;;CA+BjB,CAAC"}