@masterteam/work-center 0.0.61 → 0.0.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masterteam/work-center",
-  "version": "0.0.61",
+  "version": "0.0.63",
   "publishConfig": {
     "directory": "../../../dist/masterteam/work-center",
     "linkDirectory": false,
@@ -20,12 +20,12 @@
     "rxjs": "^7.8.2",
     "tailwindcss": "^4.2.2",
     "tailwindcss-primeui": "^0.6.1",
-    "@masterteam/client-components": "^0.0.66",
-    "@masterteam/components": "^0.0.238",
+    "@masterteam/client-components": "^0.0.67",
+    "@masterteam/components": "^0.0.240",
     "@masterteam/icons": "^0.0.17",
-    "@masterteam/forms": "^0.0.126",
+    "@masterteam/structure-builder": "^0.0.61",
     "@masterteam/discussion": "^0.0.26",
-    "@masterteam/structure-builder": "^0.0.61"
+    "@masterteam/forms": "^0.0.127"
   },
   "sideEffects": false,
   "exports": {

package/types/masterteam-work-center.d.ts

@@ -1,5 +1,5 @@
 import * as _masterteam_components_table from '@masterteam/components/table';
-import { ColumnDef, TableFilters } from '@masterteam/components/table';
+import { ColumnDef, TableFilters, TablePersistStateKey } from '@masterteam/components/table';
 import * as _masterteam_components_statistic_card from '@masterteam/components/statistic-card';
 import { StatisticCardData } from '@masterteam/components/statistic-card';
 import * as _masterteam_work_center from '@masterteam/work-center';
@@ -28,6 +28,29 @@ declare const WORK_CENTER_QUERY_VERSION = 1;
 declare const WORK_CENTER_MAX_PAGE_SIZE = 100;
 declare const WORK_CENTER_MAX_FILTERS = 20;
 declare const WORK_CENTER_MAX_SORT = 5;
+/**
+ * Backend column key carrying the row's LevelData display label
+ * (`extra.levelDataName`). Grouping by it maps to a single backend sort on the
+ * same key — see `WORK_CENTER_LEVEL_GROUP_FIELD` for the grouping identity.
+ */
+declare const WORK_CENTER_LEVEL_NAME_KEY = "levelDataName";
+/**
+ * Synthetic per-row field holding the *identity* behind the Level Name column.
+ * The visible label is ambiguous (two LevelData records may share a name), so
+ * rows are bucketed by `context.levelDataId` instead — except rows with no
+ * visible label, which get an empty identity so they all collapse into the one
+ * shared "—" group the backend contract requires.
+ */
+declare const WORK_CENTER_LEVEL_GROUP_FIELD = "__mtLevelGroup";
+/** Rendered in place of a missing / restricted LevelData label. */
+declare const WORK_CENTER_EMPTY_LABEL = "\u2014";
+/**
+ * Bootstrap `group` value meaning "the user turned grouping off". Needed
+ * because an absent `group` means "not chosen yet" and falls back to the
+ * default grouping — without a distinct value, clearing the group would be
+ * undone by the next navigation.
+ */
+declare const WORK_CENTER_GROUP_NONE = "none";
 interface ApiEnvelope<T> {
     endpoint: string | null;
     status: number;
@@ -208,6 +231,11 @@ interface WorkCenterAreaState {
      * Same `(field, op)` pair from this slice overrides a header rule.
      */
     columnFilters: WorkCenterFilterRule[];
+    /**
+     * Column key the table groups rows by. UI-only — never part of the runtime
+     * request; grouping is expressed to the backend as `context.sort`.
+     */
+    groupBy: string | null;
     menuItems: ClientPageMenuItem[];
     rows: Record<string, unknown>[];
     columns: ColumnDef[];
@@ -239,6 +267,8 @@ interface WorkCenterBootstrapInputs {
     levelDataId?: unknown;
     sort?: unknown;
     filters?: unknown;
+    /** Grouped column key, so a grouped view survives reload / deep-link. */
+    group?: unknown;
 }
 interface WorkCenterItemModalComponentInput {
     contextKey: WorkCenterItemContextKey;
@@ -267,7 +297,7 @@ interface WorkCenterClientFormModalOptions {
     buttonIcon?: string;
     lookups?: ClientLookup[];
 }
-type WorkCenterLoadReason = 'route-enter' | 'menu-change' | 'filters-change' | 'table-lazy' | 'refresh' | 'manual';
+type WorkCenterLoadReason = 'route-enter' | 'menu-change' | 'filters-change' | 'group-change' | 'table-lazy' | 'refresh' | 'manual';
 
 declare class WorkCenterPage {
     private readonly facade;
@@ -289,6 +319,15 @@ declare class WorkCenterPage {
     readonly runtimeFiltersChanged: _angular_core.OutputEmitterRef<WorkCenterFilterRule[]>;
     readonly itemClicked: _angular_core.OutputEmitterRef<string>;
     readonly cardSelected: _angular_core.OutputEmitterRef<string>;
+    /**
+     * Emitted whenever the backend sort changes (including grouping, which is
+     * sent as a sort). Hosts should persist it — the runtime query is rebuilt
+     * from `bootstrapInputs`, so a sort that isn't round-tripped is dropped on
+     * the next navigation.
+     */
+    readonly sortChanged: _angular_core.OutputEmitterRef<WorkCenterSortRule[]>;
+    /** Emitted when the grouped column changes; `null` when grouping is cleared. */
+    readonly groupChanged: _angular_core.OutputEmitterRef<string | null>;
     protected readonly context: _angular_core.Signal<_masterteam_work_center.WorkCenterContext>;
     protected readonly headerFilters: _angular_core.Signal<WorkCenterFilterRule[]>;
     protected readonly tableFilters: _angular_core.WritableSignal<TableFilters>;
@@ -312,6 +351,14 @@ declare class WorkCenterPage {
     protected readonly totalCount: _angular_core.Signal<number>;
     protected readonly columnFilters: _angular_core.Signal<WorkCenterFilterRule[]>;
     protected readonly loading: _angular_core.Signal<boolean>;
+    protected readonly groupBy: _angular_core.Signal<string | null>;
+    /**
+     * Sort and grouping live in the runtime query (and the host's URL), not in
+     * table storage — persisting them locally would let a restored table claim a
+     * grouping the backend query no longer has. Stable reference: a fresh array
+     * per change detection would re-run the table's persistence effect.
+     */
+    protected readonly persistStateExclude: TablePersistStateKey[];
     protected readonly tableColumns: _angular_core.Signal<{
         sortable: boolean;
         key: string;
@@ -320,18 +367,29 @@ declare class WorkCenterPage {
         customCellTpl?: _angular_core.TemplateRef<any>;
         filterConfig?: _masterteam_components_table.FilterConfig;
         statusMap?: Record<string, _masterteam_components_table.TableStatusMapValue>;
+        groupable?: boolean;
+        groupKey?: string;
+        showGroupColumnLabel?: boolean;
         readonly?: boolean;
         width?: string;
         filterOnly?: boolean;
         exportable?: boolean;
         exportValue?: (row: any) => string | number | boolean | null;
     }[]>;
+    /**
+     * Grouping is executed by the backend as a single sort, so the table's own
+     * sort state is driven from the query we actually sent instead of the
+     * table's internal memory of it.
+     */
+    protected readonly sortField: _angular_core.Signal<string>;
+    protected readonly sortDirection: _angular_core.Signal<"asc" | "desc" | null>;
     /**
      * Maps each status/group display label to its total count from the KPI
      * summary cards so the group header shows the real backend total rather than
-     * the current-page row count.
+     * the current-page row count. Withheld for groups the backend doesn't
+     * aggregate — see `PAGE_LOCAL_GROUP_KEYS`.
      */
-    protected readonly statusGroupCountMap: _angular_core.Signal<Map<string, number>>;
+    protected readonly groupCountMap: _angular_core.Signal<Map<string, number> | null>;
     protected readonly propertyFilterSchema: _angular_core.Signal<PropertyFilterBuilderSchema | null>;
     protected readonly showGeneralTaskCreateButton: _angular_core.Signal<boolean>;
     protected readonly generalTaskButtonLabel: _angular_core.Signal<string>;
@@ -349,14 +407,27 @@ declare class WorkCenterPage {
      * (handled by `applyColumnFiltersAndLoad`); when only paging/sort changed
      * we fall through to `applyTableLazyLoadAndLoad`.
      */
+    /**
+     * The table asks to group; the backend does the ordering. `setGroupByAndLoad`
+     * rewrites `context.sort` and resets paging, so the lazy event the table
+     * fires straight after carries the same sort and lands as a no-op.
+     */
+    onTableGroupByChange(key: string | null): void;
     onTableLazyLoad(event: any): void;
+    /**
+     * Announces the backend sort to the host only when it actually moved, so a
+     * host that mirrors it into the URL doesn't churn history on every page hit.
+     * Reads the snapshot, not the signal — this runs in the same tick as the
+     * dispatch that changed it.
+     */
+    private emitSortIfChanged;
     onGeneralTaskCreateClick(): void;
     onRowClick(row: Record<string, unknown>): void;
     protected readonly rowsClickable: _angular_core.Signal<boolean>;
     private getOpLabel;
     private resolveRowContextKey;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<WorkCenterPage, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WorkCenterPage, "mt-work-center-page", never, { "area": { "alias": "area"; "required": false; "isSignal": true; }; "pageTitle": { "alias": "pageTitle"; "required": false; "isSignal": true; }; "menuIcon": { "alias": "menuIcon"; "required": false; "isSignal": true; }; "lookups": { "alias": "lookups"; "required": false; "isSignal": true; }; "showSidebar": { "alias": "showSidebar"; "required": false; "isSignal": true; }; "bootstrapInputs": { "alias": "bootstrapInputs"; "required": false; "isSignal": true; }; "openItemDrawer": { "alias": "openItemDrawer"; "required": false; "isSignal": true; }; "itemReadOnly": { "alias": "itemReadOnly"; "required": false; "isSignal": true; }; "openItemsInModal": { "alias": "openItemsInModal"; "required": false; "isSignal": true; }; "itemModal": { "alias": "itemModal"; "required": false; "isSignal": true; }; "generalTaskModal": { "alias": "generalTaskModal"; "required": false; "isSignal": true; }; }, { "runtimeFiltersChanged": "runtimeFiltersChanged"; "itemClicked": "itemClicked"; "cardSelected": "cardSelected"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WorkCenterPage, "mt-work-center-page", never, { "area": { "alias": "area"; "required": false; "isSignal": true; }; "pageTitle": { "alias": "pageTitle"; "required": false; "isSignal": true; }; "menuIcon": { "alias": "menuIcon"; "required": false; "isSignal": true; }; "lookups": { "alias": "lookups"; "required": false; "isSignal": true; }; "showSidebar": { "alias": "showSidebar"; "required": false; "isSignal": true; }; "bootstrapInputs": { "alias": "bootstrapInputs"; "required": false; "isSignal": true; }; "openItemDrawer": { "alias": "openItemDrawer"; "required": false; "isSignal": true; }; "itemReadOnly": { "alias": "itemReadOnly"; "required": false; "isSignal": true; }; "openItemsInModal": { "alias": "openItemsInModal"; "required": false; "isSignal": true; }; "itemModal": { "alias": "itemModal"; "required": false; "isSignal": true; }; "generalTaskModal": { "alias": "generalTaskModal"; "required": false; "isSignal": true; }; }, { "runtimeFiltersChanged": "runtimeFiltersChanged"; "itemClicked": "itemClicked"; "cardSelected": "cardSelected"; "sortChanged": "sortChanged"; "groupChanged": "groupChanged"; }, never, never, true, never>;
 }
 
 declare class WorkCenterClientFormModal {
@@ -495,6 +566,18 @@ declare class ApplyColumnFilters {
     static readonly type = "[WorkCenter] Apply Column Filters";
     constructor(area: WorkCenterArea, filters: WorkCenterFilterRule[]);
 }
+/**
+ * Sets the grouped column. Grouping is expressed to the backend as a single
+ * sort on the same field, so this also rewrites `context.sort` and resets
+ * `page` to 1 before reloading. `groupBy: null` clears both.
+ */
+declare class SetGroupBy {
+    area: WorkCenterArea;
+    groupBy: string | null;
+    dir: 'asc' | 'desc';
+    static readonly type = "[WorkCenter] Set Group By";
+    constructor(area: WorkCenterArea, groupBy: string | null, dir?: 'asc' | 'desc');
+}
 /**
  * Clears both the header filter slice and the column filter slice in one
  * state update, triggering a single BE reload.
@@ -508,7 +591,7 @@ declare class ClearAllFilters {
 declare class WorkCenterFacade {
     private readonly store;
     readonly activeArea: _angular_core.Signal<WorkCenterArea>;
-    readonly context: _angular_core.Signal<_masterteam_work_center.WorkCenterContext>;
+    readonly context: _angular_core.Signal<WorkCenterContext>;
     readonly menuItems: _angular_core.Signal<_masterteam_components_types_masterteam_components_client_page_menu.ClientPageMenuItem[]>;
     readonly rows: _angular_core.Signal<Record<string, unknown>[]>;
     readonly columns: _angular_core.Signal<_masterteam_components_types_masterteam_components_table.ColumnDef[]>;
@@ -517,12 +600,20 @@ declare class WorkCenterFacade {
     readonly runtimeFilterSchema: _angular_core.Signal<_masterteam_work_center.WorkCenterRuntimeFilterSchema | null>;
     readonly headerFilters: _angular_core.Signal<WorkCenterFilterRule[]>;
     readonly columnFilters: _angular_core.Signal<WorkCenterFilterRule[]>;
+    readonly groupBy: _angular_core.Signal<string | null>;
     readonly totalCount: _angular_core.Signal<number>;
     readonly warnings: _angular_core.Signal<_masterteam_work_center.WorkCenterRuntimeWarningDto[]>;
     private readonly loadingActive;
     private readonly errors;
     readonly loading: _angular_core.Signal<boolean>;
     readonly error: _angular_core.Signal<string | null>;
+    /**
+     * Snapshot reads for callers that must observe state *immediately* after a
+     * dispatch — e.g. an output handler mirroring the runtime query into the URL.
+     * The `select()` signals above are the right choice everywhere else.
+     */
+    snapshotContext(): WorkCenterContext;
+    snapshotGroupBy(): string | null;
     enterArea(area: WorkCenterArea): rxjs.Observable<void>;
     hydrateContext(area: WorkCenterArea, patch: WorkCenterHydratePatch): rxjs.Observable<void>;
     setParams(area: WorkCenterArea, inputs: WorkCenterBootstrapInputs): rxjs.Observable<void>;
@@ -540,6 +631,13 @@ declare class WorkCenterFacade {
      * and reloads with merged `headerFilters` + `columnFilters`.
      */
     applyColumnFiltersAndLoad(area: WorkCenterArea, runtimeFilters: WorkCenterFilterRule[]): rxjs.Observable<void>;
+    /**
+     * Groups the table by `groupBy` (or clears grouping with `null`). Pushes the
+     * grouped column down as the single backend sort, resets to page 1 and
+     * reloads. Safe to call from the table's `groupByChange` — the lazy event
+     * that follows carries the same sort and is absorbed as a no-op.
+     */
+    setGroupByAndLoad(area: WorkCenterArea, groupBy: string | null, dir?: 'asc' | 'desc'): rxjs.Observable<void>;
     /**
      * Clears both header and column filter slices in one state update,
      * triggering a single BE reload.
@@ -547,6 +645,12 @@ declare class WorkCenterFacade {
     clearAllFiltersAndLoad(area: WorkCenterArea): rxjs.Observable<void>;
     loadRuntime(area: WorkCenterArea, reason?: WorkCenterLoadReason): rxjs.Observable<void>;
     private toPositiveInt;
+    /**
+     * `mt-table` always reports its sort on a lazy event, so a `null` field is an
+     * explicit "no sort" and must clear `context.sort` (the BE contract asks for
+     * `sort: []`). Only an event with no `sortField` key at all — nothing the
+     * current table emits — leaves the existing sort alone.
+     */
     private toSortFromLazyEvent;
     private isSameSort;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<WorkCenterFacade, never>;
@@ -566,6 +670,7 @@ declare class WorkCenterState {
     static runtimeFilterSchema(snapshot: WorkCenterAreaState): WorkCenterRuntimeFilterSchema | null;
     static headerFilters(snapshot: WorkCenterAreaState): WorkCenterFilterRule[];
     static columnFilters(snapshot: WorkCenterAreaState): WorkCenterFilterRule[];
+    static groupBy(snapshot: WorkCenterAreaState): string | null;
     static totalCount(snapshot: WorkCenterAreaState): number;
     static warnings(snapshot: WorkCenterAreaState): _masterteam_work_center.WorkCenterRuntimeWarningDto[];
     static lookups(state: WorkCenterStateModel): _masterteam_work_center.WorkCenterLookups;
@@ -577,6 +682,12 @@ declare class WorkCenterState {
     setLookups(ctx: StateContext<WorkCenterStateModel>, action: SetLookups): void;
     applyHeaderFilters(ctx: StateContext<WorkCenterStateModel>, action: ApplyHeaderFilters): rxjs.Observable<void> | undefined;
     applyColumnFilters(ctx: StateContext<WorkCenterStateModel>, action: ApplyColumnFilters): rxjs.Observable<void> | undefined;
+    /**
+     * Grouping is a backend concern: the table only renders contiguous rows, so
+     * the grouped column is pushed down as the single `context.sort` entry and
+     * pagination restarts at page 1. Clearing the group sends `sort: []`.
+     */
+    setGroupBy(ctx: StateContext<WorkCenterStateModel>, action: SetGroupBy): rxjs.Observable<void> | undefined;
     clearAllFilters(ctx: StateContext<WorkCenterStateModel>, action: ClearAllFilters): rxjs.Observable<void> | undefined;
     private applyFilterSlice;
     loadRuntime(ctx: StateContext<WorkCenterStateModel>, action: LoadRuntime): rxjs.Observable<WorkCenterRuntimeResponseData>;
@@ -587,5 +698,5 @@ declare class WorkCenterState {
 
 declare const APP_STATES: (typeof WorkCenterState)[];
 
-export { APP_STATES, ApplyColumnFilters, ApplyHeaderFilters, ClearAllFilters, EnterArea, HydrateFromContext, LoadRuntime, SetLookups, SetParams, WORK_CENTER_MAX_FILTERS, WORK_CENTER_MAX_PAGE_SIZE, WORK_CENTER_MAX_SORT, WORK_CENTER_QUERY_VERSION, WorkCenterActionKey, WorkCenterClientFormModal, WorkCenterFacade, WorkCenterItemModal, WorkCenterItemModalRoute, WorkCenterPage, WorkCenterState, decodeWorkCenterRouteContextKey, encodeWorkCenterRouteContextKey };
+export { APP_STATES, ApplyColumnFilters, ApplyHeaderFilters, ClearAllFilters, EnterArea, HydrateFromContext, LoadRuntime, SetGroupBy, SetLookups, SetParams, WORK_CENTER_EMPTY_LABEL, WORK_CENTER_GROUP_NONE, WORK_CENTER_LEVEL_GROUP_FIELD, WORK_CENTER_LEVEL_NAME_KEY, WORK_CENTER_MAX_FILTERS, WORK_CENTER_MAX_PAGE_SIZE, WORK_CENTER_MAX_SORT, WORK_CENTER_QUERY_VERSION, WorkCenterActionKey, WorkCenterClientFormModal, WorkCenterFacade, WorkCenterItemModal, WorkCenterItemModalRoute, WorkCenterPage, WorkCenterState, decodeWorkCenterRouteContextKey, encodeWorkCenterRouteContextKey };
 export type { ApiEnvelope, TranslatableDto, WorkCenterArea, WorkCenterAreaState, WorkCenterBootstrapInputs, WorkCenterClientFormModalData, WorkCenterClientFormModalOptions, WorkCenterColumnsConfig, WorkCenterContext, WorkCenterFilterOperator, WorkCenterFilterRule, WorkCenterHydratePatch, WorkCenterItemActionAfterSuccess, WorkCenterItemActionExecutionResult, WorkCenterItemActionsData, WorkCenterItemBasicInfoData, WorkCenterItemContextKey, WorkCenterItemModalComponentInput, WorkCenterItemModalOptions, WorkCenterLoadReason, WorkCenterLookups, WorkCenterPreviewLevelTarget, WorkCenterRuntimeCard, WorkCenterRuntimeFilterSchema, WorkCenterRuntimeItemAction, WorkCenterRuntimeOperatorOption, WorkCenterRuntimePagination, WorkCenterRuntimeProperty, WorkCenterRuntimeRequest, WorkCenterRuntimeResponseData, WorkCenterRuntimeSelectedCard, WorkCenterRuntimeStatsItem, WorkCenterRuntimeWarningDto, WorkCenterSortRule, WorkCenterStateModel };