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

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

@@ -1,152 +1,175 @@
-import type * as EffectSchema from 'effect/Schema';
+import type * as Schema from 'effect/Schema';
 import { type EncodedReference } from '@dxos/echo-protocol';
-import type * as Keys from '@dxos/keys';
-import { type ToMutable } from './internal';
-import * as EchoSchema from './internal';
+import { type DXN } from '@dxos/keys';
+import { type ToMutable } from '@dxos/util';
+import type * as EntityModule from './Entity';
+import * as internal from './internal';
+import type * as ObjModule from './Obj';
 import type * as RelationModule from './Relation';
-export declare const KindId: unique symbol;
-export type KindId = typeof KindId;
-export declare const Kind: typeof EchoSchema.EntityKind;
 /**
- * Assigns a kind to an Object or Relation instance.
+ * Dynamic type that can be constructed, mutated, and persisted in the ECHO database.
  */
-export interface OfKind<Kind extends EchoSchema.EntityKind> {
-    readonly id: Keys.ObjectId;
-    readonly [KindId]: Kind;
-}
+export declare const RuntimeType: typeof internal.EchoSchema;
 /**
- * Base ECHO schema type.
+ * Dynamic type that can be constructed, mutated, and persisted in the ECHO database.
  */
-export type Schema = EchoSchema.EchoSchema;
+export type RuntimeType = internal.EchoSchema;
 /**
- * Returns all properties of an object or relation except for the id and kind.
+ * Type that marks a schema as an ECHO schema.
+ * The value indicates the entity kind (Object or Relation).
  */
-export type Properties<T = any> = Omit<T, 'id' | KindId | RelationModule.Source | RelationModule.Target>;
-interface ObjJsonProps {
-    id: string;
-}
+type EchoSchemaKind<K extends internal.EntityKind = internal.EntityKind> = {
+    readonly [internal.SchemaKindId]: K;
+};
 /**
- * Return type of the `Obj` schema constructor.
+ * 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.
  *
- * This typedef avoids `TS4023` error (name from external module cannot be used named).
- * See Effect's note on interface types.
+ * @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 interface obj<Self extends EffectSchema.Schema.Any> extends EchoSchema.TypeMeta, EffectSchema.AnnotableClass<obj<Self>, OfKind<EchoSchema.EntityKind.Object> & ToMutable<EffectSchema.Schema.Type<Self>>, EffectSchema.Simplify<ObjJsonProps & ToMutable<EffectSchema.Schema.Encoded<Self>>>, EffectSchema.Schema.Context<Self>> {
+export interface Obj<T, Fields extends Schema.Struct.Fields = Schema.Struct.Fields> extends internal.TypeMeta, EchoSchemaKind<internal.EntityKind.Object>, Schema.AnnotableClass<Obj<T, Fields>, EntityModule.OfKind<typeof EntityModule.Kind.Object> & T, Schema.Simplify<ObjModule.BaseObjJson & ToMutable<T>>, never> {
+    /**
+     * The fields defined in the original struct schema.
+     * Allows accessing field definitions for introspection.
+     */
+    readonly fields: Fields;
 }
 /**
- * Object schema.
+ * 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 declare const Obj: {
-    (opts: EchoSchema.TypeMeta): <Self extends EffectSchema.Schema.Any>(self: Self) => obj<Self>;
+type ObjectSchemaBase = Schema.Schema.AnyNoContext & {
+    readonly typename: string;
+    readonly version: string;
 };
 /**
- * Object schema type definitions.
+ * Type that represents any ECHO object schema.
+ * Accepts both static schemas (Type.object()) and mutable schemas (EchoSchema).
  */
-export declare namespace Obj {
-    /**
-     * Type that represents an arbitrary schema type of an object.
-     * NOTE: This is not an instance type.
-     */
-    type Any = EffectSchema.Schema.AnyNoContext;
-}
-export interface Expando extends OfKind<EchoSchema.EntityKind.Object> {
-    [key: string]: any;
-}
-type ExpandoEncoded = EffectSchema.Simplify<ObjJsonProps & {
-    [key: string]: any;
-}>;
-export declare const Expando: EffectSchema.Schema<Expando, ExpandoEncoded, never>;
-interface RelationJsonProps {
-    id: string;
-    [EchoSchema.ATTR_RELATION_SOURCE]: string;
-    [EchoSchema.ATTR_RELATION_TARGET]: string;
-}
+export type AnyObj = ObjectSchemaBase;
 /**
- * Return type of the `Relation` schema constructor.
+ * Factory function to create an ECHO object schema.
+ * Adds object 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 Person = Schema.Struct({
+ *   name: Schema.String,
+ * }).pipe(Type.object({ typename: 'example.com/type/Person', version: '0.1.0' }));
+ * ```
+ */
+export declare const object: {
+    (opts: internal.TypeMeta): <Self extends Schema.Schema.Any>(self: Self) => Obj<Schema.Schema.Type<Self>>;
+};
+export declare const PersistentType: Obj<internal.PersistentSchema>;
+export interface PersistentType extends Schema.Schema.Type<typeof PersistentType> {
+}
+/**
+ * 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 interface relation<Self extends EffectSchema.Schema.Any, SourceSchema extends EffectSchema.Schema.Any, TargetSchema extends EffectSchema.Schema.Any> extends EchoSchema.TypeMeta, EffectSchema.AnnotableClass<relation<Self, SourceSchema, TargetSchema>, OfKind<EchoSchema.EntityKind.Relation> & Relation.Endpoints<EffectSchema.Schema.Type<SourceSchema>, EffectSchema.Schema.Type<TargetSchema>> & ToMutable<EffectSchema.Schema.Type<Self>>, EffectSchema.Simplify<RelationJsonProps & ToMutable<EffectSchema.Schema.Encoded<Self>>>, EffectSchema.Schema.Context<Self>> {
+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>, EntityModule.OfKind<typeof EntityModule.Kind.Relation> & RelationModule.Endpoints<Source, Target> & T, Schema.Simplify<RelationModule.BaseRelationJson & ToMutable<T>>, never> {
+    /**
+     * The fields defined in the original struct schema.
+     * Allows accessing field definitions for introspection.
+     */
+    readonly fields: Fields;
 }
 /**
- * Relation schema.
+ * 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.
  */
-export declare const Relation: {
-    <Source extends EffectSchema.Schema.AnyNoContext, Target extends EffectSchema.Schema.AnyNoContext>(opts: EchoSchema.EchoRelationOptions<Source, Target>): <Self extends EffectSchema.Schema.Any>(self: Self) => relation<Self, Source, Target>;
+type RelationSchemaBase = Schema.Schema.AnyNoContext & {
+    readonly typename: string;
+    readonly version: string;
 };
 /**
- * Relation schema type definitions.
+ * Type that represents any ECHO relation schema.
+ * Accepts static schemas (Type.relation()).
  */
-export declare namespace Relation {
-    /**
-     * Type that represents an arbitrary schema type of a relation.
-     * NOTE: This is not an instance type.
-     */
-    type Any = EffectSchema.Schema.AnyNoContext;
-    /**
-     * Get relation source type.
-     */
-    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> = {
-        [RelationModule.Source]: Source;
-        [RelationModule.Target]: Target;
-    };
-}
+export type AnyRelation = RelationSchemaBase;
 /**
- * Return type of the `Ref` schema constructor.
+ * 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: 'example.com/type/WorksFor',
+ *   version: '0.1.0',
+ *   source: Person,
+ *   target: Company,
+ * }));
+ * ```
+ */
+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>>;
+};
+/**
+ * Type alias for any ECHO entity schema (object or relation).
+ * Use this in type annotations for schema parameters.
  */
-export interface ref<TargetSchema extends EffectSchema.Schema.Any> extends EchoSchema.Ref$<EffectSchema.Schema.Type<TargetSchema>> {
-}
+export type AnyEntity = AnyObj | AnyRelation;
 /**
- * Ref schema.
+ * 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 Ref: <S extends Obj.Any>(schema: S) => ref<S>;
-export interface Ref<T> extends EffectSchema.SchemaClass<EchoSchema.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 = EffectSchema.Schema<EchoSchema.Ref<any>, EncodedReference>;
-}
+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:echo:SSSSSSSSSS:XXXXXXXXXXXXX"
  */
-export declare const getDXN: (schema: Obj.Any | Relation.Any) => Keys.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`.
  */
-export declare const getTypename: (schema: Obj.Any | Relation.Any) => string;
+export declare const getTypename: (schema: AnyEntity) => string;
 /**
  * Gets the version of the schema.
  * @example 0.1.0
  */
-export declare const getVersion: (schema: Obj.Any | Relation.Any) => string;
+export declare const getVersion: (schema: AnyEntity) => string;
 /**
  * @returns True if the schema is mutable.
  */
-export declare const isMutable: (schema: EffectSchema.Schema.AnyNoContext) => schema is EchoSchema.EchoSchema;
+export declare const isMutable: (schema: Schema.Schema.AnyNoContext) => schema is internal.EchoSchema;
 /**
  * ECHO type metadata.
  */
-export type Meta = EchoSchema.TypeAnnotation;
+export type Meta = internal.TypeAnnotation;
 /**
  * Gets the meta data of the schema.
  */
-export declare const getMeta: (schema: Obj.Any | Relation.Any) => Meta | undefined;
-export { SpaceId, ObjectId, DXN } from '@dxos/keys';
-export { Format, JsonSchemaType as JsonSchema, toEffectSchema, toJsonSchema } from './internal';
+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,YAAY,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AAExC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,KAAK,cAAc,MAAM,YAAY,CAAC;AAMlD,eAAO,MAAM,MAAM,EAAE,OAAO,MAAuC,CAAC;AACpE,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,eAAO,MAAM,IAAI,8BAAwB,CAAC;AAE1C;;GAEG;AAEH,MAAM,WAAW,MAAM,CAAC,IAAI,SAAS,UAAU,CAAC,UAAU;IACxD,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC;IAC3B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAMzG,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,IAAI,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,CACvD,SAAQ,UAAU,CAAC,QAAQ,EACzB,YAAY,CAAC,cAAc,CACzB,GAAG,CAAC,IAAI,CAAC,EACT,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAChF,YAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAClF,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAClC;CAAG;AAER;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,GAAG,CAAC,IAAI,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;CAC/D,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B;;;OAGG;IAGH,KAAY,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC;CACpD;AAOD,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;IACnE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,KAAK,cAAc,GAAG,YAAY,CAAC,QAAQ,CAAC,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC,CAAC;AAEnF,eAAO,MAAM,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAA6B,CAAC;AAMtG,UAAU,iBAAiB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC1C,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CACvB,IAAI,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,EACpC,YAAY,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,EAC5C,YAAY,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,CAC5C,SAAQ,UAAU,CAAC,QAAQ,EACzB,YAAY,CAAC,cAAc,CACzB,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,EAC1C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,GACpC,QAAQ,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAClG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAC3C,YAAY,CAAC,QAAQ,CAAC,iBAAiB,GAAG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EACvF,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAClC;CAAG;AAER;;GAEG;AAEH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,MAAM,SAAS,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,SAAS,YAAY,CAAC,MAAM,CAAC,YAAY,EAC/F,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,GACnD,CAAC,IAAI,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACxD,CAAC;AAEnC;;GAEG;AACH,yBAAiB,QAAQ,CAAC;IACxB;;;OAGG;IAEH,KAAY,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC;IAEnD;;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,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;CACH;AAMD;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,YAAY,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,CAC/D,SAAQ,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;CAAG;AAEpE;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAkB,CAAC;AAE5E,MAAM,WAAW,GAAG,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC;CAAG;AAGhG,yBAAiB,GAAG,CAAC;IACnB;;;OAGG;IACH,KAAY,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC;CAC9E;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,IAAI,CAAC,GAAG,GAAG,SAElE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAI5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAI3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,+EAAuB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,IAAI,GAAG,SAE/D,CAAC;AAGF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,cAAc,IAAI,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAIA,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,YAAY,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,SAAS,MAAM,OAAO,CAAC;AACxC,OAAO,KAAK,KAAK,cAAc,MAAM,YAAY,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,4BAAsB,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC;AAM9C;;;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,YAAY,CAAC,MAAM,CAAC,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EACxD,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,QAAQ,CAAC,gBAAgB,CAAoC,CAAC;AAE/F,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,YAAY,CAAC,MAAM,CAAC,OAAO,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,EACrG,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,uEAAqB,CAAC;AAE5C;;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":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC,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;;;;;;;;;;;;;;;wBAoBf,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,11 +1,25 @@
-export * from './errors';
-export * from './query';
+export { QueryAST } from '@dxos/echo-protocol';
+export { DXN } from '@dxos/keys';
+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 { QueryAST } from '@dxos/echo-protocol';
-export { DXN } from '@dxos/keys';
-export { type Live } from '@dxos/live-object';
+export * as Collection from './Collection';
+export * as View from './View';
+export * as Dataset from './Dataset';
 //# 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,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AAExB,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,IAAI,MAAM,QAAQ,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,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"}

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

@@ -0,0 +1,209 @@
+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';
+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.
+ */
+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: 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: 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: 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: 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: 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: 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> {
+}
+/**
+ * Icon to render in the UI.
+ */
+export declare const IconAnnotation: AnnotationHelper<IconAnnotation>;
+export {};
+//# sourceMappingURL=annotations.d.ts.map