@beinformed/ui 1.65.29 → 1.67.0

package/esm/redux/_modularui/types.js.flow

@@ -29,6 +29,13 @@ export type ModularUIState = {
   ...
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SetModelAction = {
   type: "MODULARUI/SET",
   payload: {
@@ -37,6 +44,13 @@ export type SetModelAction = {
   },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type InitModelAction = {
   type: "MODULARUI/INIT",
   payload: Array<{
@@ -45,16 +59,37 @@ export type InitModelAction = {
   }>,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateModelAction = {
   type: "MODULARUI/UPDATE",
   payload: ModularUIModel,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateFormAction = {
   type: "MODULARUI/UPDATE_FORM",
   payload: ModularUIModel,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SuccessAction = (
   model: ModularUIModel,
 ) => UpdateModelAction | SetModelAction;
@@ -63,6 +98,13 @@ export type ErrorAction = (
   error: FetchException,
 ) => UpdateStatusAction | RemoveModelByKeyAction | NoAction;
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ModularUIAction = {
   type: "MODULARUI/FETCH",
   payload: {
@@ -98,15 +140,36 @@ export type ModularUIAction = {
   },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type RemoveModelByKeyAction = {
   type: "MODULARUI/REMOVE_KEY",
   payload: string,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ResetModularUIAction = {
   type: "MODULARUI/RESET",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateStatusAction = {
   type: "MODULARUI/STATUS",
   payload: {

package/esm/redux/_modularui/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../src/redux/_modularui/types.js"],"sourcesContent":["// @flow\nimport type { ModularUIModel } from \"../../models/types\";\nimport type Href from \"../../models/href/Href\";\nimport type { FetchException } from \"../../exceptions\";\nimport type { NoAction } from \"../types\";\nimport typeof {\n  HTTP_METHODS,\n  MODULARUI_STATUS,\n} from \"../../constants/Constants\";\nimport type { ComponentType } from \"react\";\nimport type { TargetModel } from \"../../modularui/types\";\nimport type { RequestModularUIOptions } from \"../../utils/fetch/types\";\n\nexport type ModularUIOptions = {\n  propName?: string,\n  removeOnUnmount?: boolean,\n  ...RequestModularUIOptions,\n};\n\nexport type ModelEntry = {\n  +status: string,\n  +model: ModularUIModel,\n  +lastModification: number,\n  +requestOptions?: any,\n};\n\nexport type ModularUIState = {\n  [string]: ModelEntry,\n  ...\n};\n\nexport type SetModelAction = {\n  type: \"MODULARUI/SET\",\n  payload: {\n    key: string,\n    model: ?ModularUIModel,\n  },\n};\n\nexport type InitModelAction = {\n  type: \"MODULARUI/INIT\",\n  payload: Array<{\n    key: string,\n    model: ModularUIModel,\n  }>,\n};\n\nexport type UpdateModelAction = {\n  type: \"MODULARUI/UPDATE\",\n  payload: ModularUIModel,\n};\n\nexport type UpdateFormAction = {\n  type: \"MODULARUI/UPDATE_FORM\",\n  payload: ModularUIModel,\n};\n\nexport type SuccessAction = (\n  model: ModularUIModel,\n) => UpdateModelAction | SetModelAction;\n\nexport type ErrorAction = (\n  error: FetchException,\n) => UpdateStatusAction | RemoveModelByKeyAction | NoAction;\n\nexport type ModularUIAction = {\n  type: \"MODULARUI/FETCH\",\n  payload: {\n    key: string,\n    origin?: string,\n    contextPath?: string,\n    href: Href,\n    method?: $Keys<HTTP_METHODS>,\n    params?: string,\n    data?: any,\n    timeout?: number,\n    headers?: {\n      [headerName: string]: string,\n      Accept?: string,\n      \"Accept-Language\"?: string,\n      \"Content-Type\"?: string,\n      \"x-filename\"?: string,\n      \"x-filesize\"?: string,\n    },\n    events?: { [eventName: string]: () => void },\n    onProgress?: ProgressEventHandler,\n    locale: string,\n    childmodels?: boolean,\n    targetModel?: TargetModel,\n    forceTargetModel?: boolean,\n    cache?: boolean,\n    isReload?: boolean,\n    withCredentials?: boolean,\n    successAction: (\n      model: ModularUIModel,\n    ) => UpdateModelAction | SetModelAction,\n    errorAction?: ErrorAction,\n  },\n};\n\nexport type RemoveModelByKeyAction = {\n  type: \"MODULARUI/REMOVE_KEY\",\n  payload: string,\n};\n\nexport type ResetModularUIAction = {\n  type: \"MODULARUI/RESET\",\n};\n\nexport type UpdateStatusAction = {\n  type: \"MODULARUI/STATUS\",\n  payload: {\n    key: string,\n    status: $Keys<MODULARUI_STATUS>,\n    requestOptions: any,\n  },\n};\n\nexport type ModularUIConnector = (\n  Component: ComponentType<any>,\n) => ComponentType<any>;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/redux/_modularui/types.js"],"sourcesContent":["// @flow\nimport type { ModularUIModel } from \"../../models/types\";\nimport type Href from \"../../models/href/Href\";\nimport type { FetchException } from \"../../exceptions\";\nimport type { NoAction } from \"../types\";\nimport typeof {\n  HTTP_METHODS,\n  MODULARUI_STATUS,\n} from \"../../constants/Constants\";\nimport type { ComponentType } from \"react\";\nimport type { TargetModel } from \"../../modularui/types\";\nimport type { RequestModularUIOptions } from \"../../utils/fetch/types\";\n\nexport type ModularUIOptions = {\n  propName?: string,\n  removeOnUnmount?: boolean,\n  ...RequestModularUIOptions,\n};\n\nexport type ModelEntry = {\n  +status: string,\n  +model: ModularUIModel,\n  +lastModification: number,\n  +requestOptions?: any,\n};\n\nexport type ModularUIState = {\n  [string]: ModelEntry,\n  ...\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SetModelAction = {\n  type: \"MODULARUI/SET\",\n  payload: {\n    key: string,\n    model: ?ModularUIModel,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type InitModelAction = {\n  type: \"MODULARUI/INIT\",\n  payload: Array<{\n    key: string,\n    model: ModularUIModel,\n  }>,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateModelAction = {\n  type: \"MODULARUI/UPDATE\",\n  payload: ModularUIModel,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateFormAction = {\n  type: \"MODULARUI/UPDATE_FORM\",\n  payload: ModularUIModel,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SuccessAction = (\n  model: ModularUIModel,\n) => UpdateModelAction | SetModelAction;\n\nexport type ErrorAction = (\n  error: FetchException,\n) => UpdateStatusAction | RemoveModelByKeyAction | NoAction;\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ModularUIAction = {\n  type: \"MODULARUI/FETCH\",\n  payload: {\n    key: string,\n    origin?: string,\n    contextPath?: string,\n    href: Href,\n    method?: $Keys<HTTP_METHODS>,\n    params?: string,\n    data?: any,\n    timeout?: number,\n    headers?: {\n      [headerName: string]: string,\n      Accept?: string,\n      \"Accept-Language\"?: string,\n      \"Content-Type\"?: string,\n      \"x-filename\"?: string,\n      \"x-filesize\"?: string,\n    },\n    events?: { [eventName: string]: () => void },\n    onProgress?: ProgressEventHandler,\n    locale: string,\n    childmodels?: boolean,\n    targetModel?: TargetModel,\n    forceTargetModel?: boolean,\n    cache?: boolean,\n    isReload?: boolean,\n    withCredentials?: boolean,\n    successAction: (\n      model: ModularUIModel,\n    ) => UpdateModelAction | SetModelAction,\n    errorAction?: ErrorAction,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type RemoveModelByKeyAction = {\n  type: \"MODULARUI/REMOVE_KEY\",\n  payload: string,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ResetModularUIAction = {\n  type: \"MODULARUI/RESET\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateStatusAction = {\n  type: \"MODULARUI/STATUS\",\n  payload: {\n    key: string,\n    status: $Keys<MODULARUI_STATUS>,\n    requestOptions: any,\n  },\n};\n\nexport type ModularUIConnector = (\n  Component: ComponentType<any>,\n) => ComponentType<any>;\n"],"mappings":"","ignoreList":[]}

package/esm/redux/_router/types.js.flow

@@ -6,6 +6,13 @@ export type RouterState = {
   +action: HistoryAction,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type LocationChangeAction = {
   type: "ROUTER/LOCATION_CHANGE",
   payload: {
@@ -14,6 +21,13 @@ export type LocationChangeAction = {
   },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type PushAction = {
   type: "ROUTER/PUSH",
   payload: {
@@ -21,6 +35,14 @@ export type PushAction = {
     state?: { ... },
   },
 };
+
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ReplaceAction = {
   type: "ROUTER/REPLACE",
   payload: {
@@ -28,16 +50,39 @@ export type ReplaceAction = {
     state?: { ... },
   },
 };
+
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type GoAction = {
   type: "ROUTER/GO",
   payload: {
     delta: number,
   },
 };
+
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type GoBackAction = {
   type: "ROUTER/GOBACK",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type GoForwardAction = {
   type: "ROUTER/GOFORWARD",
 };

package/esm/redux/_router/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../src/redux/_router/types.js"],"sourcesContent":["// @flow\nimport type { HistoryAction, Location, LocationShape } from \"react-router\";\n\nexport type RouterState = {\n  +location: Location,\n  +action: HistoryAction,\n};\n\nexport type LocationChangeAction = {\n  type: \"ROUTER/LOCATION_CHANGE\",\n  payload: {\n    location: Location,\n    action: HistoryAction,\n  },\n};\n\nexport type PushAction = {\n  type: \"ROUTER/PUSH\",\n  payload: {\n    location: string | LocationShape,\n    state?: { ... },\n  },\n};\nexport type ReplaceAction = {\n  type: \"ROUTER/REPLACE\",\n  payload: {\n    location: string | LocationShape,\n    state?: { ... },\n  },\n};\nexport type GoAction = {\n  type: \"ROUTER/GO\",\n  payload: {\n    delta: number,\n  },\n};\nexport type GoBackAction = {\n  type: \"ROUTER/GOBACK\",\n};\n\nexport type GoForwardAction = {\n  type: \"ROUTER/GOFORWARD\",\n};\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/redux/_router/types.js"],"sourcesContent":["// @flow\nimport type { HistoryAction, Location, LocationShape } from \"react-router\";\n\nexport type RouterState = {\n  +location: Location,\n  +action: HistoryAction,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type LocationChangeAction = {\n  type: \"ROUTER/LOCATION_CHANGE\",\n  payload: {\n    location: Location,\n    action: HistoryAction,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type PushAction = {\n  type: \"ROUTER/PUSH\",\n  payload: {\n    location: string | LocationShape,\n    state?: { ... },\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ReplaceAction = {\n  type: \"ROUTER/REPLACE\",\n  payload: {\n    location: string | LocationShape,\n    state?: { ... },\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type GoAction = {\n  type: \"ROUTER/GO\",\n  payload: {\n    delta: number,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type GoBackAction = {\n  type: \"ROUTER/GOBACK\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type GoForwardAction = {\n  type: \"ROUTER/GOFORWARD\",\n};\n"],"mappings":"","ignoreList":[]}

package/esm/redux/types.js.flow

@@ -52,28 +52,66 @@ export type UpdateFormOptions = {
   validate?: boolean,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ */
 export type NoAction = {
   type: "NO_ACTION",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useErrorHandler) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SaveErrorAction = {
   type: "SAVE_ERROR",
   payload: ErrorResponse,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useModal) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ShowModalAction = {
   type: "SHOW_MODAL",
   payload: string,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useModal) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type CloseModalAction = {
   type: "CLOSE_MODAL",
   payload: string,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. onDismiss: () => void`.
+ * - Use the appropriate hook (useNotification) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type DismissNotificationAction = {
   type: "DISMISS_NOTIFICATION",
 };
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useNotification) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ShowNotificationAction = {
   type: "SHOW_NOTIFICATION",
   payload: {
@@ -83,50 +121,134 @@ export type ShowNotificationAction = {
   },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (usePreference) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SetPreferenceAction = {
   type: "SET_PREFERENCE",
   payload: { [name: string]: PreferenceValue },
 };
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (usePreference) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SetPreferencesAction = {
   type: "SET_PREFERENCES",
   payload: { [name: string]: PreferenceValue },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type StartProgressAction = {
   type: "START_PROGRESS",
 };
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type FinishProgressAction = {
   type: "FINISH_PROGRESS",
 };
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ResetProgressAction = {
   type: "RESET_PROGRESS",
 };
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateProgressAction = {
   type: "UPDATE_PROGRESS",
   payload: { percentComplete: number },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useAuthentication) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type SendAuthenticationErrorAction = {
   type: "AUTHENTICATION_ERROR",
   payload: string,
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useAuthentication) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ResetAuthErrorsAction = {
   type: "AUTHENTICATION_RESET_ERRORS",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useAuthentication) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type LoginSuccessAction = {
   type: "AUTHENTICATION_SUCCESS",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useAuthentication) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type ChangePasswordAction = {
   type: "CHANGE_PASSWORD",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useAuthentication) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type LogoutSuccessAction = {
   type: "AUTHENTICATION_LOGOUT",
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook (useFormNavigation) to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateAutosaveAction = {
   type: "UPDATE_AUTOSAVE_STATUS",
   payload: {
@@ -135,11 +257,21 @@ export type UpdateAutosaveAction = {
   },
 };
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.
+ */
 export type UpdateEntryDateAction = {
   type: "UPDATE_ENTRYDATE",
   payload: ISO_DATE,
 };
 
+/**
+ * @deprecated This union type is a legacy pattern and is not maintained for new actions.
+ */
 export type ReduxAction =
   | UpdateStatusAction
   | SetModelAction
@@ -177,7 +309,6 @@ export type ReduxAction =
   | ModularUIAction
   | NoAction;
 
-// Redux state
 export type AuthState = {
   +mustChangePassword: boolean,
   +error: ?string,
@@ -232,9 +363,6 @@ export type ReduxState = {
 
 export type GetState = () => ReduxState;
 
-/**
- * A function that accepts a listener callback and returns an unsubscribe function.
- */
 export type Subscribe = (listener: () => void) => () => void;
 
 export type ThunkExtra = {
@@ -242,28 +370,32 @@ export type ThunkExtra = {
   ...
 };
 
-// 1. Define ThunkAction first.
-// We use 'any' for Dispatch here temporarily to break the circularity
-// or use the specialized function type.
 export type ThunkAction<R = any> = (
   dispatch: Dispatch,
   getState: GetState,
   extra: ThunkExtra,
 ) => R;
 
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ */
 export type PromiseAction = Promise<ReduxAction | ThunkAction<any>>;
 
-// 2. Define Dispatch as a naked function type.
-// This is much more reliable in modern Flow than DispatchAPI<...>.
 export type Dispatch = (
   action: ReduxAction | ThunkAction<any> | PromiseAction,
 ) => any;
 
-// 3. Update ReduxStore to use the ReduxAction for the base reducer
-// but our custom Dispatch for the store instance.
 export type ReduxStore = Store<ReduxState, ReduxAction, Dispatch>;
 
-// 4. Clean up PossibleAction if you still use it elsewhere
+/**
+ * @deprecated This manual action type will be removed in a future major release.
+ * Recommended fixes:
+ * - Type component props as a simple callback: e.g. `onDismiss: () => void`.
+ * - Use the appropriate hook to encapsulate this logic.
+ */
 export type PossibleAction = ReduxAction | ThunkAction<any> | PromiseAction;
 
 export type CustomReducers = { [reducerKey: string]: any };

package/esm/redux/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/redux/types.js"],"sourcesContent":["// @flow\nimport type { Store } from \"redux\";\n\nimport type ErrorResponse from \"../models/error/ErrorResponse\";\n\nimport type FormModel from \"../models/form/FormModel\";\nimport typeof {\n  NOTIFICATION_TYPES,\n  AUTOSAVE_STATUS,\n} from \"../constants/Constants\";\n\nimport type { MessageObject } from \"../i18n/types\";\nimport type {\n  I18nState,\n  UpdateLocaleAction,\n  SetLocalesAction,\n} from \"./_i18n/types\";\nimport type {\n  ModularUIState,\n  ModularUIAction,\n  UpdateStatusAction,\n  SetModelAction,\n  UpdateModelAction,\n  UpdateFormAction,\n  RemoveModelByKeyAction,\n  ResetModularUIAction,\n  InitModelAction,\n} from \"./_modularui/types\";\nimport type {\n  RouterState,\n  LocationChangeAction,\n  PushAction,\n  ReplaceAction,\n  GoAction,\n  GoBackAction,\n  GoForwardAction,\n} from \"./_router/types\";\n\nexport type PreferenceValue =\n  | null\n  | string\n  | boolean\n  | { [key: string]: any }\n  | Array<PreferenceValue>;\n\nexport type UpdateFormOptions = {\n  autosubmit: boolean,\n  autosave: boolean,\n  autoupdate: boolean,\n  forceUpdate?: boolean,\n  /** Default true: Activate/deactivate the form object validate by an update */\n  validate?: boolean,\n};\n\nexport type NoAction = {\n  type: \"NO_ACTION\",\n};\n\nexport type SaveErrorAction = {\n  type: \"SAVE_ERROR\",\n  payload: ErrorResponse,\n};\n\nexport type ShowModalAction = {\n  type: \"SHOW_MODAL\",\n  payload: string,\n};\n\nexport type CloseModalAction = {\n  type: \"CLOSE_MODAL\",\n  payload: string,\n};\n\nexport type DismissNotificationAction = {\n  type: \"DISMISS_NOTIFICATION\",\n};\nexport type ShowNotificationAction = {\n  type: \"SHOW_NOTIFICATION\",\n  payload: {\n    type: $Keys<NOTIFICATION_TYPES>,\n    message: MessageObject,\n    error: ?ErrorResponse,\n  },\n};\n\nexport type SetPreferenceAction = {\n  type: \"SET_PREFERENCE\",\n  payload: { [name: string]: PreferenceValue },\n};\nexport type SetPreferencesAction = {\n  type: \"SET_PREFERENCES\",\n  payload: { [name: string]: PreferenceValue },\n};\n\nexport type StartProgressAction = {\n  type: \"START_PROGRESS\",\n};\nexport type FinishProgressAction = {\n  type: \"FINISH_PROGRESS\",\n};\nexport type ResetProgressAction = {\n  type: \"RESET_PROGRESS\",\n};\nexport type UpdateProgressAction = {\n  type: \"UPDATE_PROGRESS\",\n  payload: { percentComplete: number },\n};\n\nexport type SendAuthenticationErrorAction = {\n  type: \"AUTHENTICATION_ERROR\",\n  payload: string,\n};\n\nexport type ResetAuthErrorsAction = {\n  type: \"AUTHENTICATION_RESET_ERRORS\",\n};\n\nexport type LoginSuccessAction = {\n  type: \"AUTHENTICATION_SUCCESS\",\n};\n\nexport type ChangePasswordAction = {\n  type: \"CHANGE_PASSWORD\",\n};\n\nexport type LogoutSuccessAction = {\n  type: \"AUTHENTICATION_LOGOUT\",\n};\n\nexport type UpdateAutosaveAction = {\n  type: \"UPDATE_AUTOSAVE_STATUS\",\n  payload: {\n    status: $Keys<AUTOSAVE_STATUS>,\n    model: FormModel,\n  },\n};\n\nexport type UpdateEntryDateAction = {\n  type: \"UPDATE_ENTRYDATE\",\n  payload: ISO_DATE,\n};\n\nexport type ReduxAction =\n  | UpdateStatusAction\n  | SetModelAction\n  | InitModelAction\n  | UpdateModelAction\n  | UpdateFormAction\n  | RemoveModelByKeyAction\n  | ResetModularUIAction\n  | SaveErrorAction\n  | UpdateLocaleAction\n  | SetLocalesAction\n  | ShowModalAction\n  | CloseModalAction\n  | DismissNotificationAction\n  | ShowNotificationAction\n  | SetPreferenceAction\n  | SetPreferencesAction\n  | StartProgressAction\n  | FinishProgressAction\n  | ResetProgressAction\n  | UpdateProgressAction\n  | ResetAuthErrorsAction\n  | SendAuthenticationErrorAction\n  | LoginSuccessAction\n  | ChangePasswordAction\n  | LogoutSuccessAction\n  | UpdateAutosaveAction\n  | UpdateEntryDateAction\n  | LocationChangeAction\n  | PushAction\n  | ReplaceAction\n  | GoAction\n  | GoBackAction\n  | GoForwardAction\n  | ModularUIAction\n  | NoAction;\n\n// Redux state\nexport type AuthState = {\n  +mustChangePassword: boolean,\n  +error: ?string,\n};\n\nexport type ErrorState = null | ErrorResponse;\n\nexport type ModalState = {\n  +key: string,\n  +visible: boolean,\n  +size?: string,\n};\n\nexport type ModalsState = {\n  +modals: Array<ModalState>,\n};\n\nexport type NotificationState = {\n  +render: boolean,\n  +messageType: string | null,\n  +message: MessageObject | null,\n  +error: ?ErrorResponse | null,\n};\n\nexport type PreferencesState = {\n  +[name: string]: PreferenceValue,\n};\n\nexport type ProgressIndicatorState = {\n  +count: number,\n  +timestamp: number,\n  +percentComplete: number,\n};\n\nexport type ModelCatalogState = {\n  entryDate: ISO_DATE | null,\n};\n\nexport type ReduxState = {\n  +router: RouterState,\n  +modularui: ModularUIState,\n  +i18n: I18nState,\n  +auth: AuthState,\n  +modelcatalog: ModelCatalogState,\n  +error: ErrorState,\n  +modals: ModalsState,\n  +notification: NotificationState,\n  +progressindicator: ProgressIndicatorState,\n  +preferences: PreferencesState,\n  ...\n};\n\nexport type GetState = () => ReduxState;\n\n/**\n * A function that accepts a listener callback and returns an unsubscribe function.\n */\nexport type Subscribe = (listener: () => void) => () => void;\n\nexport type ThunkExtra = {\n  subscribe: Subscribe,\n  ...\n};\n\n// 1. Define ThunkAction first.\n// We use 'any' for Dispatch here temporarily to break the circularity\n// or use the specialized function type.\nexport type ThunkAction<R = any> = (\n  dispatch: Dispatch,\n  getState: GetState,\n  extra: ThunkExtra,\n) => R;\n\nexport type PromiseAction = Promise<ReduxAction | ThunkAction<any>>;\n\n// 2. Define Dispatch as a naked function type.\n// This is much more reliable in modern Flow than DispatchAPI<...>.\nexport type Dispatch = (\n  action: ReduxAction | ThunkAction<any> | PromiseAction,\n) => any;\n\n// 3. Update ReduxStore to use the ReduxAction for the base reducer\n// but our custom Dispatch for the store instance.\nexport type ReduxStore = Store<ReduxState, ReduxAction, Dispatch>;\n\n// 4. Clean up PossibleAction if you still use it elsewhere\nexport type PossibleAction = ReduxAction | ThunkAction<any> | PromiseAction;\n\nexport type CustomReducers = { [reducerKey: string]: any };\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/redux/types.js"],"sourcesContent":["// @flow\nimport type { Store } from \"redux\";\n\nimport type ErrorResponse from \"../models/error/ErrorResponse\";\n\nimport type FormModel from \"../models/form/FormModel\";\nimport typeof {\n  NOTIFICATION_TYPES,\n  AUTOSAVE_STATUS,\n} from \"../constants/Constants\";\n\nimport type { MessageObject } from \"../i18n/types\";\nimport type {\n  I18nState,\n  UpdateLocaleAction,\n  SetLocalesAction,\n} from \"./_i18n/types\";\nimport type {\n  ModularUIState,\n  ModularUIAction,\n  UpdateStatusAction,\n  SetModelAction,\n  UpdateModelAction,\n  UpdateFormAction,\n  RemoveModelByKeyAction,\n  ResetModularUIAction,\n  InitModelAction,\n} from \"./_modularui/types\";\nimport type {\n  RouterState,\n  LocationChangeAction,\n  PushAction,\n  ReplaceAction,\n  GoAction,\n  GoBackAction,\n  GoForwardAction,\n} from \"./_router/types\";\n\nexport type PreferenceValue =\n  | null\n  | string\n  | boolean\n  | { [key: string]: any }\n  | Array<PreferenceValue>;\n\nexport type UpdateFormOptions = {\n  autosubmit: boolean,\n  autosave: boolean,\n  autoupdate: boolean,\n  forceUpdate?: boolean,\n  /** Default true: Activate/deactivate the form object validate by an update */\n  validate?: boolean,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n */\nexport type NoAction = {\n  type: \"NO_ACTION\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useErrorHandler) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SaveErrorAction = {\n  type: \"SAVE_ERROR\",\n  payload: ErrorResponse,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useModal) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ShowModalAction = {\n  type: \"SHOW_MODAL\",\n  payload: string,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useModal) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type CloseModalAction = {\n  type: \"CLOSE_MODAL\",\n  payload: string,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. onDismiss: () => void`.\n * - Use the appropriate hook (useNotification) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type DismissNotificationAction = {\n  type: \"DISMISS_NOTIFICATION\",\n};\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useNotification) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ShowNotificationAction = {\n  type: \"SHOW_NOTIFICATION\",\n  payload: {\n    type: $Keys<NOTIFICATION_TYPES>,\n    message: MessageObject,\n    error: ?ErrorResponse,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (usePreference) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SetPreferenceAction = {\n  type: \"SET_PREFERENCE\",\n  payload: { [name: string]: PreferenceValue },\n};\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (usePreference) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SetPreferencesAction = {\n  type: \"SET_PREFERENCES\",\n  payload: { [name: string]: PreferenceValue },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type StartProgressAction = {\n  type: \"START_PROGRESS\",\n};\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type FinishProgressAction = {\n  type: \"FINISH_PROGRESS\",\n};\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ResetProgressAction = {\n  type: \"RESET_PROGRESS\",\n};\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useProgressIndicator) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateProgressAction = {\n  type: \"UPDATE_PROGRESS\",\n  payload: { percentComplete: number },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useAuthentication) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type SendAuthenticationErrorAction = {\n  type: \"AUTHENTICATION_ERROR\",\n  payload: string,\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useAuthentication) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ResetAuthErrorsAction = {\n  type: \"AUTHENTICATION_RESET_ERRORS\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useAuthentication) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type LoginSuccessAction = {\n  type: \"AUTHENTICATION_SUCCESS\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useAuthentication) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type ChangePasswordAction = {\n  type: \"CHANGE_PASSWORD\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useAuthentication) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type LogoutSuccessAction = {\n  type: \"AUTHENTICATION_LOGOUT\",\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook (useFormNavigation) to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateAutosaveAction = {\n  type: \"UPDATE_AUTOSAVE_STATUS\",\n  payload: {\n    status: $Keys<AUTOSAVE_STATUS>,\n    model: FormModel,\n  },\n};\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n * - Reference the action object type for middleware, use ReturnType<typeof actionCreator>.\n */\nexport type UpdateEntryDateAction = {\n  type: \"UPDATE_ENTRYDATE\",\n  payload: ISO_DATE,\n};\n\n/**\n * @deprecated This union type is a legacy pattern and is not maintained for new actions.\n */\nexport type ReduxAction =\n  | UpdateStatusAction\n  | SetModelAction\n  | InitModelAction\n  | UpdateModelAction\n  | UpdateFormAction\n  | RemoveModelByKeyAction\n  | ResetModularUIAction\n  | SaveErrorAction\n  | UpdateLocaleAction\n  | SetLocalesAction\n  | ShowModalAction\n  | CloseModalAction\n  | DismissNotificationAction\n  | ShowNotificationAction\n  | SetPreferenceAction\n  | SetPreferencesAction\n  | StartProgressAction\n  | FinishProgressAction\n  | ResetProgressAction\n  | UpdateProgressAction\n  | ResetAuthErrorsAction\n  | SendAuthenticationErrorAction\n  | LoginSuccessAction\n  | ChangePasswordAction\n  | LogoutSuccessAction\n  | UpdateAutosaveAction\n  | UpdateEntryDateAction\n  | LocationChangeAction\n  | PushAction\n  | ReplaceAction\n  | GoAction\n  | GoBackAction\n  | GoForwardAction\n  | ModularUIAction\n  | NoAction;\n\nexport type AuthState = {\n  +mustChangePassword: boolean,\n  +error: ?string,\n};\n\nexport type ErrorState = null | ErrorResponse;\n\nexport type ModalState = {\n  +key: string,\n  +visible: boolean,\n  +size?: string,\n};\n\nexport type ModalsState = {\n  +modals: Array<ModalState>,\n};\n\nexport type NotificationState = {\n  +render: boolean,\n  +messageType: string | null,\n  +message: MessageObject | null,\n  +error: ?ErrorResponse | null,\n};\n\nexport type PreferencesState = {\n  +[name: string]: PreferenceValue,\n};\n\nexport type ProgressIndicatorState = {\n  +count: number,\n  +timestamp: number,\n  +percentComplete: number,\n};\n\nexport type ModelCatalogState = {\n  entryDate: ISO_DATE | null,\n};\n\nexport type ReduxState = {\n  +router: RouterState,\n  +modularui: ModularUIState,\n  +i18n: I18nState,\n  +auth: AuthState,\n  +modelcatalog: ModelCatalogState,\n  +error: ErrorState,\n  +modals: ModalsState,\n  +notification: NotificationState,\n  +progressindicator: ProgressIndicatorState,\n  +preferences: PreferencesState,\n  ...\n};\n\nexport type GetState = () => ReduxState;\n\nexport type Subscribe = (listener: () => void) => () => void;\n\nexport type ThunkExtra = {\n  subscribe: Subscribe,\n  ...\n};\n\nexport type ThunkAction<R = any> = (\n  dispatch: Dispatch,\n  getState: GetState,\n  extra: ThunkExtra,\n) => R;\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n */\nexport type PromiseAction = Promise<ReduxAction | ThunkAction<any>>;\n\nexport type Dispatch = (\n  action: ReduxAction | ThunkAction<any> | PromiseAction,\n) => any;\n\nexport type ReduxStore = Store<ReduxState, ReduxAction, Dispatch>;\n\n/**\n * @deprecated This manual action type will be removed in a future major release.\n * Recommended fixes:\n * - Type component props as a simple callback: e.g. `onDismiss: () => void`.\n * - Use the appropriate hook to encapsulate this logic.\n */\nexport type PossibleAction = ReduxAction | ThunkAction<any> | PromiseAction;\n\nexport type CustomReducers = { [reducerKey: string]: any };\n"],"mappings":"","ignoreList":[]}

package/lib/hooks/useErrorHandler.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useErrorHandler = void 0;
+var _reactRedux = require("react-redux");
+var _react = require("react");
+var _Error = require("../redux/actions/Error");
+var _FetchException = _interopRequireDefault(require("../exceptions/FetchException"));
+/**
+ * A hook that returns a memoized function to handle application-wide errors.
+ *
+ * By default, this handler orchestrates:
+ * - Redirects for unauthorized, blocked, or concurrent users.
+ * - Handles forced password change triggers.
+ * - Saves the error in the Redux store (server-side).
+ * - Triggers global XHR error notifications.
+ */
+const useErrorHandler = () => {
+  const dispatch = (0, _reactRedux.useDispatch)();
+  return (0, _react.useCallback)(
+  /**
+   * @param {string | Error | FetchException} error - The error object or message to process.
+   */
+  error => {
+    const err = typeof error === "string" ? new Error(error) : error;
+    dispatch((0, _Error.handleError)(err));
+  }, [dispatch]);
+};
+exports.useErrorHandler = useErrorHandler;
+//# sourceMappingURL=useErrorHandler.js.map

package/lib/hooks/useErrorHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useErrorHandler.js","names":["_reactRedux","require","_react","_Error","_FetchException","_interopRequireDefault","useErrorHandler","dispatch","useDispatch","useCallback","error","err","Error","handleError","exports"],"sources":["../../src/hooks/useErrorHandler.js"],"sourcesContent":["// @flow\nimport { useDispatch } from \"react-redux\";\nimport { useCallback } from \"react\";\nimport { handleError } from \"../redux/actions/Error\";\nimport FetchException from \"../exceptions/FetchException\";\n\n/**\n * A hook that returns a memoized function to handle application-wide errors.\n *\n * By default, this handler orchestrates:\n * - Redirects for unauthorized, blocked, or concurrent users.\n * - Handles forced password change triggers.\n * - Saves the error in the Redux store (server-side).\n * - Triggers global XHR error notifications.\n */\nexport const useErrorHandler = (): ((\n  error: string | Error | FetchException,\n) => void) => {\n  const dispatch = useDispatch();\n\n  return useCallback(\n    /**\n     * @param {string | Error | FetchException} error - The error object or message to process.\n     */\n    (error: string | Error | FetchException) => {\n      const err = typeof error === \"string\" ? new Error(error) : error;\n      dispatch(handleError(err));\n    },\n    [dispatch],\n  );\n};\n"],"mappings":";;;;;;;AACA,IAAAA,WAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AACA,IAAAG,eAAA,GAAAC,sBAAA,CAAAJ,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMK,eAAe,GAAGA,CAAA,KAEjB;EACZ,MAAMC,QAAQ,GAAG,IAAAC,uBAAW,EAAC,CAAC;EAE9B,OAAO,IAAAC,kBAAW;EAChB;AACJ;AACA;EACKC,KAAsC,IAAK;IAC1C,MAAMC,GAAG,GAAG,OAAOD,KAAK,KAAK,QAAQ,GAAG,IAAIE,KAAK,CAACF,KAAK,CAAC,GAAGA,KAAK;IAChEH,QAAQ,CAAC,IAAAM,kBAAW,EAACF,GAAG,CAAC,CAAC;EAC5B,CAAC,EACD,CAACJ,QAAQ,CACX,CAAC;AACH,CAAC;AAACO,OAAA,CAAAR,eAAA,GAAAA,eAAA","ignoreList":[]}

package/lib/hooks/useI18n.js

@@ -4,13 +4,15 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useTranslate = exports.useMessage = exports.useLocaleCodes = exports.useLocale = void 0;
+exports.useUpdateLocale = exports.useTranslate = exports.useMessage = exports.useLocaleCodes = exports.useLocale = void 0;
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/json/stringify"));
 var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/map"));
+var _react = require("react");
 var _reactRedux = require("react-redux");
 var _reselect = require("reselect");
 var _memoize = _interopRequireDefault(require("lodash/memoize"));
 var _i18n = require("../redux/selectors/i18n");
+var _I18nActions = require("../redux/_i18n/I18nActions");
 const getMessage = (0, _reselect.createSelector)([_i18n.getLocales, _i18n.getLocale], (locales, localeCode) => (0, _memoize.default)((id, defaultMessage, placeholders) => locales.getLocale(localeCode).getMessage(id, defaultMessage, placeholders), (...args) => (0, _stringify.default)(args)));
 
 /**
@@ -33,5 +35,18 @@ const getLocaleCodes = (0, _reselect.createSelector)(state => state.i18n.locales
  * Retrieve all available locale codes
  */
 const useLocaleCodes = () => (0, _reactRedux.useSelector)(getLocaleCodes);
+
+/**
+ * A hook that returns a memoized function to update the application locale.
+ *
+ * @returns {(locale: string) => void} A memoized function to update the locale.
+ */
 exports.useLocaleCodes = useLocaleCodes;
+const useUpdateLocale = () => {
+  const dispatch = (0, _reactRedux.useDispatch)();
+  return (0, _react.useCallback)(locale => {
+    dispatch((0, _I18nActions.updateLocale)(locale));
+  }, [dispatch]);
+};
+exports.useUpdateLocale = useUpdateLocale;
 //# sourceMappingURL=useI18n.js.map