@dxos/echo 0.8.4-main.406dc2a → 0.8.4-main.59c2e9b

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

@@ -0,0 +1,170 @@
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import { DXN } from '@dxos/keys';
+import { type Primitive } from '@dxos/util';
+import { EntityKind } from '../types';
+/**
+ * Sets the path for the field.
+ * @param path Data source path in the json path format. This is the field path in the source object.
+ */
+export declare const FieldPath: (path: string) => <A, I, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>;
+/**
+ * ECHO identifier (for a stored schema).
+ * Must be a `dxn:echo:` URI.
+ */
+export declare const TypeIdentifierAnnotationId: unique symbol;
+export declare const getTypeIdentifierAnnotation: (schema: Schema.Schema.All) => string | undefined;
+/**
+ * @returns DXN of the schema.
+ *
+ * For non-stored schema returns `dxn:type:`.
+ * For stored schema returns `dxn:echo:`.
+ */
+export declare const getSchemaDXN: (schema: Schema.Schema.All) => DXN | undefined;
+/**
+ * @param input schema or a typename string.
+ * @return type DXN.
+ */
+export declare const getTypeDXNFromSpecifier: (input: Schema.Schema.All | string) => DXN;
+/**
+ * Fully qualified globally unique typename.
+ * Example: `dxos.org/type/Message`
+ */
+export declare const TypenameSchema: Schema.refine<string, typeof Schema.String>;
+/**
+ * Semantic version format: `major.minor.patch`
+ * Example: `1.0.0`
+ */
+export declare const VersionSchema: Schema.refine<string, typeof Schema.String>;
+export declare const TypeMeta: Schema.Struct<{
+    typename: Schema.refine<string, typeof Schema.String>;
+    version: Schema.refine<string, typeof Schema.String>;
+}>;
+export interface TypeMeta extends Schema.Schema.Type<typeof TypeMeta> {
+}
+/**
+ * Entity type.
+ */
+export declare const TypeAnnotationId: unique symbol;
+/**
+ * Payload stored under {@link TypeAnnotationId}.
+ */
+export declare const TypeAnnotation: Schema.extend<Schema.Struct<{
+    typename: Schema.refine<string, typeof Schema.String>;
+    version: Schema.refine<string, typeof Schema.String>;
+}>, Schema.Struct<{
+    kind: Schema.Enums<typeof EntityKind>;
+    /**
+     * If this is a relation, the schema of the source object.
+     * Must be present if entity kind is {@link EntityKind.Relation}.
+     */
+    sourceSchema: Schema.optional<Schema.refine<string, typeof Schema.NonEmptyString>>;
+    /**
+     * If this is a relation, the schema of the target object.
+     * Must be present if entity kind is {@link EntityKind.Relation}.
+     */
+    targetSchema: Schema.optional<Schema.refine<string, typeof Schema.NonEmptyString>>;
+}>>;
+export interface TypeAnnotation extends Schema.Schema.Type<typeof TypeAnnotation> {
+}
+/**
+ * @returns {@link TypeAnnotation} from a schema.
+ * Schema must have been created with {@link TypedObject} or {@link TypedLink} or manually assigned an appropriate annotation.
+ */
+export declare const getTypeAnnotation: (schema: Schema.Schema.All) => TypeAnnotation | undefined;
+/**
+ * @returns {@link EntityKind} from a schema.
+ */
+export declare const getEntityKind: (schema: Schema.Schema.All) => EntityKind | undefined;
+/**
+ * Checks if the object is an instance of the schema.
+ * Only typename is compared, the schema version is ignored.
+ *
+ * The following cases are considered to mean that the object is an instance of the schema:
+ *  - Object was created with this exact schema.
+ *  - Object was created with a different version of this schema.
+ *  - Object was created with a different schema (maybe dynamic) that has the same typename.
+ */
+export declare const isInstanceOf: <Schema extends Schema.Schema.AnyNoContext>(schema: Schema, object: any) => object is Schema.Schema.Type<Schema>;
+/**
+ * PropertyMeta (metadata for dynamic schema properties).
+ * For user-defined annotations.
+ */
+export declare const PropertyMetaAnnotationId: unique symbol;
+export type PropertyMetaValue = Primitive | Record<string, Primitive> | Primitive[];
+export type PropertyMetaAnnotation = {
+    [name: string]: PropertyMetaValue;
+};
+export declare const PropertyMeta: (name: string, value: PropertyMetaValue) => <A, I, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>;
+export declare const getPropertyMetaAnnotation: <T>(prop: SchemaAST.PropertySignature, name: string) => T | undefined;
+/**
+ * Schema reference.
+ */
+export declare const ReferenceAnnotationId: unique symbol;
+export type ReferenceAnnotationValue = TypeAnnotation;
+export declare const ReferenceAnnotation: import("./util").AnnotationHelper<TypeAnnotation>;
+/**
+ * SchemaMeta.
+ */
+export declare const SchemaMetaSymbol: unique symbol;
+export type SchemaMeta = TypeMeta & {
+    id: string;
+};
+/**
+ * Identifies a schema as a schema for a hidden system type.
+ */
+export declare const SystemTypeAnnotationId: unique symbol;
+export declare const SystemTypeAnnotation: import("./util").AnnotationHelper<boolean>;
+/**
+ * Identifies label property or JSON path expression.
+ * Either a string or an array of strings representing field accessors each matched in priority order.
+ */
+export declare const LabelAnnotationId: unique symbol;
+export declare const LabelAnnotation: import("./util").AnnotationHelper<string[]>;
+/**
+ * Returns the label for a given object based on {@link LabelAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
+ */
+export declare const getLabelWithSchema: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>) => string | undefined;
+/**
+ * Sets the label for a given object based on {@link LabelAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
+ */
+export declare const setLabelWithSchema: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, label: string) => void;
+/**
+ * Identifies description property or JSON path expression.
+ * A string representing field accessor.
+ */
+export declare const DescriptionAnnotationId: unique symbol;
+export declare const DescriptionAnnotation: import("./util").AnnotationHelper<string>;
+/**
+ * Returns the description for a given object based on {@link DescriptionAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
+ */
+export declare const getDescriptionWithSchema: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>) => string | undefined;
+/**
+ * Sets the description for a given object based on {@link DescriptionAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
+ */
+export declare const setDescriptionWithSchema: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, description: string) => void;
+/**
+ * Identifies if a property should be included in a form or not.
+ * By default, all properties are included in forms, so this is opt-out.
+ */
+export declare const FormInputAnnotationId: unique symbol;
+export declare const FormInputAnnotation: import("./util").AnnotationHelper<boolean>;
+/**
+ * Default field to be used on referenced schema to lookup the value.
+ */
+export declare const FieldLookupAnnotationId: unique symbol;
+/**
+ * Generate test data.
+ */
+export declare const GeneratorAnnotationId: unique symbol;
+export type GeneratorAnnotationValue = string | {
+    generator: string;
+    args?: any[];
+    probability?: number;
+};
+export declare const GeneratorAnnotation: import("./util").AnnotationHelper<GeneratorAnnotationValue>;
+//# sourceMappingURL=annotations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../../../../src/internal/annotations/annotations.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAK9C,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAsB,UAAU,EAAqB,MAAM,UAAU,CAAC;AAS7E;;;GAGG;AAEH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,MAmQ5B,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,AAnQY,CAAC;AAMrF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,eAAuD,CAAC;AAE/F,eAAO,MAAM,2BAA2B,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,uBAItD,CAAC;AAEhB;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,KAAG,GAAG,GAAG,SAc9D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,KAAG,GAQ3E,CAAC;AAMF;;;GAGG;AAGH,eAAO,MAAM,cAAc,6CAK1B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,6CAGxB,CAAC;AAEH,eAAO,MAAM,QAAQ;;;EAGnB,CAAC;AAEH,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC;CAAG;AAExE;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAA6C,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;IAKvB;;;OAGG;;IAGH;;;OAGG;;GAGN,CAAC;AAEF,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC;CAAG;AAEpF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,KAAG,cAAc,GAAG,SAM9E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,CAAC,MAAM,CAAC,GAAG,KAAG,UAAU,GAAG,SAA4C,CAAC;AAoEpH;;;;;;;;GAQG;AAEH,eAAO,MAAM,YAAY,GAAI,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACpE,QAAQ,MAAM,EACd,QAAQ,GAAG,KACV,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CA0BrC,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,eAAqD,CAAC;AAE3F,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;AAEpF,MAAM,MAAM,sBAAsB,GAAG;IACnC,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACnC,CAAC;AAIF,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,EAAE,OAAO,iBAAiB,MACzD,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAStE,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,CAAC,EAAE,MAAM,SAAS,CAAC,iBAAiB,EAAE,MAAM,MAAM,kBAKzF,CAAC;AAMJ;;GAEG;AACH,eAAO,MAAM,qBAAqB,eAAkD,CAAC;AACrF,MAAM,MAAM,wBAAwB,GAAG,cAAc,CAAC;AACtD,eAAO,MAAM,mBAAmB,mDAA0E,CAAC;AAE3G;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAwC,CAAC;AACtE,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,sBAAsB,eAAmD,CAAC;AACvF,eAAO,MAAM,oBAAoB,4CAA0D,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,iBAAiB,eAA8C,CAAC;AAC7E,eAAO,MAAM,eAAe,6CAAsD,CAAC;AAEnF;;;GAGG;AAEH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC5D,QAAQ,CAAC,EACT,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAC5B,MAAM,GAAG,SAwBX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC5D,QAAQ,CAAC,EACT,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAC7B,OAAO,MAAM,SAOd,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,eAAoD,CAAC;AACzF,eAAO,MAAM,qBAAqB,2CAA0D,CAAC;AAE7F;;;GAGG;AAEH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClE,QAAQ,CAAC,EACT,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAC5B,MAAM,GAAG,SAiBX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAClE,QAAQ,CAAC,EACT,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAC7B,aAAa,MAAM,SAIpB,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,qBAAqB,eAAkD,CAAC;AACrF,eAAO,MAAM,mBAAmB,4CAAyD,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,uBAAuB,eAAoD,CAAC;AAEzF;;GAEG;AACH,eAAO,MAAM,qBAAqB,eAAkD,CAAC;AAErF,MAAM,MAAM,wBAAwB,GAChC,MAAM,GACN;IACE,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,eAAO,MAAM,mBAAmB,6DAA0E,CAAC"}

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

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

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

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

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

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

package/dist/types/src/internal/annotations/util.d.ts

@@ -0,0 +1,27 @@
+import type * as Option from 'effect/Option';
+import type * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import { EntityKind } from '../types';
+export interface AnnotationHelper<T> {
+    get: (schema: Schema.Schema.Any) => Option.Option<T>;
+    getFromAst: (ast: SchemaAST.AST) => Option.Option<T>;
+    set: (value: T) => <S extends Schema.Schema.Any>(schema: S) => S;
+}
+export declare const createAnnotationHelper: <T>(id: symbol) => AnnotationHelper<T>;
+/**
+ * If property is optional returns the nested property, otherwise returns the property.
+ */
+export declare const unwrapOptional: (property: SchemaAST.PropertySignature) => SchemaAST.AST | SchemaAST.PropertySignature;
+/**
+ * @see JSONSchemaAnnotationId
+ * @returns JSON-schema annotation so that the schema can be serialized with correct parameters.
+ */
+export declare const makeTypeJsonSchemaAnnotation: (options: {
+    identifier?: string;
+    kind: EntityKind;
+    typename: string;
+    version: string;
+    relationSource?: string;
+    relationTarget?: string;
+}) => any;
+//# sourceMappingURL=util.d.ts.map

package/dist/types/src/internal/annotations/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../../src/internal/annotations/util.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAK9C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrD,UAAU,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrD,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;CAClE;AAED,eAAO,MAAM,sBAAsB,GAAI,CAAC,EAAE,IAAI,MAAM,KAAG,gBAAgB,CAAC,CAAC,CASxE,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,cAAc,GAAI,UAAU,SAAS,CAAC,iBAAiB,gDAMnE,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,4BAA4B,GAAI,SAAS;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,QAiBA,CAAC"}

package/dist/types/src/internal/api/annotations.d.ts

@@ -0,0 +1,23 @@
+import { type Mutable } from '../proxy';
+import { type AnyProperties } from '../types';
+/**
+ * Get the label of an entity.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const getLabel: (entity: AnyProperties) => string | undefined;
+/**
+ * Set the label of an entity.
+ * Must be called within an Obj.change or Relation.change callback.
+ */
+export declare const setLabel: (entity: Mutable<AnyProperties>, label: string) => void;
+/**
+ * Get the description of an entity.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const getDescription: (entity: AnyProperties) => string | undefined;
+/**
+ * Set the description of an entity.
+ * Must be called within an Obj.change or Relation.change callback.
+ */
+export declare const setDescription: (entity: Mutable<AnyProperties>, description: string) => void;
+//# sourceMappingURL=annotations.d.ts.map

package/dist/types/src/internal/api/annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/annotations.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,UAAU,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,aAAa,KAAG,MAAM,GAAG,SAKzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,MAAM,SAKrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,aAAa,KAAG,MAAM,GAAG,SAK/D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,OAAO,CAAC,aAAa,CAAC,EAAE,aAAa,MAAM,SAKjF,CAAC"}

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

@@ -0,0 +1,13 @@
+import { type DXN } from '@dxos/keys';
+import type { AnyEntity } from '../types';
+/**
+ * Get the DXN of an entity.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const getDXN: (entity: AnyEntity) => DXN;
+/**
+ * Get the database the entity belongs to.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const getDatabase: (entity: AnyEntity) => any | undefined;
+//# sourceMappingURL=entity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/entity.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,SAAS,KAAG,GAI1C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,SAAS,KAAG,GAAG,GAAG,SAGrD,CAAC"}

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

@@ -0,0 +1,15 @@
+/**
+ * Shared API helpers for Obj and Relation modules.
+ * These implementations use generic Entity types.
+ * Obj and Relation modules re-export with strongly-typed signatures.
+ *
+ * TODO(wittjosiah): Could this become the new "internal" where we slowly refactor
+ * existing internal modules into here? This would provide a cleaner boundary
+ * and prevent external packages from using internals directly.
+ */
+export * from './annotations';
+export * from './entity';
+export * from './meta';
+export * from './sorting';
+export * from './version';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}

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

@@ -0,0 +1,42 @@
+import type { ForeignKey } from '@dxos/echo-protocol';
+import type { DeepReadonly } from '@dxos/util';
+import { type Mutable } from '../proxy';
+import { type AnyProperties, type ObjectMeta } from '../types';
+/**
+ * Deeply read-only version of ObjectMeta.
+ */
+export type ReadonlyMeta = DeepReadonly<ObjectMeta>;
+/**
+ * Mutable meta type received in meta mutation callbacks.
+ */
+export type Meta = ObjectMeta;
+/**
+ * Get the metadata for an entity with validation.
+ * Returns mutable meta when passed a mutable entity (inside change callback).
+ * Returns read-only meta when passed a regular entity or snapshot.
+ *
+ * TODO(burdon): When passed a Snapshot, should return a snapshot of meta, not the live meta proxy.
+ */
+export declare function getMetaChecked(entity: Mutable<AnyProperties>): ObjectMeta;
+export declare function getMetaChecked(entity: AnyProperties): ReadonlyMeta;
+/**
+ * @returns Foreign keys for the entity from the specified source.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const getKeys: (entity: AnyProperties, source: string) => ForeignKey[];
+/**
+ * Delete all keys from the entity for the specified source.
+ * Must be called within an Obj.change or Relation.change callback.
+ */
+export declare const deleteKeys: (entity: Mutable<AnyProperties>, source: string) => void;
+/**
+ * Add a tag to the entity.
+ * Must be called within an Obj.change or Relation.change callback.
+ */
+export declare const addTag: (entity: Mutable<AnyProperties>, tag: string) => void;
+/**
+ * Remove a tag from the entity.
+ * Must be called within an Obj.change or Relation.change callback.
+ */
+export declare const removeTag: (entity: Mutable<AnyProperties>, tag: string) => void;
+//# sourceMappingURL=meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/meta.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAuB,MAAM,UAAU,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC;AAE9B;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;AAC3E,wBAAgB,cAAc,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAC;AAQpE;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,aAAa,EAAE,QAAQ,MAAM,KAAG,UAAU,EAKzE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,OAAO,CAAC,aAAa,CAAC,EAAE,QAAQ,MAAM,SAQxE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,OAAO,CAAC,aAAa,CAAC,EAAE,KAAK,MAAM,SAIjE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,CAAC,aAAa,CAAC,EAAE,KAAK,MAAM,SAWpE,CAAC"}

package/dist/types/src/internal/api/sorting.d.ts

@@ -0,0 +1,24 @@
+import type { AnyEntity } from '../types';
+/**
+ * String comparison helper for sorting.
+ */
+export declare const compare: (a?: string, b?: string) => number;
+/**
+ * Comparator function type for sorting entities.
+ * Accepts both reactive entities and snapshots.
+ */
+export type Comparator<T extends AnyEntity = AnyEntity> = (a: T, b: T) => number;
+/**
+ * Sort entities by label.
+ */
+export declare const sortByLabel: Comparator;
+/**
+ * Sort entities by typename.
+ */
+export declare const sortByTypename: Comparator;
+/**
+ * Compose multiple comparators into one.
+ * Applies comparators in order until one returns non-zero.
+ */
+export declare const sort: <T extends AnyEntity>(...comparators: Comparator<T>[]) => Comparator<T>;
+//# sourceMappingURL=sorting.d.ts.map

package/dist/types/src/internal/api/sorting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/sorting.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAI1C;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,IAAI,MAAM,EAAE,IAAI,MAAM,KAAG,MAQhD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC;AAEjF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,UAA8E,CAAC;AAEzG;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,UAAoF,CAAC;AAElH;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,SAAS,EAAE,GAAG,aAAa,UAAU,CAAC,CAAC,CAAC,EAAE,KAAG,UAAU,CAAC,CAAC,CAUvF,CAAC"}

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

@@ -0,0 +1,42 @@
+import { type AnyEntity, VersionTypeId } from '../types';
+/**
+ * Represent entity version.
+ * May be backed by Automerge.
+ * Entities with no history are not versioned.
+ * Named EntityVersion to avoid conflict with types/version.ts.
+ */
+export interface EntityVersion {
+    [VersionTypeId]: {};
+    /**
+     * Whether the entity is versioned.
+     */
+    versioned: boolean;
+    /**
+     * Automerge heads.
+     */
+    automergeHeads?: string[];
+}
+/**
+ * Checks that `obj` is a version object.
+ */
+export declare const isVersion: (entity: unknown) => entity is EntityVersion;
+/**
+ * Returns the version of an entity.
+ * Accepts both reactive entities and snapshots.
+ */
+export declare const version: (entity: AnyEntity) => EntityVersion;
+/**
+ * Checks that `version` is a valid version object.
+ */
+export declare const versionValid: (ver: EntityVersion) => boolean;
+export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
+/**
+ * Compares two versions.
+ * @param version1
+ * @param version2
+ * @returns 'unversioned' if either entity is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
+ */
+export declare const compareVersions: (version1: EntityVersion, version2: EntityVersion) => VersionCompareResult;
+export declare const encodeVersion: (ver: EntityVersion) => string;
+export declare const decodeVersion: (ver: string) => EntityVersion;
+//# sourceMappingURL=version.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../../../src/internal/api/version.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAOD;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,OAAO,KAAG,MAAM,IAAI,aAErD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,SAAS,KAAG,aAM3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,aAAa,KAAG,OAGjD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG,OAAO,GAAG,WAAW,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,aAAa,EAAE,UAAU,aAAa,KAAG,oBAgBlF,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,KAAK,aAAa,KAAG,MAElD,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,KAAG,aAI3C,CAAC"}

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

@@ -0,0 +1,20 @@
+import * as Schema from 'effect/Schema';
+import type * as Types from 'effect/Types';
+import { type ToMutable } from '@dxos/util';
+import { type TypeMeta } from '../annotations';
+import { type AnyEntity, type EntityKind, SchemaKindId } from '../types';
+export type EchoTypeSchemaProps<T, ExtraFields = {}> = Types.Simplify<AnyEntity & ToMutable<T> & ExtraFields>;
+export interface EchoTypeSchema<Self extends Schema.Schema.Any, ExtraFields = {}, K extends EntityKind = EntityKind, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> extends TypeMeta, Schema.AnnotableClass<EchoTypeSchema<Self, ExtraFields, K, Fields>, EchoTypeSchemaProps<Schema.Schema.Type<Self>, ExtraFields>, EchoTypeSchemaProps<Schema.Schema.Encoded<Self>, ExtraFields>, Schema.Schema.Context<Self>> {
+    /**
+     * Schema kind key that marks this as an ECHO schema and indicates its kind.
+     * Makes EchoTypeSchema satisfy the Type.Obj.Any or Type.Relation.Any type.
+     */
+    readonly [SchemaKindId]: K;
+    /**
+     * The fields defined in the original struct schema.
+     * Allows accessing field definitions for introspection.
+     */
+    readonly fields: Fields;
+    instanceOf(value: unknown): boolean;
+}
+//# sourceMappingURL=entity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../../../src/internal/entities/entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAKzE,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,WAAW,GAAG,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC;AAG9G,MAAM,WAAW,cAAc,CAC7B,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9B,WAAW,GAAG,EAAE,EAChB,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAC1D,SAAQ,QAAQ,EACd,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,CAAC,EAC5C,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,EAC1D,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,EAC7D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC5B;IACH;;;OAGG;IACH,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;CACrC"}

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

@@ -0,0 +1,6 @@
+export * from './entity';
+export * from './model';
+export * from './object';
+export * from './relation';
+export * from './util';
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/types/src/internal/entities/model.d.ts

@@ -0,0 +1,77 @@
+import type * as Schema from 'effect/Schema';
+import { type ForeignKey } from '@dxos/echo-protocol';
+import { DXN, ObjectId } from '@dxos/keys';
+import type * as Database from '../../Database';
+import { type ATTR_META, type ATTR_TYPE, EntityKind, KindId, type MetaId, type ObjectMeta, type SchemaId, TypeId, type Version } from '../types';
+import { type ATTR_RELATION_SOURCE, type ATTR_RELATION_TARGET, RelationSourceDXNId, RelationSourceId, RelationTargetDXNId, RelationTargetId } from './relation';
+/**
+ * Property name for self DXN when object is serialized to JSON.
+ */
+export declare const ATTR_SELF_DXN = "@dxn";
+/**
+ * DXN to the object itself.
+ */
+export declare const SelfDXNId: unique symbol;
+/**
+ * Property name for deleted when object is serialized to JSON.
+ */
+export declare const ATTR_DELETED = "@deleted";
+/**
+ * Deletion marker.
+ */
+export declare const ObjectDeletedId: unique symbol;
+/**
+ * Object version accessor symbol.
+ */
+export declare const ObjectVersionId: unique symbol;
+/**
+ * Object database accessor symbol.
+ */
+export declare const ObjectDatabaseId: unique symbol;
+/**
+ * Internal runtime representation of an object.
+ * The fields are accessed through getter functions.
+ */
+export interface InternalObjectProps {
+    readonly id: ObjectId;
+    readonly [SelfDXNId]: DXN;
+    readonly [KindId]: EntityKind;
+    readonly [SchemaId]: Schema.Schema.AnyNoContext;
+    readonly [TypeId]: DXN;
+    readonly [MetaId]?: ObjectMeta;
+    readonly [ObjectDatabaseId]?: Database.Database;
+    readonly [ObjectDeletedId]?: boolean;
+    readonly [ObjectVersionId]?: Version;
+    readonly [RelationSourceDXNId]?: DXN;
+    readonly [RelationTargetDXNId]?: DXN;
+    readonly [RelationSourceId]?: InternalObjectProps;
+    readonly [RelationTargetId]?: InternalObjectProps;
+}
+/**
+ * Entity metadata.
+ */
+export interface ObjectMetaJSON {
+    keys: ForeignKey[];
+    tags?: string[];
+}
+/**
+ * JSON representation of an object or relation metadata.
+ */
+export interface ObjectJSON {
+    id: string;
+    [ATTR_TYPE]: DXN.String;
+    [ATTR_SELF_DXN]?: DXN.String;
+    [ATTR_DELETED]?: boolean;
+    [ATTR_META]?: ObjectMetaJSON;
+    [ATTR_RELATION_SOURCE]?: DXN.String;
+    [ATTR_RELATION_TARGET]?: DXN.String;
+    /**
+     * Application-specific properties.
+     */
+    [key: string]: unknown;
+}
+/**
+ * NOTE: Keep as `function` to avoid type inference issues.
+ */
+export declare function assertObjectModel(obj: unknown): asserts obj is InternalObjectProps;
+//# sourceMappingURL=model.d.ts.map

package/dist/types/src/internal/entities/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../../../src/internal/entities/model.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,KAAK,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAChD,OAAO,EACL,KAAK,SAAS,EACd,KAAK,SAAS,EACd,UAAU,EACV,MAAM,EACN,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,MAAM,EACN,KAAK,OAAO,EACb,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAMpB;;GAEG;AACH,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,eAA+B,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,YAAY,aAAa,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAmC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAAyC,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAoC,CAAC;AAElE;;;GAGG;AAEH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;IAC1B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IAChD,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;IACvB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAChD,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,CAAC;IACrC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,CAAC;IACrC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,mBAAmB,CAAC;IAClD,QAAQ,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,mBAAmB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IACxB,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAC7B,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC;IACzB,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC;IAC7B,CAAC,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IACpC,CAAC,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAEpC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,IAAI,mBAAmB,CAgBlF"}

package/dist/types/src/internal/entities/object.d.ts

@@ -0,0 +1,18 @@
+import * as Schema from 'effect/Schema';
+import { type TypeMeta } from '../annotations';
+import { EntityKind } from '../types';
+import { type EchoTypeSchema } from './entity';
+/**
+ * Object schema type with kind marker.
+ */
+export type EchoObjectSchema<Self extends Schema.Schema.Any, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> = EchoTypeSchema<Self, {}, EntityKind.Object, Fields>;
+/**
+ * Schema for Obj entity types.
+ * Pipeable function to add ECHO object annotations to a schema.
+ */
+export declare const EchoObjectSchema: {
+    (meta: TypeMeta): <Self extends Schema.Schema.Any, Fields extends Schema.Struct.Fields = Schema.Struct.Fields>(self: Self & {
+        fields?: Fields;
+    }) => EchoObjectSchema<Self, Fields>;
+};
+//# sourceMappingURL=object.d.ts.map

package/dist/types/src/internal/entities/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../../../src/internal/entities/object.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAKxC,OAAO,EAAyC,KAAK,QAAQ,EAAgC,MAAM,gBAAgB,CAAC;AACpH,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,KAAK,cAAc,EAAsB,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAC1B,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9B,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IACxD,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE;IAC7B,CACE,IAAI,EAAE,QAAQ,GACb,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAC5F,IAAI,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAC7B,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;CA4BrC,CAAC"}

package/dist/types/src/internal/entities/relation.d.ts

@@ -0,0 +1,62 @@
+import * as Schema from 'effect/Schema';
+import { type TypeMeta } from '../annotations';
+import { EntityKind } from '../types';
+import { type EchoTypeSchema } from './entity';
+/**
+ * Property name for relation source when object is serialized to JSON.
+ */
+export declare const ATTR_RELATION_SOURCE = "@relationSource";
+/**
+ * Used to access relation source ref on live ECHO objects.
+ * Reading this symbol must return `Live<EchoObjectSchema<any>>` or a DXN.
+ */
+export declare const RelationSourceId: unique symbol;
+/**
+ * Used to access relation source ref on live ECHO objects.
+ * Reading this symbol must return `Live<EchoObjectSchema<any>>` or a DXN.
+ */
+export declare const RelationSourceDXNId: unique symbol;
+/**
+ * Property name for relation target when object is serialized to JSON.
+ */
+export declare const ATTR_RELATION_TARGET = "@relationTarget";
+/**
+ * Used to access relation target ref on live ECHO objects.
+ * Reading this symbol must return `Live<EchoObjectSchema<any>>` or a DXN.
+ */
+export declare const RelationTargetId: unique symbol;
+/**
+ * Used to access relation target ref on live ECHO objects.
+ * Reading this symbol must return `Live<EchoObjectSchema<any>>` or a DXN.
+ */
+export declare const RelationTargetDXNId: unique symbol;
+/**
+ * Source and target props on relations.
+ */
+export type RelationSourceTargetRefs<Source = any, Target = any> = {
+    /**
+     * Source ECHO live object.
+     */
+    [RelationSourceId]: Source;
+    /**
+     * Target ECHO live object.
+     */
+    [RelationTargetId]: Target;
+};
+export type RelationSource<R> = R extends RelationSourceTargetRefs<infer Source, infer _Target> ? Source : never;
+export type RelationTarget<R> = R extends RelationSourceTargetRefs<infer _Source, infer Target> ? Target : never;
+export type EchoRelationSchemaOptions<TSource extends Schema.Schema.AnyNoContext, TTarget extends Schema.Schema.AnyNoContext> = TypeMeta & {
+    source: TSource;
+    target: TTarget;
+};
+/**
+ * Relation schema type with kind marker.
+ */
+export type EchoRelationSchema<Self extends Schema.Schema.Any, Source extends Schema.Schema.AnyNoContext, Target extends Schema.Schema.AnyNoContext, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> = EchoTypeSchema<Self, RelationSourceTargetRefs<Schema.Schema.Type<Source>, Schema.Schema.Type<Target>>, EntityKind.Relation, Fields>;
+/**
+ * Schema for Relation entity types.
+ */
+export declare const EchoRelationSchema: <Source extends Schema.Schema.AnyNoContext, Target extends Schema.Schema.AnyNoContext>({ source, target, typename, version, }: EchoRelationSchemaOptions<Source, Target>) => <Self extends Schema.Schema.Any, Fields extends Schema.Struct.Fields = Schema.Struct.Fields>(self: Self & {
+    fields?: Fields;
+}) => EchoRelationSchema<Self, Source, Target, Fields>;
+//# sourceMappingURL=relation.d.ts.map

package/dist/types/src/internal/entities/relation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.d.ts","sourceRoot":"","sources":["../../../../../src/internal/entities/relation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAOxC,OAAO,EAGL,KAAK,QAAQ,EAKd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,KAAK,cAAc,EAAsB,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAgD,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAmD,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAgD,CAAC;AAEvF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAmD,CAAC;AAE7F;;GAEG;AAEH,MAAM,MAAM,wBAAwB,CAAC,MAAM,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI;IACjE;;OAEG;IACH,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,wBAAwB,CAAC,MAAM,MAAM,EAAE,MAAM,OAAO,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AACjH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,wBAAwB,CAAC,MAAM,OAAO,EAAE,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjH,MAAM,MAAM,yBAAyB,CACnC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,IACxC,QAAQ,GAAG;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAC5B,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9B,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACzC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACzC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IACxD,cAAc,CAChB,IAAI,EACJ,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAChF,UAAU,CAAC,QAAQ,EACnB,MAAM,CACP,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC7B,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACzC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACzC,wCAKC,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,MAYlC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAChG,MAAM,IAAI,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC/B,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAgCnD,CAAC"}

package/dist/types/src/internal/entities/util.d.ts

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

package/dist/types/src/internal/entities/util.d.ts.map

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