@ai-matrx/records-ui 0.110.1 → 0.110.2

package/dist/first-page.d.cts

@@ -1,5 +1,5 @@
-import { Uuid, RecordFilter, RuleExpression, RecordPageSort, RecordsConfig, Table, Field } from '@ai-matrx/records';
-import { RecordsSeed, RecordsClient } from '@ai-matrx/records/core';
+import { Uuid, RecordFilter, RuleExpression, RecordsConfig, RecordPageSort, Table, Field } from '@ai-matrx/records';
+import { RecordsClient, RecordsSeed } from '@ai-matrx/records/core';
 import { TableStyle, GroupAggregateSpec, GroupOrder } from '@ai-matrx/design-system/data-table';
 import { FieldFormatConfig } from '@ai-matrx/design-system/field-formats';
 
@@ -257,6 +257,64 @@ interface SavedView extends SavedViewSpec {
     movedFrom: Record<string, unknown> | null;
 }
 
+/** The block's own props that decide a chart's question. */
+interface EntityChartQuestionInput {
+    /** The Dimension to group by. Absent: one total. */
+    by?: string | undefined;
+    /** What to count: the rows (default) or a number column summed. */
+    measure?: {
+        op: "count";
+    } | {
+        op: "sum" | "avg" | "min" | "max";
+        of: string;
+    } | undefined;
+    where?: Record<string, unknown> | undefined;
+    organization?: string | undefined;
+}
+
+type Base = {
+    dataSource: unknown;
+    organizationId: Uuid;
+    actor: RecordsConfig["actor"];
+};
+/** Several seeds as one: the later answer wins on the same door and arguments; `at` is the oldest. */
+declare function mergeSeeds(...seeds: Array<RecordsSeed | null | undefined>): RecordsSeed;
+/**
+ * AN ENTITY SOURCE'S BLOCK (a table, board or card of "task", "project", "crm_deal", "hr_employee"):
+ * its columns and first page, asked through the entity engine's own port with the question the block's
+ * `useEntityTable` sends — `question.pageSize` (the block's page size: 100, or 50 embedded) and the
+ * viewer's `question.search`, if any. Never throws.
+ */
+declare function askEntityBlockSeed(input: Base & {
+    token: string;
+    question?: {
+        pageSize?: number | undefined;
+        search?: string | null | undefined;
+    };
+}): Promise<RecordsSeed>;
+/**
+ * AN ENTITY SOURCE'S CHART (`EntityChartBlock`): `platform.drill_ask` with the question the block sends.
+ * `question` is the block's own props: `by`, `measure`, `where`, `organization`.
+ */
+declare function askChartSeed(input: Base & {
+    source: {
+        kind: "entity";
+        token: string;
+    };
+    question?: EntityChartQuestionInput;
+}): Promise<RecordsSeed>;
+/** One aggregate question of a tile: `client.recordAggregate`'s arguments but the table. */
+type TileSpec = Omit<Parameters<RecordsClient["recordAggregate"]>[0], "table_id">;
+/**
+ * A TABLE'S TILE: `custom.record_aggregate` over `tableId` for each `spec` (a tile that also shows a
+ * whole-table total gives both). The tile reads the number back with `useSeededAggregate`
+ * (`@ai-matrx/records/react`) under the very same spec.
+ */
+declare function askTileSeed(input: Base & {
+    tableId: Uuid;
+    spec: TileSpec | TileSpec[];
+}): Promise<RecordsSeed>;
+
 /** The table page's own page size (`TablePage`: 100 unless embedded). */
 declare const TABLE_PAGE_SIZE = 100;
 /**
@@ -304,14 +362,15 @@ declare function firstGridPageRequest(client: Pick<RecordsClient, "tableRead" |
  * the seed, and the page asks it for itself.
  */
 /**
- * THE PERSON'S SERVER-ROWS KNOBS, FROM THE TABLE'S BUNDLE (lane SSR-ROWS-2): `custom.table_page_bundle`
- * carries a `server_rows` part — `data.server_rows` and `data.server_rows_budget_ms` resolved for the
- * person asking in that organization. Null when the seed holds no such answer (an older store, a
- * refused part): the host treats that as off.
+ * THE PERSON'S SERVER-ROWS KNOBS, FROM THE TABLE'S BUNDLE (lanes SSR-ROWS-2, SSR-ROWS-3):
+ * `custom.table_page_bundle` carries a `server_rows` part — `data.server_rows` and
+ * `data.server_rows_cap_ms` (how long the page may wait for the server's rows before the browser asks
+ * for itself) resolved for the person asking in that organization. Null when the seed holds no such
+ * answer (an older store, a refused part): the host treats that as off.
  */
 declare function serverRowsOf(seed: RecordsSeed | null | undefined): {
     on: boolean;
-    budgetMs: number | null;
+    capMs: number | null;
 } | null;
 declare function askTablePageSeed(input: {
     dataSource: unknown;
@@ -332,4 +391,4 @@ declare function askTablePageSeed(input: {
     pageSize?: number;
 }): Promise<RecordsSeed>;
 
-export { EMBEDDED_PAGE_SIZE, type FirstGridPageArgs, TABLE_PAGE_SIZE, askTablePageSeed, firstGridPageArgs, firstGridPageRequest, serverRowsOf };
+export { EMBEDDED_PAGE_SIZE, type FirstGridPageArgs, TABLE_PAGE_SIZE, type TileSpec, askChartSeed, askEntityBlockSeed, askTablePageSeed, askTileSeed, firstGridPageArgs, firstGridPageRequest, mergeSeeds, serverRowsOf };

package/dist/first-page.d.ts

@@ -1,5 +1,5 @@
-import { Uuid, RecordFilter, RuleExpression, RecordPageSort, RecordsConfig, Table, Field } from '@ai-matrx/records';
-import { RecordsSeed, RecordsClient } from '@ai-matrx/records/core';
+import { Uuid, RecordFilter, RuleExpression, RecordsConfig, RecordPageSort, Table, Field } from '@ai-matrx/records';
+import { RecordsClient, RecordsSeed } from '@ai-matrx/records/core';
 import { TableStyle, GroupAggregateSpec, GroupOrder } from '@ai-matrx/design-system/data-table';
 import { FieldFormatConfig } from '@ai-matrx/design-system/field-formats';
 
@@ -257,6 +257,64 @@ interface SavedView extends SavedViewSpec {
     movedFrom: Record<string, unknown> | null;
 }
 
+/** The block's own props that decide a chart's question. */
+interface EntityChartQuestionInput {
+    /** The Dimension to group by. Absent: one total. */
+    by?: string | undefined;
+    /** What to count: the rows (default) or a number column summed. */
+    measure?: {
+        op: "count";
+    } | {
+        op: "sum" | "avg" | "min" | "max";
+        of: string;
+    } | undefined;
+    where?: Record<string, unknown> | undefined;
+    organization?: string | undefined;
+}
+
+type Base = {
+    dataSource: unknown;
+    organizationId: Uuid;
+    actor: RecordsConfig["actor"];
+};
+/** Several seeds as one: the later answer wins on the same door and arguments; `at` is the oldest. */
+declare function mergeSeeds(...seeds: Array<RecordsSeed | null | undefined>): RecordsSeed;
+/**
+ * AN ENTITY SOURCE'S BLOCK (a table, board or card of "task", "project", "crm_deal", "hr_employee"):
+ * its columns and first page, asked through the entity engine's own port with the question the block's
+ * `useEntityTable` sends — `question.pageSize` (the block's page size: 100, or 50 embedded) and the
+ * viewer's `question.search`, if any. Never throws.
+ */
+declare function askEntityBlockSeed(input: Base & {
+    token: string;
+    question?: {
+        pageSize?: number | undefined;
+        search?: string | null | undefined;
+    };
+}): Promise<RecordsSeed>;
+/**
+ * AN ENTITY SOURCE'S CHART (`EntityChartBlock`): `platform.drill_ask` with the question the block sends.
+ * `question` is the block's own props: `by`, `measure`, `where`, `organization`.
+ */
+declare function askChartSeed(input: Base & {
+    source: {
+        kind: "entity";
+        token: string;
+    };
+    question?: EntityChartQuestionInput;
+}): Promise<RecordsSeed>;
+/** One aggregate question of a tile: `client.recordAggregate`'s arguments but the table. */
+type TileSpec = Omit<Parameters<RecordsClient["recordAggregate"]>[0], "table_id">;
+/**
+ * A TABLE'S TILE: `custom.record_aggregate` over `tableId` for each `spec` (a tile that also shows a
+ * whole-table total gives both). The tile reads the number back with `useSeededAggregate`
+ * (`@ai-matrx/records/react`) under the very same spec.
+ */
+declare function askTileSeed(input: Base & {
+    tableId: Uuid;
+    spec: TileSpec | TileSpec[];
+}): Promise<RecordsSeed>;
+
 /** The table page's own page size (`TablePage`: 100 unless embedded). */
 declare const TABLE_PAGE_SIZE = 100;
 /**
@@ -304,14 +362,15 @@ declare function firstGridPageRequest(client: Pick<RecordsClient, "tableRead" |
  * the seed, and the page asks it for itself.
  */
 /**
- * THE PERSON'S SERVER-ROWS KNOBS, FROM THE TABLE'S BUNDLE (lane SSR-ROWS-2): `custom.table_page_bundle`
- * carries a `server_rows` part — `data.server_rows` and `data.server_rows_budget_ms` resolved for the
- * person asking in that organization. Null when the seed holds no such answer (an older store, a
- * refused part): the host treats that as off.
+ * THE PERSON'S SERVER-ROWS KNOBS, FROM THE TABLE'S BUNDLE (lanes SSR-ROWS-2, SSR-ROWS-3):
+ * `custom.table_page_bundle` carries a `server_rows` part — `data.server_rows` and
+ * `data.server_rows_cap_ms` (how long the page may wait for the server's rows before the browser asks
+ * for itself) resolved for the person asking in that organization. Null when the seed holds no such
+ * answer (an older store, a refused part): the host treats that as off.
  */
 declare function serverRowsOf(seed: RecordsSeed | null | undefined): {
     on: boolean;
-    budgetMs: number | null;
+    capMs: number | null;
 } | null;
 declare function askTablePageSeed(input: {
     dataSource: unknown;
@@ -332,4 +391,4 @@ declare function askTablePageSeed(input: {
     pageSize?: number;
 }): Promise<RecordsSeed>;
 
-export { EMBEDDED_PAGE_SIZE, type FirstGridPageArgs, TABLE_PAGE_SIZE, askTablePageSeed, firstGridPageArgs, firstGridPageRequest, serverRowsOf };
+export { EMBEDDED_PAGE_SIZE, type FirstGridPageArgs, TABLE_PAGE_SIZE, type TileSpec, askChartSeed, askEntityBlockSeed, askTablePageSeed, askTileSeed, firstGridPageArgs, firstGridPageRequest, mergeSeeds, serverRowsOf };