@masterteam/client-components 0.0.35 → 0.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masterteam/client-components",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "publishConfig": {
     "directory": "../../../dist/masterteam/client-components",
     "linkDirectory": true,
@@ -16,9 +16,9 @@
     "rxjs": "^7.8.2",
     "tailwindcss": "^4.2.2",
     "tailwindcss-primeui": "^0.6.1",
-    "@masterteam/forms": "^0.0.72",
-    "@masterteam/components": "^0.0.158",
-    "@masterteam/dashboard-builder": "^0.0.27"
+    "@masterteam/components": "^0.0.159",
+    "@masterteam/dashboard-builder": "^0.0.27",
+    "@masterteam/forms": "^0.0.72"
   },
   "dependencies": {
     "tslib": "^2.8.1"

package/types/masterteam-client-components-client-list.d.ts

@@ -1,9 +1,10 @@
 import * as _angular_core from '@angular/core';
 import { TemplateRef, OnDestroy, WritableSignal } from '@angular/core';
+import { TableAction, TableActionShape, ColumnDef, TableFilters } from '@masterteam/components/table';
 import * as _masterteam_components_entities from '@masterteam/components/entities';
 import { EntityData, EntityConfiguration } from '@masterteam/components/entities';
 import { DashboardBuilderData } from '@masterteam/dashboard-builder';
-import { TableAction, TableActionShape, ColumnDef, TableFilters } from '@masterteam/components/table';
+import { RuntimeAction } from '@masterteam/components/runtime-action';
 import { Observable } from 'rxjs';
 
 type ClientListMode = 'auto' | 'override';
@@ -34,6 +35,63 @@ interface ClientListBaseConfiguration {
     rowActions?: TableAction[];
     actionShape?: TableActionShape;
     dataLoaded?: ClientListDataLoadedHandler;
+    /**
+     * Lazy backend-driven per-row actions. When enabled, ClientList fetches
+     * each row's available `RuntimeAction[]` only when the user opens the row's
+     * 3-dots menu (default `loadStrategy: 'onMenuOpen'`), then merges them into
+     * the row's action list. Replaces the eager fan-out of one HTTP per visible
+     * row that callers used to wire by hand.
+     */
+    runtimeRecordActions?: ClientListRuntimeRecordActionsConfig;
+}
+interface ClientListRuntimeRecordActionsContext {
+    listKey: string;
+    contextKey: string | null;
+    instanceId: number | null;
+    moduleId: number;
+    row: RuntimeTableDisplayRow;
+    recordId: number;
+}
+interface ClientListRuntimeRecordActionsConfig {
+    /** Master flag — set to false to disable without removing the config block. */
+    enabled: boolean;
+    /**
+     * `onMenuOpen` (default): fetch when the 3-dots popover opens for a row.
+     * Requires `actionShape: 'popover'`. `eager`: fetch for every visible row
+     * after the list loads (legacy behavior, kept for opt-in).
+     */
+    loadStrategy?: 'onMenuOpen' | 'eager';
+    /**
+     * Endpoint template. `{instanceId}` is replaced with the list's
+     * `instanceId`. Defaults to
+     * `LevelData/{instanceId}/workspace-record-actions`.
+     */
+    endpoint?: string;
+    /**
+     * Query params per row. Defaults to
+     * `{ targetType: 'ModuleData', targetId: recordId, moduleKey? }`.
+     */
+    buildParams?: (ctx: ClientListRuntimeRecordActionsContext) => Record<string, string | number>;
+    /** Cache TTL in ms. `null` = until manual invalidation. Default: 60_000. */
+    cacheTtlMs?: number | null;
+    /** Read the record id from a row. Defaults to `row.Id ?? row.id ?? row.ModuleDataId`. */
+    resolveRecordId?: (row: RuntimeTableDisplayRow) => number | null;
+    /** Read the module key from a row (for the `moduleKey` query param). */
+    resolveModuleKey?: (row: RuntimeTableDisplayRow, ctx: {
+        listKey: string;
+        moduleId: number;
+    }) => string | null;
+    /**
+     * Called after a runtime action executes successfully (the list also
+     * auto-reloads and the per-row cache is invalidated). Use this to refresh
+     * any external state the consumer owns.
+     */
+    onActionExecuted?: (action: RuntimeAction, ctx: ClientListRuntimeRecordActionsContext) => void;
+    /**
+     * Visual: icon used for runtime action buttons (popover entries). Defaults
+     * to `media.play-circle`.
+     */
+    actionIcon?: string;
 }
 interface ClientListTableDisplayConfig {
     pageSize?: number;
@@ -287,6 +345,7 @@ interface NormalizedClientListConfiguration {
     rowActions: TableAction[];
     actionShape?: TableActionShape;
     dataLoaded?: ClientListDataLoadedHandler;
+    runtimeRecordActions?: ClientListRuntimeRecordActionsConfig;
 }
 interface ClientListContentTemplateContext {
     $implicit: ClientListState;
@@ -332,6 +391,8 @@ declare class ClientListStateService {
 declare class ClientList implements OnDestroy {
     private readonly api;
     protected readonly state: ClientListStateService;
+    private readonly runtimeActions;
+    private readonly runtimeRunner;
     readonly configurations: _angular_core.InputSignal<ClientListConfiguration[]>;
     readonly defaultTake: _angular_core.InputSignal<number>;
     readonly loaded: _angular_core.OutputEmitterRef<string>;
@@ -351,6 +412,32 @@ declare class ClientList implements OnDestroy {
     toggleExpanded(key: string): void;
     onTableRowClick(item: ClientListState, row: RuntimeTableDisplayRow): void;
     onCardClick(item: ClientListState, card: ClientListCard): void;
+    /**
+     * Called by the table view when a row's 3-dots menu is opened. Triggers a
+     * lazy fetch of that row's runtime actions when `runtimeRecordActions` is
+     * enabled with the default `onMenuOpen` strategy. Skips when the cache is
+     * still warm — the service handles in-flight dedupe and TTL.
+     */
+    onRowActionsRequested(item: ClientListState, row: RuntimeTableDisplayRow): void;
+    /**
+     * Per-row predicate used by the popover skeleton state.
+     */
+    isRowActionsLoading(item: ClientListState, row: RuntimeTableDisplayRow): boolean;
+    /**
+     * Per-list merged row-actions, keyed by item.key. Static `rowActions` are
+     * augmented with one entry per distinct runtime `actionKey` discovered for
+     * any row in the list, and re-evaluated when the runtime cache changes.
+     */
+    protected readonly mergedRowActionsByKey: _angular_core.Signal<ReadonlyMap<string, TableAction[]>>;
+    /** Fallback used by the template when no entry exists for an item.key. */
+    private readonly emptyActions;
+    private readonly rowActionsLoadingFnCache;
+    rowActionsFor(item: ClientListState): TableAction[];
+    rowActionsLoadingFnFor(item: ClientListState): (row: RuntimeTableDisplayRow) => boolean;
+    private computeMergedRowActions;
+    private executeRuntimeAction;
+    private toRuntimeActionsContext;
+    private resolveRecordId;
     templateContext(item: ClientListState): ClientListContentTemplateContext;
     defaultTitle(item: ClientListState): string;
     ngOnDestroy(): void;
@@ -370,6 +457,7 @@ declare class ClientList implements OnDestroy {
     private resolvePositiveInteger;
     private cleanupStaleResources;
     private notifyDataLoaded;
+    private maybeEagerLoadRuntimeActions;
     private toTableQuery;
     private createTableRequestSignature;
     private createCardsRequestSignature;
@@ -403,6 +491,42 @@ declare class ClientListApiService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<ClientListApiService>;
 }
 
+/**
+ * Lazy per-row runtime actions. Fetches `workspace-record-actions` only when
+ * the row's 3-dots menu is opened (or for every visible row when the list
+ * opts in to `eager`), with per-row caching, in-flight dedupe, and a single
+ * cache-invalidation hook tied to action execution.
+ */
+declare class ClientListRuntimeActionsService {
+    private readonly http;
+    private readonly cache;
+    private readonly inFlightKeys;
+    private readonly inFlight;
+    /** Actions keyed by `${listKey}:${recordId}`. */
+    readonly actionsByRowKey: _angular_core.Signal<ReadonlyMap<string, RuntimeAction[]>>;
+    /** Row keys currently being fetched. Drives the popover skeleton state. */
+    readonly loadingRowKeys: _angular_core.Signal<ReadonlySet<string>>;
+    rowKey(listKey: string, recordId: number): string;
+    has(listKey: string, recordId: number, ttlMs: number | null | undefined): boolean;
+    /**
+     * Fetch (or reuse cached/in-flight) per-row runtime actions for a row.
+     * Returns an Observable so callers can chain off the result; the cache and
+     * loading signals are also kept in sync so the table popover skeleton and
+     * the merged-actions computation react automatically.
+     */
+    request(config: ClientListRuntimeRecordActionsConfig, ctx: ClientListRuntimeRecordActionsContext): Observable<RuntimeAction[]>;
+    invalidateRow(listKey: string, recordId: number): void;
+    invalidateList(listKey: string): void;
+    clearAll(): void;
+    private writeCache;
+    private markLoading;
+    private resolveEndpoint;
+    private buildParams;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ClientListRuntimeActionsService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<ClientListRuntimeActionsService>;
+}
+declare function defaultResolveRecordId(row: RuntimeTableDisplayRow): number | null;
+
 /**
  * Toolbar state for a single client-list instance: search term, column filters,
  * group column, and active tab. Kept as mutable signals so both the table view
@@ -430,5 +554,5 @@ declare class ClientListToolbarService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<ClientListToolbarService>;
 }
 
-export { ClientList, ClientListApiService, ClientListStateService, ClientListToolbarService };
-export type { ClientListAreaType, ClientListBaseConfiguration, ClientListBaseState, ClientListCard, ClientListCardModule, ClientListCardProperty, ClientListCardsPayload, ClientListCardsState, ClientListClickableItem, ClientListCollapseConfig, ClientListConfiguration, ClientListContentTemplateContext, ClientListDataLoadedHandler, ClientListFetchCardDisplayOrderItem, ClientListFetchCardGroup, ClientListFetchCatalog, ClientListFetchProjection, ClientListFetchProjectionMeta, ClientListFetchPropertyMeta, ClientListFetchQueryRequest, ClientListFetchQueryResponse, ClientListFetchRecord, ClientListFetchRequestDisplay, ClientListFetchRequestFilter, ClientListFetchSchema, ClientListFetchTableColumn, ClientListFetchValueCell, ClientListFormConfiguration, ClientListInformativeChartLink, ClientListInformativeConfiguration, ClientListInformativeDashboardPayload, ClientListInformativeState, ClientListItemClickedEvent, ClientListLayoutConfig, ClientListLazyLoadEvent, ClientListMode, ClientListRuntimeContext, ClientListState, ClientListTableDisplayConfig, ClientListTableQuery, ClientListTableSettingsCatalogResponse, ClientListTableSettingsColumn, ClientListTableState, ClientListToolbarBucket, ClientListType, NormalizedClientListConfiguration, NormalizedClientListTableDisplayConfig, Response, RuntimeEntityColumnDef, RuntimeTableDisplayRow, RuntimeTableRowsResponse };
+export { ClientList, ClientListApiService, ClientListRuntimeActionsService, ClientListStateService, ClientListToolbarService, defaultResolveRecordId };
+export type { ClientListAreaType, ClientListBaseConfiguration, ClientListBaseState, ClientListCard, ClientListCardModule, ClientListCardProperty, ClientListCardsPayload, ClientListCardsState, ClientListClickableItem, ClientListCollapseConfig, ClientListConfiguration, ClientListContentTemplateContext, ClientListDataLoadedHandler, ClientListFetchCardDisplayOrderItem, ClientListFetchCardGroup, ClientListFetchCatalog, ClientListFetchProjection, ClientListFetchProjectionMeta, ClientListFetchPropertyMeta, ClientListFetchQueryRequest, ClientListFetchQueryResponse, ClientListFetchRecord, ClientListFetchRequestDisplay, ClientListFetchRequestFilter, ClientListFetchSchema, ClientListFetchTableColumn, ClientListFetchValueCell, ClientListFormConfiguration, ClientListInformativeChartLink, ClientListInformativeConfiguration, ClientListInformativeDashboardPayload, ClientListInformativeState, ClientListItemClickedEvent, ClientListLayoutConfig, ClientListLazyLoadEvent, ClientListMode, ClientListRuntimeContext, ClientListRuntimeRecordActionsConfig, ClientListRuntimeRecordActionsContext, ClientListState, ClientListTableDisplayConfig, ClientListTableQuery, ClientListTableSettingsCatalogResponse, ClientListTableSettingsColumn, ClientListTableState, ClientListToolbarBucket, ClientListType, NormalizedClientListConfiguration, NormalizedClientListTableDisplayConfig, Response, RuntimeEntityColumnDef, RuntimeTableDisplayRow, RuntimeTableRowsResponse };