@pega/lists-core 8.0.0-build.27.14

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

@@ -0,0 +1,316 @@
+import type { OmitStrict } from '@pega/cosmos-react-core';
+import type { ModalManagerContextValue } from '@pega/cosmos-react-core/lib/components/Modal/Modal.types';
+import type RsInternal from '../RsInternal';
+import type { SupportedConsumerActionType } from '../actions/actionConstants';
+import type { Errors, State } from '../../../types/State.types';
+import type { FieldDef, ROW_DENSITY } from '../../../types/Meta.types';
+import type { ActionMeta, ColumnFilteringActionPayload, ExpandCollapsePayload, PaginationPayload } from '../actions/actions.types';
+import type View from './ViewGenerator';
+export type SupportedConsumerPayloads = boolean | NonNullable<View['requiredDef']> | NonNullable<View['debugInfo']>[number] | OmitStrict<NonNullable<View['confirmationActionDetails']>, 'onSubmit' | 'onCancel'> | NonNullable<State['externalState']> | Pick<NonNullable<State['forceUpdateFeatures']>, 'updateSelectedRows'>;
+export default function viewUtilityMethods(rsInternal: RsInternal): {
+    /**
+     * Dispatches an action that creates a new state object without any internal modifications.
+     *
+     * If {@link instantRender} is false and {@link forceUpdateFeatures} are provided,
+     * it updates the {@link State.forceUpdateFeatures forceUpdateFeatures} slice in the state.
+     *
+     * @param instantRender - Determines if the render should happen instantly.
+     * @param forceUpdateFeatures - The features to force update in the state on next render cycle.
+     */
+    forceUpdate(instantRender?: boolean, forceUpdateFeatures?: State["forceUpdateFeatures"]): void;
+    /**
+     * Handles the reordering of rows.
+     *
+     * If {@link Meta.moveListRecords moveListRecords} is set to true in Meta, it dispatches an action
+     * that updates the keys of the {@link sourceKey source} row and the {@link destinationKey destination} row
+     * in the {@link State.sourceKey sourceKey} and {@link State.destinationKey destinationKey} state slices, respectively.
+     *
+     * Otherwise, it calls {@link ApiContext.applyRowReorder applyRowReorder} from the apiContext and triggers
+     * a {@link utilMethods.forceRefresh forceRefresh} on the state.
+     *
+     * @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;
+    /**
+     * Sets the count-related information onto the {@link View view} via {@link View.setProp setProp} and triggers {@link utilMethods.forceUpdate forceUpdate}.
+     *
+     * @param args - The count information object.
+     * @param args.count - The total record count of the view, including group headers.
+     * @param args.hasMoreResults - Indicates if the view has more records.
+     * @param args.selectedRecordsCount - The total count of selected records.
+     * @param args._countGeneratedInternally - Indicates if the count is generated internally. This is used for RS core internal purposes. Setting this from apiContext might lead to erroneous behavior.
+     * @returns void
+     */
+    setRecordCount({ count, hasMoreResults, selectedRecordsCount, _countGeneratedInternally }: {
+        count?: View["totalItemCount"];
+        hasMoreResults?: View["hasMoreTotalRecords"];
+        selectedRecordsCount?: View["selectedRecordsCount"];
+        _countGeneratedInternally?: View["countGeneratedInternally"];
+    }): void;
+    /**
+     * Dispatches an action to interact with repeating structures, allowing consumers
+     * to perform operations using standard actions and payloads.
+     *
+     * @param action The action to be dispatched.
+     * @param payload The payload associated with the action.
+     * @returns The return value after the action has been processed by the repeating structure.
+     */
+    dispatchAction(action: SupportedConsumerActionType, payload?: SupportedConsumerPayloads): Promise<any> | undefined;
+    /** Returns the Html events required for reordering a column. */
+    getFieldReorderProps(): import("./ColumnGenerator.types").ColumnReorderProps | null;
+    /**
+     * Triggers the expand or collapse action for a group header.
+     * Dispatches an action to update the {@link State.groupToggle groupToggle} slices in the state.
+     *
+     * @param payload The data related to the groups.
+     */
+    toggleGroupExpansion(payload: OmitStrict<ExpandCollapsePayload, "groups">): void;
+    /**
+     * Clears hierarchical groups by dispatching an action to reset the {@link State.hierarchicalGroup hierarchicalGroup} slice in the state.
+     */
+    clearHierarchicalGroup(): void;
+    /**
+     * Dispatches a pagination action to update {@link State.paginationOptions paginationOptions} in the state slice.
+     *
+     * @param payload - The pagination options to update.
+     * @param actionMeta - The action metadata.
+     */
+    onPaginate(payload: PaginationPayload, actionMeta?: ActionMeta): void;
+    /**
+     * Removes a notification message.
+     * Dispatches an action to update the {@link State.notifications notifications} slice in the state.
+     *
+     * @param payload The notification messages to be removed.
+     */
+    removeNotification(payload: string[]): void;
+    /**
+     * Applies a filter to the repeating structures.
+     * Dispatches an action that updates the {@link State.filterExpression filterExpression} in the state.
+     *
+     * @param params The filter expression to apply.
+     */
+    applyFilter(params: ColumnFilteringActionPayload): void;
+    /**
+     * Dispatches an action to replace the {@link State.columnAlias columnAlias} slice in the state.
+     *
+     * @param params - Parameters for the action. Specify the necessary details.
+     */
+    applyAliases(params: NonNullable<State["columnAlias"]>): void;
+    /**
+     * Clears filters for the specified {@link columnId}.
+     * Dispatches an action to update the {@link State.clearColFilter clearColFilter} slice in the state.
+     * @param columnId - The column on which the filter should be cleared.
+     */
+    clearFilter(columnId: string): void;
+    /**
+     * Applies grouping to repeating structures.
+     * Dispatches an action that adds {@link State.groups groups} in the state.
+     * @param payload
+     */
+    applyGrouping(payload: NonNullable<State["groups"]>): void;
+    /**
+     * Applies sorting the repeating structures.
+     * Dispatches an action that adds {@link State.sortingOrder sortingOrder} in state.
+     * @param payload
+     */
+    applySorting(payload: NonNullable<State["sortingOrder"]>): void;
+    /**
+     * Toggles the visibility of header icons.
+     * Dispatches an action to update {@link State.showHeaderIcons} in the state.
+     *
+     * @param status The status indicating whether to show or hide header icons.
+     */
+    updateHeaderIconsVisibility(status: NonNullable<State["showHeaderIcons"]>): void;
+    /**
+     * Applies freezing to a set of columns.
+     * Dispatches an action to update {@link State.freezeColumns freezeColumns} in the state.
+     *
+     * @param payload The payload containing information about the columns to freeze.
+     */
+    applyFreeze(payload: string[]): void;
+    /**
+     * Toggles the visibility of columns.
+     * Dispatches an action that updates {@link State.hiddenColumns hiddenColumns} in the state.
+     * @param payload
+     */
+    applyToggleVisibility(payload: string[]): void;
+    /**
+     * Sets the {@link State.hiddenColumns hiddenColumns} in the state, including out-of-the-box columns like dragHandle.
+     *
+     * @param payload - The payload containing columns to hide.
+     * @param ootbColumns - The out-of-the-box columns to include in {@link State.hiddenColumns hiddenColumns}.
+     */
+    applyHiddenColumns(payload: string[], ootbColumns: {
+        dragHandle?: boolean;
+    }): void;
+    /**
+     * Dispatches an action that replace {@link State.aggregationInfo aggregationInfo} slice in the state with the given {@link payload}.
+     * @param payload
+     */
+    applyAggregations(payload: NonNullable<State["aggregationInfo"]>): void;
+    /**
+     * Applies order to columns of a repeatings structure with the given {@link payload}.
+     * Dispatches an action that sets {@link State.colOrder columnOrder} in the state with the given {@link payload}.
+     * @param payload
+     */
+    applyOrder(payload: string[]): void;
+    /**
+     * Saves the current personalization state.
+     * Dispatches an action that invokes {@link ApiContext.updatePersonalization} to persist the changes.
+     *
+     * @param personalizationKey The key representing the current personalization.
+     * @param markAsDefault Whether to mark the current personalization as default.
+     * @param markAsAppDefault Whether to mark the current personalization as app default.
+     */
+    updatePersonalization(personalizationKey: string, markAsDefault: boolean, markAsAppDefault: boolean): void;
+    /**
+     * Sets the selected personalization state as the current state of the repeating structures.
+     * Dispatches an action to update the {@link State} of the repeating structures with the selected personalization state,
+     * and updates the active personalization in the {@link State.personalization personalization} state slice.
+     *
+     * @param args Method arguments.
+     * @param args.id ID of the personalization to be set active.
+     * @param args.isPreset Indicates if the personalization is preset.
+     */
+    applyActivePersonalization({ id, isPreset }: {
+        id: string;
+        isPreset: boolean;
+    }): void;
+    /**
+     * Creates a new personalization in the state.
+     * Dispatches an action that calls {@link ApiContext.createPersonalization createPersonalization} API to create
+     * a new personalization with the provided name and saves it in the {@link State.personalization personalization}.
+     *
+     * @param name The name of the personalization.
+     * @param markAsDefault Indicates whether the new personalization should be marked as default.
+     */
+    createPersonalization(name: string, markAsDefault: boolean): void;
+    /**
+     * Updates the name, markAsDefault, and markAsAppDefault flags of the current personalization.
+     *
+     * @param active The current active personalization key.
+     * @param name The updated name.
+     * @param markAsDefault Indicates whether the current personalization should be marked as default.
+     * @param markAsAppDefault Indicates whether the current personalization should be marked as app default.
+     */
+    editPersonalization(active: string, name: string, markAsDefault: boolean, markAsAppDefault: boolean): void;
+    /**
+     * Deletes the current personalization identified by the given key.
+     * Dispatches an action that calls {@link ApiContext.deletePersonalization deletePersonalization} API
+     * and updates the {@link State.personalization personalization} state by removing the deleted personalization.
+     *
+     * @param personalizationKey - The key or ID of the personalization to be deleted.
+     */
+    deletePersonalization(personalizationKey: string): void;
+    /**
+     * Sets the current personalization key as the default personalization.
+     * Dispatches an action to update `defaultPersonalization` in the `personalization` state slice
+     * and calls {@link ApiContext.updatePersonalization updatePersonalization} API.
+     *
+     * @param personalizationKey - The key identifying the personalization to set as default.
+     */
+    setDefaultPersonalization(personalizationKey: string): void;
+    /**
+     * Sets the current {@link personalizationKey} as the app's default personalization.
+     * Dispatches an action that invokes {@link ApiContext.updatePersonalization updatePersonalization} api with markAsAppDefault=true for the current personalization.
+     *
+     * @param personalizationKey The key of the personalization to set as default.
+     * @param trimmedName The name of the personalization to update.
+     */
+    setAppDefaultPersonalization(personalizationKey: string, trimmedName: string): void;
+    /**
+     * Applies the provided search value as a filter expression in the state,
+     * using an OR condition with a contains clause.
+     *
+     * @param value The search value to apply.
+     */
+    applySearch(value: string): void;
+    /**
+     * Applies the given row density in {@link State.selectedHeightOption selectedHeightOption} state slice.
+     *
+     * @param payload the row density id.
+     */
+    applyRowHeight(payload: (typeof ROW_DENSITY)[keyof typeof ROW_DENSITY]): void;
+    /**
+     * Sets the {@link State.bootstrap bootstrap} status of repeating structures and update the {@link State.version version}in state.
+     */
+    doBootstrap(): void;
+    /**
+     * Triggers a refresh of data in repeating structures.
+     * Dispatches an action that injects {@link State.refresh refresh} flag in the state.
+     * @param flushState The state slice that needs to be reset on refresh. See {@link SUPPORTED_AVOIDABLE_FEATURES}.
+     * @param featuresToAvoid The features that should not run as part of refresh. See {@link SUPPORTED_FLUSH_KEYS}.
+     */
+    forceRefresh(flushState?: {
+        [k: string]: boolean;
+    }, featuresToAvoid?: string[]): void;
+    /**
+     * 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;
+    })[]> | undefined;
+    /**
+     * This resets the selection and refreshes the {@link rows} data.
+     * @param rows
+     */
+    clearSelectionAndRefreshRows(rows: string[]): Promise<void>;
+    /**
+     * This removes {@link State.showConfirmationAction confirmationAction}  from the state.
+     */
+    completeConfirmationAction(): void;
+    /**
+     * This sets the {@link State.errors errors} in the state.
+     * @param payload
+     */
+    setErrors(payload: Errors): void;
+    /**
+     *  Dispatches the dom container responsive breakpoints to state.
+     * @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>;
+    /**
+     * Select/Deselect all rows(all pages in case of paginated data) by calling {@link ApiContext.setSelectedRows setSelectedRows}/ {@link ApiContext.clearSelectedRows clearSelectedRows} api.
+     * It also updates the selected rows received from {@link ApiContext.getSelectedRows getSelectedRows} api in {@link State.selectedRows selectedRows} state slice.
+     * @param isSelected
+     */
+    selectAllRows(isSelected: boolean): Promise<void>;
+    /**
+     * 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;
+    /**
+     * Updates the visibility of columns by modifying {@link State.hiddenColumns}.
+     * @param columns - An object mapping column IDs to their visibility status. `true` indicates the column is visible, and `false` means it is hidden.
+     */
+    updateColumnsVisibility(columns: {
+        [key: FieldDef["id"]]: boolean;
+    }): void;
+    setConditionalStyleFormats(conditionalStyleFormats: NonNullable<State["conditionalStyleFormats"]>): void;
+};
+export type UtilityFunctions = ReturnType<typeof viewUtilityMethods>;
+//# sourceMappingURL=viewUtilityMethods.d.ts.map

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

@@ -0,0 +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;AAE5C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAM9E,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,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAIxC,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAChC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,GACtC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC,GACnF,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,GACnC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,EAAE,oBAAoB,CAAC,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;+FAMA;QACD,KAAK,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/B,cAAc,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC7C,oBAAoB,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpD,yBAAyB,CAAC,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;KAC9D;IAkBD;;;;;;;OAOG;2BAGO,2BAA2B,YACzB,yBAAyB,GAClC,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS;IA8D3B,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,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAItD;;;;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,eAAe;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE;IAI3E;;;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;IAIjF;;;;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;IAqBhC;;;;OAIG;8BAC6B,OAAO;IA6CvC;;;;OAIG;0BACmB,wBAAwB,CAAC,QAAQ,CAAC;IAYxD;;;OAGG;;IAaH;;;OAGG;;IAaH;;;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"}