@dxos/echo 0.8.4-main.70d3990 → 0.8.4-main.74a063c4e0

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

@@ -1,142 +1,176 @@
-import type * as Schema$ from 'effect/Schema';
+import type * as Schema from 'effect/Schema';
 import { type EncodedReference } from '@dxos/echo-protocol';
 import { type DXN } from '@dxos/keys';
 import { type ToMutable } from '@dxos/util';
-import type * as Entity$ from './Entity';
-import { type ATTR_RELATION_SOURCE, type ATTR_RELATION_TARGET, type EchoRelationSchemaOptions, EchoSchema, Expando as Expando$, type ExpandoEncoded, PersistentSchema, type PersistentSchemaEncoded, Ref as Ref$, type RefFn, type RefSchema, type TypeAnnotation, type TypeMeta, toEffectSchema, toJsonSchema } from './internal';
-import type * as Relation$ from './Relation';
-export { toEffectSchema, toJsonSchema };
+import type * as Entity from './Entity';
+import * as internal from './internal';
+import * as typeInternal from './internal/Type';
+import type * as ObjModule from './Obj';
+import type * as RelationModule from './Relation';
 /**
- * Returns all properties of an object or relation except for the id and kind.
+ * Dynamic type that can be constructed, mutated, and persisted in the ECHO database.
  */
-export type Properties<T = any> = Omit<T, 'id' | Entity$.KindId | Relation$.Source | Relation$.Target>;
-export declare namespace Entity {
-    /**
-     * Type.Obj.Any | Type.Relation.Any.
-     */
-    type Any = Obj.Any | Relation.Any;
-}
-interface ObjJsonProps {
-    id: string;
-}
+export declare const RuntimeType: typeof internal.EchoSchema;
 /**
- * Return type of the `Obj` schema constructor.
- *
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
- * See Effect's note on interface types.
+ * Dynamic type that can be constructed, mutated, and persisted in the ECHO database.
  */
-export interface obj<Self extends Schema$.Schema.Any> extends TypeMeta, Schema$.AnnotableClass<obj<Self>, Entity$.OfKind<typeof Entity$.Kind.Object> & ToMutable<Schema$.Schema.Type<Self>>, Schema$.Simplify<ObjJsonProps & ToMutable<Schema$.Schema.Encoded<Self>>>, Schema$.Schema.Context<Self>> {
-}
+export type RuntimeType = typeInternal.EchoSchema;
 /**
- * Object schema.
+ * Type that marks a schema as an ECHO schema.
+ * The value indicates the entity kind (Object or Relation).
  */
-export declare const Obj: {
-    (opts: TypeMeta): <Self extends Schema$.Schema.Any>(self: Self) => obj<Self>;
+type EchoSchemaKind<K extends internal.EntityKind = internal.EntityKind> = {
+    readonly [internal.SchemaKindId]: K;
 };
 /**
- * Object schema type definitions.
+ * TypeScript type for an ECHO object schema.
+ * `T` is the instance type produced by the schema.
+ * `Fields` is the optional struct fields type for introspection.
+ *
+ * @example
+ * ```ts
+ * const PersonSchema: Type.Obj<Person> = Schema.Struct({
+ *   name: Schema.String,
+ * }).pipe(Type.object({ typename: 'Person', version: '0.1.0' }));
+ *
+ * // Access fields for introspection:
+ * Object.keys(PersonSchema.fields); // ['name']
+ * ```
  */
-export declare namespace Obj {
+export interface Obj<T, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> extends internal.TypeMeta, EchoSchemaKind<internal.EntityKind.Object>, Schema.AnnotableClass<Obj<T, Fields>, Entity.OfKind<typeof Entity.Kind.Object> & T, Schema.Simplify<ObjModule.BaseObjJson & ToMutable<T>>, never> {
     /**
-     * Type that represents an arbitrary schema type of an object.
-     * NOTE: This is not an instance type.
+     * The fields defined in the original struct schema.
+     * Allows accessing field definitions for introspection.
      */
-    type Any = obj<Schema$.Schema.AnyNoContext>;
-}
-export declare const Expando: obj<Schema$.Schema<Expando$, ExpandoEncoded>>;
-export type Expando = obj<Schema$.Schema<Expando$, ExpandoEncoded>>;
-export declare const PersistentType: obj<Schema$.Schema<PersistentSchema, PersistentSchemaEncoded>>;
-export type PersistentType = obj<Schema$.Schema<PersistentSchema, PersistentSchemaEncoded>>;
-export { EchoSchema as RuntimeType };
-interface RelationJsonProps {
-    id: string;
-    [ATTR_RELATION_SOURCE]: string;
-    [ATTR_RELATION_TARGET]: string;
+    readonly fields: Fields;
 }
 /**
- * Return type of the `Relation` schema constructor.
- *
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
- * See Effect's note on interface types.
+ * Structural base type for any ECHO object schema.
+ * Accepts both static schemas (created with Type.object()) and EchoSchema.
+ * NOTE: Does not include the brand symbol to avoid TS4053 declaration portability issues.
+ * Use Type.isObjectSchema() for runtime type guards.
  */
-export interface relation<Self extends Schema$.Schema.Any, SourceSchema extends Schema$.Schema.Any, TargetSchema extends Schema$.Schema.Any> extends TypeMeta, Schema$.AnnotableClass<relation<Self, SourceSchema, TargetSchema>, Entity$.OfKind<typeof Entity$.Kind.Relation> & Relation.Endpoints<Schema$.Schema.Type<SourceSchema>, Schema$.Schema.Type<TargetSchema>> & ToMutable<Schema$.Schema.Type<Self>>, Schema$.Simplify<RelationJsonProps & ToMutable<Schema$.Schema.Encoded<Self>>>, Schema$.Schema.Context<Self>> {
-}
+type ObjectSchemaBase = Schema.Schema.AnyNoContext & {
+    readonly typename: string;
+    readonly version: string;
+};
 /**
- * Relation schema.
+ * Type that represents any ECHO object schema.
+ * Accepts both static schemas (Type.object()) and mutable schemas (EchoSchema).
+ */
+export type AnyObj = ObjectSchemaBase;
+/**
+ * Factory function to create an ECHO object schema.
+ * Adds object metadata annotations to an Effect schema.
+ *
+ * @example
+ * ```ts
+ * const Person = Schema.Struct({
+ *   name: Schema.String,
+ * }).pipe(Type.object({ typename: 'com.example.type.person', version: '0.1.0' }));
+ * ```
  */
-export declare const Relation: {
-    <Source extends Schema$.Schema.AnyNoContext, Target extends Schema$.Schema.AnyNoContext>(opts: EchoRelationSchemaOptions<Source, Target>): <Self extends Schema$.Schema.Any>(self: Self) => relation<Self, Source, Target>;
+export declare const object: {
+    (opts: internal.TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => Obj<Schema.Schema.Type<Self>>;
 };
+export declare const PersistentType: Obj<typeInternal.PersistentSchema>;
+export interface PersistentType extends Schema.Schema.Type<typeof PersistentType> {
+}
 /**
- * Relation schema type definitions.
+ * TypeScript type for an ECHO relation schema.
+ * `T` is the instance type produced by the schema (excluding source/target).
+ * `Source` and `Target` are the endpoint types.
+ * `Fields` is the optional struct fields type for introspection.
  */
-export declare namespace Relation {
-    /**
-     * Type that represents an arbitrary schema type of a relation.
-     * NOTE: This is not an instance type.
-     */
-    type Any = Schema$.Schema.AnyNoContext;
+export interface Relation<T, Source, Target, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> extends internal.TypeMeta, EchoSchemaKind<internal.EntityKind.Relation>, Schema.AnnotableClass<Relation<T, Source, Target, Fields>, Entity.OfKind<typeof Entity.Kind.Relation> & RelationModule.Endpoints<Source, Target> & T, Schema.Simplify<RelationModule.BaseRelationJson & ToMutable<T>>, never> {
     /**
-     * Get relation source type.
+     * The fields defined in the original struct schema.
+     * Allows accessing field definitions for introspection.
      */
-    type Source<A> = A extends Relation.Endpoints<infer S, infer _T> ? S : never;
-    /**
-     * Get relation target type.
-     */
-    type Target<A> = A extends Relation.Endpoints<infer _S, infer T> ? T : never;
-    type Endpoints<Source, Target> = {
-        [Relation$.Source]: Source;
-        [Relation$.Target]: Target;
-    };
+    readonly fields: Fields;
 }
 /**
- * Return type of the `Ref` schema constructor.
+ * Structural base type for any ECHO relation schema.
+ * Accepts static schemas (created with Type.relation()).
+ * NOTE: Does not include the brand symbol to avoid TS4053 declaration portability issues.
+ * Use Type.isRelationSchema() for runtime type guards.
+ */
+type RelationSchemaBase = Schema.Schema.AnyNoContext & {
+    readonly typename: string;
+    readonly version: string;
+};
+/**
+ * Type that represents any ECHO relation schema.
+ * Accepts static schemas (Type.relation()).
+ */
+export type AnyRelation = RelationSchemaBase;
+/**
+ * Factory function to create an ECHO relation schema.
+ * Adds relation metadata annotations to an Effect schema.
  *
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
- * See Effect's note on interface types.
+ * @example
+ * ```ts
+ * const WorksFor = Schema.Struct({
+ *   role: Schema.String,
+ * }).pipe(Type.relation({
+ *   typename: 'com.example.type.works-for',
+ *   version: '0.1.0',
+ *   source: Person,
+ *   target: Company,
+ * }));
+ * ```
  */
-export interface ref<TargetSchema extends Schema$.Schema.Any> extends RefSchema<Schema$.Schema.Type<TargetSchema>> {
-}
+export declare const relation: {
+    <SourceSchema extends Schema.Schema.AnyNoContext, TargetSchema extends Schema.Schema.AnyNoContext>(opts: internal.EchoRelationSchemaOptions<SourceSchema, TargetSchema>): <Self extends Schema.Schema.Any>(self: Self) => Relation<Schema.Schema.Type<Self>, Schema.Schema.Type<SourceSchema>, Schema.Schema.Type<TargetSchema>>;
+};
 /**
- * Ref schema.
+ * Type alias for any ECHO entity schema (object or relation).
+ * Use this in type annotations for schema parameters.
  */
-export declare const Ref: RefFn;
-export interface Ref<T> extends Schema$.SchemaClass<Ref$<T>, EncodedReference> {
-}
-export declare namespace Ref {
-    /**
-     * Type that represents an arbitrary schema type of a reference.
-     * NOTE: This is not an instance type.
-     */
-    type Any = Schema$.Schema<Ref$<any>, EncodedReference>;
-}
+export type AnyEntity = AnyObj | AnyRelation;
+/**
+ * Type guard to check if a schema is an object schema.
+ * NOTE: This checks SCHEMAS, not instances. Use Obj.isObject for instances.
+ */
+export declare const isObjectSchema: (schema: AnyEntity) => schema is AnyObj;
+/**
+ * Type guard to check if a schema is a relation schema.
+ * NOTE: This checks SCHEMAS, not instances. Use Relation.isRelation for instances.
+ */
+export declare const isRelationSchema: (schema: AnyEntity) => schema is AnyRelation;
+/**
+ * Type that represents any Ref schema (with unknown target type).
+ * This is a schema type, not an instance type.
+ */
+export type AnyRef = Schema.Schema<internal.Ref<any>, EncodedReference>;
 /**
  * Gets the full DXN of the schema.
  * Will include the version if it's a `type` DXN.
- * @example "dxn:example.com/type/Person:0.1.0"
+ * @example "dxn:com.example.type.person:0.1.0"
  * @example "dxn:echo:SSSSSSSSSS:XXXXXXXXXXXXX"
  */
-export declare const getDXN: (schema: Entity.Any) => DXN | undefined;
+export declare const getDXN: (schema: AnyEntity) => DXN | undefined;
 /**
  * @param schema - Schema to get the typename from.
- * @returns The typename of the schema. Example: `example.com/type/Person`.
+ * @returns The typename of the schema. Example: `com.example.type.person`.
  */
-export declare const getTypename: (schema: Entity.Any) => string;
+export declare const getTypename: (schema: AnyEntity) => string;
 /**
  * Gets the version of the schema.
  * @example 0.1.0
  */
-export declare const getVersion: (schema: Entity.Any) => string;
+export declare const getVersion: (schema: AnyEntity) => string;
 /**
  * @returns True if the schema is mutable.
  */
-export declare const isMutable: (schema: Schema$.Schema.AnyNoContext) => schema is EchoSchema;
+export declare const isMutable: (schema: Schema.Schema.AnyNoContext) => schema is internal.EchoSchema;
 /**
  * ECHO type metadata.
  */
-export type Meta = TypeAnnotation;
+export type Meta = internal.TypeAnnotation;
 /**
  * Gets the meta data of the schema.
  */
-export declare const getMeta: (schema: Entity.Any) => Meta | undefined;
+export declare const getMeta: (schema: AnyEntity) => Meta | undefined;
+export {};
 //# sourceMappingURL=Type.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,OAAO,MAAM,eAAe,CAAC;AAE9C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,KAAK,OAAO,MAAM,UAAU,CAAC;AACzC,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAGzB,KAAK,yBAAyB,EAC9B,UAAU,EACV,OAAO,IAAI,QAAQ,EACnB,KAAK,cAAc,EACnB,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,GAAG,IAAI,IAAI,EACX,KAAK,KAAK,EACV,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,QAAQ,EAMb,cAAc,EACd,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,KAAK,SAAS,MAAM,YAAY,CAAC;AAG7C,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;AAMvG,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,KAAY,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;CAC1C;AAMD,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,IAAI,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,CAClD,SAAQ,QAAQ,EACd,OAAO,CAAC,cAAc,CACpB,GAAG,CAAC,IAAI,CAAC,EACT,OAAO,CAAC,MAAM,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EACjF,OAAO,CAAC,QAAQ,CAAC,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EACxE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC7B;CAAG;AAER;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,IAAI,EAAE,QAAQ,GAAG,CAAC,IAAI,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;CACpD,CAAC;AAE5B;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B;;;OAGG;IAGH,KAAY,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;CACpD;AAMD,eAAO,MAAM,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAmB,CAAC;AACtF,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;AAMpE,eAAO,MAAM,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAA2B,CAAC;AACtH,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC,CAAC;AAE5F,OAAO,EAAE,UAAU,IAAI,WAAW,EAAE,CAAC;AAMrC,UAAU,iBAAiB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC/B,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CACvB,IAAI,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,EAC/B,YAAY,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,EACvC,YAAY,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,CACvC,SAAQ,QAAQ,EACd,OAAO,CAAC,cAAc,CACpB,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,EAC1C,OAAO,CAAC,MAAM,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAC1C,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GACxF,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAC7E,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC7B;CAAG;AAER;;GAEG;AAGH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,MAAM,SAAS,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,SAAS,OAAO,CAAC,MAAM,CAAC,YAAY,EACrF,IAAI,EAAE,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9C,CAAC,IAAI,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACxD,CAAC;AAE9B;;GAEG;AACH,yBAAiB,QAAQ,CAAC;IACxB;;;OAGG;IAEH,KAAY,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;IAE9C;;OAEG;IACH,KAAY,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAEpF;;OAEG;IACH,KAAY,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAEpF,KAAY,SAAS,CAAC,MAAM,EAAE,MAAM,IAAI;QACtC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAC3B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH;AAOD;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,YAAY,SAAS,OAAO,CAAC,MAAM,CAAC,GAAG,CAAE,SAAQ,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;CAAG;AAErH;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,KAAY,CAAC;AAE/B,MAAM,WAAW,GAAG,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC;CAAG;AAEjF,yBAAiB,GAAG,CAAC;IACnB;;;OAGG;IACH,KAAY,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC;CAC/D;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,MAAM,CAAC,GAAG,KAAG,GAAG,GAAG,SAEjD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,CAAC,GAAG,KAAG,MAIhD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,CAAC,GAAG,KAAG,MAI/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,+DAAa,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,cAAc,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,MAAM,CAAC,GAAG,KAAG,IAAI,GAAG,SAEnD,CAAC"}
+{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,KAAK,SAAS,MAAM,OAAO,CAAC;AACxC,OAAO,KAAK,KAAK,cAAc,MAAM,YAAY,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,4BAA0B,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,UAAU,CAAC;AAMlD;;;GAGG;AACH,KAAK,cAAc,CAAC,CAAC,SAAS,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,IAAI;IACzE,QAAQ,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;CACrC,CAAC;AAMF;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,GAAG,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAChF,SACE,QAAQ,CAAC,QAAQ,EACjB,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAC1C,MAAM,CAAC,cAAc,CACnB,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,EACd,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAC5C,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,EACrD,KAAK,CACN;IACH;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,KAAK,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG;IACnD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,gBAAgB,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,GAAG,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;CACvE,CAAC;AAMrC,eAAO,MAAM,cAAc,EAAE,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAwC,CAAC;AAEvG,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC;CAAG;AAEpF;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CACrG,SACE,QAAQ,CAAC,QAAQ,EACjB,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAC5C,MAAM,CAAC,cAAc,CACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACnC,MAAM,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,EACzF,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,EAC/D,KAAK,CACN;IACH;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,KAAK,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG;IACrD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,YAAY,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAC/F,IAAI,EAAE,QAAQ,CAAC,yBAAyB,CAAC,YAAY,EAAE,YAAY,CAAC,GACnE,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAChC,IAAI,EAAE,IAAI,KACP,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;CACxE,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,WAAW,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,SAAS,KAAG,MAAM,IAAI,MAE5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,SAAS,KAAG,MAAM,IAAI,WAE9D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC;AAMxE;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,SAAS,KAAG,GAAG,GAAG,SAEhD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,SAAS,KAAG,MAI/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,SAAS,KAAG,MAI9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,uEAAyB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,cAAc,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,SAAS,KAAG,IAAI,GAAG,SAElD,CAAC"}

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

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

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

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

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

@@ -0,0 +1,68 @@
+import * as Schema from 'effect/Schema';
+import { QueryAST } from '@dxos/echo-protocol';
+import { JsonPath } from '@dxos/effect';
+import * as internal from './internal';
+import * as Obj from './Obj';
+import * as Type from './Type';
+/**
+ * Stored field metadata (e.g., for UX).
+ */
+export declare const FieldSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    path: Schema.Schema<JsonPath, JsonPath, never>;
+    visible: Schema.optional<typeof Schema.Boolean>;
+    referencePath: Schema.optional<Schema.Schema<JsonPath, JsonPath, never>>;
+}>;
+export type FieldType = Schema.Schema.Type<typeof FieldSchema>;
+export declare const KeyValueProps: Schema.Record$<typeof Schema.String, typeof Schema.Any>;
+export declare const createFieldId: () => string;
+export declare const Projection: Schema.Struct<{
+    /**
+     * Optional schema override used to customize the underlying schema.
+     */
+    schema: Schema.optional<Schema.Schema<internal.JsonSchemaType, internal.JsonSchemaType, never>>;
+    /**
+     * UX metadata associated with displayed fields (in table, form, etc.)
+     */
+    fields: Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        path: Schema.Schema<JsonPath, JsonPath, never>;
+        visible: Schema.optional<typeof Schema.Boolean>;
+        referencePath: Schema.optional<Schema.Schema<JsonPath, JsonPath, never>>;
+    }>>;
+    /**
+     * The id for the field used to pivot the view.
+     * E.g., the field to use for kanban columns or the field to use for map coordinates.
+     */
+    pivotFieldId: Schema.optional<typeof Schema.String>;
+}>;
+export type Projection = Schema.Schema.Type<typeof Projection>;
+/**
+ * Views are generated or user-defined projections of a schema's properties.
+ * They are used to configure the visual representation of the data.
+ */
+declare const ViewSchema: Type.Obj<{
+    readonly query: {
+        readonly ast: QueryAST.QuerySelectClause | QueryAST.QueryFilterClause | QueryAST.QueryReferenceTraversalClause | QueryAST.QueryIncomingReferencesClause | QueryAST.QueryRelationClause | QueryAST.QueryRelationTraversalClause | QueryAST.QueryHierarchyTraversalClause | QueryAST.QueryUnionClause | QueryAST.QuerySetDifferenceClause | QueryAST.QueryOrderClause | QueryAST.QueryOptionsClause | QueryAST.QueryLimitClause | QueryAST.QueryFromClause;
+        readonly raw?: string | undefined;
+    };
+    readonly projection: {
+        readonly schema?: internal.JsonSchemaType | undefined;
+        readonly fields: readonly {
+            readonly id: string;
+            readonly path: JsonPath;
+            readonly visible?: boolean | undefined;
+            readonly referencePath?: JsonPath | undefined;
+        }[];
+        readonly pivotFieldId?: string | undefined;
+    };
+}, Schema.Struct.Fields>;
+export interface View extends Schema.Schema.Type<typeof ViewSchema> {
+}
+/**
+ * View instance type.
+ */
+export declare const View: Type.Obj<View>;
+export declare const make: (props: Partial<Obj.MakeProps<typeof View>>) => View;
+export {};
+//# sourceMappingURL=View.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"View.d.ts","sourceRoot":"","sources":["../../../src/View.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAKxC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;EAOtB,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,CAAC;AAE/D,eAAO,MAAM,aAAa,yDAA2D,CAAC;AAEtF,eAAO,MAAM,aAAa,cAAsC,CAAC;AAEjE,eAAO,MAAM,UAAU;IACrB;;OAEG;;IAGH;;OAEG;;;;;;;IAIH;;;OAGG;;EAEH,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D;;;GAGG;AACH,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;wBAwBf,CAAC;AAEF,MAAM,WAAW,IAAK,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC;CAAG;AAEtE;;GAEG;AAMH,eAAO,MAAM,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,CAAC;AAEtD,eAAO,MAAM,IAAI,GAAI,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,CAAC,CAAC,KAAG,IAMjE,CAAC"}

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

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

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

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

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

@@ -1,15 +1,26 @@
+export { QueryAST } from '@dxos/echo-protocol';
 export { DXN } from '@dxos/keys';
-export * from './errors';
-export * from './query';
 export * as Annotation from './Annotation';
 export * as Database from './Database';
 export * as Entity from './Entity';
+export * as Err from './Err';
+export * as Feed from './Feed';
+export * as Filter from './Filter';
 export * as Format from './Format';
+export * as Hypergraph from './Hypergraph';
 export * as JsonSchema from './JsonSchema';
 export * as Key from './Key';
 export * as Obj from './Obj';
+export * as Order from './Order';
+export * as Query from './Query';
+export * as QueryResult from './QueryResult';
 export * as Ref from './Ref';
 export * as Relation from './Relation';
+export * as SchemaRegistry from './SchemaRegistry';
 export * as Tag from './Tag';
 export * as Type from './Type';
+export * as Collection from './Collection';
+export * as View from './View';
+export * as Dataset from './Dataset';
+export * as Extension from './Extension';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,cAAc,UAAU,CAAC;AAGzB,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC"}

package/dist/types/src/internal/{annotations → Annotation}/annotations.d.ts

@@ -1,9 +1,10 @@
 import * as Schema from 'effect/Schema';
 import * as SchemaAST from 'effect/SchemaAST';
-import { Reference } from '@dxos/echo-protocol';
 import { DXN } from '@dxos/keys';
 import { type Primitive } from '@dxos/util';
-import { EntityKind } from '../types';
+import { type Mutable } from '../common/proxy';
+import { type AnyProperties, EntityKind } from '../common/types';
+import { type AnnotationHelper } from './util';
 /**
  * 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.
@@ -15,9 +16,21 @@ export declare const FieldPath: (path: string) => <A, I, R>(self: Schema.Schema<
  */
 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/Person`
+ * Example: `org.dxos.type.message`
  */
 export declare const TypenameSchema: Schema.refine<string, typeof Schema.String>;
 /**
@@ -91,7 +104,7 @@ export declare const getPropertyMetaAnnotation: <T>(prop: SchemaAST.PropertySign
  */
 export declare const ReferenceAnnotationId: unique symbol;
 export type ReferenceAnnotationValue = TypeAnnotation;
-export declare const getReferenceAnnotation: (schema: Schema.Schema.AnyNoContext) => TypeAnnotation | undefined;
+export declare const ReferenceAnnotation: AnnotationHelper<TypeAnnotation>;
 /**
  * SchemaMeta.
  */
@@ -103,41 +116,46 @@ export type SchemaMeta = TypeMeta & {
  * 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>;
+export declare const SystemTypeAnnotation: 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[]>;
+export declare const LabelAnnotation: AnnotationHelper<string[]>;
 /**
  * Returns the label for a given object based on {@link LabelAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
+ * Skips empty strings and whitespace-only strings, continuing to the next field.
  */
-export declare const getLabel: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>) => string | undefined;
+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 setLabel: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, label: string) => void;
+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>;
+export declare const DescriptionAnnotation: AnnotationHelper<string>;
 /**
- * Returns the label for a given object based on {@link LabelAnnotationId}.
+ * Returns the description for a given object based on {@link DescriptionAnnotationId}.
+ * Lower-level version that requires explicit schema parameter.
  */
-export declare const getDescription: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>) => string | undefined;
+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 setDescription: <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, description: string) => void;
+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>;
+export declare const FormInputAnnotation: AnnotationHelper<boolean>;
 /**
  * Default field to be used on referenced schema to lookup the value.
  */
@@ -151,24 +169,63 @@ export type GeneratorAnnotationValue = string | {
     args?: any[];
     probability?: number;
 };
-export declare const GeneratorAnnotation: import("./util").AnnotationHelper<GeneratorAnnotationValue>;
+export declare const GeneratorAnnotation: AnnotationHelper<GeneratorAnnotationValue>;
+interface MakeAnnoationsProps<T> {
+    id: string;
+    schema: Schema.Schema<T, any, never>;
+}
+export declare const makeUserAnnotation: <T>(props: MakeAnnoationsProps<T>) => AnnotationHelper<T>;
+declare const IconAnnotationSchema: Schema.Struct<{
+    /**
+     * Phosphor icon name (e.g., 'ph--user--regular', 'ph--cube--regular', 'ph--link--regular ', etc.)
+     */
+    icon: Schema.filter<typeof Schema.String>;
+    /**
+     * Color name.
+     *
+     * List of colors:
+     *  - 'red'
+     *  - 'orange'
+     *  - 'amber'
+     *  - 'yellow'
+     *  - 'lime'
+     *  - 'green'
+     *  - 'emerald'
+     *  - 'teal'
+     *  - 'cyan'
+     *  - 'violet'
+     *  - 'purple'
+     *  - 'fuchsia'
+     *  - 'pink'
+     *  - 'rose'
+     */
+    hue: Schema.optional<typeof Schema.String>;
+}>;
+export interface IconAnnotation extends Schema.Schema.Type<typeof IconAnnotationSchema> {
+}
 /**
- * @returns DXN of the schema.
- *
- * For non-stored schema returns `dxn:type:`.
- * For stored schema returns `dxn:echo:`.
+ * Icon to render in the UI.
  */
-export declare const getSchemaDXN: (schema: Schema.Schema.All) => DXN | undefined;
+export declare const IconAnnotation: AnnotationHelper<IconAnnotation>;
 /**
- * Returns a reference that will be used to point to a schema.
- * @deprecated Use {@link getSchemaDXN} instead.
+ * Get the label of an entity.
+ * Accepts both reactive entities and snapshots.
  */
-export declare const getTypeReference: (schema: Schema.Schema.All | undefined) => Reference | undefined;
+export declare const getLabel: (entity: AnyProperties) => string | undefined;
 /**
- * Returns a reference that will be used to point to a schema.
- * @throws If it is not possible to reference this schema.
- *
- * @deprecated Use {@link getSchemaDXN} instead.
+ * 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 requireTypeReference: (schema: Schema.Schema.AnyNoContext) => Reference;
+export declare const setDescription: (entity: Mutable<AnyProperties>, description: string) => void;
+export {};
 //# sourceMappingURL=annotations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../../../../src/internal/Annotation/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,EAAE,KAAK,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,KAAK,aAAa,EAAE,UAAU,EAAqB,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,KAAK,gBAAgB,EAA0B,MAAM,QAAQ,CAAC;AAOvE;;;GAGG;AAEH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,MAoQ5B,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,AApQY,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;AAIH,eAAO,MAAM,cAAc,6CAKzB,CAAC;AAEH;;;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,kCAA0E,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,2BAA0D,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,iBAAiB,eAA8C,CAAC;AAC7E,eAAO,MAAM,eAAe,4BAAsD,CAAC;AAEnF;;;;GAIG;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,SA8BX,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,0BAA0D,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,2BAAyD,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,4CAA0E,CAAC;AAE3G,UAAU,mBAAmB,CAAC,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;CACtC;AAGD,eAAO,MAAM,kBAAkB,GAAI,CAAC,EAAE,OAAO,mBAAmB,CAAC,CAAC,CAAC,KAAG,gBAAgB,CAAC,CAAC,CAmBvF,CAAC;AAEF,QAAA,MAAM,oBAAoB;IACxB;;OAEG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;EAGH,CAAC;AAEH,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC;CAAG;AAE1F;;GAEG;AACH,eAAO,MAAM,cAAc,kCAGzB,CAAC;AAEH;;;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/Annotation/annotations.test.d.ts.map

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

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

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

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

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