@beinformed/react 1.0.0-beta.0

package/dist/redux/index.d.cts

@@ -0,0 +1,458 @@
+import * as _reduxjs_toolkit from '@reduxjs/toolkit';
+import { Middleware } from '@reduxjs/toolkit';
+import { S as ShowNotificationArguments, $ as RootState, a0 as BEIDispatch, V as RouterLocation, C as FetchModelResult, F as FetchModelPayload, b as Locales, R as PreferenceValue, W as RouterState, P as PreferencesState, y as ModularUIState, I as I18nState, A as AuthState, E as ErrorState, o as ModalsState, v as ModelCatalogState, N as NotificationState, T as ProgressIndicatorState } from '../styled-components.d-CrkOxzv5.cjs';
+export { _ as BEIStore, n as ModalState, B as ModelEntry, D as NOTIFICATION_TYPES, g as authReducer, q as closeModal, H as dismissNotification, i as errorReducer, m as i18nReducer, X as locationChange, l as loginSuccess, e as logoutSuccess, t as modalsReducer, x as modelCatalogReducer, z as modularUIReducer, J as notificationReducer, Q as preferencesReducer, U as progressIndicatorReducer, j as receiveLocale, r as resetAuthErrors, Y as routerReducer, f as saveChangePassword, h as saveError, s as sendAuthenticationError, k as setLocales, K as setPreference, O as setPreferences, Z as setupStore, p as showModal, G as showNotification, w as updateEntryDate, u as updateLocale } from '../styled-components.d-CrkOxzv5.cjs';
+import * as _beinformed_ui_models from '@beinformed/ui/models';
+import { FormModel, ErrorResponse, ApplicationModel, FormObjectModel, AttributeModel, ModularUIModel, Href } from '@beinformed/ui/models';
+import * as redux from 'redux';
+import { LocationState, History } from 'history';
+export { a as BeforeRenderHook, B as BeforeRenderHookProps, h as handleBeforeRenderHooks } from '../beforeRenderHooks-CNvsMmi8.cjs';
+import { U as UpdateFormOptions } from '../useForm-CG_DMYfZ.cjs';
+import * as react_redux from 'react-redux';
+import { ISO_DATE } from '@beinformed/ui/types';
+import { ModularUIRequestOptions } from '@beinformed/ui/utils';
+import 'immer';
+import '@beinformed/ui/settings';
+import 'styled-components';
+import '../types-CGXygEPz.cjs';
+
+/**
+ * Show form notification
+ */
+declare const showFormNotification: _reduxjs_toolkit.AsyncThunk<{
+    payload: undefined;
+    type: "FINISH_PROGRESS";
+}, FormModel, {
+    state?: unknown;
+    dispatch?: _reduxjs_toolkit.ThunkDispatch<unknown, unknown, redux.UnknownAction>;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+/**
+ * Show error notification
+ */
+declare const showXHRErrorNotification: (error: ErrorResponse) => _reduxjs_toolkit.AsyncThunkAction<void, ShowNotificationArguments, {
+    state?: unknown;
+    dispatch?: _reduxjs_toolkit.ThunkDispatch<unknown, unknown, redux.UnknownAction>;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+/**
+ * Retrieve entrydate for the model catalog
+ */
+declare const getEntryDate: (state: RootState) => ISO_DATE;
+
+declare const reloadApplication: _reduxjs_toolkit.AsyncThunk<void, void, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    extra: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+/**
+ * Get the application model, which is the model with selfhref '/'
+ */
+declare const getApplication: (state: RootState) => ApplicationModel | undefined;
+
+declare const loginFailed: (errorMessage: string) => {
+    payload: string;
+    type: "AUTHENTICATION_ERROR";
+};
+declare const changePassword: _reduxjs_toolkit.AsyncThunk<{
+    payload: {
+        location: string | RouterLocation;
+        state: LocationState;
+    };
+    type: string;
+}, void, {
+    state: RootState;
+    dispatch?: _reduxjs_toolkit.ThunkDispatch<unknown, unknown, redux.UnknownAction> | undefined;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+declare const login: _reduxjs_toolkit.AsyncThunk<void, {
+    username: string;
+    password: string;
+}, {
+    state: RootState;
+    dispatch: BEIDispatch;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+declare const logout: _reduxjs_toolkit.AsyncThunk<void, void, {
+    dispatch: BEIDispatch;
+    state?: unknown;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+declare const handleUnauthorized: _reduxjs_toolkit.AsyncThunk<void, ErrorResponse, {
+    state: RootState;
+    dispatch: BEIDispatch;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+declare const getDataFromServer: () => Record<string, unknown>;
+
+declare const updateFormAttribute: _reduxjs_toolkit.AsyncThunk<void, {
+    form: FormModel;
+    formObject: FormObjectModel;
+    attribute: AttributeModel;
+    inputvalue: string;
+    options?: UpdateFormOptions;
+}, {
+    dispatch: BEIDispatch;
+    state?: unknown;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+/**
+ * POSSIBLE AUTOSAVE STATUSSES
+ * @type {{START: string, FINISHED: string}}
+ */
+declare enum AUTOSAVE_STATUS {
+    START = 0,
+    FINISHED = 1
+}
+declare const autosaveFormObject: (form: FormModel) => (dispatch: BEIDispatch) => void | undefined;
+
+declare const autosubmitFormObject: (form: FormModel, attribute: AttributeModel, forceUpdate?: boolean) => _reduxjs_toolkit.AsyncThunkAction<FetchModelResult, FetchModelPayload, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    rejectValue: _beinformed_ui_models.ErrorResponse;
+    extra?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}> | null;
+
+declare const autoupdateFormObject: (form: FormModel, attribute: AttributeModel) => _reduxjs_toolkit.AsyncThunkAction<FetchModelResult, FetchModelPayload, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    rejectValue: _beinformed_ui_models.ErrorResponse;
+    extra?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}> | null;
+
+declare const previousObject: (form: FormModel) => {
+    payload: _beinformed_ui_models.ModularUIModel;
+    type: "MODULARUI/UPDATE_FORM";
+};
+declare const cancelForm: _reduxjs_toolkit.AsyncThunk<{
+    payload: undefined;
+    type: string;
+}, FormModel, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+declare const addRepeatableAttributeSet: (form: FormModel) => {
+    payload: _beinformed_ui_models.ModularUIModel;
+    type: "MODULARUI/UPDATE_FORM";
+};
+declare const cancelRepeatableAttributeSet: (form: FormModel, formObject: FormObjectModel) => {
+    payload: _beinformed_ui_models.ModularUIModel;
+    type: "MODULARUI/UPDATE_FORM";
+};
+declare const removeRepeatableAttributeSet: (form: FormModel, formObject: FormObjectModel) => {
+    payload: _beinformed_ui_models.ModularUIModel;
+    type: "MODULARUI/UPDATE_FORM";
+};
+
+declare const validateFormObject: (form: FormModel) => (dispatch: BEIDispatch) => void;
+
+/**
+ * Retrieve the locale from state
+ */
+declare const getLocale: (state: RootState) => string;
+/**
+ * Retrieve all available locales in the store
+ */
+declare const getLocales: (state: RootState) => Locales;
+
+declare enum MODULARUI_STATUS {
+    IDLE = "IDLE",
+    LOADING = "LOADING",
+    FINISHED = "FINISHED",
+    ERROR = "ERROR"
+}
+
+declare const fetchModel: _reduxjs_toolkit.AsyncThunk<FetchModelResult, FetchModelPayload, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    rejectValue: ErrorResponse;
+    extra?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+declare const updateErrorStatus: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[key: string, error: ErrorResponse], {
+    key: string;
+    error: ErrorResponse;
+}, "MODULARUI/ERROR_STATUS", never, never>;
+declare const setModel: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[key: string, model: ModularUIModel], {
+    key: string;
+    model: ModularUIModel;
+}, "MODULARUI/SET", never, never>;
+declare const initModels: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[models: {
+    key: string;
+    model: ModularUIModel;
+}[]], {
+    key: string;
+    model: ModularUIModel;
+}[], "MODULARUI/INIT", never, never>;
+declare const updateModel: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[model: ModularUIModel], ModularUIModel, "MODULARUI/UPDATE", never, never>;
+declare const updateForm: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[model: ModularUIModel], ModularUIModel, "MODULARUI/UPDATE_FORM", never, never>;
+declare const removeModelByKey: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[key: string], string, "MODULARUI/REMOVE_KEY", never, never>;
+/**
+ * Removes all models except the application model from the modular ui reducer
+ */
+declare const resetModularUI: _reduxjs_toolkit.ActionCreatorWithoutPayload<"MODULARUI/RESET">;
+
+declare const reloadModel: (model: ModularUIModel, options?: ModularUIRequestOptions) => _reduxjs_toolkit.AsyncThunkAction<FetchModelResult, FetchModelPayload, {
+    dispatch: BEIDispatch;
+    state: RootState;
+    rejectValue: _beinformed_ui_models.ErrorResponse;
+    extra?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+
+/**
+ * Retrieve the preferred language for this request, falls back to the browser language or english
+ */
+declare const getRequestLocale: (optionLocale: string | undefined, currentStateLocale: string) => string;
+
+declare const setServerPreference: (propertyName: string, defaultValue: PreferenceValue, type?: string) => {
+    payload: {
+        key: string;
+        value: PreferenceValue;
+    };
+    type: "SET_PREFERENCE";
+};
+declare const setThemePreference: (configTheme: string) => {
+    payload: {
+        key: string;
+        value: PreferenceValue;
+    };
+    type: "SET_PREFERENCE";
+};
+/**
+ * Make modular-ui-content-in-data preference available client side
+ */
+declare const setAllContentInDataSetting: (state?: RootState) => {
+    payload: {
+        key: string;
+        value: PreferenceValue;
+    };
+    type: "SET_PREFERENCE";
+};
+/**
+ * Retrieve settings for date time conversion
+ */
+declare const setDateTimeSettings: (state?: RootState) => {
+    payload: {
+        key: string;
+        value: PreferenceValue;
+    };
+    type: "SET_PREFERENCE";
+};
+/**
+ * Retrieves login settings from runtime preferences and sets them as setting in the preference reducer
+ */
+declare const setLoginPreferences: (state?: RootState) => {
+    payload: {
+        [x: string]: PreferenceValue;
+    };
+    type: "SET_PREFERENCES";
+};
+
+/**
+ * Returns a singleton instance of the browser history.
+ * Creates the instance on the first call.
+ * This pattern is suitable for client-side applications.
+ */
+declare function getBrowserHistory(): History;
+
+declare const push: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[location: string | RouterLocation, state?: unknown], {
+    location: string | RouterLocation;
+    state: unknown;
+}, "ROUTER/PUSH", never, never>;
+declare const replace: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[location: string | RouterLocation, state?: unknown], {
+    location: string | RouterLocation;
+    state: unknown;
+}, "ROUTER/REPLACE", never, never>;
+declare const go: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[delta: number], {
+    delta: number;
+}, "ROUTER/GO", never, never>;
+declare const goBack: _reduxjs_toolkit.ActionCreatorWithoutPayload<"ROUTER/GOBACK">;
+declare const goForward: _reduxjs_toolkit.ActionCreatorWithoutPayload<"ROUTER/GOFORWARD">;
+
+declare const routerMiddleware: (history: History) => Middleware<{}, RootState>;
+
+declare const useBEIDispatch: react_redux.UseDispatch<_reduxjs_toolkit.ThunkDispatch<{
+    router: RouterState;
+    preferences: PreferencesState;
+    modularui: ModularUIState;
+    i18n: I18nState;
+    auth: AuthState;
+    error: ErrorState;
+    modals: ModalsState;
+    modelcatalog: ModelCatalogState;
+    notification: NotificationState;
+    progressindicator: ProgressIndicatorState;
+}, undefined, redux.UnknownAction> & redux.Dispatch<redux.UnknownAction>>;
+declare const useBEISelector: react_redux.UseSelector<{
+    router: RouterState;
+    preferences: PreferencesState;
+    modularui: ModularUIState;
+    i18n: I18nState;
+    auth: AuthState;
+    error: ErrorState;
+    modals: ModalsState;
+    modelcatalog: ModelCatalogState;
+    notification: NotificationState;
+    progressindicator: ProgressIndicatorState;
+}>;
+declare const useBEIStore: react_redux.UseStore<_reduxjs_toolkit.EnhancedStore<{
+    router: RouterState;
+    preferences: PreferencesState;
+    modularui: ModularUIState;
+    i18n: I18nState;
+    auth: AuthState;
+    error: ErrorState;
+    modals: ModalsState;
+    modelcatalog: ModelCatalogState;
+    notification: NotificationState;
+    progressindicator: ProgressIndicatorState;
+}, redux.UnknownAction, _reduxjs_toolkit.Tuple<[redux.StoreEnhancer<{
+    dispatch: _reduxjs_toolkit.ThunkDispatch<{
+        router: RouterState;
+        preferences: PreferencesState;
+        modularui: ModularUIState;
+        i18n: I18nState;
+        auth: AuthState;
+        error: ErrorState;
+        modals: ModalsState;
+        modelcatalog: ModelCatalogState;
+        notification: NotificationState;
+        progressindicator: ProgressIndicatorState;
+    }, undefined, redux.UnknownAction>;
+}>, redux.StoreEnhancer]>>>;
+
+declare const noAction: _reduxjs_toolkit.ActionCreatorWithoutPayload<"NO_ACTION">;
+
+declare const getFirstModelByInstance: <T extends new (...args: unknown[]) => unknown>(state: RootState, instance: T) => InstanceType<T> | undefined;
+/**
+ * Returns all model keys found in the store, restrict on href
+ */
+declare const allKeysByHref: (state: RootState, href: Href | string) => string[];
+
+type DefaultHandler = typeof defaultErrorResponseHandler;
+declare const defaultErrorResponseHandler: (error: ErrorResponse) => (dispatch: BEIDispatch) => {
+    payload: undefined;
+    type: "CHANGE_PASSWORD";
+} | {
+    payload: ErrorResponse;
+    type: "SAVE_ERROR";
+} | (Promise<_reduxjs_toolkit.PayloadAction<void, string, {
+    arg: ShowNotificationArguments;
+    requestId: string;
+    requestStatus: "fulfilled";
+}, never> | _reduxjs_toolkit.PayloadAction<unknown, string, {
+    arg: ShowNotificationArguments;
+    requestId: string;
+    requestStatus: "rejected";
+    aborted: boolean;
+    condition: boolean;
+} & ({
+    rejectedWithValue: true;
+} | ({
+    rejectedWithValue: false;
+} & {})), _reduxjs_toolkit.SerializedError>> & {
+    __linterBrands: "SafePromise";
+} & {
+    abort: (reason?: string) => void;
+    requestId: string;
+    arg: ShowNotificationArguments;
+    unwrap: () => Promise<void>;
+}) | {
+    payload: undefined;
+    type: "NO_ACTION";
+} | (Promise<_reduxjs_toolkit.PayloadAction<void, string, {
+    arg: ErrorResponse;
+    requestId: string;
+    requestStatus: "fulfilled";
+}, never> | _reduxjs_toolkit.PayloadAction<unknown, string, {
+    arg: ErrorResponse;
+    requestId: string;
+    requestStatus: "rejected";
+    aborted: boolean;
+    condition: boolean;
+} & ({
+    rejectedWithValue: true;
+} | ({
+    rejectedWithValue: false;
+} & {})), _reduxjs_toolkit.SerializedError>> & {
+    __linterBrands: "SafePromise";
+} & {
+    abort: (reason?: string) => void;
+    requestId: string;
+    arg: ErrorResponse;
+    unwrap: () => Promise<void>;
+}) | undefined;
+type CustomErrorResponseHandler = (error: ErrorResponse, defaultHandler: DefaultHandler) => (dispatch: BEIDispatch) => void;
+declare const setCustomErrorResponseHandler: (handler: CustomErrorResponseHandler) => void;
+declare const handleError: (error: unknown) => (dispatch: BEIDispatch) => void;
+
+export { AUTOSAVE_STATUS, AuthState, BEIDispatch, ErrorState, FetchModelPayload, FetchModelResult, I18nState, MODULARUI_STATUS, ModalsState, ModelCatalogState, ModularUIState, NotificationState, PreferenceValue, PreferencesState, ProgressIndicatorState, RootState, RouterLocation, RouterState, ShowNotificationArguments, addRepeatableAttributeSet, allKeysByHref, autosaveFormObject, autosubmitFormObject, autoupdateFormObject, cancelForm, cancelRepeatableAttributeSet, changePassword, fetchModel, getApplication, getBrowserHistory, getDataFromServer, getEntryDate, getFirstModelByInstance, getLocale, getLocales, getRequestLocale, go, goBack, goForward, handleError, handleUnauthorized, initModels, login, loginFailed, logout, noAction, previousObject, push, reloadApplication, reloadModel, removeModelByKey, removeRepeatableAttributeSet, replace, resetModularUI, routerMiddleware, setAllContentInDataSetting, setCustomErrorResponseHandler, setDateTimeSettings, setLoginPreferences, setModel, setServerPreference, setThemePreference, showFormNotification, showXHRErrorNotification, updateErrorStatus, updateForm, updateFormAttribute, updateModel, useBEIDispatch, useBEISelector, useBEIStore, validateFormObject };