import * as Schema from 'effect/Schema';
import type { ForeignKey } from '@dxos/echo-protocol';
import type { EntityId, URI } from '@dxos/keys';
import * as internal from './internal';
import type * as Ref from './Ref';
import type * as Relation from './Relation';
import type * as Tag from './Tag';
import * as Type from './Type';
export declare const KindId: "~@dxos/echo/Kind";
export type KindId = typeof internal.KindId;
export declare const SnapshotKindId: "~@dxos/echo/SnapshotKind";
export type SnapshotKindId = typeof internal.SnapshotKindId;
export declare const Kind: typeof internal.EntityKind;
export type Kind = internal.EntityKind;
export declare const KindSchema: Schema.Enums<typeof internal.EntityKind>;
/**
 * Assigns a kind to an Object or Relation instance.
 * NOTE: Needed to make `isRelation` and `isObject` checks work.
 */
export interface OfKind<K extends Kind> {
    readonly [KindId]: K;
    readonly id: EntityId;
}
/**
 * Assigns a snapshot kind to an Object or Relation snapshot.
 */
export interface SnapshotOfKind<K extends Kind> {
    readonly [SnapshotKindId]: K;
    readonly id: EntityId;
}
/**
 * Obj or Relation with a specific set of properties.
 */
export type Entity<Props> = OfKind<Kind> & Props;
/**
 * Unknown Obj or Relation (reactive).
 */
export interface Unknown extends OfKind<Kind> {
}
/**
 * Effect Schema for any ECHO entity (object or relation).
 *
 * Kind-agnostic counterpart to `Obj.Unknown` / `Relation.Unknown` — validates
 * the structural shape (id + properties) without constraining `[KindId]`. Used
 * in operation input schemas that accept any entity flavour (e.g.
 * `Schema.Array(Entity.Unknown)`).
 *
 * The cast bridges the runtime structural schema to the branded `Unknown` type:
 * `[KindId]` is a symbol brand that can't be expressed in a runtime `Struct`,
 * so the entity guarantee is carried at the type level only (same approach as
 * `Obj.Unknown` / `Relation.Unknown`). Unlike those, this is kind-agnostic so it
 * isn't an `UnknownTypeSchema<_, K>` (there's no single `K`) and carries no
 * `TypeAnnotation`.
 */
export declare const Unknown: Schema.Schema<Unknown>;
/**
 * Snapshot of an Obj or Relation.
 * Branded with SnapshotKindId instead of KindId.
 */
export interface Snapshot extends SnapshotOfKind<Kind> {
}
/**
 * Object with arbitrary properties.
 *
 * NOTE: Due to how typescript works, this type is not assignable to a specific schema type.
 * In that case, use `Obj.instanceOf` to check if an object is of a specific type.
 *
 * This type is very permissive and allows accessing any property on the object.
 * We should move to Obj.Unknown that is not permissive and requires explicit instanceof checks..
 */
export interface Any extends OfKind<Kind> {
    [key: string]: unknown;
}
/**
 * Returns all properties of an object or relation except for the id and kind.
 */
export type Properties<T> = Omit<T, 'id' | KindId | Relation.Source | Relation.Target>;
/**
 * Check if a value is an ECHO entity (object or relation).
 * Returns `false` for snapshots.
 */
export declare const isEntity: (value: unknown) => value is Unknown;
/**
 * Test if a value is an instance of a given object or relation type.
 *
 * Kind-agnostic counterpart to `Obj.instanceOf` / `Relation.instanceOf` —
 * use this when the caller's input type is `Type.AnyObj | Type.AnyRelation`.
 *
 * @example
 * ```ts
 * // Caller doesn't know whether `type` is object- or relation-kind.
 * const matches = <T extends Type.AnyObj | Type.AnyRelation>(type: T, value: unknown) =>
 *   Entity.instanceOf(type, value);
 * ```
 */
export declare const instanceOf: {
    <S extends Type.AnyEntity>(schema: S): (value: unknown) => value is Type.InstanceType<S>;
    <S extends Type.AnyEntity>(schema: S, value: unknown): value is Type.InstanceType<S>;
};
/**
 * Check if a value is an ECHO entity snapshot.
 * Returns `false` for entities.
 */
export declare const isSnapshot: (value: unknown) => value is Snapshot;
export declare const getKind: (schema: Schema.Schema.All) => internal.EntityKind | undefined;
/**
 * Property that accesses metadata for an entity.
 */
export declare const Meta: unique symbol;
/**
 * Property that accesses metadata for an entity.
 */
export type Meta = typeof Meta;
/**
 * JSON representation of an entity.
 */
export type JSON = internal.ObjectJSON;
/**
 * Any value the read accessors operate on: a reactive entity or a snapshot.
 * Type entities (`Type.AnyEntity`) are also accepted — they're first-class
 * entities, and `Unknown`'s kind-agnostic brand already subsumes them.
 */
export type AnyInput = Unknown | Snapshot;
/**
 * Get the canonical URI of an entity (object, relation, or type). Returns `URI.URI` —
 * an `EID` for object/relation instances and persisted types, or a typename
 * `DXN` for static type entities; narrow with `EID.parse(uri)` or
 * `DXN.tryMake(uri)` at the point of use.
 *
 * @param options.prefer - Controls the URI form (see {@link internal.GetURIOptions}).
 */
export declare const getURI: (entity: AnyInput, options?: internal.GetURIOptions) => URI.URI;
/**
 * Get the DXN of an entity's type. For object/relation instances this is the URI
 * of the type they were created from; for a type entity it is the URI of the
 * meta-type ({@link Type.Type}, `dxn:org.dxos.type.schema:0.1.0`).
 */
export declare const getTypeURI: (entity: AnyInput) => URI.URI | undefined;
/**
 * Get the type entity (`Type.AnyEntity`) the instance was created from.
 *
 * Returns `undefined` when the entity's type isn't registered in this runtime
 * (e.g. a freshly deserialized snapshot whose type entity hasn't been wired
 * up yet, or an entity loaded from storage before its schema is known). To
 * get the Effect Schema from the returned entity, use `Type.getSchema(...)`.
 *
 * For a type entity, returns the meta-type {@link Type.Type} (a type entity's
 * type is "Type").
 */
export declare const getType: (entity: AnyInput) => Type.AnyEntity | undefined;
/**
 * Get the typename of an entity's type. For object/relation instances this is the
 * typename of the type they were created from; for a type entity it is the type's
 * own typename (e.g. `com.example.type.person`).
 */
export declare const getTypename: (entity: AnyInput) => string | undefined;
/**
 * Get the database an entity belongs to.
 */
export declare const getDatabase: (entity: Unknown | Snapshot) => any | undefined;
/**
 * Get the metadata for an entity.
 * Returns mutable meta when passed a mutable entity (inside change callback).
 * Returns read-only meta when passed a regular entity or snapshot.
 */
export declare function getMeta(entity: Mutable<Unknown>): internal.EntityMeta;
export declare function getMeta(entity: Unknown | Snapshot): internal.ReadonlyMeta;
/**
 * Get foreign keys for an entity from the specified source.
 */
export declare const getKeys: (entity: Unknown | Snapshot, source: string) => ForeignKey[];
/**
 * Check if an entity is deleted.
 */
export declare const isDeleted: (entity: Unknown | Snapshot) => boolean;
/**
 * Get the label of an entity.
 *
 * @param options.fallback `'typename'` returns the entity's typename when no
 *   label is set (e.g. `org.dxos.type.table`).
 */
export declare const getLabel: (entity: Unknown | Snapshot, options?: internal.GetLabelOptions) => string | undefined;
/**
 * Set the label of an entity.
 * Must be called within an `Entity.update` / `Obj.update` / `Relation.update` callback.
 */
export declare const setLabel: (entity: Mutable<Unknown>, label: string) => void;
/**
 * Get the description of an entity.
 */
export declare const getDescription: (entity: Unknown | Snapshot) => string | undefined;
/**
 * Get the icon annotation for an entity (object or relation), resolved via its type-level
 * `IconAnnotation`. Returns the full `{ icon, hue }` annotation so callers can use both
 * the phosphor icon name and the suggested colour.
 */
export declare const getIcon: (entity: Unknown | Snapshot) => internal.IconAnnotation | undefined;
/**
 * Convert an entity to its JSON representation.
 */
export declare const toJSON: (entity: Unknown | Snapshot) => JSON;
/**
 * Subscribe to changes on an entity (object or relation).
 * @returns Unsubscribe function.
 */
export declare const subscribe: (entity: Unknown, callback: () => void) => (() => void);
/**
 * Used to provide a mutable view of an entity within `Entity.update`.
 */
export type Mutable<T> = internal.Mutable<T>;
/**
 * Perform mutations on an entity (object or relation) within a change context.
 *
 * Entities are read-only by default. Mutations are batched and notifications fire
 * when the callback completes. Direct mutations outside of `Entity.update` will throw
 * at runtime.
 *
 * @param entity - The echo entity (object or relation) to mutate.
 * @param callback - Receives a mutable view of the entity. All mutations must occur here.
 *
 * @example
 * ```typescript
 * // Mutate within Entity.update
 * Entity.update(entity, (obj) => {
 *   obj.name = 'Updated';
 *   obj.count = 42;
 * });
 *
 * // Direct mutation throws
 * entity.name = 'Bob'; // Error: Cannot modify outside Entity.update()
 * ```
 *
 * Note: For type-specific operations, prefer `Obj.update` or `Relation.update`.
 */
export declare const update: <T extends Unknown>(entity: T, callback: internal.ChangeCallback<T>) => void;
/**
 * Add a tag to an entity.
 * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
 */
export declare const addTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
/**
 * Remove a tag from an entity.
 * Must be called within an `Entity.update`, `Obj.update`, or `Relation.update` callback.
 */
export declare const removeTag: (entity: Mutable<Unknown>, tag: Ref.Ref<Tag.Tag>) => void;
export declare const atom: <T extends Unknown>(entity: T) => import("@effect-atom/atom/Atom").Atom<Snapshot>;
//# sourceMappingURL=Entity.d.ts.map