@pega/lists-react 8.0.0-build.27.14

package/lib/types.d.ts

@@ -0,0 +1,231 @@
+import type { ReactNode, RefObject } from 'react';
+import type { Condition } from '@pega/cosmos-react-condition-builder';
+import type { RsCoreTypes } from 'pega-repeating-structures-core';
+import type { FormControlProps, IconName, OmitStrict } from '@pega/cosmos-react-core';
+type ColumnContext = ReturnType<RsCoreTypes.Column['getContext']>;
+type ViewContext = ReturnType<RsCoreTypes.View['getContext']>;
+type RsCoreStyleFormat = NonNullable<RsCoreTypes.RsCoreInitArgs['styleFormats']>[number];
+type PropsFromRenderFactory = Pick<RsCoreTypes.RenderFactoryWithProps, 'props'>;
+interface RsStyleFormatConfig extends OmitStrict<RsCoreStyleFormat['config'], 'icon'> {
+    icon: {
+        /** An icon from set of icons available from cosmos for current theme. */
+        name: IconName;
+        /** The color of icon. */
+        color: string;
+    };
+}
+export interface RsStyleFormat extends OmitStrict<RsCoreStyleFormat, 'config'> {
+    config: RsStyleFormatConfig;
+}
+/**
+ * A set of props that will be exposed to Cell renderers.
+ *
+ */
+type CellRendererProps = {
+    /** Reference to the cell body element */
+    getElement: () => HTMLElement;
+    /** Styles applicable to current cell. This should be applied to cell renderers.
+     * This is method is only available for data cells.
+     */
+    getStyles?: () => {
+        /**
+         * Foreground color applicable to the cell content, otherwise undefined.
+         *
+         * Note: This will be applied by default to `cell container`(having class `cell-content`) of repeating structures.
+         *
+         * Supports standard CSS color formats like below:
+         * - Named colors: `'red'`, `'blue'`, `'green'`, `'yellow'`, `'black'`, `'white'`, etc.
+         * - Hex codes: `'#RRGGBB'`, `'#RGB'`, `'#RRGGBBAA'`, `'#RGBA'`
+         * - RGB: `'rgb(255, 0, 0)'`
+         * - RGBA: `'rgba(255, 0, 0, 0.5)'`
+         *
+         * Optional
+         */
+        foregroundColor?: string;
+    };
+    /** Formatted value of the cell. */
+    value: ReturnType<ColumnContext['getFormattedValue']>;
+    /** Tooltip value of the cell. */
+    title: ReturnType<ColumnContext['getToolTipValue']>;
+} & ColumnContext & PropsFromRenderFactory;
+type ExternalStateInfo = {
+    /** External state key and its persisted value in the RS state. Supported external state keys are:
+     * - Value of {@link RsCoreTypes.Meta.externalFilters externalFilters}
+     */
+    [externalStateKey: string]: NonNullable<RsCoreTypes.State['externalState']>[''];
+};
+/**
+ * A set of props that will be exposed to View renderer. Supported view renderers are:
+ * - Renderer for {@link RsCoreTypes.Meta.externalFilters externalFilters}
+ */
+type ViewRendererProps = ViewContext & {
+    /** A unique id to identify the current repeating structure. */
+    rsID: RsCoreTypes.View['rsID'];
+} & ExternalStateInfo & PropsFromRenderFactory;
+type RendererProps = CellRendererProps | ViewRendererProps;
+interface RsRenderFactoryReturnType extends OmitStrict<RsCoreTypes.RenderFactoryWithProps, 'component'> {
+    /**
+     * A function that accepts component props and returns a React node to be rendered as a cell within repeating structures.
+     * @param props - The props passed by repeating structures and {@link PropsFromRenderFactory static props } from the render factory.
+     * @returns The component function or null or undefined. If component definition is null/undefined then cell will be rendered directly with value derived for the cell or the formatted value(if {@link RsCoreTypes.RsCoreInitArgs.formatters formatters} are provided for that column)
+     */
+    component: ((props: RendererProps) => ReactNode) | null | undefined;
+}
+export declare namespace RSTypes {
+    /** Group configuration on repeating structure state */
+    type Group = RsCoreTypes.Group;
+    /** Metadata for field */
+    type FieldDef = RsCoreTypes.FieldDef;
+    /** Group filter from the repeating structure state */
+    type GroupFilter = NonNullable<RsCoreTypes.State['groupFilters']>[0];
+    /** Sort configuration on repeating structure state */
+    type Sort = NonNullable<RsCoreTypes.State['sortingOrder']>[0];
+    /** Aggregation types */
+    type AggregationType = NonNullable<RsCoreTypes.State['aggregationInfo']>[0]['type'];
+    /** Aggregation state on the repeating structure */
+    type Aggregation = NonNullable<RsCoreTypes.State['aggregationInfo']>[0];
+    /** A meta data object to provide definition of repeating structure */
+    type Meta = RsCoreTypes.Meta;
+    /** A set of api's to communicate b/w repeating structure and its consumer (e.g. providing data to repeating structure)
+     */
+    type ApiContext = RsCoreTypes.ApiContext;
+    /**
+     * Error object from the repeating structure
+     */
+    type Errors = RsCoreTypes.Errors;
+    /**
+     * State object from the repeating structure
+     */
+    type State = RsCoreTypes.State;
+    /**
+     * Personalized state object from the repeating structure. This state is generally shared to consumer.
+     */
+    type PersonalizedState = RsCoreTypes.PersonalizedState;
+    /** An array of multiple variants of metadata of repeating structures. */
+    type Presets = RsCoreTypes.RsCoreInitArgs['presets'];
+    /** This ref holds functions for manipulating the component after mount */
+    type ImperativeApi = {
+        /**
+         * It is used to trigger re-render of repeating structure and force re-fetch data and re-fetch selections using apiContext.getSelectedRows api(if any of the selection mode is enabled).
+         * @returns {void} void
+         */
+        refreshView: rsUtilityCallbacks['forceRefresh'];
+        /** Sets the number of rows */
+        setRecordCount: rsUtilityCallbacks['setRecordCount'];
+        /**
+         * It is used to trigger specific actions to the Repeating structures with a specific payload. Actions supported:
+         * - {@link CLEAR_DATA_REFRESH_NOTIFICATION}
+         * - {@link TOGGLE_DISABLE_SELECTION}
+         * - {@link TOGGLE_REQUIRED}
+         * - {@link UPDATE_DEBUG_INFO}
+         * - {@link NOTIFY_DATA_REFRESH}
+         * - {@link USER_CONFIRMATION_ACTION}
+         * - {@link UPDATE_SELECTED_ROWS}<br>
+         *
+         * Refer [dispatchAction](https://git.pega.io/projects/PS/repos/ui-lists-lib/browse/packages/RepeatingStructures/README.md?useDefaultHandler=true#152) documentation for more details.
+         * @param {string} action - Action type that needs to be dispatched to Repeating structures.
+         * @param {string | boolean | Object } [payload] - An optional payload for a given action.
+         * @returns {void} void
+         */
+        dispatchAction: rsUtilityCallbacks['dispatchAction'];
+        /** Returns info of current active view */
+        getActiveViewInfo: () => ActiveViewInfo;
+        /** Sets the hiddenColumns property in component state and rerenders with features appropriately
+         * @param columns an array of fieldDefs {@link FieldDef.id id} for respective column
+         * @param ootbColumns an optional payload that can be used for hidding and showing the columns provided by repeating structure
+         * @param {boolean} [ootbColumns.dragHandle] boolean that can be used to hide the dragdrop column
+         */
+        setHiddenColumns?: (columns: string[], ootbColumns: {
+            dragHandle: boolean;
+        }) => void;
+        /** Sets the colOrder property in component state and rerenders with features appropriately
+         * @param columns an array of fieldDefs {@link FieldDef.id id} for respective column
+         */
+        setColumnOrder?: (columns: string[]) => void;
+        /** Sets the filterExpression property in component state and rerenders with features appropriately */
+        setFilter: (filter: Condition | undefined) => void;
+        /** Sets the groups property in component state and rerenders with features appropriately */
+        setGrouping?: (groups: Group[]) => void;
+        /** Sets the sortingOrder property in component state and rerenders with features appropriately */
+        setSorting: (sorts: NonNullable<State['sortingOrder']>) => void;
+        /** Sets the aliases on columns */
+        setAliases: (aliases: {
+            [columnId: string]: string;
+        }) => void;
+        /** Sets the aggregationInfo property in component state and rerenders with features appropriately */
+        setAggregations: (agg: Aggregation[]) => void;
+        /** Sets the visibility of {@link Meta.rowReorderField rowReorderField} if enabled. */
+        setRowReorderFieldVisibility: (visibility: boolean) => void;
+        /** Updates the visibility of {@link columns}. */
+        updateColumnsVisibility: (columns: {
+            [key: FieldDef['id']]: boolean;
+        }) => void;
+        /** Updates the conditional style formats in component state. */
+        setConditionalStyleFormats: (conditionalStyleFormats: NonNullable<State['conditionalStyleFormats']>) => void;
+    };
+    type ActiveViewInfo = {
+        id: string;
+        name: string;
+        isDirty: boolean;
+    };
+    type rsUtilityCallbacks = Parameters<NonNullable<RSTypes.ApiContext['addCallbacks']>>[0];
+    /** Represents a row in Repeating structures */
+    type RowData = RsCoreTypes.RowData;
+}
+/**
+ * Props for the repeating structure component
+ */
+export type RepeatingStructuresProps = {
+    /** A imperative handle ref object to which repeating structures attach some api's to interact with repeating structure component after mount. */
+    ref?: RefObject<RSTypes.ImperativeApi | undefined>;
+    /** An initial state that can be provided to repeating structure to load repeating structure instance with that state.\
+     * **Note**: If {@link RSTypes.Meta.personalization personalization} in meta is set to true then persistedInfo will be ignored. */
+    persistedInfo?: RSTypes.PersonalizedState;
+    /** A meta data object to provide definition of repeating structure */
+    meta: RSTypes.Meta;
+    /** A set of api's provided to repeating structure to establish communication b/w repeating structure and its consumer (e.g. providing data to repeating structure) */
+    apiContext: RSTypes.ApiContext;
+    /** To provide multiple variants of metadata of repeating structures. If multiple variations is provided make sure the first variation should be part of {@link RepeatingStructuresProps.meta meta} key and rest all should be fed to presets. */
+    presets?: RSTypes.Presets;
+    /** A debug mode will print logs in console for the action dispatched by RsCore and the state derived after consumption of it. */
+    mode?: 'info' | 'debug' | 'normal';
+    errors?: RSTypes.Errors;
+    /** This should be a factory function that returns component or component definition for specified type.
+     * @param type -
+     * - For cell renderer - Value of {@link RsCoreTypes.FieldDef.cellRenderer cellRenderer}(if added in fieldDefs of that column).
+     * - For view renderer - Value of supported external view renderers in `Meta`. Supported view renderer is {@link RsCoreTypes.Meta.externalFilters externalFilters}.
+     *
+     * @param field - Metadata which contains info configured for that column. Applicable only in case of `cell renderer`.
+     * @returns It should return a component definition (or an object that contains component definition).
+     * This component definition will be used by RepeatingStructures to render a cell with the component provided by renderFactory.
+     * If component definition is not provided from render factory or renderFactory is not provided to Repeating structures then cell will be rendered directly with value derived for the cell or the formatted value(if {@link RsCoreTypes.RsCoreInitArgs.formatters formatters} are provided for that column)
+     */
+    renderFactory?: (type: string, field?: RSTypes.FieldDef) => Pick<RsRenderFactoryReturnType, 'component'> | RsRenderFactoryReturnType;
+    /** A map of formatters that will be displayed to consumer to format a fieldDef in repeating structure */
+    renderFormatterTypeMap?: RsCoreTypes.RsCoreInitArgs['renderFormatterTypeMap'];
+    /**
+     * This function acts as a callback that is invoked when the view is ready
+     * @param utilityCallbacks - Few utility callbacks to interact with Repeating structures.
+     * @returns {void} void
+     */
+    onViewReady?: (utilityCallbacks: Pick<RsCoreTypes.View['type'], 'setRecordCount' | 'dispatchAction'>) => void;
+    /** An object of formatter functions which formats the raw value. */
+    formatters?: RsCoreTypes.RsCoreInitArgs['formatters'];
+    /** A set of style formatters to be applied on FieldDef. E.g. background, icon.
+     *
+     * **Note**: Style formats are only supported for `Table` template.
+     */
+    styleFormats?: RsStyleFormat[];
+    /** A list of all the toolbar actions to be displayed at the top of a repeating structure */
+    toolBarOptions?: RsCoreTypes.RsCoreInitArgs['toolBarOptions'];
+    /**
+     * This function is provided as ui props in row generator to attach it as click handler to a row in repeating structure
+     * @param {RsCoreTypes.RowData} data - current row data
+     * @returns {void} void
+     */
+    onRowClickAction?: RsCoreTypes.RsCoreInitArgs['onRowClickAction'];
+    /** Pass a heading and content to show additional information in the toolbar */
+    additionalInfo?: FormControlProps['additionalInfo'];
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAEtF,KAAK,aAAa,GAAG,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;AAClE,KAAK,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;AAC9D,KAAK,iBAAiB,GAAG,WAAW,CAAC,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AACzF,KAAK,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;AAChF,UAAU,mBAAoB,SAAQ,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACnF,IAAI,EAAE;QACJ,yEAAyE;QACzE,IAAI,EAAE,QAAQ,CAAC;QACf,yBAAyB;QACzB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAGD,MAAM,WAAW,aAAc,SAAQ,UAAU,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAC5E,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAGD;;;GAGG;AACH,KAAK,iBAAiB,GAAG;IACvB,yCAAyC;IACzC,UAAU,EAAE,MAAM,WAAW,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM;QAChB;;;;;;;;;;;;WAYG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,mCAAmC;IACnC,KAAK,EAAE,UAAU,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtD,iCAAiC;IACjC,KAAK,EAAE,UAAU,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC;CACrD,GAAG,aAAa,GACf,sBAAsB,CAAC;AAGzB,KAAK,iBAAiB,GAAG;IACvB;;OAEG;IACH,CAAC,gBAAgB,EAAE,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;CACjF,CAAC;AAEF;;;GAGG;AACH,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACrC,+DAA+D;IAC/D,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;CAChC,GAAG,iBAAiB,GACnB,sBAAsB,CAAC;AAEzB,KAAK,aAAa,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAI3D,UAAU,yBACR,SAAQ,UAAU,CAAC,WAAW,CAAC,sBAAsB,EAAE,WAAW,CAAC;IACnE;;;;OAIG;IACH,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE,aAAa,KAAK,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;CACrE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAE/B,uDAAuD;IACvD,KAAY,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAEtC,yBAAyB;IACzB,KAAY,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;IAE5C,sDAAsD;IACtD,KAAY,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E,sDAAsD;IACtD,KAAY,IAAI,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAErE,wBAAwB;IACxB,KAAY,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAE3F,mDAAmD;IACnD,KAAY,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/E,sEAAsE;IACtE,KAAY,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;IAEpC;OACG;IACH,KAAY,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC;IAEhD;;OAEG;IACH,KAAY,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAExC;;OAEG;IACH,KAAY,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IACtC;;OAEG;IACH,KAAY,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAC;IAC9D,yEAAyE;IACzE,KAAY,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAE5D,0EAA0E;IAC1E,KAAY,aAAa,GAAG;QAC1B;;;WAGG;QACH,WAAW,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAChD,8BAA8B;QAC9B,cAAc,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QACrD;;;;;;;;;;;;;;WAcG;QACH,cAAc,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QACrD,0CAA0C;QAC1C,iBAAiB,EAAE,MAAM,cAAc,CAAC;QACxC;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE;YAAE,UAAU,EAAE,OAAO,CAAA;SAAE,KAAK,IAAI,CAAC;QACrF;;WAEG;QACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;QAC7C,sGAAsG;QACtG,SAAS,EAAE,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,KAAK,IAAI,CAAC;QACnD,4FAA4F;QAC5F,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;QACxC,kGAAkG;QAClG,UAAU,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,KAAK,IAAI,CAAC;QAChE,kCAAkC;QAClC,UAAU,EAAE,CAAC,OAAO,EAAE;YAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QAC9D,qGAAqG;QACrG,eAAe,EAAE,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;QAC9C,sFAAsF;QACtF,4BAA4B,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;QAC5D,iDAAiD;QACjD,uBAAuB,EAAE,CAAC,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;SAAE,KAAK,IAAI,CAAC;QAC/E,gEAAgE;QAChE,0BAA0B,EAAE,CAC1B,uBAAuB,EAAE,WAAW,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,KACnE,IAAI,CAAC;KACX,CAAC;IAGF,KAAK,cAAc,GAAG;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IAGF,KAAK,kBAAkB,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzF,+CAA+C;IAC/C,KAAY,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;CAC3C;AACD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,iJAAiJ;IACjJ,GAAG,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAEnD;sIACkI;IAClI,aAAa,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAE1C,sEAAsE;IACtE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC;IAEnB,sKAAsK;IACtK,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC;IAE/B,iPAAiP;IACjP,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;IAE1B,iIAAiI;IACjI,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAEnC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CACd,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,KACrB,IAAI,CAAC,yBAAyB,EAAE,WAAW,CAAC,GAAG,yBAAyB,CAAC;IAE9E,yGAAyG;IACzG,sBAAsB,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAE9E;;;;OAIG;IACH,WAAW,CAAC,EAAE,CACZ,gBAAgB,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,KAClF,IAAI,CAAC;IAEV,oEAAoE;IACpE,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IAEtD;;;OAGG;IACH,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAE/B,4FAA4F;IAC5F,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAE9D;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAElE,+EAA+E;IAC/E,cAAc,CAAC,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CACrD,CAAC"}

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ReactNode, RefObject } from 'react';\n\nimport type { Condition } from '@pega/cosmos-react-condition-builder';\nimport type { RsCoreTypes } from 'pega-repeating-structures-core';\nimport type { FormControlProps, IconName, OmitStrict } from '@pega/cosmos-react-core';\n\ntype ColumnContext = ReturnType<RsCoreTypes.Column['getContext']>;\ntype ViewContext = ReturnType<RsCoreTypes.View['getContext']>;\ntype RsCoreStyleFormat = NonNullable<RsCoreTypes.RsCoreInitArgs['styleFormats']>[number];\ntype PropsFromRenderFactory = Pick<RsCoreTypes.RenderFactoryWithProps, 'props'>;\ninterface RsStyleFormatConfig extends OmitStrict<RsCoreStyleFormat['config'], 'icon'> {\n  icon: {\n    /** An icon from set of icons available from cosmos for current theme. */\n    name: IconName;\n    /** The color of icon. */\n    color: string;\n  };\n}\n\n// RS can only accept icons that are supported in cosmos, while RsCore accepts icon generically, therefore overriding the interface.\nexport interface RsStyleFormat extends OmitStrict<RsCoreStyleFormat, 'config'> {\n  config: RsStyleFormatConfig;\n}\n\n// Contract for Cell renderer props.\n/**\n * A set of props that will be exposed to Cell renderers.\n *\n */\ntype CellRendererProps = {\n  /** Reference to the cell body element */\n  getElement: () => HTMLElement;\n  /** Styles applicable to current cell. This should be applied to cell renderers.\n   * This is method is only available for data cells.\n   */\n  getStyles?: () => {\n    /**\n     * Foreground color applicable to the cell content, otherwise undefined.\n     *\n     * Note: This will be applied by default to `cell container`(having class `cell-content`) of repeating structures.\n     *\n     * Supports standard CSS color formats like below:\n     * - Named colors: `'red'`, `'blue'`, `'green'`, `'yellow'`, `'black'`, `'white'`, etc.\n     * - Hex codes: `'#RRGGBB'`, `'#RGB'`, `'#RRGGBBAA'`, `'#RGBA'`\n     * - RGB: `'rgb(255, 0, 0)'`\n     * - RGBA: `'rgba(255, 0, 0, 0.5)'`\n     *\n     * Optional\n     */\n    foregroundColor?: string;\n  };\n  /** Formatted value of the cell. */\n  value: ReturnType<ColumnContext['getFormattedValue']>;\n  /** Tooltip value of the cell. */\n  title: ReturnType<ColumnContext['getToolTipValue']>;\n} & ColumnContext &\n  PropsFromRenderFactory;\n\n// Contract for View renderer props.\ntype ExternalStateInfo = {\n  /** External state key and its persisted value in the RS state. Supported external state keys are:\n   * - Value of {@link RsCoreTypes.Meta.externalFilters externalFilters}\n   */\n  [externalStateKey: string]: NonNullable<RsCoreTypes.State['externalState']>[''];\n};\n\n/**\n * A set of props that will be exposed to View renderer. Supported view renderers are:\n * - Renderer for {@link RsCoreTypes.Meta.externalFilters externalFilters}\n */\ntype ViewRendererProps = ViewContext & {\n  /** A unique id to identify the current repeating structure. */\n  rsID: RsCoreTypes.View['rsID'];\n} & ExternalStateInfo &\n  PropsFromRenderFactory;\n\ntype RendererProps = CellRendererProps | ViewRendererProps;\n\n// RsCore exposes generic function types for `component`.\n// For RepeatingStructures, these types are overridden to include additional renderer props, and the return type is specified as ReactNode.\ninterface RsRenderFactoryReturnType\n  extends OmitStrict<RsCoreTypes.RenderFactoryWithProps, 'component'> {\n  /**\n   * A function that accepts component props and returns a React node to be rendered as a cell within repeating structures.\n   * @param props - The props passed by repeating structures and {@link PropsFromRenderFactory static props } from the render factory.\n   * @returns The component function or null or undefined. If component definition is null/undefined then cell will be rendered directly with value derived for the cell or the formatted value(if {@link RsCoreTypes.RsCoreInitArgs.formatters formatters} are provided for that column)\n   */\n  component: ((props: RendererProps) => ReactNode) | null | undefined;\n}\n\nexport declare namespace RSTypes {\n  // Exported members\n  /** Group configuration on repeating structure state */\n  export type Group = RsCoreTypes.Group;\n\n  /** Metadata for field */\n  export type FieldDef = RsCoreTypes.FieldDef;\n\n  /** Group filter from the repeating structure state */\n  export type GroupFilter = NonNullable<RsCoreTypes.State['groupFilters']>[0];\n\n  /** Sort configuration on repeating structure state */\n  export type Sort = NonNullable<RsCoreTypes.State['sortingOrder']>[0];\n\n  /** Aggregation types */\n  export type AggregationType = NonNullable<RsCoreTypes.State['aggregationInfo']>[0]['type'];\n\n  /** Aggregation state on the repeating structure */\n  export type Aggregation = NonNullable<RsCoreTypes.State['aggregationInfo']>[0];\n\n  /** A meta data object to provide definition of repeating structure */\n  export type Meta = RsCoreTypes.Meta;\n\n  /** A set of api's to communicate b/w repeating structure and its consumer (e.g. providing data to repeating structure)\n   */\n  export type ApiContext = RsCoreTypes.ApiContext;\n\n  /**\n   * Error object from the repeating structure\n   */\n  export type Errors = RsCoreTypes.Errors;\n\n  /**\n   * State object from the repeating structure\n   */\n  export type State = RsCoreTypes.State;\n  /**\n   * Personalized state object from the repeating structure. This state is generally shared to consumer.\n   */\n  export type PersonalizedState = RsCoreTypes.PersonalizedState;\n  /** An array of multiple variants of metadata of repeating structures. */\n  export type Presets = RsCoreTypes.RsCoreInitArgs['presets'];\n\n  /** This ref holds functions for manipulating the component after mount */\n  export type ImperativeApi = {\n    /**\n     * It is used to trigger re-render of repeating structure and force re-fetch data and re-fetch selections using apiContext.getSelectedRows api(if any of the selection mode is enabled).\n     * @returns {void} void\n     */\n    refreshView: rsUtilityCallbacks['forceRefresh'];\n    /** Sets the number of rows */\n    setRecordCount: rsUtilityCallbacks['setRecordCount'];\n    /**\n     * It is used to trigger specific actions to the Repeating structures with a specific payload. Actions supported:\n     * - {@link CLEAR_DATA_REFRESH_NOTIFICATION}\n     * - {@link TOGGLE_DISABLE_SELECTION}\n     * - {@link TOGGLE_REQUIRED}\n     * - {@link UPDATE_DEBUG_INFO}\n     * - {@link NOTIFY_DATA_REFRESH}\n     * - {@link USER_CONFIRMATION_ACTION}\n     * - {@link UPDATE_SELECTED_ROWS}<br>\n     *\n     * Refer [dispatchAction](https://git.pega.io/projects/PS/repos/ui-lists-lib/browse/packages/RepeatingStructures/README.md?useDefaultHandler=true#152) documentation for more details.\n     * @param {string} action - Action type that needs to be dispatched to Repeating structures.\n     * @param {string | boolean | Object } [payload] - An optional payload for a given action.\n     * @returns {void} void\n     */\n    dispatchAction: rsUtilityCallbacks['dispatchAction'];\n    /** Returns info of current active view */\n    getActiveViewInfo: () => ActiveViewInfo;\n    /** Sets the hiddenColumns property in component state and rerenders with features appropriately\n     * @param columns an array of fieldDefs {@link FieldDef.id id} for respective column\n     * @param ootbColumns an optional payload that can be used for hidding and showing the columns provided by repeating structure\n     * @param {boolean} [ootbColumns.dragHandle] boolean that can be used to hide the dragdrop column\n     */\n    setHiddenColumns?: (columns: string[], ootbColumns: { dragHandle: boolean }) => void;\n    /** Sets the colOrder property in component state and rerenders with features appropriately\n     * @param columns an array of fieldDefs {@link FieldDef.id id} for respective column\n     */\n    setColumnOrder?: (columns: string[]) => void;\n    /** Sets the filterExpression property in component state and rerenders with features appropriately */\n    setFilter: (filter: Condition | undefined) => void;\n    /** Sets the groups property in component state and rerenders with features appropriately */\n    setGrouping?: (groups: Group[]) => void;\n    /** Sets the sortingOrder property in component state and rerenders with features appropriately */\n    setSorting: (sorts: NonNullable<State['sortingOrder']>) => void;\n    /** Sets the aliases on columns */\n    setAliases: (aliases: { [columnId: string]: string }) => void;\n    /** Sets the aggregationInfo property in component state and rerenders with features appropriately */\n    setAggregations: (agg: Aggregation[]) => void;\n    /** Sets the visibility of {@link Meta.rowReorderField rowReorderField} if enabled. */\n    setRowReorderFieldVisibility: (visibility: boolean) => void;\n    /** Updates the visibility of {@link columns}. */\n    updateColumnsVisibility: (columns: { [key: FieldDef['id']]: boolean }) => void;\n    /** Updates the conditional style formats in component state. */\n    setConditionalStyleFormats: (\n      conditionalStyleFormats: NonNullable<State['conditionalStyleFormats']>\n    ) => void;\n  };\n\n  // Non-exported members\n  type ActiveViewInfo = {\n    id: string;\n    name: string;\n    isDirty: boolean;\n  };\n\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  type rsUtilityCallbacks = Parameters<NonNullable<RSTypes.ApiContext['addCallbacks']>>[0];\n\n  /** Represents a row in Repeating structures */\n  export type RowData = RsCoreTypes.RowData;\n}\n/**\n * Props for the repeating structure component\n */\nexport type RepeatingStructuresProps = {\n  /** A imperative handle ref object to which repeating structures attach some api's to interact with repeating structure component after mount. */\n  ref?: RefObject<RSTypes.ImperativeApi | undefined>;\n\n  /** An initial state that can be provided to repeating structure to load repeating structure instance with that state.\\\n   * **Note**: If {@link RSTypes.Meta.personalization personalization} in meta is set to true then persistedInfo will be ignored. */\n  persistedInfo?: RSTypes.PersonalizedState;\n\n  /** A meta data object to provide definition of repeating structure */\n  meta: RSTypes.Meta;\n\n  /** A set of api's provided to repeating structure to establish communication b/w repeating structure and its consumer (e.g. providing data to repeating structure) */\n  apiContext: RSTypes.ApiContext;\n\n  /** To provide multiple variants of metadata of repeating structures. If multiple variations is provided make sure the first variation should be part of {@link RepeatingStructuresProps.meta meta} key and rest all should be fed to presets. */\n  presets?: RSTypes.Presets;\n\n  /** A debug mode will print logs in console for the action dispatched by RsCore and the state derived after consumption of it. */\n  mode?: 'info' | 'debug' | 'normal';\n\n  errors?: RSTypes.Errors;\n\n  /** This should be a factory function that returns component or component definition for specified type.\n   * @param type -\n   * - For cell renderer - Value of {@link RsCoreTypes.FieldDef.cellRenderer cellRenderer}(if added in fieldDefs of that column).\n   * - For view renderer - Value of supported external view renderers in `Meta`. Supported view renderer is {@link RsCoreTypes.Meta.externalFilters externalFilters}.\n   *\n   * @param field - Metadata which contains info configured for that column. Applicable only in case of `cell renderer`.\n   * @returns It should return a component definition (or an object that contains component definition).\n   * This component definition will be used by RepeatingStructures to render a cell with the component provided by renderFactory.\n   * If component definition is not provided from render factory or renderFactory is not provided to Repeating structures then cell will be rendered directly with value derived for the cell or the formatted value(if {@link RsCoreTypes.RsCoreInitArgs.formatters formatters} are provided for that column)\n   */\n  renderFactory?: (\n    type: string,\n    field?: RSTypes.FieldDef\n  ) => Pick<RsRenderFactoryReturnType, 'component'> | RsRenderFactoryReturnType;\n\n  /** A map of formatters that will be displayed to consumer to format a fieldDef in repeating structure */\n  renderFormatterTypeMap?: RsCoreTypes.RsCoreInitArgs['renderFormatterTypeMap'];\n\n  /**\n   * This function acts as a callback that is invoked when the view is ready\n   * @param utilityCallbacks - Few utility callbacks to interact with Repeating structures.\n   * @returns {void} void\n   */\n  onViewReady?: (\n    utilityCallbacks: Pick<RsCoreTypes.View['type'], 'setRecordCount' | 'dispatchAction'>\n  ) => void;\n\n  /** An object of formatter functions which formats the raw value. */\n  formatters?: RsCoreTypes.RsCoreInitArgs['formatters'];\n\n  /** A set of style formatters to be applied on FieldDef. E.g. background, icon.\n   *\n   * **Note**: Style formats are only supported for `Table` template.\n   */\n  styleFormats?: RsStyleFormat[];\n\n  /** A list of all the toolbar actions to be displayed at the top of a repeating structure */\n  toolBarOptions?: RsCoreTypes.RsCoreInitArgs['toolBarOptions'];\n\n  /**\n   * This function is provided as ui props in row generator to attach it as click handler to a row in repeating structure\n   * @param {RsCoreTypes.RowData} data - current row data\n   * @returns {void} void\n   */\n  onRowClickAction?: RsCoreTypes.RsCoreInitArgs['onRowClickAction'];\n\n  /** Pass a heading and content to show additional information in the toolbar */\n  additionalInfo?: FormControlProps['additionalInfo'];\n};\n"]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@pega/lists-react",
+  "version": "8.0.0-build.27.14",
+  "description": "Repeating view structures such as Table, Gallery(Repeating layouts), Kanban etc.",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Pegasystems",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "SECURITY.md"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json"
+  },
+  "dependencies": {
+    "@pega/cosmos-react-condition-builder": "8.0.0-build.27.14",
+    "@pega/cosmos-react-core": "8.0.0-build.27.14",
+    "@pega/cosmos-react-rte": "8.0.0-build.27.14",
+    "@pega/cosmos-react-work": "8.0.0-build.27.14",
+    "@types/lodash.get": "^4.4.9",
+    "@types/react": "^17.0.62 || ^18.3.3",
+    "@types/react-dom": "^17.0.20 || ^18.3.0",
+    "@types/uuid": "^9.0.0",
+    "dayjs": "^1.11.10",
+    "fast-deep-equal": "^3.1.3",
+    "lodash.get": "^4.4.2",
+    "pega-repeating-structures-core": "npm:@pega/lists-core@8.0.0-build.27.14",
+    "pega-ui-list-data-apis": "npm:@pega/lists-core-utils@8.0.0-build.27.14",
+    "polished": "^4.1.0",
+    "prop-types": "^15.8.1",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "styled-components": "^5.2.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@storybook/addon-coverage": "^1.0.4",
+    "@storybook/addon-interactions": "~8.2.9",
+    "@storybook/preview-api": "~8.2.9",
+    "@storybook/react": "~8.2.9",
+    "@storybook/test": "~8.2.9",
+    "@storybook/test-runner": "^0.19.1",
+    "@storybook/theming": "~8.2.9",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/user-event": "^14.5.1",
+    "jest-axe": "^8.0.0",
+    "srs-utils": "8.0.0-build.27.14",
+    "typescript": "~5.5.4"
+  }
+}