@ai-matrx/entity-data 0.3.43 → 0.4.0

package/dist/realtime-DL-bfUFj.d.ts

@@ -1,244 +0,0 @@
-import * as _ai_matrx_realtime from '@ai-matrx/realtime';
-import { RealtimeManager, ChannelSpec } from '@ai-matrx/realtime';
-import { RecordsResult, Uuid as Uuid$1 } from '@ai-matrx/records';
-import { Lane, Uuid } from '@ai-matrx/records/data';
-
-/** A link as the door words it: `{token, id, label}`. */
-interface EntityWireRef {
-    token: string;
-    id: Uuid;
-    label: string | null;
-}
-/** One row exactly as `platform.entity_list_scoped` / `entity_get` answer it. */
-interface EntityWireRow {
-    id: Uuid;
-    version: number;
-    organization_id: Uuid;
-    /** The row's own organization's custom fields, already masked by the store (a hidden field is null). */
-    _custom?: Record<string, unknown>;
-    /** The token's own columns; link columns are `EntityWireRef[]`. */
-    [column: string]: unknown;
-}
-interface EntitySortApplied {
-    column: string;
-    dir: "asc" | "desc";
-    nulls: "first" | "last";
-}
-interface EntityListAnswer {
-    rows: EntityWireRow[];
-    /** null when not asked for. */
-    total: number | null;
-    /** The total stopped at the store's count cap; `total` is then a floor, not a count. */
-    total_is_capped: boolean;
-    page_size: number;
-    /** The keyset cursor of the next page; opaque. */
-    next_after: string | null;
-    has_more: boolean;
-    sort_applied: EntitySortApplied[];
-    /** Sort columns the door could not use (it keeps one key today). Said back, never hidden. */
-    sort_ignored: string[];
-    feed_cursor: null;
-}
-interface EntityGetAnswer {
-    rows: EntityWireRow[];
-    /** Ids that are not there or that this person cannot open. */
-    missing: Uuid[];
-    feed_cursor: null;
-}
-interface EntityColumnWire {
-    key: string;
-    label: string;
-    type: string;
-    origin: "platform" | "custom";
-    required: boolean;
-    readOnly: boolean;
-    linksTo?: string[];
-    choices?: string[];
-    /** Custom columns only. */
-    field_id?: Uuid;
-    organization?: string;
-    organization_id?: Uuid;
-}
-interface EntityColumnsAnswer {
-    label: string;
-    token: string;
-    columns: EntityColumnWire[];
-    can_create: boolean;
-    can_update: boolean;
-    /** The type's landing lane (`platform.entity_default_list_scope`). */
-    default_scope: Lane;
-}
-/** One filter predicate as the door reads it (CONTRACT §3.2). */
-interface EntityWirePredicate {
-    column: string;
-    op: string;
-    value?: unknown;
-    values?: unknown[];
-    negated?: boolean;
-}
-interface EntityWireSort {
-    column: string;
-    dir: "asc" | "desc";
-    nulls: "last";
-}
-interface EntityWireQuery {
-    /** Absent = the type's own landing lane. `organization_id` narrows any lane and never locks it. */
-    scope?: {
-        kind?: Lane;
-        organization_id?: Uuid;
-    };
-    filter?: {
-        all: EntityWirePredicate[];
-    };
-    search?: string;
-    sort?: EntityWireSort[];
-    pageSize?: number;
-}
-/** What every write door answers (`entity_insert` / `entity_update` / `entity_archive` / `entity_unarchive`). */
-interface EntityWriteAnswer {
-    status: string;
-    /** The rows as the read door now reads them, each with its NEW `version`. */
-    rows: EntityWireRow[];
-    validation: unknown[];
-    feed_cursor: null;
-    /** Archive and restore say what they did, in the store's words (trash words on these types). */
-    message?: string;
-}
-
-/**
- * THE ECHO HEADER (U6). The entity doors take no `_op_id` argument: the writer's op id rides the request
- * as this header, PostgREST hands it to `request.headers`, and `platform._entity_org_notice` puts it on
- * the notice as `op_id`, so the browser that wrote drops its own echo (`@ai-matrx/records` `isOwnOp`).
- */
-declare const OP_ID_HEADER = "x-matrx-op-id";
-/** What a write takes beyond its arguments: the op id minted for it (`mintOpId`). */
-interface EntityWriteOptions {
-    opId?: string;
-}
-/** The schema every entity door lives in. */
-declare const ENTITY_DOOR_SCHEMA = "platform";
-interface CreateEntityClientOptions {
-    /** A supabase-js v2 client for the signed-in person, or anything with `rpc(fn, args, {schema})`. */
-    dataSource?: unknown;
-    /** Same thing, spelled the way the plan names it. Give one of the two. */
-    supabase?: unknown;
-}
-interface EntityListRequest extends EntityWireQuery {
-    token: string;
-    /** Keyset cursor from the previous answer's `next_after`. */
-    after?: string | null;
-    /** Ask the door to skip the count. Default: counted. */
-    withTotal?: boolean;
-    archived?: "active" | "archived" | "all";
-}
-interface EntityClient {
-    list(request: EntityListRequest): Promise<RecordsResult<EntityListAnswer>>;
-    get(request: {
-        token: string;
-        ids: readonly Uuid$1[];
-    }): Promise<RecordsResult<EntityGetAnswer>>;
-    /** `organizationId` null reads the custom fields of every organization the person belongs to. */
-    columns(request: {
-        token: string;
-        organizationId?: Uuid$1 | null;
-    }): Promise<RecordsResult<EntityColumnsAnswer>>;
-    /** One `entity_data` knob as `platform.knob_resolve` answers it for an organization (live updates read three). */
-    knob(request: {
-        key: string;
-        organizationId?: Uuid$1 | null;
-    }): Promise<RecordsResult<unknown>>;
-    /** `platform.entity_insert`: rows into the organization the host names (never guessed). */
-    insert(request: {
-        token: string;
-        organizationId: Uuid$1;
-        rows: readonly Record<string, unknown>[];
-    } & EntityWriteOptions): Promise<RecordsResult<EntityWriteAnswer>>;
-    /** `platform.entity_update`: one row, refused as stale (`MX001`) unless `baseVersion` is still current. */
-    update(request: {
-        token: string;
-        id: Uuid$1;
-        baseVersion: number;
-        patch: Record<string, unknown>;
-    } & EntityWriteOptions): Promise<RecordsResult<EntityWriteAnswer>>;
-    /** `platform.entity_archive` (on these types, the trash). */
-    archive(request: {
-        token: string;
-        ids: readonly Uuid$1[];
-    } & EntityWriteOptions): Promise<RecordsResult<EntityWriteAnswer>>;
-    /** `platform.entity_unarchive`. */
-    unarchive(request: {
-        token: string;
-        ids: readonly Uuid$1[];
-    } & EntityWriteOptions): Promise<RecordsResult<EntityWriteAnswer>>;
-    /** The organizations the person belongs to, as row security counts them (`iam.my_orgs()`: archived ones closed). */
-    memberOrganizations(): Promise<RecordsResult<Uuid$1[]>>;
-}
-declare function createEntityClient(options: CreateEntityClientOptions): EntityClient;
-
-/** The topic is a CONTRACT WITH THE DATABASE (a trigger writes it, an RLS policy parses it): built once, here. */
-declare const entityOrgChannel: _ai_matrx_realtime.ChannelNamespace;
-/** The broadcast event the database sends on an organization topic. */
-declare const ENTITY_NOTICE_EVENT = "entity_bump";
-/** Starting values of the knobs the runtime coalesces with (entity_data.realtime_batch_ms / _max_wait_ms). */
-declare const DEFAULT_BATCH_MS = 150;
-declare const DEFAULT_MAX_WAIT_MS = 1000;
-/** Starting value of knob entity_data.realtime_max_org_topics. */
-declare const DEFAULT_MAX_ORG_TOPICS = 20;
-interface EntityNotice {
-    id?: string;
-    entity_type?: string;
-    organization_id?: string;
-    op?: "created" | "updated" | "deleted";
-    /** The client operation that caused it (header `x-matrx-op-id`), or null for any other writer. */
-    op_id?: string | null;
-    /** `null` MEANS "more changed than the database lists: re-read". */
-    ids?: string[] | null;
-    at?: string;
-}
-/** A redelivered notice is the same notice: the database mints one id per send. */
-declare function entityNoticeKey(notice: EntityNotice): string | undefined;
-declare function entityOrgTopic(organizationId: string, token: string): string;
-/** The channel spec for one (organization, token): private, echo-guarded, deduped, backfilled. */
-declare function entityOrgChannelSpec(organizationId: string, token: string, onNotice: (notice: EntityNotice) => void, onBackfill: () => void): ChannelSpec;
-/**
- * Which organization topics to join, in order, until `max`: the active organization, the alias's `org`
- * filter, then the organizations of held rows by number of held rows (descending; organization id
- * ascending on ties), then the person's remaining memberships by id. Only memberships are kept when they
- * are known — any other topic is refused by the database anyway. Deterministic for the same input.
- */
-declare function orderOrganizationTopics(input: {
-    active?: string | null;
-    filter?: string | null;
-    held?: ReadonlyMap<string, number>;
-    members?: readonly string[] | null;
-    max: number;
-}): string[];
-interface EntityNoticeSink {
-    /** `ids` to re-read, or `null` to re-read everything this reader shows. */
-    rows(ids: string[] | null): void;
-}
-interface EntityRealtime {
-    /** Hear `token` across `organizationIds`; the sink gets one coalesced call per burst. Returns the stop. */
-    subscribe(target: {
-        token: string;
-        organizationIds: readonly string[];
-    }, sink: EntityNoticeSink): () => void;
-}
-interface CreateEntityRealtimeOptions {
-    /** The host's realtime manager. Left out, the AMBIENT manager the app mounted — never a socket of our own. */
-    manager?: RealtimeManager;
-    /** Knob entity_data.realtime_batch_ms (starting value 150). */
-    batchMs?: number;
-    /** Knob entity_data.realtime_max_wait_ms (starting value 1000). */
-    maxWaitMs?: number;
-}
-/** The live-notice layer for platform lists, bound to a realtime manager. One per host is enough. */
-declare function createEntityRealtime(options?: CreateEntityRealtimeOptions): EntityRealtime;
-/** The three live-update knobs as the store answers them for an organization (starting values when unset). */
-declare function readEntityRealtimeKnobs(client: Pick<EntityClient, "knob">, organizationId?: string | null): Promise<{
-    batchMs: number;
-    maxWaitMs: number;
-    maxOrgTopics: number;
-}>;
-
-export { entityOrgTopic as A, orderOrganizationTopics as B, type CreateEntityClientOptions as C, DEFAULT_BATCH_MS as D, ENTITY_DOOR_SCHEMA as E, readEntityRealtimeKnobs as F, OP_ID_HEADER as O, type CreateEntityRealtimeOptions as a, DEFAULT_MAX_ORG_TOPICS as b, DEFAULT_MAX_WAIT_MS as c, ENTITY_NOTICE_EVENT as d, type EntityClient as e, type EntityColumnWire as f, type EntityColumnsAnswer as g, type EntityGetAnswer as h, type EntityListAnswer as i, type EntityListRequest as j, type EntityNotice as k, type EntityNoticeSink as l, type EntityRealtime as m, type EntitySortApplied as n, type EntityWirePredicate as o, type EntityWireQuery as p, type EntityWireRef as q, type EntityWireRow as r, type EntityWireSort as s, type EntityWriteAnswer as t, type EntityWriteOptions as u, createEntityClient as v, createEntityRealtime as w, entityNoticeKey as x, entityOrgChannel as y, entityOrgChannelSpec as z };