@ai-matrx/entity-data 0.3.43 → 0.4.0

package/dist/react/index.d.ts

@@ -1,235 +1 @@
-import * as _tanstack_react_query from '@tanstack/react-query';
-import * as react from 'react';
-import { ReactNode } from 'react';
-import { DataScope, DataRead, DataRows, DataMutations } from '@ai-matrx/records/data/react';
-export { DataMutations, DataRead, DataRows } from '@ai-matrx/records/data/react';
-import { Lane, Uuid, HostDataPort, Column, Query, Row } from '@ai-matrx/records/data';
-import { RecordsResult, Uuid as Uuid$1 } from '@ai-matrx/records';
-
-/** 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;
-}
-
-/** What a write takes beyond its arguments: the op id minted for it (`mintOpId`). */
-interface EntityWriteOptions {
-    opId?: string;
-}
-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[]>>;
-}
-
-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;
-}
-
-/** A type as the person may use it: its name and whether she may add or change rows (`entity_columns`' own answer). */
-interface EntityTypeFacts {
-    token: string;
-    label: string;
-    canCreate: boolean;
-    canUpdate: boolean;
-}
-/** The host's entity port: the DataPort, plus `describe` for a token-first screen that has no `sources()` entry. */
-interface EntityDataPort extends HostDataPort {
-    /** The type behind an alias, from the same one `entity_columns` read `columns()` uses. */
-    describe(alias: string): Promise<RecordsResult<EntityTypeFacts>>;
-}
-
-/** The cache prefix of the one entity port: `["@ai-matrx/records","data","entity-data",<token>,…]`. */
-declare const ENTITY_PORT_KEY = "entity-data";
-interface EntityDataProviderProps {
-    /** The supabase-js client carrying the signed-in person's session (or a records data seam). */
-    dataSource?: unknown;
-    /** … or an entity client already built. Give one of the two. */
-    client?: EntityClient;
-    /**
-     * Where a NEW row is saved and which organization's topic is joined first: the host's active
-     * organization, never guessed. `null` while none is chosen — `create` is then refused
-     * `organization_required` and nothing is sent. Lists never narrow by it.
-     */
-    activeOrganizationId: Uuid | null;
-    /**
-     * Live notices. Left out: the app's ambient realtime manager (`createEntityRealtime()`), never a socket
-     * of our own. `false`: not live (the console says so once).
-     */
-    realtime?: EntityRealtime | false;
-    /** A second, separate cache (tests, two seats on one page). Default `entity-data`. */
-    portKey?: string;
-    children?: ReactNode;
-}
-/** The engine's scope over the one entity port. */
-interface EntityScope extends DataScope {
-    port: EntityDataPort;
-}
-declare function EntityDataProvider({ dataSource, client, activeOrganizationId, realtime, portKey, children }: EntityDataProviderProps): react.FunctionComponentElement<react.ProviderProps<EntityScope | null>> | react.FunctionComponentElement<_tanstack_react_query.QueryClientProviderProps>;
-/** The entity port's scope when an `EntityDataProvider` is mounted above, else null (a host component deciding whether to mount one). */
-declare function useOptionalEntityScope(): EntityScope | null;
-/** The entity port's scope, or a loud failure naming what to mount. */
-declare function useEntityScope(): EntityScope;
-/** One type's list: keyset pages, `loadMore`, `newer`, live. `query.org` is a filter, never a lock. */
-declare function useEntityList(token: string, query?: Query): DataRows;
-/** One type's columns: platform columns and the organizations' custom fields, with `origin`. */
-declare function useEntityColumns(token: string): DataRead<Column[]>;
-/**
- * The type itself: its name and whether this person may add or change rows. Read from the same
- * `entity_columns` answer the columns come from (one request per type), cached under the type's own
- * key, so a shape notice refreshes it with the columns.
- */
-declare function useEntityType(token: string): DataRead<EntityTypeFacts>;
-/** One row by id (drawn at once from a loaded page, confirmed by the read). */
-declare function useEntityRow(token: string, id: Uuid | null): DataRead<Row | null>;
-/**
- * Writes for one type, optimistic with rollback: `create` (into the active organization), `update` (with
- * the `_version` the person saw), `archive` / `restore`. Each answers `RecordsResult`; a refusal carries
- * the store's sentence verbatim.
- */
-declare function useEntityWrite(token: string): DataMutations;
-
-export { ENTITY_PORT_KEY, EntityDataProvider, type EntityDataProviderProps, type EntityScope, type EntityTypeFacts, useEntityColumns, useEntityList, useEntityRow, useEntityScope, useEntityType, useEntityWrite, useOptionalEntityScope };
+export * from '@ai-matrx/records/entity/react';