@pega/lists-core 9.0.0-build.9.8 → 9.0.0

package/lib/src/core/generators/ViewGenerator.types.d.ts

@@ -3,7 +3,7 @@ import type { State } from '../../../types/State.types';
 import type { FieldDef } from '../../../types/Meta.types';
 import type { Formatters } from '../../../types/RsCoreBootArgs.types';
 import type View from './ViewGenerator';
-export type ViewConfig = Partial<Pick<View, 'data' | 'columns' | 'rows' | 'groupHeaders' | 'resultsCount' | 'hasMoreResults' | 'showCount' | 'totalItemCount' | 'selectedRecordsCount' | 'bodyHeight' | 'bodyMaxHeight' | 'rowHeight' | 'rowHeightClass' | 'isFilterApplied' | 'isLoading' | 'freezeLine' | 'state' | 'domContainer' | 'scrollerNode' | 'itemElement' | 'virtualizeElements' | 'debugInfo' | 'requiredDef' | 'hierarchicalGroupEnabled' | 'confirmationActionDetails' | 'externalStateKeys' | 'isCountUpdateRequired' | 'countGeneratedInternally' | 'isInstantRender' | 'viewHeight' | 'refreshNotification' | 'announceCount'>> & Pick<View, 'meta'> & {
+export type ViewConfig = Partial<Pick<View, 'data' | 'columns' | 'rows' | 'groupHeaders' | 'resultsCount' | 'hasMoreResults' | 'showCount' | 'totalItemCount' | 'selectedRecordsCount' | 'bodyHeight' | 'bodyMaxHeight' | 'rowHeight' | 'rowHeightClass' | 'isFilterApplied' | 'isLoading' | 'freezeLine' | 'state' | 'domContainer' | 'scrollerNode' | 'itemElement' | 'virtualizeElements' | 'debugInfo' | 'requiredDef' | 'hierarchicalGroupEnabled' | 'confirmationActionDetails' | 'externalStateKeys' | 'isCountUpdateRequired' | 'countGeneratedInternally' | 'isInstantRender' | 'viewHeight' | 'refreshNotification' | 'announceCount' | 'enableGlobalSearch' | 'warningMessages' | 'template'>> & Pick<View, 'meta'> & {
     singleSelectionRowKey?: string;
 };
 export type ViewContext = {
@@ -19,10 +19,14 @@ export type ViewContext = {
     selectedRecordsCount: View['selectedRecordsCount'];
     /** Returns the {@link View.resultsCount resultsCount} */
     resultsCount: View['resultsCount'];
+    /** Returns the {@link View.hasMoreResults hasMoreResults} */
+    hasMoreResults: View['hasMoreResults'];
     /** Returns the {@link View.requiredDef requiredDef} */
     getRequiredDef: () => View['requiredDef'];
     /** Returns the {@link View.getRowDensity getRowDensity} */
     getRowDensity: View['getRowDensity'];
+    /** Returns the {@link View.getVisibleColumns getVisibleColumns} */
+    getVisibleColumns: View['getVisibleColumns'];
 };
 /** Interface exposed for confirmation dialogue */
 export interface ConfirmationActionDetails {
@@ -106,6 +110,14 @@ export interface RequiredDefinition {
     required: boolean;
     validatemessage: string;
 }
+/**
+ * Warning detail structure from DX API responses.
+ * Contains message information that can be localized and displayed to users.
+ */
+export interface WarningDetail {
+    /** Localized Message */
+    message?: string;
+}
 /** UI props to be set on the view for A11Y purpose */
 export interface UIProps {
     /** This attribute conveys the number of columns in the repeating structures to screen readers. */

package/lib/src/core/generators/ViewGenerator.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewGenerator.types.d.ts","sourceRoot":"","sources":["../../../../src/core/generators/ViewGenerator.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAEtE,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,MAAM,MAAM,UAAU,GAAG,OAAO,CAC9B,IAAI,CACF,IAAI,EACF,MAAM,GACN,SAAS,GACT,MAAM,GACN,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,sBAAsB,GACtB,YAAY,GACZ,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,OAAO,GACP,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,WAAW,GACX,aAAa,GACb,0BAA0B,GAC1B,2BAA2B,GAC3B,mBAAmB,GACnB,uBAAuB,GACvB,0BAA0B,GAC1B,iBAAiB,GACjB,YAAY,GACZ,qBAAqB,GACrB,eAAe,CAClB,CACF,GACC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG;IAAE,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC1D,MAAM,MAAM,WAAW,GAAG;IACxB,yCAAyC;IACzC,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,uFAAuF;IACvF,2BAA2B,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACjE,yEAAyE;IACzE,oBAAoB,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACnD,yDAAyD;IACzD,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACnC,uDAAuD;IACvD,cAAc,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1C,2DAA2D;IAC3D,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;CACtC,CAAC;AAEF,kDAAkD;AAClD,MAAM,WAAW,yBAAyB;IACxC,2CAA2C;IAC3C,MAAM,EAAE;QACN,iDAAiD;QACjD,OAAO,EAAE,MAAM,CAAC;QAEhB,sDAAsD;QACtD,WAAW,EAAE,MAAM,CAAC;QAEpB,qEAAqE;QACrE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qEAAqE;QACrE,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF,4CAA4C;IAC5C,sBAAsB,EAAE,OAAO,CAAC;IAEhC,qEAAqE;IACrE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAEhC,uEAAuE;IACvE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAClC;AAED,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,wCAAwC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qCAAqC;AACrC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,uGAAuG;AACvG,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAEpE,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IAEb,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IAEjB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAEhB,sCAAsC;IACtC,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,UAAU,EAAE,OAAO,CAAC;IAEpB,6CAA6C;IAC7C,cAAc,EAAE,OAAO,CAAC;IAExB,sCAAsC;IACtC,UAAU,EAAE,OAAO,CAAC;IAEpB,2BAA2B;IAC3B,SAAS,EAAE,OAAO,CAAC;IAEnB,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IAEd,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IAEd,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,2DAA2D;IAC3D,sBAAsB,EAAE,OAAO,CAAC;IAEhC,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,sDAAsD;AACtD,MAAM,WAAW,OAAO;IACtB,kGAAkG;IAClG,eAAe,EAAE,MAAM,CAAC;IAExB,sFAAsF;IACtF,YAAY,EAAE,MAAM,CAAC;IAErB,+FAA+F;IAC/F,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAChC,KAAK,EACH,cAAc,GACd,qBAAqB,GACrB,UAAU,GACV,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,mBAAmB,CACtB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5B,yCAAyC;AACzC,UAAU,mBAAmB;IAC3B,wCAAwC;IACxC,uBAAuB,EAAE,OAAO,CAAC;IAEjC,mFAAmF;IACnF,eAAe,EAAE,MAAM,CAAC;IAExB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IAEpB,2CAA2C;IAC3C,cAAc,EAAE,OAAO,CAAC;IAExB,0EAA0E;IAC1E,cAAc,EAAE,OAAO,CAAC;IAExB,uDAAuD;IACvD,IAAI,EAAE;QACJ,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,mDAAmD;AACnD,UAAU,kBAAkB;IAC1B,qCAAqC;IACrC,UAAU,EAAE,WAAW,CAAC;IAExB,qHAAqH;IACrH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uCAAuC;IACvC,UAAU,EAAE,WAAW,CAAC;IAExB,uCAAuC;IACvC,KAAK,EAAE,mBAAmB,CAAC;IAE3B,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,WAAW,CAAC;IAEtC,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IAEX,2DAA2D;IAC3D,WAAW,EAAE,MAAM,IAAI,CAAC;IAExB,6DAA6D;IAC7D,EAAE,EAAE,kBAAkB,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAChC;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC;AAE7D,MAAM,WAAW,mBAAmB;IAClC,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"ViewGenerator.types.d.ts","sourceRoot":"","sources":["../../../../src/core/generators/ViewGenerator.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAEtE,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,MAAM,MAAM,UAAU,GAAG,OAAO,CAC9B,IAAI,CACF,IAAI,EACF,MAAM,GACN,SAAS,GACT,MAAM,GACN,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,sBAAsB,GACtB,YAAY,GACZ,eAAe,GACf,WAAW,GACX,gBAAgB,GAChB,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,OAAO,GACP,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,WAAW,GACX,aAAa,GACb,0BAA0B,GAC1B,2BAA2B,GAC3B,mBAAmB,GACnB,uBAAuB,GACvB,0BAA0B,GAC1B,iBAAiB,GACjB,YAAY,GACZ,qBAAqB,GACrB,eAAe,GACf,oBAAoB,GACpB,iBAAiB,GACjB,UAAU,CACb,CACF,GACC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG;IAAE,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC1D,MAAM,MAAM,WAAW,GAAG;IACxB,yCAAyC;IACzC,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,uFAAuF;IACvF,2BAA2B,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACjE,yEAAyE;IACzE,oBAAoB,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACnD,yDAAyD;IACzD,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACnC,6DAA6D;IAC7D,cAAc,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACvC,uDAAuD;IACvD,cAAc,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1C,2DAA2D;IAC3D,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IACrC,mEAAmE;IACnE,iBAAiB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;CAC9C,CAAC;AAEF,kDAAkD;AAClD,MAAM,WAAW,yBAAyB;IACxC,2CAA2C;IAC3C,MAAM,EAAE;QACN,iDAAiD;QACjD,OAAO,EAAE,MAAM,CAAC;QAEhB,sDAAsD;QACtD,WAAW,EAAE,MAAM,CAAC;QAEpB,qEAAqE;QACrE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qEAAqE;QACrE,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IAEF,4CAA4C;IAC5C,sBAAsB,EAAE,OAAO,CAAC;IAEhC,qEAAqE;IACrE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAEhC,uEAAuE;IACvE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAClC;AAED,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IAEjB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,wCAAwC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qCAAqC;AACrC,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,uGAAuG;AACvG,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAEpE,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IAEb,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IAEjB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAEhB,sCAAsC;IACtC,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IAEb,+BAA+B;IAC/B,UAAU,EAAE,OAAO,CAAC;IAEpB,6CAA6C;IAC7C,cAAc,EAAE,OAAO,CAAC;IAExB,sCAAsC;IACtC,UAAU,EAAE,OAAO,CAAC;IAEpB,2BAA2B;IAC3B,SAAS,EAAE,OAAO,CAAC;IAEnB,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IAEd,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IAEd,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,2DAA2D;IAC3D,sBAAsB,EAAE,OAAO,CAAC;IAEhC,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sDAAsD;AACtD,MAAM,WAAW,OAAO;IACtB,kGAAkG;IAClG,eAAe,EAAE,MAAM,CAAC;IAExB,sFAAsF;IACtF,YAAY,EAAE,MAAM,CAAC;IAErB,+FAA+F;IAC/F,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAChC,KAAK,EACH,cAAc,GACd,qBAAqB,GACrB,UAAU,GACV,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,mBAAmB,CACtB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5B,yCAAyC;AACzC,UAAU,mBAAmB;IAC3B,wCAAwC;IACxC,uBAAuB,EAAE,OAAO,CAAC;IAEjC,mFAAmF;IACnF,eAAe,EAAE,MAAM,CAAC;IAExB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IAEpB,2CAA2C;IAC3C,cAAc,EAAE,OAAO,CAAC;IAExB,0EAA0E;IAC1E,cAAc,EAAE,OAAO,CAAC;IAExB,uDAAuD;IACvD,IAAI,EAAE;QACJ,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,mDAAmD;AACnD,UAAU,kBAAkB;IAC1B,qCAAqC;IACrC,UAAU,EAAE,WAAW,CAAC;IAExB,qHAAqH;IACrH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uCAAuC;IACvC,UAAU,EAAE,WAAW,CAAC;IAExB,uCAAuC;IACvC,KAAK,EAAE,mBAAmB,CAAC;IAE3B,oCAAoC;IACpC,UAAU,EAAE,WAAW,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,WAAW,CAAC;IAEtC,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IAEX,2DAA2D;IAC3D,WAAW,EAAE,MAAM,IAAI,CAAC;IAExB,6DAA6D;IAC7D,EAAE,EAAE,kBAAkB,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAChC;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC;AAE7D,MAAM,WAAW,mBAAmB;IAClC,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}

package/lib/src/core/generators/ViewGenerator.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ViewGenerator.types.js","sourceRoot":"","sources":["../../../../src/core/generators/ViewGenerator.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { OmitStrict } from '@pega/cosmos-react-core';\n\nimport type { State } from '../../../types/State.types';\nimport type { FieldDef } from '../../../types/Meta.types';\nimport type { Formatters } from '../../../types/RsCoreBootArgs.types';\n\nimport type View from './ViewGenerator';\n\n// @ts-check findout which are the mandatory properties in View options.\nexport type ViewConfig = Partial<\n  Pick<\n    View,\n    | 'data'\n    | 'columns'\n    | 'rows'\n    | 'groupHeaders'\n    | 'resultsCount'\n    | 'hasMoreResults'\n    | 'showCount'\n    | 'totalItemCount'\n    | 'selectedRecordsCount'\n    | 'bodyHeight'\n    | 'bodyMaxHeight'\n    | 'rowHeight'\n    | 'rowHeightClass'\n    | 'isFilterApplied'\n    | 'isLoading'\n    | 'freezeLine'\n    | 'state'\n    | 'domContainer'\n    | 'scrollerNode'\n    | 'itemElement'\n    | 'virtualizeElements'\n    | 'debugInfo'\n    | 'requiredDef'\n    | 'hierarchicalGroupEnabled'\n    | 'confirmationActionDetails'\n    | 'externalStateKeys'\n    | 'isCountUpdateRequired'\n    | 'countGeneratedInternally'\n    | 'isInstantRender'\n    | 'viewHeight'\n    | 'refreshNotification'\n    | 'announceCount'\n  >\n> &\n  Pick<View, 'meta'> & { singleSelectionRowKey?: string };\nexport type ViewContext = {\n  /** Returns the {@link View.meta meta} */\n  getMeta: () => View['meta'];\n  /** Returns the {@link View.state state} */\n  getState: () => View['state'];\n  /** Returns the {@link View.columns columns} */\n  getColumns: () => View['columns'];\n  /** Returns the {@link View.getRenderingEnginePropsById getRenderingEnginePropsById} */\n  getRenderingEnginePropsById: View['getRenderingEnginePropsById'];\n  /** Returns the {@link View.selectedRecordsCount selectedRecordsCount} */\n  selectedRecordsCount: View['selectedRecordsCount'];\n  /** Returns the {@link View.resultsCount resultsCount} */\n  resultsCount: View['resultsCount'];\n  /** Returns the {@link View.requiredDef requiredDef} */\n  getRequiredDef: () => View['requiredDef'];\n  /** Returns the {@link View.getRowDensity getRowDensity} */\n  getRowDensity: View['getRowDensity'];\n};\n\n/** Interface exposed for confirmation dialogue */\nexport interface ConfirmationActionDetails {\n  /** Labels for the confirmation dialogue */\n  labels: {\n    /** Header of the confirmation dialogue pop up */\n    heading: string;\n\n    /** Description of the confirmation dialogue pop up */\n    description: string;\n\n    /** Label of the submit button inside confirmation dialogue pop up */\n    submitButtonLabel: string;\n\n    /** Label of the cancel button inside confirmation dialogue pop up */\n    cancelButtonLabel: string;\n  };\n\n  /** Boolean to toggle the show/visibility */\n  showConfirmationAction: boolean;\n\n  /** Function to be executed upon submission of the concerned modal */\n  onSubmit: (value?: any) => void;\n\n  /** Function to be executed upon cancellation of the concerned modal */\n  onCancel: (reason?: any) => void;\n}\n\n/** Interface for displaying API stats on the view */\nexport interface DebugInfo {\n  /** Class name of the data page */\n  className: string;\n\n  /** Name of the data page */\n  dataPage: string;\n\n  /** Source of the data page */\n  dataSource?: string;\n\n  /** Unique identifier for the insight */\n  insightId?: string;\n\n  /** Time taken by the API */\n  timeTaken?: string;\n}\n\n/** Style interface for freezeline */\nexport interface FreezeLine {\n  styles: {\n    left: string;\n  };\n}\n\n/** An interface used for group headers, consisting of grouping and hierarchical grouping properties */\nexport interface GroupHeader {\n  /** Applied aggregation to be displayed in group header */\n  aggregation: { [key: FieldDef['name']]: { [key: string]: number } };\n\n  /** Count to be displayed in group header */\n  count: number;\n\n  /** Data */\n  data: object;\n\n  /** End index of the rows in a particular group */\n  endIndex: number;\n\n  /** group-key: Computed using getGroupKey utility */\n  groupBy: string;\n\n  /** String array denoting hierarchy */\n  hierarchy: string[];\n\n  /** Hierarchical grouping info object */\n  info: object;\n\n  /** Indicates expanded state */\n  isExpanded: boolean;\n\n  /** Indicates if its hierarchical grouping */\n  isHierarchical: boolean;\n\n  /** Indicates if it is a leaf node. */\n  isLeafNode: boolean;\n\n  /** Indicates visibility */\n  isVisible: boolean;\n\n  /** Label of the group header to be displayed on UI */\n  label: string;\n\n  /** Level denoting the nesting level of a group header */\n  level: number;\n\n  /** Name attribute on a group header */\n  name: string;\n\n  /** Boolean to toggle displaying the hierarchical footer */\n  showHierarchicalFooter: boolean;\n\n  /** End index of the rows in a particular group */\n  startIndex: number;\n}\n\nexport interface RequiredDefinition {\n  required: boolean;\n  validatemessage: string;\n}\n\n/** UI props to be set on the view for A11Y purpose */\nexport interface UIProps {\n  /** This attribute conveys the number of columns in the repeating structures to screen readers. */\n  'aria-colcount': number;\n\n  /** This attribute conveys the label of the repeating structures to screen readers. */\n  'aria-label': string;\n\n  /** This attribute conveys the number of rows in the repeating structures to screen readers. */\n  'aria-rowcount': number;\n\n  /**  HTML role attribute for the view.\n   * @default 'grid'\n   */\n  role: string;\n}\n\nexport type ViewState = OmitStrict<\n  State,\n  | 'groupFilters'\n  | 'forceUpdateFeatures'\n  | 'template'\n  | 'presetId'\n  | 'version'\n  | 'renderFormatter'\n  | 'hierarchicalGroup'\n> & { searchText?: string };\n\n/** Personalization information object */\ninterface PersonalizationInfo {\n  /** Coordinates of current row index. */\n  existingItemBoundingBox: DOMRect;\n\n  /** Common visible item in view before and after paint (previous and next paint) */\n  currentRowIndex: number;\n\n  /** Possible index on view top */\n  topRowIndex: number;\n\n  /** Buffer coordinates while pagination. */\n  bufferOldCords: DOMRect;\n\n  /** Buffer coordinates while pagination is in progress and user scroll. */\n  bufferNewCords: DOMRect;\n\n  /** View object containing start index and end index */\n  view: {\n    startIndex: number;\n    endIndex: number;\n  };\n}\n\n/** Interface structure for virtualizer instance */\ninterface VirtualizeInstance {\n  /** DOM element for body container */\n  bContainer: HTMLElement;\n\n  /** Multiplier to be used when calculating the buffer rows to be loaded, bufferRows = bufferMultiplier * totalrows */\n  bufferMultiplier: number;\n\n  /** Number denoting the row height */\n  itemHeight: number;\n\n  /** DOM element for parent container */\n  pContainer: HTMLElement;\n\n  /** Virtualizer specific information */\n  pInfo: PersonalizationInfo;\n\n  /** DOM element for row container */\n  rContainer: HTMLElement;\n}\n\n/**\n * Attributes of the virtualizer being used\n */\nexport interface RootVirtualizer {\n  /**\n   * Returns the parent container pContainer set on the virtualizer\n   * @returns div with id pContainer\n   */\n  getParentContainer: () => HTMLElement;\n\n  /** Unique identifier of the virtualizer */\n  id: string;\n\n  /** Function to execute to scroll the virtualizer to top */\n  scrollToTop: () => void;\n\n  /** Additional information set on the virtualizer instance */\n  vi: VirtualizeInstance;\n}\n\nexport interface VirtualizeElement {\n  [key: string]: RootVirtualizer;\n}\n\nexport type FormatterFunction = Formatters[keyof Formatters];\n\nexport interface RefreshNotification {\n  /** A unique identifier for a refresh notification published by consumer of RS. */\n  id: number;\n  /** The message that needs to be displayed as refresh notification */\n  message: string;\n  /** The label for the refresh action button. */\n  refreshActionLabel: string;\n}\n"]}
+{"version":3,"file":"ViewGenerator.types.js","sourceRoot":"","sources":["../../../../src/core/generators/ViewGenerator.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { OmitStrict } from '@pega/cosmos-react-core';\n\nimport type { State } from '../../../types/State.types';\nimport type { FieldDef } from '../../../types/Meta.types';\nimport type { Formatters } from '../../../types/RsCoreBootArgs.types';\n\nimport type View from './ViewGenerator';\n\n// @ts-check findout which are the mandatory properties in View options.\nexport type ViewConfig = Partial<\n  Pick<\n    View,\n    | 'data'\n    | 'columns'\n    | 'rows'\n    | 'groupHeaders'\n    | 'resultsCount'\n    | 'hasMoreResults'\n    | 'showCount'\n    | 'totalItemCount'\n    | 'selectedRecordsCount'\n    | 'bodyHeight'\n    | 'bodyMaxHeight'\n    | 'rowHeight'\n    | 'rowHeightClass'\n    | 'isFilterApplied'\n    | 'isLoading'\n    | 'freezeLine'\n    | 'state'\n    | 'domContainer'\n    | 'scrollerNode'\n    | 'itemElement'\n    | 'virtualizeElements'\n    | 'debugInfo'\n    | 'requiredDef'\n    | 'hierarchicalGroupEnabled'\n    | 'confirmationActionDetails'\n    | 'externalStateKeys'\n    | 'isCountUpdateRequired'\n    | 'countGeneratedInternally'\n    | 'isInstantRender'\n    | 'viewHeight'\n    | 'refreshNotification'\n    | 'announceCount'\n    | 'enableGlobalSearch'\n    | 'warningMessages'\n    | 'template'\n  >\n> &\n  Pick<View, 'meta'> & { singleSelectionRowKey?: string };\nexport type ViewContext = {\n  /** Returns the {@link View.meta meta} */\n  getMeta: () => View['meta'];\n  /** Returns the {@link View.state state} */\n  getState: () => View['state'];\n  /** Returns the {@link View.columns columns} */\n  getColumns: () => View['columns'];\n  /** Returns the {@link View.getRenderingEnginePropsById getRenderingEnginePropsById} */\n  getRenderingEnginePropsById: View['getRenderingEnginePropsById'];\n  /** Returns the {@link View.selectedRecordsCount selectedRecordsCount} */\n  selectedRecordsCount: View['selectedRecordsCount'];\n  /** Returns the {@link View.resultsCount resultsCount} */\n  resultsCount: View['resultsCount'];\n  /** Returns the {@link View.hasMoreResults hasMoreResults} */\n  hasMoreResults: View['hasMoreResults'];\n  /** Returns the {@link View.requiredDef requiredDef} */\n  getRequiredDef: () => View['requiredDef'];\n  /** Returns the {@link View.getRowDensity getRowDensity} */\n  getRowDensity: View['getRowDensity'];\n  /** Returns the {@link View.getVisibleColumns getVisibleColumns} */\n  getVisibleColumns: View['getVisibleColumns'];\n};\n\n/** Interface exposed for confirmation dialogue */\nexport interface ConfirmationActionDetails {\n  /** Labels for the confirmation dialogue */\n  labels: {\n    /** Header of the confirmation dialogue pop up */\n    heading: string;\n\n    /** Description of the confirmation dialogue pop up */\n    description: string;\n\n    /** Label of the submit button inside confirmation dialogue pop up */\n    submitButtonLabel: string;\n\n    /** Label of the cancel button inside confirmation dialogue pop up */\n    cancelButtonLabel: string;\n  };\n\n  /** Boolean to toggle the show/visibility */\n  showConfirmationAction: boolean;\n\n  /** Function to be executed upon submission of the concerned modal */\n  onSubmit: (value?: any) => void;\n\n  /** Function to be executed upon cancellation of the concerned modal */\n  onCancel: (reason?: any) => void;\n}\n\n/** Interface for displaying API stats on the view */\nexport interface DebugInfo {\n  /** Class name of the data page */\n  className: string;\n\n  /** Name of the data page */\n  dataPage: string;\n\n  /** Source of the data page */\n  dataSource?: string;\n\n  /** Unique identifier for the insight */\n  insightId?: string;\n\n  /** Time taken by the API */\n  timeTaken?: string;\n}\n\n/** Style interface for freezeline */\nexport interface FreezeLine {\n  styles: {\n    left: string;\n  };\n}\n\n/** An interface used for group headers, consisting of grouping and hierarchical grouping properties */\nexport interface GroupHeader {\n  /** Applied aggregation to be displayed in group header */\n  aggregation: { [key: FieldDef['name']]: { [key: string]: number } };\n\n  /** Count to be displayed in group header */\n  count: number;\n\n  /** Data */\n  data: object;\n\n  /** End index of the rows in a particular group */\n  endIndex: number;\n\n  /** group-key: Computed using getGroupKey utility */\n  groupBy: string;\n\n  /** String array denoting hierarchy */\n  hierarchy: string[];\n\n  /** Hierarchical grouping info object */\n  info: object;\n\n  /** Indicates expanded state */\n  isExpanded: boolean;\n\n  /** Indicates if its hierarchical grouping */\n  isHierarchical: boolean;\n\n  /** Indicates if it is a leaf node. */\n  isLeafNode: boolean;\n\n  /** Indicates visibility */\n  isVisible: boolean;\n\n  /** Label of the group header to be displayed on UI */\n  label: string;\n\n  /** Level denoting the nesting level of a group header */\n  level: number;\n\n  /** Name attribute on a group header */\n  name: string;\n\n  /** Boolean to toggle displaying the hierarchical footer */\n  showHierarchicalFooter: boolean;\n\n  /** End index of the rows in a particular group */\n  startIndex: number;\n}\n\nexport interface RequiredDefinition {\n  required: boolean;\n  validatemessage: string;\n}\n\n/**\n * Warning detail structure from DX API responses.\n * Contains message information that can be localized and displayed to users.\n */\nexport interface WarningDetail {\n  /** Localized Message */\n  message?: string;\n}\n\n/** UI props to be set on the view for A11Y purpose */\nexport interface UIProps {\n  /** This attribute conveys the number of columns in the repeating structures to screen readers. */\n  'aria-colcount': number;\n\n  /** This attribute conveys the label of the repeating structures to screen readers. */\n  'aria-label': string;\n\n  /** This attribute conveys the number of rows in the repeating structures to screen readers. */\n  'aria-rowcount': number;\n\n  /**  HTML role attribute for the view.\n   * @default 'grid'\n   */\n  role: string;\n}\n\nexport type ViewState = OmitStrict<\n  State,\n  | 'groupFilters'\n  | 'forceUpdateFeatures'\n  | 'template'\n  | 'presetId'\n  | 'version'\n  | 'renderFormatter'\n  | 'hierarchicalGroup'\n> & { searchText?: string };\n\n/** Personalization information object */\ninterface PersonalizationInfo {\n  /** Coordinates of current row index. */\n  existingItemBoundingBox: DOMRect;\n\n  /** Common visible item in view before and after paint (previous and next paint) */\n  currentRowIndex: number;\n\n  /** Possible index on view top */\n  topRowIndex: number;\n\n  /** Buffer coordinates while pagination. */\n  bufferOldCords: DOMRect;\n\n  /** Buffer coordinates while pagination is in progress and user scroll. */\n  bufferNewCords: DOMRect;\n\n  /** View object containing start index and end index */\n  view: {\n    startIndex: number;\n    endIndex: number;\n  };\n}\n\n/** Interface structure for virtualizer instance */\ninterface VirtualizeInstance {\n  /** DOM element for body container */\n  bContainer: HTMLElement;\n\n  /** Multiplier to be used when calculating the buffer rows to be loaded, bufferRows = bufferMultiplier * totalrows */\n  bufferMultiplier: number;\n\n  /** Number denoting the row height */\n  itemHeight: number;\n\n  /** DOM element for parent container */\n  pContainer: HTMLElement;\n\n  /** Virtualizer specific information */\n  pInfo: PersonalizationInfo;\n\n  /** DOM element for row container */\n  rContainer: HTMLElement;\n}\n\n/**\n * Attributes of the virtualizer being used\n */\nexport interface RootVirtualizer {\n  /**\n   * Returns the parent container pContainer set on the virtualizer\n   * @returns div with id pContainer\n   */\n  getParentContainer: () => HTMLElement;\n\n  /** Unique identifier of the virtualizer */\n  id: string;\n\n  /** Function to execute to scroll the virtualizer to top */\n  scrollToTop: () => void;\n\n  /** Additional information set on the virtualizer instance */\n  vi: VirtualizeInstance;\n}\n\nexport interface VirtualizeElement {\n  [key: string]: RootVirtualizer;\n}\n\nexport type FormatterFunction = Formatters[keyof Formatters];\n\nexport interface RefreshNotification {\n  /** A unique identifier for a refresh notification published by consumer of RS. */\n  id: number;\n  /** The message that needs to be displayed as refresh notification */\n  message: string;\n  /** The label for the refresh action button. */\n  refreshActionLabel: string;\n}\n"]}

package/lib/src/core/generators/__tests__/viewUtilityMockSetup.d.ts

@@ -26,6 +26,7 @@ export default function setupViewUtilityMock({ dispatchMock, rsPropsMock, viewSe
         applyHiddenColumns(payload: string[], ootbColumns?: {
             dragHandle?: boolean;
         }): void;
+        applyVisibleColumns(payload: string[]): void;
         applyAggregations(payload: NonNullable<import("../../../../types/State.types").State["aggregationInfo"]>): void;
         applyOrder(payload: string[]): void;
         updatePersonalization(personalizationKey: string, markAsDefault: boolean, markAsAppDefault: boolean): void;
@@ -40,6 +41,7 @@ export default function setupViewUtilityMock({ dispatchMock, rsPropsMock, viewSe
         setAppDefaultPersonalization(personalizationKey: string, trimmedName: string): void;
         applySearch(value: string): void;
         applyRowHeight(payload: typeof import("../../../..").ROW_DENSITY[keyof typeof import("../../../..").ROW_DENSITY]): void;
+        applyGalleryLayout(layout: import("../../../../types/Meta.types").GalleryLayout): void;
         doBootstrap(): void;
         forceRefresh(flushState?: {
             [k: string]: boolean;
@@ -60,6 +62,7 @@ export default function setupViewUtilityMock({ dispatchMock, rsPropsMock, viewSe
             [key: import("../../../../types/Meta.types").FieldDef["id"]]: boolean;
         }): void;
         setConditionalStyleFormats(conditionalStyleFormats: NonNullable<import("../../../../types/State.types").State["conditionalStyleFormats"]>): void;
+        changeTemplate(template: NonNullable<import("../ViewGenerator").default["template"]>): void;
     };
     mockRsInternalProps: any;
 };

package/lib/src/core/generators/__tests__/viewUtilityMockSetup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewUtilityMockSetup.d.ts","sourceRoot":"","sources":["../../../../../src/core/generators/__tests__/viewUtilityMockSetup.js"],"names":[],"mappings":"AAGA;;;;;iBAc4+I,CAAC;0BAA4C,CAAC;gCAAoD,CAAC;qCAA+D,CAAC;oBAAkD,CAAC;;;;;;;;;;;;;;;;;sBAA2pR,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAD71a"}
+{"version":3,"file":"viewUtilityMockSetup.d.ts","sourceRoot":"","sources":["../../../../../src/core/generators/__tests__/viewUtilityMockSetup.js"],"names":[],"mappings":"AAGA;;;;;iBAcinJ,CAAC;0BAA4C,CAAC;gCAAoD,CAAC;qCAA+D,CAAC;oBAAkD,CAAC;;;;;;;;;;;;;;;;;sBAAm6R,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAD1ub"}

package/lib/src/core/generators/viewUtilityMethods.d.ts

@@ -3,10 +3,10 @@ import type { ModalManagerContextValue } from '@pega/cosmos-react-core/lib/compo
 import type RsInternal from '../RsInternal';
 import ActionTypes from '../actions/actionConstants';
 import type { Errors, State } from '../../../types/State.types';
-import type { FieldDef, ROW_DENSITY } from '../../../types/Meta.types';
+import type { FieldDef, GalleryLayout, ROW_DENSITY } from '../../../types/Meta.types';
 import type { ActionMeta, ApplyAliasesActionPayload, ColumnFilteringActionPayload, ExpandCollapsePayload, PaginationPayload } from '../actions/actions.types';
 import type View from './ViewGenerator';
-import type { DebugInfo, RefreshNotification, RequiredDefinition } from './ViewGenerator.types';
+import type { DebugInfo, RefreshNotification, RequiredDefinition, WarningDetail } from './ViewGenerator.types';
 export type RefreshNotificationForConsumer = OmitStrict<RefreshNotification, 'id'>;
 export type SupportedConsumerPayloads = {
     [ActionTypes.USER_CONFIRMATION_ACTION]: OmitStrict<NonNullable<View['confirmationActionDetails']>, 'onSubmit' | 'onCancel'>;
@@ -16,6 +16,7 @@ export type SupportedConsumerPayloads = {
     [ActionTypes.NOTIFY_DATA_REFRESH]: RefreshNotificationForConsumer;
     [ActionTypes.SET_IN_EXTERNAL_STATE]: NonNullable<State['externalState']>;
     [ActionTypes.UPDATE_SELECTED_ROWS]: undefined;
+    [ActionTypes.SET_WARNING_MESSAGES]: WarningDetail[];
 };
 export type SupportedConsumerActionType = keyof SupportedConsumerPayloads;
 export default function viewUtilityMethods(rsInternal: RsInternal): {
@@ -41,7 +42,6 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
      *
      * @param sourceKey - The itemKey for the row being dragged.
      * @param destinationKey - The itemKey for the row on which it is dropped.
-     * @returns
      */
     handleRowReorder(sourceKey: string, destinationKey: string): void;
     /**
@@ -157,6 +157,11 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
     applyHiddenColumns(payload: string[], ootbColumns?: {
         dragHandle?: boolean;
     }): void;
+    /**
+     * Sets the {@link State.visibleColumns visibleColumns} in the state.
+     * @param columnId - A single column ID or an array of column IDs to make visible.
+     */
+    applyVisibleColumns(payload: string[]): void;
     /**
      * Dispatches an action that replace {@link State.aggregationInfo aggregationInfo} slice in the state with the given {@link payload}.
      * @param payload
@@ -245,6 +250,12 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
      * @param payload the row density id.
      */
     applyRowHeight(payload: (typeof ROW_DENSITY)[keyof typeof ROW_DENSITY]): void;
+    /**
+     * Applies gallery layout on the current view.
+     *
+     * @param layout - Gallery layout mode.
+     */
+    applyGalleryLayout(layout: GalleryLayout): void;
     /**
      * Sets the {@link State.bootstrap bootstrap} status of repeating structures and update the {@link State.version version}in state.
      */
@@ -261,7 +272,6 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
     /**
      * Fetches actions for the {@link selectedItems} using {@link ApiContext.fetchActions fetchActions} api.
      * @param selectedItems
-     * @returns
      */
     fetchActions(selectedItems: string[]): Promise<(Pick<import("../../../types/Meta.types").RowAction, "text" | "id"> & {
         onClick: (rowIds: string[], clearSelectionAndRefreshRowsCallback: () => void) => void;
@@ -282,15 +292,14 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
     setErrors(payload: Errors): void;
     /**
      *  Dispatches the dom container responsive breakpoints to state.
-     * @param {*} breakpoint
-     * @param {*} value
+     * @param breakpoint
+     * @param value
      */
     setDomContainerResponsiveBreakpoints(breakpoint: string, value: boolean): void;
     /**
      * Refreshes the {@link View.data data} for {@link rows} by calling {@link ApiContext.fetchRowsData fetchRowsData} api.
      * It also calls {@link utilMethods.forceUpdate forceUpdate } to trigger state change for re-rendering.
      * @param rows
-     * @returns
      */
     refreshRows(rows?: string[]): Promise<void>;
     /**
@@ -302,17 +311,14 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
     /**
      * Triggers {@link ApiContext.importCSVData importCSVData} api.
      * @param create
-     * @returns
      */
     importCSVData(create: ModalManagerContextValue["create"]): Promise<void> | undefined;
     /**
      * Triggers {@link ApiContext.exportData exportData} api.
-     * @returns
      */
     exportToExcel(): Promise<void> | undefined;
     /**
      * Triggers {@link ApiContext.exportDataToCSV exportDataToCSV} api.
-     * @returns
      */
     exportToCSV(): Promise<void> | undefined;
     /**
@@ -323,6 +329,13 @@ export default function viewUtilityMethods(rsInternal: RsInternal): {
         [key: FieldDef["id"]]: boolean;
     }): void;
     setConditionalStyleFormats(conditionalStyleFormats: NonNullable<State["conditionalStyleFormats"]>): void;
+    /**
+     * Switches the active template for the view at runtime
+     * (e.g. when the user toggles between Table and Gallery from the toolbar).
+     *
+     * @param template The target template to switch to.
+     */
+    changeTemplate(template: NonNullable<View["template"]>): void;
 };
 export type UtilityFunctions = ReturnType<typeof viewUtilityMethods>;
 //# sourceMappingURL=viewUtilityMethods.d.ts.map

package/lib/src/core/generators/viewUtilityMethods.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewUtilityMethods.d.ts","sourceRoot":"","sources":["../../../../src/core/generators/viewUtilityMethods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AAEzG,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,WAAW,MAAM,4BAA4B,CAAC;AAMrD,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAMhE,OAAO,KAAK,EAAE,QAAQ,EAAQ,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EACV,UAAU,EACV,yBAAyB,EACzB,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAExC,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEhG,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AAEnF,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAChD,WAAW,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,EAC9C,UAAU,GAAG,UAAU,CACxB,CAAC;IACF,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC3C,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAChD,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAClD,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,8BAA8B,CAAC;IAClE,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IACzE,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,MAAM,yBAAyB,CAAC;AAS1E,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,UAAU,EAAE,UAAU;IAI7D;;;;;;;;OAQG;gCACyB,OAAO,wBAAwB,KAAK,CAAC,qBAAqB,CAAC;IAIvF;;;;;;;;;;;;;OAaG;gCACyB,MAAM,kBAAkB,MAAM;IAiB1D;;;;;;;;;OASG;yGAOA;QACD,KAAK,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,cAAc,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxC,oBAAoB,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpD,yBAAyB,CAAC,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC7D,QAAQ,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;KAClC;IAiBD;;;;;;;OAOG;mBAGY,CAAC,SAAS,2BAA2B,UAC1C,CAAC,YACC,yBAAyB,CAAC,CAAC,CAAC,GACrC,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS;IA+D3B,gEAAgE;;IAMhE;;;;;OAKG;kCAC2B,UAAU,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAIzE;;OAEG;;IAMH;;;;;OAKG;wBACiB,iBAAiB,eAAe,UAAU;IAI9D;;;;;OAKG;gCACyB,MAAM,EAAE;IAIpC;;;;;OAKG;wBACiB,4BAA4B;IAIhD;;;;OAIG;yBACkB,yBAAyB;IAI9C;;;;OAIG;0BACmB,MAAM;IAI5B;;;;OAIG;2BACoB,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAInD;;;;OAIG;0BACmB,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAIxD;;;;;OAKG;wCACiC,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAIzE;;;;;OAKG;yBACkB,MAAM,EAAE;IAI7B;;;;OAIG;mCAC4B,MAAM,EAAE;IAIvC;;;;;OAKG;gCACyB,MAAM,EAAE,gBAAgB;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE;IAI5E;;;OAGG;+BACwB,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAIhE;;;;OAIG;wBACiB,MAAM,EAAE;IAI5B;;;;;;;OAOG;8CAEmB,MAAM,iBACX,OAAO,oBACJ,OAAO;IAO3B;;;;;;;;OAQG;iDACkD;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE;IAUtF;;;;;;;OAOG;gCACyB,MAAM,iBAAiB,OAAO;IAI1D;;;;;;;OAOG;gCAEO,MAAM,QACR,MAAM,iBACG,OAAO,oBACJ,OAAO;IAO3B;;;;;;OAMG;8CACuC,MAAM;IAIhD;;;;;;OAMG;kDAC2C,MAAM;IAIpD;;;;;;OAMG;qDAC8C,MAAM,eAAe,MAAM;IAM5E;;;;;OAKG;uBAEgB,MAAM;IAIzB;;;;OAIG;4BACqB,CAAC,OAAO,WAAW,EAAE,MAAM,OAAO,WAAW,CAAC;IAItE;;OAEG;;IAMH;;;;;OAKG;8BACsB;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,oBAAwB,MAAM,EAAE;IAUjF;;;;OAIG;gCACyB,MAAM,EAAE;;;IAIpC;;;OAGG;uCACsC,MAAM,EAAE;IAIjD;;OAEG;;IAKH;;;OAGG;uBACgB,MAAM;IAMzB;;;;OAIG;qDAC8C,MAAM,SAAS,OAAO;IAKvE;;;;;OAKG;uBACqB,MAAM,EAAE;IA2BhC;;;;OAIG;8BAC6B,OAAO;IA8CvC;;;;OAIG;0BACmB,wBAAwB,CAAC,QAAQ,CAAC;IAYxD;;;OAGG;;IAkBH;;;OAGG;;IAkBH;;;OAGG;qCAC8B;QAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;KAAE;wDAKxC,WAAW,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;EAM3E;AACD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"viewUtilityMethods.d.ts","sourceRoot":"","sources":["../../../../src/core/generators/viewUtilityMethods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AAEzG,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,WAAW,MAAM,4BAA4B,CAAC;AAMrD,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAMhE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAQ,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC5F,OAAO,KAAK,EACV,UAAU,EACV,yBAAyB,EACzB,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAExC,OAAO,KAAK,EACV,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACd,MAAM,uBAAuB,CAAC;AAG/B,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AAEnF,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE,UAAU,CAChD,WAAW,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,EAC9C,UAAU,GAAG,UAAU,CACxB,CAAC;IACF,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC3C,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAChD,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAClD,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,8BAA8B,CAAC;IAClE,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IACzE,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;IAC9C,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,aAAa,EAAE,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,MAAM,yBAAyB,CAAC;AAS1E,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,UAAU,EAAE,UAAU;IAI7D;;;;;;;;OAQG;gCACyB,OAAO,wBAAwB,KAAK,CAAC,qBAAqB,CAAC;IAIvF;;;;;;;;;;;;OAYG;gCACyB,MAAM,kBAAkB,MAAM;IAiB1D;;;;;;;;;OASG;yGAOA;QACD,KAAK,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,cAAc,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxC,oBAAoB,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpD,yBAAyB,CAAC,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC7D,QAAQ,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;KAClC;IAiBD;;;;;;;OAOG;mBAGY,CAAC,SAAS,2BAA2B,UAC1C,CAAC,YACC,yBAAyB,CAAC,CAAC,CAAC,GACrC,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS;IAoE3B,gEAAgE;;IAMhE;;;;;OAKG;kCAC2B,UAAU,CAAC,qBAAqB,EAAE,QAAQ,CAAC;IAIzE;;OAEG;;IAMH;;;;;OAKG;wBACiB,iBAAiB,eAAe,UAAU;IAI9D;;;;;OAKG;gCACyB,MAAM,EAAE;IAIpC;;;;;OAKG;wBACiB,4BAA4B;IAIhD;;;;OAIG;yBACkB,yBAAyB;IAI9C;;;;OAIG;0BACmB,MAAM;IAI5B;;;;OAIG;2BACoB,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAInD;;;;OAIG;0BACmB,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAIxD;;;;;OAKG;wCACiC,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAIzE;;;;;OAKG;yBACkB,MAAM,EAAE;IAI7B;;;;OAIG;mCAC4B,MAAM,EAAE;IAIvC;;;;;OAKG;gCACyB,MAAM,EAAE,gBAAgB;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE;IAI5E;;;OAGG;iCAC0B,MAAM,EAAE;IAIrC;;;OAGG;+BACwB,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAIhE;;;;OAIG;wBACiB,MAAM,EAAE;IAI5B;;;;;;;OAOG;8CAEmB,MAAM,iBACX,OAAO,oBACJ,OAAO;IAO3B;;;;;;;;OAQG;iDACkD;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE;IAUtF;;;;;;;OAOG;gCACyB,MAAM,iBAAiB,OAAO;IAI1D;;;;;;;OAOG;gCAEO,MAAM,QACR,MAAM,iBACG,OAAO,oBACJ,OAAO;IAO3B;;;;;;OAMG;8CACuC,MAAM;IAIhD;;;;;;OAMG;kDAC2C,MAAM;IAIpD;;;;;;OAMG;qDAC8C,MAAM,eAAe,MAAM;IAM5E;;;;;OAKG;uBAEgB,MAAM;IAIzB;;;;OAIG;4BACqB,CAAC,OAAO,WAAW,EAAE,MAAM,OAAO,WAAW,CAAC;IAItE;;;;OAIG;+BACwB,aAAa;IAIxC;;OAEG;;IAMH;;;;;OAKG;8BACsB;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,oBAAwB,MAAM,EAAE;IAajF;;;OAGG;gCACyB,MAAM,EAAE;;;IAIpC;;;OAGG;uCACsC,MAAM,EAAE;IAIjD;;OAEG;;IAKH;;;OAGG;uBACgB,MAAM;IAKzB;;;;OAIG;qDAC8C,MAAM,SAAS,OAAO;IAKvE;;;;OAIG;uBACqB,MAAM,EAAE;IA2BhC;;;;OAIG;8BAC6B,OAAO;IA8CvC;;;OAGG;0BACmB,wBAAwB,CAAC,QAAQ,CAAC;IAYxD;;OAEG;;IAiCH;;OAEG;;IAkBH;;;OAGG;qCAC8B;QAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;KAAE;wDAKxC,WAAW,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAKxE;;;;;OAKG;6BACsB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;EAMzD;AACD,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/lib/src/core/generators/viewUtilityMethods.js

@@ -1,7 +1,7 @@
 import ActionTypes from '../actions/actionConstants';
 import * as actions from '../actions/actions';
 import { rowSelectColumnMeta } from '../constants';
-import { validateAction, passablePromise, deepCopy } from '../utils/util';
+import { validateAction, passablePromise, deepCopy, deepEqual } from '../utils/util';
 function syncData(key, sourceArray, modifiedArray) {
     return sourceArray.map(item => {
         const item2 = modifiedArray.find(i2 => i2[key] === item[key]);
@@ -35,7 +35,6 @@ export default function viewUtilityMethods(rsInternal) {
          *
          * @param sourceKey - The itemKey for the row being dragged.
          * @param destinationKey - The itemKey for the row on which it is dropped.
-         * @returns
          */
         handleRowReorder(sourceKey, destinationKey) {
             if (getView()?.meta?.moveListRecords) {
@@ -110,7 +109,7 @@ export default function viewUtilityMethods(rsInternal) {
                     utilMethods.forceUpdate(false);
                     break;
                 case ActionTypes.TOGGLE_DISABLE_SELECTION: {
-                    let rowSelectColumn = getView().columns?.find(column => column.field.name === rowSelectColumnMeta.field.name);
+                    let rowSelectColumn = getView().columns?.find(column => column.field.id === rowSelectColumnMeta.field.id);
                     if (rowSelectColumn) {
                         rowSelectColumn = rowSelectColumn.setProp({
                             disableSelection: payload
@@ -138,6 +137,12 @@ export default function viewUtilityMethods(rsInternal) {
                         updateSelectedRows: new Date().getTime()
                     });
                     break;
+                case ActionTypes.SET_WARNING_MESSAGES:
+                    if (!deepEqual(getView().getWarningMessages(), payload)) {
+                        getView().setProp({ warningMessages: payload });
+                        utilMethods.forceUpdate(false);
+                    }
+                    break;
                 default:
             }
             return actionReturnValue;
@@ -257,6 +262,13 @@ export default function viewUtilityMethods(rsInternal) {
         applyHiddenColumns(payload, ootbColumns) {
             getRsStateResolver().dispatch(actions.actionHiddenColumnUpdate(payload, ootbColumns));
         },
+        /**
+         * Sets the {@link State.visibleColumns visibleColumns} in the state.
+         * @param columnId - A single column ID or an array of column IDs to make visible.
+         */
+        applyVisibleColumns(payload) {
+            getRsStateResolver().dispatch(actions.actionVisibleColumnUpdate(payload));
+        },
         /**
          * Dispatches an action that replace {@link State.aggregationInfo aggregationInfo} slice in the state with the given {@link payload}.
          * @param payload
@@ -368,6 +380,14 @@ export default function viewUtilityMethods(rsInternal) {
         applyRowHeight(payload) {
             getRsStateResolver().dispatch(actions.actionRowHeightChange(payload));
         },
+        /**
+         * Applies gallery layout on the current view.
+         *
+         * @param layout - Gallery layout mode.
+         */
+        applyGalleryLayout(layout) {
+            getRsStateResolver().dispatch(actions.actionGalleryLayoutChange(layout));
+        },
         /**
          * Sets the {@link State.bootstrap bootstrap} status of repeating structures and update the {@link State.version version}in state.
          */
@@ -385,14 +405,16 @@ export default function viewUtilityMethods(rsInternal) {
             // If a refresh is in progress, don't trigger another refresh.
             if (getRsStore().refreshInProgress)
                 return;
+            // Communicate forceRefresh to apiContext via ApiOptions.
             getRsStore().refreshInProgress = true;
             getRsStore().refreshToken = Date.now();
+            // Communicate forceRefresh to apiContext via callback.
+            getRsProps().apiContext.onBeforeRefresh?.();
             getRsStateResolver().dispatch(actions.actionForceRefresh(flushState, featuresToAvoid));
         },
         /**
          * Fetches actions for the {@link selectedItems} using {@link ApiContext.fetchActions fetchActions} api.
          * @param selectedItems
-         * @returns
          */
         fetchActions(selectedItems) {
             return getRsProps().apiContext.fetchActions?.(selectedItems);
@@ -421,8 +443,8 @@ export default function viewUtilityMethods(rsInternal) {
         },
         /**
          *  Dispatches the dom container responsive breakpoints to state.
-         * @param {*} breakpoint
-         * @param {*} value
+         * @param breakpoint
+         * @param value
          */
         setDomContainerResponsiveBreakpoints(breakpoint, value) {
             const payload = { breakpoint, value };
@@ -432,7 +454,6 @@ export default function viewUtilityMethods(rsInternal) {
          * Refreshes the {@link View.data data} for {@link rows} by calling {@link ApiContext.fetchRowsData fetchRowsData} api.
          * It also calls {@link utilMethods.forceUpdate forceUpdate } to trigger state change for re-rendering.
          * @param rows
-         * @returns
          */
         async refreshRows(rows = []) {
             const rsProps = getRsProps();
@@ -500,7 +521,6 @@ export default function viewUtilityMethods(rsInternal) {
         /**
          * Triggers {@link ApiContext.importCSVData importCSVData} api.
          * @param create
-         * @returns
          */
         importCSVData(create) {
             return getRsProps()
@@ -513,16 +533,25 @@ export default function viewUtilityMethods(rsInternal) {
         },
         /**
          * Triggers {@link ApiContext.exportData exportData} api.
-         * @returns
          */
         exportToExcel() {
+            function getVisibleColumnFormatters() {
+                const visibleColumns = getView().getVisibleColumns();
+                const formatters = {};
+                visibleColumns?.forEach(column => {
+                    if (column.formatterConfig) {
+                        formatters[column.field.id] = column.formatterConfig;
+                    }
+                });
+                return formatters;
+            }
             return getRsProps()
                 .apiContext.exportData?.(deepCopy(getView().state), getView().meta, {
                 ...(getRsStore().refreshInProgress && {
                     invalidateCache: true,
                     invalidateCacheToken: getRsStore().refreshToken
                 })
-            })
+            }, getVisibleColumnFormatters())
                 .catch(err => {
                 getRsStateResolver().dispatch(actions.actionNotificationAdd({
                     content: err
@@ -531,7 +560,6 @@ export default function viewUtilityMethods(rsInternal) {
         },
         /**
          * Triggers {@link ApiContext.exportDataToCSV exportDataToCSV} api.
-         * @returns
          */
         exportToCSV() {
             return getRsProps()
@@ -556,6 +584,17 @@ export default function viewUtilityMethods(rsInternal) {
         },
         setConditionalStyleFormats(conditionalStyleFormats) {
             getRsStateResolver().dispatch(actions.setConditionalStyleFormats(conditionalStyleFormats));
+        },
+        /**
+         * Switches the active template for the view at runtime
+         * (e.g. when the user toggles between Table and Gallery from the toolbar).
+         *
+         * @param template The target template to switch to.
+         */
+        changeTemplate(template) {
+            if (getView().meta.allowSwitchTemplate === false)
+                return;
+            getRsStateResolver().dispatch(actions.actionChangeTemplate(template));
         }
     };
     return utilMethods;