<%# Copyright 2013-2026 the original author or authors from the JHipster project. This file is part of the JHipster project, see https://www.jhipster.tech/ for more information. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -%> import { UnknownAction, AsyncThunk, ActionReducerMapBuilder, createSlice, SerializedError, SliceCaseReducers, ValidateSliceCaseReducers, } from '@reduxjs/toolkit'; import { AxiosError, isAxiosError } from 'axios'; /** * Model for redux actions with pagination */ export type IQueryParams = { query?: string; page?: number; size?: number; sort?: string }; /** * Useful types for working with actions */ type GenericAsyncThunk = AsyncThunk; export type PendingAction = ReturnType; export type RejectedAction = ReturnType; export type FulfilledAction = ReturnType; /** * Check if the async action type is rejected */ export function isRejectedAction(action: UnknownAction) { return action.type.endsWith('/rejected'); } /** * Check if the async action type is pending */ export function isPendingAction(action: UnknownAction) { return action.type.endsWith('/pending'); } /** * Check if the async action type is completed */ export function isFulfilledAction(action: UnknownAction) { return action.type.endsWith('/fulfilled'); } const commonErrorProperties: (keyof SerializedError)[] = ['name', 'message', 'stack', 'code']; /** * Serialize function used for async action errors, * since the default function from Redux Toolkit strips useful info from axios errors */ export const serializeAxiosError = (value: any): AxiosError | SerializedError => { if (typeof value === 'object' && value !== null) { if (isAxiosError(value)) { return value; } const simpleError: SerializedError = {}; for (const property of commonErrorProperties) { if (typeof value[property] === 'string') { simpleError[property] = value[property]; } } return simpleError; } return { message: String(value) }; }; export interface EntityState { loading: boolean; errorMessage: string | null; entities: readonly T[]; entity: T; links?: any; updating: boolean; totalItems?: number; updateSuccess: boolean; } /** * A wrapper on top of createSlice from Redux Toolkit to extract * common reducers and matchers used by entities */ export const createEntitySlice = >>({ name = '', initialState, reducers, extraReducers, skipRejectionHandling, }: { name: string; initialState: EntityState; reducers?: ValidateSliceCaseReducers, Reducers>; extraReducers?: (builder: ActionReducerMapBuilder>) => void; skipRejectionHandling?: boolean; }) => { return createSlice({ name, initialState, reducers: { /** * Reset the entity state to initial state */ reset() { return initialState; }, ...reducers, }, extraReducers(builder) { extraReducers(builder); /* * Common rejection logic is handled here. * If you want to add your own rejection logic, pass `skipRejectionHandling: true` * while calling `createEntitySlice` * */ if (!skipRejectionHandling) { builder.addMatcher(isRejectedAction, state => { state.loading = false; state.updating = false; state.updateSuccess = false; state.errorMessage = null; }); } }, }); };