@mmlogic/components 0.2.0 → 0.3.0

package/dist/types/components/mrd-table/mrd-table.d.ts

@@ -1,13 +1,16 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-import { AlternativeView, ColumnFilter, TableAction, TableColumn } from '../../utils/cell-renderer';
-import { AggregationResult } from '../../types/client-layout';
+import { ColumnFilter } from '../../utils/cell-renderer';
+import { AggregationResult, ClientLayoutItem } from '../../types/client-layout';
 export declare class MrdTable {
     el: HTMLElement;
     private pendingPages;
     private debounceTimer;
     private outsideClickHandler;
     private keydownHandler;
-    columns: TableColumn[];
+    /** The VIEW or RELATED_VIEW layout item. Contains view config, dataClass, fromClass, actions etc. */
+    item: ClientLayoutItem | null;
+    /** Parent record id — required for RELATED_VIEW to build /{fromClass}/{parentId}/{dataClass}. */
+    parentId: string;
     /** Direct rows (non-paginated mode, used when totalElements === 0). */
     rows: Record<string, any>[];
     locale: string;
@@ -19,19 +22,12 @@ export declare class MrdTable {
     rowHeight: number;
     /** Height of the scroll container in px. */
     tableHeight: number;
-    /** Initial sort applied on load, e.g. "timestamp,desc" or "name".
-     *  Parsed by init() into sortField + sortDir. */
-    defaultSort: string;
-    /** Toolbar action buttons rendered above the table. */
-    actions: TableAction[];
-    /** Display label of the current view — shown in the toolbar center as a view picker trigger. */
-    viewLabel: string;
-    /** Alternative views available for this table; renders a dropdown when non-empty. */
-    alternativeViews: AlternativeView[];
     /** Clamp renderEnd when totalElements shrinks (e.g. after a filter is applied). */
     totalElementsChanged(newVal: number): void;
-    /** Apply defaultSort when the prop changes (e.g. after a view switch). */
-    defaultSortChanged(newVal: string): void;
+    /** Reset to primary view when the item prop is replaced from outside. */
+    itemChanged(newVal: ClientLayoutItem | null): void;
+    /** Index into allViews[] for the currently displayed view. 0 = primary, 1+ = alternatives. */
+    private activeViewIdx;
     loadedPages: Map<number, Record<string, any>[]>;
     requestedPages: Set<number>;
     renderStart: number;
@@ -65,27 +61,26 @@ export declare class MrdTable {
     mrdLoadPage: EventEmitter<{
         page: number;
         sort: string;
+        path: string;
+        qs: string;
     }>;
     /** Fired when a data row is clicked. Detail is the full row object including _links. */
     mrdRowClick: EventEmitter<Record<string, any>>;
-    /** Fired when a toolbar action button is clicked. Detail contains the action identifier. */
+    /** Fired when a toolbar action button is clicked.
+     *  For 'export': includes `path` (relative excel path) and `qs` (current sort+filter params).
+     *  For 'create': includes `dataClass` (target type) and `parentPath` (e.g. /buyers/123 for RELATED_VIEW). */
     mrdAction: EventEmitter<{
         action: string;
-    }>;
-    /** Fired when active filters change. Host translates filters to API query params. */
-    mrdFilter: EventEmitter<{
-        filters: ColumnFilter[];
+        path?: string;
+        qs?: string;
+        dataClass?: string;
+        parentPath?: string | null;
     }>;
     /** Fired when a FILE or IMAGE cell is clicked. Host resolves the href to a signed download URL. */
     mrdDownload: EventEmitter<{
         href: string;
         fileName: string;
     }>;
-    /** Fired when the user selects an alternative view from the view switcher dropdown. */
-    mrdSwitchView: EventEmitter<{
-        name: string;
-        class?: string;
-    }>;
     /** Fired when aggregation totals need to be (re-)fetched.
      *  Detail contains the fields grouped by aggregate function.
      *  Host calls the /aggregations endpoint and passes the result to setAggregations(). */
@@ -93,6 +88,8 @@ export declare class MrdTable {
         sum?: string[];
         avg?: string[];
         count?: string[];
+        path: string;
+        qs: string;
     }>;
     componentWillLoad(): void;
     private applyDefaultSort;
@@ -117,6 +114,21 @@ export declare class MrdTable {
     componentDidRender(): void;
     private visibleCount;
     private sortParam;
+    /** Stable ordered list: primary view first, then alternatives (from the item prop). */
+    private get allViews();
+    /** Relative excel export path for the current view.
+     *  VIEW:         /excel/{dataClass}
+     *  RELATED_VIEW: /excel/{fromClass}/{parentId}/{dataClass}  */
+    private buildExcelPath;
+    private buildActionDetail;
+    /** Relative data path for the current view, without query string.
+     *  VIEW:         /{dataClass}
+     *  RELATED_VIEW: /{fromClass}/{parentId}/{dataClass}  */
+    private buildDataPath;
+    /** Build query params for a page request from current sort, view filters, filterClass and active column filters. */
+    private buildQueryParams;
+    private get columns();
+    private get tableActions();
     private colName;
     private colDataType;
     private buildAggregationParams;

package/dist/types/components.d.ts

@@ -7,10 +7,8 @@
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
 import { ClientLayout, ClientLayoutItem, ClientLayoutItemFieldDataType, ClientLayoutItemRelationDisplayType, ClientLayoutItemRelationEditBehavior, ClientListValue, CurrencyValue, RelationSearchResult as RelationSearchResult1 } from "./types";
 import { AggregationResult, ClientLayoutItem as ClientLayoutItem1, ClientLayoutItemNavigate, ClientViewMetadata, RelationSearchResult } from "./types/client-layout";
-import { AlternativeView, ColumnFilter, TableAction, TableColumn } from "./utils/cell-renderer";
 export { ClientLayout, ClientLayoutItem, ClientLayoutItemFieldDataType, ClientLayoutItemRelationDisplayType, ClientLayoutItemRelationEditBehavior, ClientListValue, CurrencyValue, RelationSearchResult as RelationSearchResult1 } from "./types";
 export { AggregationResult, ClientLayoutItem as ClientLayoutItem1, ClientLayoutItemNavigate, ClientViewMetadata, RelationSearchResult } from "./types/client-layout";
-export { AlternativeView, ColumnFilter, TableAction, TableColumn } from "./utils/cell-renderer";
 export namespace Components {
     interface MrdBooleanField {
         /**
@@ -291,7 +289,7 @@ export namespace Components {
          */
         "items": ClientLayoutItem1[];
         /**
-          * Top-level _links from ClientDashboardMetadata; used to resolve hrefs for VIEW items.
+          * Legacy: top-level _links from ClientDashboardMetadata. Not needed in new flat format.
           * @default {}
          */
         "links": Record<string, { href: string }>;
@@ -316,11 +314,11 @@ export namespace Components {
          */
         "setViewAggregations": (name: string, data: any) => Promise<void>;
         /**
-          * Inject data into an embedded mrd-table for a RELATED_VIEW or VIEW item. Pass totalElements on page 0 to initialise the table; omit on subsequent pages. Pass pageLinks (_links from the page response) on page 0 to enable action hrefs in mrdViewAction.
+          * Inject data into an embedded mrd-table for a RELATED_VIEW or VIEW item. Pass totalElements to update the pagination total (safe to pass on every page).
          */
-        "setViewPage": (name: string, page: number, rows: any[], totalElements?: number, pageLinks?: Record<string, { href: string; }>) => Promise<void>;
+        "setViewPage": (name: string, page: number, rows: any[], totalElements?: number) => Promise<void>;
         /**
-          * View metadata map (ClientDashboardMetadata.views) for RELATED_VIEW and VIEW items.
+          * Legacy: view metadata map (ClientDashboardMetadata.views). Not needed in new flat format.
           * @default {}
          */
         "views": Record<string, ClientViewMetadata>;
@@ -482,29 +480,15 @@ export namespace Components {
         "value": string | string[] | RelationSearchResult1 | RelationSearchResult1[] | null;
     }
     interface MrdTable {
-        /**
-          * Toolbar action buttons rendered above the table.
-          * @default []
-         */
-        "actions": TableAction[];
-        /**
-          * Alternative views available for this table; renders a dropdown when non-empty.
-          * @default []
-         */
-        "alternativeViews": AlternativeView[];
-        /**
-          * @default []
-         */
-        "columns": TableColumn[];
-        /**
-          * Initial sort applied on load, e.g. "timestamp,desc" or "name". Parsed by init() into sortField + sortDir.
-          * @default ''
-         */
-        "defaultSort": string;
         /**
           * Initialise (or reset) the virtual scroll. Call after setting all props and registering the mrdLoadPage listener, but before calling setPage(0, rows).
          */
         "init": () => Promise<void>;
+        /**
+          * The VIEW or RELATED_VIEW layout item. Contains view config, dataClass, fromClass, actions etc.
+          * @default null
+         */
+        "item": ClientLayoutItem1 | null;
         /**
           * @default navigator.language
          */
@@ -514,6 +498,11 @@ export namespace Components {
           * @default 20
          */
         "pageSize": number;
+        /**
+          * Parent record id — required for RELATED_VIEW to build /{fromClass}/{parentId}/{dataClass}.
+          * @default ''
+         */
+        "parentId": string;
         /**
           * Row height in px — used for spacer and scroll-position maths.
           * @default 36
@@ -542,11 +531,6 @@ export namespace Components {
           * @default 0
          */
         "totalElements": number;
-        /**
-          * Display label of the current view — shown in the toolbar center as a view picker trigger.
-          * @default ''
-         */
-        "viewLabel": string;
     }
     interface MrdTextField {
         /**
@@ -904,11 +888,10 @@ declare global {
         "mrdNavigate": { href?: string; label: string; navigate?: ClientLayoutItemNavigate };
         "mrdSearch": { query: string; dataClass: string };
         "mrdDownload": { href: string; fileName: string };
-        "mrdLoadView": { name: string; href?: string; viewConfig: ClientViewMetadata; sort: string; filters: ColumnFilter[] };
-        "mrdLoadViewPage": { name: string; page: number; sort: string; filters: ColumnFilter[] };
+        "mrdLoadViewPage": { name: string; page: number; sort: string; path: string; qs: string };
         "mrdLoadImage": { fieldName: string; href: string };
-        "mrdViewAction": { name: string; action: string; href?: string };
-        "mrdLoadViewAggregations": { name: string; href?: string; filters: ColumnFilter[]; sum?: string[]; avg?: string[]; count?: string[] };
+        "mrdViewAction": { name: string; action: string; dataClass: string; path?: string; qs?: string; parentPath?: string | null };
+        "mrdLoadViewAggregations": { name: string; dataClass: string; path: string; qs: string; sum?: string[]; avg?: string[]; count?: string[] };
     }
     interface HTMLMrdLayoutSectionElement extends Components.MrdLayoutSection, HTMLStencilElement {
         addEventListener<K extends keyof HTMLMrdLayoutSectionElementEventMap>(type: K, listener: (this: HTMLMrdLayoutSectionElement, ev: MrdLayoutSectionCustomEvent<HTMLMrdLayoutSectionElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -999,13 +982,11 @@ declare global {
         new (): HTMLMrdRelationFieldElement;
     };
     interface HTMLMrdTableElementEventMap {
-        "mrdLoadPage": { page: number; sort: string };
+        "mrdLoadPage": { page: number; sort: string; path: string; qs: string };
         "mrdRowClick": Record<string, any>;
-        "mrdAction": { action: string };
-        "mrdFilter": { filters: ColumnFilter[] };
+        "mrdAction": { action: string; path?: string; qs?: string; dataClass?: string; parentPath?: string | null };
         "mrdDownload": { href: string; fileName: string };
-        "mrdSwitchView": { name: string; class?: string };
-        "mrdLoadAggregations": { sum?: string[]; avg?: string[]; count?: string[] };
+        "mrdLoadAggregations": { sum?: string[]; avg?: string[]; count?: string[]; path: string; qs: string };
     }
     interface HTMLMrdTableElement extends Components.MrdTable, HTMLStencilElement {
         addEventListener<K extends keyof HTMLMrdTableElementEventMap>(type: K, listener: (this: HTMLMrdTableElement, ev: MrdTableCustomEvent<HTMLMrdTableElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1410,7 +1391,7 @@ declare namespace LocalJSX {
          */
         "items"?: ClientLayoutItem1[];
         /**
-          * Top-level _links from ClientDashboardMetadata; used to resolve hrefs for VIEW items.
+          * Legacy: top-level _links from ClientDashboardMetadata. Not needed in new flat format.
           * @default {}
          */
         "links"?: Record<string, { href: string }>;
@@ -1423,26 +1404,22 @@ declare namespace LocalJSX {
           * Fired once on load for each IMAGE field that has an href; host resolves the URL and calls setImagePreview().
          */
         "onMrdLoadImage"?: (event: MrdLayoutSectionCustomEvent<{ fieldName: string; href: string }>) => void;
-        /**
-          * Fired once on load for each RELATED_VIEW and VIEW item; host fetches page 0 and calls setViewPage().
-         */
-        "onMrdLoadView"?: (event: MrdLayoutSectionCustomEvent<{ name: string; href?: string; viewConfig: ClientViewMetadata; sort: string; filters: ColumnFilter[] }>) => void;
         /**
           * Re-emitted from an embedded mrd-table's mrdLoadAggregations; host calls setViewAggregations() with the result.
          */
-        "onMrdLoadViewAggregations"?: (event: MrdLayoutSectionCustomEvent<{ name: string; href?: string; filters: ColumnFilter[]; sum?: string[]; avg?: string[]; count?: string[] }>) => void;
+        "onMrdLoadViewAggregations"?: (event: MrdLayoutSectionCustomEvent<{ name: string; dataClass: string; path: string; qs: string; sum?: string[]; avg?: string[]; count?: string[] }>) => void;
         /**
           * Re-emitted from an embedded mrd-table's mrdLoadPage; host fetches the next page and calls setViewPage().
          */
-        "onMrdLoadViewPage"?: (event: MrdLayoutSectionCustomEvent<{ name: string; page: number; sort: string; filters: ColumnFilter[] }>) => void;
+        "onMrdLoadViewPage"?: (event: MrdLayoutSectionCustomEvent<{ name: string; page: number; sort: string; path: string; qs: string }>) => void;
         "onMrdNavigate"?: (event: MrdLayoutSectionCustomEvent<{ href?: string; label: string; navigate?: ClientLayoutItemNavigate }>) => void;
         "onMrdSearch"?: (event: MrdLayoutSectionCustomEvent<{ query: string; dataClass: string }>) => void;
         /**
-          * Re-emitted from an embedded mrd-table's mrdAction; includes the view name and resolved href.
+          * Re-emitted from an embedded mrd-table's mrdAction; host builds the target URL from dataClass.
          */
-        "onMrdViewAction"?: (event: MrdLayoutSectionCustomEvent<{ name: string; action: string; href?: string }>) => void;
+        "onMrdViewAction"?: (event: MrdLayoutSectionCustomEvent<{ name: string; action: string; dataClass: string; path?: string; qs?: string; parentPath?: string | null }>) => void;
         /**
-          * View metadata map (ClientDashboardMetadata.views) for RELATED_VIEW and VIEW items.
+          * Legacy: view metadata map (ClientDashboardMetadata.views). Not needed in new flat format.
           * @default {}
          */
         "views"?: Record<string, ClientViewMetadata>;
@@ -1612,61 +1589,44 @@ declare namespace LocalJSX {
     }
     interface MrdTable {
         /**
-          * Toolbar action buttons rendered above the table.
-          * @default []
-         */
-        "actions"?: TableAction[];
-        /**
-          * Alternative views available for this table; renders a dropdown when non-empty.
-          * @default []
-         */
-        "alternativeViews"?: AlternativeView[];
-        /**
-          * @default []
-         */
-        "columns"?: TableColumn[];
-        /**
-          * Initial sort applied on load, e.g. "timestamp,desc" or "name". Parsed by init() into sortField + sortDir.
-          * @default ''
+          * The VIEW or RELATED_VIEW layout item. Contains view config, dataClass, fromClass, actions etc.
+          * @default null
          */
-        "defaultSort"?: string;
+        "item"?: ClientLayoutItem1 | null;
         /**
           * @default navigator.language
          */
         "locale"?: string;
         /**
-          * Fired when a toolbar action button is clicked. Detail contains the action identifier.
+          * Fired when a toolbar action button is clicked. For 'export': includes `path` (relative excel path) and `qs` (current sort+filter params). For 'create': includes `dataClass` (target type) and `parentPath` (e.g. /buyers/123 for RELATED_VIEW).
          */
-        "onMrdAction"?: (event: MrdTableCustomEvent<{ action: string }>) => void;
+        "onMrdAction"?: (event: MrdTableCustomEvent<{ action: string; path?: string; qs?: string; dataClass?: string; parentPath?: string | null }>) => void;
         /**
           * Fired when a FILE or IMAGE cell is clicked. Host resolves the href to a signed download URL.
          */
         "onMrdDownload"?: (event: MrdTableCustomEvent<{ href: string; fileName: string }>) => void;
-        /**
-          * Fired when active filters change. Host translates filters to API query params.
-         */
-        "onMrdFilter"?: (event: MrdTableCustomEvent<{ filters: ColumnFilter[] }>) => void;
         /**
           * Fired when aggregation totals need to be (re-)fetched. Detail contains the fields grouped by aggregate function. Host calls the /aggregations endpoint and passes the result to setAggregations().
          */
-        "onMrdLoadAggregations"?: (event: MrdTableCustomEvent<{ sum?: string[]; avg?: string[]; count?: string[] }>) => void;
+        "onMrdLoadAggregations"?: (event: MrdTableCustomEvent<{ sum?: string[]; avg?: string[]; count?: string[]; path: string; qs: string }>) => void;
         /**
           * Fired when a page needs to be fetched. Host fetches and calls setPage(). `sort` is the raw query-param value, e.g. "name" or "name,desc".
          */
-        "onMrdLoadPage"?: (event: MrdTableCustomEvent<{ page: number; sort: string }>) => void;
+        "onMrdLoadPage"?: (event: MrdTableCustomEvent<{ page: number; sort: string; path: string; qs: string }>) => void;
         /**
           * Fired when a data row is clicked. Detail is the full row object including _links.
          */
         "onMrdRowClick"?: (event: MrdTableCustomEvent<Record<string, any>>) => void;
-        /**
-          * Fired when the user selects an alternative view from the view switcher dropdown.
-         */
-        "onMrdSwitchView"?: (event: MrdTableCustomEvent<{ name: string; class?: string }>) => void;
         /**
           * Records per page (must match the API page size).
           * @default 20
          */
         "pageSize"?: number;
+        /**
+          * Parent record id — required for RELATED_VIEW to build /{fromClass}/{parentId}/{dataClass}.
+          * @default ''
+         */
+        "parentId"?: string;
         /**
           * Row height in px — used for spacer and scroll-position maths.
           * @default 36
@@ -1687,11 +1647,6 @@ declare namespace LocalJSX {
           * @default 0
          */
         "totalElements"?: number;
-        /**
-          * Display label of the current view — shown in the toolbar center as a view picker trigger.
-          * @default ''
-         */
-        "viewLabel"?: string;
     }
     interface MrdTextField {
         /**
@@ -1909,13 +1864,12 @@ declare namespace LocalJSX {
         "value": string | string[] | RelationSearchResult | RelationSearchResult[] | null;
     }
     interface MrdTableAttributes {
+        "parentId": string;
         "locale": string;
         "totalElements": number;
         "pageSize": number;
         "rowHeight": number;
         "tableHeight": number;
-        "defaultSort": string;
-        "viewLabel": string;
     }
     interface MrdTextFieldAttributes {
         "name": string;

package/dist/types/types/client-layout.d.ts

@@ -119,12 +119,6 @@ export interface ClientLayoutItemNavigate {
     icon?: string | null;
     navigationType?: string | null;
 }
-export interface ClientLayoutItemView {
-    /** Key into the `views` map of DashboardMetadata. */
-    name: string;
-    dataClass: string;
-    showTitle: boolean;
-}
 export interface ClientLayoutItemRelatedView {
     name: string;
     fromClass?: string | null;
@@ -152,16 +146,19 @@ export interface ClientLayoutItem {
     relation?: ClientLayoutItemRelation;
     items?: ClientLayoutItem[];
     navigate?: ClientLayoutItemNavigate;
-    view?: ClientLayoutItemView;
+    view?: ClientViewMetadata;
     relatedView?: ClientLayoutItemRelatedView;
     relatedObject?: ClientLayoutItemRelatedObject;
     search?: ClientLayoutItemSearch;
     name?: string;
     showTitle?: boolean;
+    /** Embedded alternative view configs (new flat format). */
     alternativeViews?: Array<{
-        name: string;
         label?: string;
-        class?: string;
+        dataClass?: string;
+        fromClass?: string | null;
+        filterClass?: string | null;
+        view?: ClientViewMetadata;
     }>;
     /** Toolbar buttons for embedded views. null/omitted = ["NEW","EXPORT"]; [] = none. */
     actions?: string[] | null;
@@ -199,6 +196,11 @@ export interface ClientLayout {
     tabPage?: boolean;
     items: ClientLayoutItem[];
 }
+export interface ViewFilter {
+    name: string;
+    value?: string | null;
+    operator?: 'EQUALS' | 'FROM' | 'TO' | 'STARTS_WITH' | 'NOT_EMPTY' | 'EMPTY' | null;
+}
 export interface ClientViewMetadata {
     name: string | null;
     defaultView: boolean;
@@ -206,11 +208,7 @@ export interface ClientViewMetadata {
     /** Column definitions — each item is a FIELD or RELATION item. */
     values: ClientLayoutItem[];
     /** Static query-param filters baked into the view definition. */
-    filter?: Array<{
-        name: string;
-        value?: string | null;
-        operator?: 'EQUALS' | 'FROM' | 'TO' | 'STARTS_WITH' | 'NOT_EMPTY' | 'EMPTY' | null;
-    }> | null;
+    filter?: ViewFilter[] | null;
     type?: string;
     referenceType?: string | null;
     filterType?: string | null;
@@ -219,7 +217,8 @@ export interface ClientViewMetadata {
 }
 export interface ClientDashboardMetadata {
     layouts: ClientLayout[];
-    views: Record<string, ClientViewMetadata>;
+    /** Legacy: view metadata map keyed by generated name. Absent in new flat format. */
+    views?: Record<string, ClientViewMetadata>;
     layoutType: ClientLayoutType;
     _links?: Record<string, {
         href: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mmlogic/components",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Stencil.js web component library for dynamic forms and virtual-scroll data tables",
   "license": "MIT",
   "author": "Mosterd",