@beinformed/react 1.0.0-beta.0

package/dist/server/index.d.cts

@@ -0,0 +1,78 @@
+import { _ as BEIStore, a2 as Theme, V as RouterLocation, b as Locales, d as LocaleConfiguration } from '../styled-components.d-CrkOxzv5.cjs';
+import react__default from 'react';
+import { ServerStyleSheet } from 'styled-components';
+import { H as HttpServletRequestJava } from '../types-CGXygEPz.cjs';
+import { Reducer } from '@reduxjs/toolkit';
+import { a as BeforeRenderHook } from '../beforeRenderHooks-CNvsMmi8.cjs';
+import 'history';
+import 'redux';
+import '@beinformed/ui/models';
+import '@beinformed/ui/types';
+import 'immer';
+import '@beinformed/ui/utils';
+import '@beinformed/ui/settings';
+
+declare const setApplication: (store: BEIStore) => void;
+
+interface TemplateProps {
+    contextPath: string;
+    html: string;
+    head: Record<string, unknown>;
+    state: string;
+    UUID: string;
+}
+declare const htmlpage: (props?: Partial<TemplateProps>) => string;
+
+interface Props {
+    store: BEIStore;
+    theme?: Theme | Theme[];
+    UUID: string;
+    render: () => react__default.ReactNode;
+    template?: (arg0: TemplateProps) => string;
+}
+declare const renderSSRMinimal: ({ store, theme, UUID, render, template, }: Props) => string;
+declare const createHead: (sheet: ServerStyleSheet, helmetContext?: Record<string, unknown>) => Record<string, unknown>;
+
+declare const getFullRequestUrl: (request: HttpServletRequestJava) => string;
+declare const getFullRequestLocation: (request: HttpServletRequestJava) => RouterLocation;
+declare const getCookieFromRequest: (request: HttpServletRequestJava, cookieName: string) => null | string;
+declare const getPreferredLocale: (request: HttpServletRequestJava, locales: Locales) => void | string;
+
+interface ServerPreferenceValue {
+    name: string;
+    defaultValue?: string | null;
+    type?: string;
+}
+declare const setServerPreferencesFromArray: (store: BEIStore, serverPreferences: (string | ServerPreferenceValue)[]) => void;
+/**
+ * Server preferences can be suplied by an array of preference names,
+ * or an array of objects which has the name, an optional default value and an optional type.<br>
+ * When the type is set to string, a comma separated value is not converted to an array:
+ *
+ * @example
+ * // value becomes an array [default1, default2]
+ * { name: "prefName", defaultValue: "default1, default2" }
+ * // value remains a string "default1, default2"
+ * { name: "prefName", defaultValue: "default1, default2", type: "string" }
+ *
+ * @param store
+ * @param serverPreferences
+ */
+declare const setServerPreferences: (store: BEIStore, serverPreferences: (string | ServerPreferenceValue)[]) => void;
+
+interface serverProps {
+    request: HttpServletRequestJava;
+    locales?: LocaleConfiguration[];
+    customReducers?: Record<string, Reducer>;
+    theme?: Theme | Theme[];
+    serverPreferences?: (string | ServerPreferenceValue)[];
+    render: () => react__default.ReactNode;
+    template?: (arg0: TemplateProps) => string;
+    beforeRenderHooks?: BeforeRenderHook[];
+    preloadApplication?: boolean;
+}
+declare const serverNoSSR: ({ request, locales, customReducers, serverPreferences, theme, render, template, beforeRenderHooks, preloadApplication, }: serverProps) => string;
+
+declare const dehydrate: (store: BEIStore) => string;
+
+export { HttpServletRequestJava, type ServerPreferenceValue, type TemplateProps, createHead, dehydrate, getCookieFromRequest, getFullRequestLocation, getFullRequestUrl, getPreferredLocale, htmlpage, renderSSRMinimal, serverNoSSR, setApplication, setServerPreferences, setServerPreferencesFromArray };

package/dist/server/index.d.ts

@@ -0,0 +1,78 @@
+import { _ as BEIStore, a2 as Theme, V as RouterLocation, b as Locales, d as LocaleConfiguration } from '../styled-components.d-CrkOxzv5.js';
+import react__default from 'react';
+import { ServerStyleSheet } from 'styled-components';
+import { H as HttpServletRequestJava } from '../types-CGXygEPz.js';
+import { Reducer } from '@reduxjs/toolkit';
+import { a as BeforeRenderHook } from '../beforeRenderHooks-Gb0tcmCY.js';
+import 'history';
+import 'redux';
+import '@beinformed/ui/models';
+import '@beinformed/ui/types';
+import 'immer';
+import '@beinformed/ui/utils';
+import '@beinformed/ui/settings';
+
+declare const setApplication: (store: BEIStore) => void;
+
+interface TemplateProps {
+    contextPath: string;
+    html: string;
+    head: Record<string, unknown>;
+    state: string;
+    UUID: string;
+}
+declare const htmlpage: (props?: Partial<TemplateProps>) => string;
+
+interface Props {
+    store: BEIStore;
+    theme?: Theme | Theme[];
+    UUID: string;
+    render: () => react__default.ReactNode;
+    template?: (arg0: TemplateProps) => string;
+}
+declare const renderSSRMinimal: ({ store, theme, UUID, render, template, }: Props) => string;
+declare const createHead: (sheet: ServerStyleSheet, helmetContext?: Record<string, unknown>) => Record<string, unknown>;
+
+declare const getFullRequestUrl: (request: HttpServletRequestJava) => string;
+declare const getFullRequestLocation: (request: HttpServletRequestJava) => RouterLocation;
+declare const getCookieFromRequest: (request: HttpServletRequestJava, cookieName: string) => null | string;
+declare const getPreferredLocale: (request: HttpServletRequestJava, locales: Locales) => void | string;
+
+interface ServerPreferenceValue {
+    name: string;
+    defaultValue?: string | null;
+    type?: string;
+}
+declare const setServerPreferencesFromArray: (store: BEIStore, serverPreferences: (string | ServerPreferenceValue)[]) => void;
+/**
+ * Server preferences can be suplied by an array of preference names,
+ * or an array of objects which has the name, an optional default value and an optional type.<br>
+ * When the type is set to string, a comma separated value is not converted to an array:
+ *
+ * @example
+ * // value becomes an array [default1, default2]
+ * { name: "prefName", defaultValue: "default1, default2" }
+ * // value remains a string "default1, default2"
+ * { name: "prefName", defaultValue: "default1, default2", type: "string" }
+ *
+ * @param store
+ * @param serverPreferences
+ */
+declare const setServerPreferences: (store: BEIStore, serverPreferences: (string | ServerPreferenceValue)[]) => void;
+
+interface serverProps {
+    request: HttpServletRequestJava;
+    locales?: LocaleConfiguration[];
+    customReducers?: Record<string, Reducer>;
+    theme?: Theme | Theme[];
+    serverPreferences?: (string | ServerPreferenceValue)[];
+    render: () => react__default.ReactNode;
+    template?: (arg0: TemplateProps) => string;
+    beforeRenderHooks?: BeforeRenderHook[];
+    preloadApplication?: boolean;
+}
+declare const serverNoSSR: ({ request, locales, customReducers, serverPreferences, theme, render, template, beforeRenderHooks, preloadApplication, }: serverProps) => string;
+
+declare const dehydrate: (store: BEIStore) => string;
+
+export { HttpServletRequestJava, type ServerPreferenceValue, type TemplateProps, createHead, dehydrate, getCookieFromRequest, getFullRequestLocation, getFullRequestUrl, getPreferredLocale, htmlpage, renderSSRMinimal, serverNoSSR, setApplication, setServerPreferences, setServerPreferencesFromArray };

package/dist/server/index.js

@@ -0,0 +1,2 @@
+import{a as e,b as f,c as g,d as h,e as i,f as j,g as k,h as l}from"../chunk-VG3QU524.js";import{a,b,c,d}from"../chunk-HDOILTJ2.js";import"../chunk-3OP2KQ56.js";import"../chunk-Y7ESITVO.js";import"../chunk-YG7XDCNV.js";import"../chunk-JYAETKRB.js";import"../chunk-4AC7YQ5Q.js";import"../chunk-DI7VM62A.js";import"../chunk-A4USB53Q.js";import"../chunk-K3DTH6XN.js";import"../chunk-WBPDMDW4.js";import"../chunk-6KRECIRI.js";import"../chunk-FW4363Y4.js";export{i as createHead,g as dehydrate,c as getCookieFromRequest,b as getFullRequestLocation,a as getFullRequestUrl,d as getPreferredLocale,f as htmlpage,h as renderSSRMinimal,l as serverNoSSR,e as setApplication,k as setServerPreferences,j as setServerPreferencesFromArray};
+//# sourceMappingURL=index.js.map

package/dist/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/styled-components.d-CrkOxzv5.d.cts

@@ -0,0 +1,346 @@
+import * as _reduxjs_toolkit from '@reduxjs/toolkit';
+import { Reducer } from '@reduxjs/toolkit';
+import * as history from 'history';
+import { Location, Action } from 'history';
+import * as redux from 'redux';
+import { ErrorResponse, BaseCollection, ModularUIModel, Href } from '@beinformed/ui/models';
+import { MessageParameters } from '@beinformed/ui/types';
+import { immerable } from 'immer';
+import { ModularUIRequestOptions, UpdateHandler } from '@beinformed/ui/utils';
+import { Setting as Setting$1 } from '@beinformed/ui/settings';
+import { DefaultTheme } from 'styled-components';
+
+interface ProgressIndicatorState {
+    count: number;
+    timestamp: number;
+    percentComplete: number;
+}
+declare const progressIndicatorReducer: redux.Reducer<ProgressIndicatorState> & {
+    getInitialState: () => ProgressIndicatorState;
+};
+
+interface LocaleConfiguration {
+    code: string;
+    messages: Record<string, string>;
+    errors?: Record<string, string>;
+    nativeName?: string;
+}
+interface MessageObject {
+    id: string;
+    defaultMessage?: string;
+    parameters?: MessageParameters;
+}
+
+interface NotificationState {
+    render: boolean;
+    messageType: string | undefined;
+    message: MessageObject | undefined;
+    error: ErrorResponse | undefined;
+}
+interface ShowNotificationArguments {
+    type: NOTIFICATION_TYPES | undefined;
+    message: MessageObject | undefined;
+    error?: ErrorResponse | undefined;
+    timeout?: number;
+}
+declare enum NOTIFICATION_TYPES {
+    SUCCESS = "SUCCESS",
+    INFO = "INFO",
+    WARNING = "WARNING",
+    ERROR = "ERROR"
+}
+declare const showNotification: _reduxjs_toolkit.AsyncThunk<void, ShowNotificationArguments, {
+    state?: unknown;
+    dispatch?: _reduxjs_toolkit.ThunkDispatch<unknown, unknown, redux.UnknownAction>;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+declare const dismissNotification: _reduxjs_toolkit.ActionCreatorWithoutPayload<"DISMISS_NOTIFICATION">;
+declare const notificationReducer: redux.Reducer<NotificationState> & {
+    getInitialState: () => NotificationState;
+};
+
+interface ModelCatalogState {
+    entryDate: string | undefined;
+}
+declare const updateEntryDate: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[entryDate: string], string, "UPDATE_ENTRYDATE", never, never>;
+/**
+ * Keep track of the entry date for the modelcatalog
+ */
+declare const modelCatalogReducer: redux.Reducer<ModelCatalogState> & {
+    getInitialState: () => ModelCatalogState;
+};
+
+interface ModalState {
+    key: string;
+    visible: boolean;
+    size?: string;
+}
+interface ModalsState {
+    modals: ModalState[];
+}
+declare const showModal: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[key: string], string, "SHOW_MODAL", never, never>;
+declare const closeModal: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[key: string], string, "CLOSE_MODAL", never, never>;
+declare const modalsReducer: redux.Reducer<ModalsState> & {
+    getInitialState: () => ModalsState;
+};
+
+interface AuthState {
+    authenticated: boolean;
+    mustChangePassword: boolean;
+    error: string | null;
+}
+declare const loginSuccess: _reduxjs_toolkit.ActionCreatorWithoutPayload<"AUTHENTICATION_SUCCESS">;
+declare const logoutSuccess: _reduxjs_toolkit.ActionCreatorWithoutPayload<"AUTHENTICATION_LOGOUT">;
+declare const sendAuthenticationError: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[errorMessage: string], string, "AUTHENTICATION_ERROR", never, never>;
+declare const resetAuthErrors: _reduxjs_toolkit.ActionCreatorWithoutPayload<"AUTHENTICATION_RESET_ERRORS">;
+declare const saveChangePassword: _reduxjs_toolkit.ActionCreatorWithoutPayload<"CHANGE_PASSWORD">;
+declare const authReducer: redux.Reducer<AuthState> & {
+    getInitialState: () => AuthState;
+};
+
+type RouterLocation = Location<{
+    from?: string;
+    modal?: boolean;
+}>;
+interface RouterState {
+    location: RouterLocation | undefined;
+    action: Action | undefined;
+}
+declare const locationChange: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[location: RouterLocation, action: Action], {
+    location: RouterLocation;
+    action: Action;
+}, "ROUTER/LOCATION_CHANGE", never, never>;
+declare const routerReducer: redux.Reducer<RouterState> & {
+    getInitialState: () => RouterState;
+};
+
+/**
+ * Create a locale
+ */
+declare class Locale {
+    #private;
+    [immerable]: boolean;
+    constructor(locale: LocaleConfiguration);
+    /**
+     * Retrieve locale code
+     */
+    get code(): string;
+    /**
+     * Retrieve nativeName
+     */
+    get nativeName(): string;
+    /**
+     * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
+     * where the ICU messageformat module uses {placeholder_name}.
+     * This method converts the ${} to {}
+     */
+    fixPlaceHolders(message: string | undefined): string | null;
+    /**
+     * Exported messages from Be Informed have placeholders in the syntax ${placeholder_name}
+     * where the ICU messageformat module uses {placeholder_name}.
+     * This method converts the ${} to {}
+     */
+    private fixPlaceHoldersInObject;
+    /**
+     * Retrieve message by id
+     */
+    getBaseMessage(id: string, defaultMessage?: string): string;
+    /**
+     * Format message using formatMessage library
+     */
+    formatMessage(message: string, parameters?: MessageParameters): string;
+    /**
+     * Retrieve a messages with replaced parameters
+     */
+    getMessage(id: string, defaultMessage?: string, parameters?: MessageParameters): string;
+    /**
+     * Add or change messages for this locale. It is not possible to remove messages.
+     */
+    update(messages?: Record<string, string>, errors?: Record<string, string>): void;
+}
+
+type ErrorMessageObject = Record<string, Record<string, string>>;
+interface HydratedLocales {
+    collection: {
+        code: string;
+        messages: Record<string, string>;
+        errors: Record<string, string>;
+    }[];
+}
+/**
+ * Array of available locales
+ * Order of locales is the preferred order of locales.
+ * When user has an accept language header that does not correspond to the locales array,
+ * the first one is used as the preferred language
+ */
+declare const availableLocales: LocaleConfiguration[];
+/**
+ * Merge an object with custom error messages (exported and translated from be informed for example) and merge them with the existing translations.
+ */
+declare const createLocalesWithConfiguredErrors: (configuredErrors: ErrorMessageObject) => LocaleConfiguration[];
+/**
+ * Locales, collection of Locale
+ */
+declare class Locales extends BaseCollection<Locale> {
+    constructor(locales?: LocaleConfiguration[]);
+    /**
+     * rehydrate
+     */
+    static rehydrate(hydatedLocales: HydratedLocales): Locales;
+    /**
+     * Check if locale with localeCode exists
+     */
+    hasLocale(localeCode: string): boolean;
+    /**
+     * Retrieve locales by localeCode from Locales collection
+     */
+    getLocale(localeCode: string): Locale;
+    /**
+     * Retrieve all available locale codes
+     */
+    get availableLocaleCodes(): string[];
+    /**
+     * Retrieve preferred locale based on the accept header of a browser
+     */
+    getPreferredLocale(acceptLanguageHeader: string | null): string | undefined;
+    /**
+     * Add or change messages and errors for the given locale.<br>
+     * It is not possible to remove messages.
+     */
+    update(locale: string, messages?: Record<string, string>, errors?: Record<string, string>): void;
+}
+
+interface I18nState {
+    locales: Locales;
+    locale: string;
+}
+declare const receiveLocale: (locale: string) => {
+    payload: string;
+    type: "UPDATE_LOCALE";
+};
+declare const updateLocale: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[locale: string], string, "UPDATE_LOCALE", never, never>;
+declare const setLocales: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[locales: Locales, locale: string], {
+    locales: Locales;
+    locale: string;
+}, "SET_LOCALES", never, never>;
+declare const i18nReducer: redux.Reducer<I18nState> & {
+    getInitialState: () => I18nState;
+};
+
+interface ModelEntry {
+    status: string;
+    model?: ModularUIModel;
+    lastModification: number;
+    requestOptions?: ModularUIRequestOptions;
+    error?: ErrorResponse;
+}
+interface FetchModelPayload {
+    key: string;
+    href: Href | string;
+    options?: ModularUIRequestOptions;
+}
+interface FetchModelResult {
+    key: string;
+    model: ModularUIModel;
+    updateHandler?: UpdateHandler;
+}
+
+type ModularUIState = Record<string, ModelEntry>;
+declare const modularUIReducer: redux.Reducer<ModularUIState> & {
+    getInitialState: () => ModularUIState;
+};
+
+type SimplePreferenceValue = null | string | boolean | Record<string, unknown>;
+type PreferenceValue = SimplePreferenceValue | SimplePreferenceValue[];
+
+type ThemePropValue = undefined | null | string | number | boolean | string[] | Record<string, Setting$1>;
+type Theme = DefaultTheme;
+interface UtilThemeProps {
+    theme: Theme;
+}
+
+type PreferencesState = Record<string, PreferenceValue> & {
+    theme?: Theme;
+};
+declare const setPreference: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[propertyName: string, propertyValue: PreferenceValue], {
+    key: string;
+    value: PreferenceValue;
+}, "SET_PREFERENCE", never, never>;
+declare const setPreferences: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[preferences: Record<string, PreferenceValue>], {
+    [x: string]: PreferenceValue;
+}, "SET_PREFERENCES", never, never>;
+declare const preferencesReducer: redux.Reducer<PreferencesState> & {
+    getInitialState: () => PreferencesState;
+};
+
+type ErrorState = null | ErrorResponse;
+declare const saveError: _reduxjs_toolkit.ActionCreatorWithPreparedPayload<[error: ErrorResponse], ErrorResponse, "SAVE_ERROR", never, never>;
+declare const errorReducer: redux.Reducer<ErrorState> & {
+    getInitialState: () => ErrorState;
+};
+
+declare const rootReducers: Reducer<{
+    router: RouterState;
+    preferences: PreferencesState;
+    modularui: ModularUIState;
+    i18n: I18nState;
+    auth: AuthState;
+    error: ErrorState;
+    modals: ModalsState;
+    modelcatalog: ModelCatalogState;
+    notification: NotificationState;
+    progressindicator: ProgressIndicatorState;
+}, redux.UnknownAction, Partial<{
+    router: RouterState | undefined;
+    preferences: PreferencesState | undefined;
+    modularui: ModularUIState | undefined;
+    i18n: I18nState | undefined;
+    auth: AuthState | undefined;
+    error: ErrorState | undefined;
+    modals: ModalsState | undefined;
+    modelcatalog: ModelCatalogState | undefined;
+    notification: NotificationState | undefined;
+    progressindicator: ProgressIndicatorState | undefined;
+}>>;
+declare const setupStore: (preloadedState?: Partial<RootState>, customReducers?: Record<string, Reducer> | null, history?: history.History<unknown>) => _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]>>;
+type BEIStore = ReturnType<typeof setupStore>;
+type RootState = ReturnType<typeof rootReducers>;
+type BEIDispatch = BEIStore["dispatch"];
+
+declare module "styled-components" {
+  export interface DefaultTheme {
+    [key: string]: ThemePropValue;
+    settings?: Record<string, Setting>;
+  }
+}
+
+export { type RootState as $, type AuthState as A, type ModelEntry as B, type FetchModelResult as C, NOTIFICATION_TYPES as D, type ErrorState as E, type FetchModelPayload as F, showNotification as G, dismissNotification as H, type I18nState as I, notificationReducer as J, setPreference as K, Locale as L, type MessageObject as M, type NotificationState as N, setPreferences as O, type PreferencesState as P, preferencesReducer as Q, type PreferenceValue as R, type ShowNotificationArguments as S, type ProgressIndicatorState as T, progressIndicatorReducer as U, type RouterLocation as V, type RouterState as W, locationChange as X, routerReducer as Y, setupStore as Z, type BEIStore as _, availableLocales as a, type BEIDispatch as a0, type ThemePropValue as a1, type Theme as a2, type UtilThemeProps as a3, Locales as b, createLocalesWithConfiguredErrors as c, type LocaleConfiguration as d, logoutSuccess as e, saveChangePassword as f, authReducer as g, saveError as h, errorReducer as i, receiveLocale as j, setLocales as k, loginSuccess as l, i18nReducer as m, type ModalState as n, type ModalsState as o, showModal as p, closeModal as q, resetAuthErrors as r, sendAuthenticationError as s, modalsReducer as t, updateLocale as u, type ModelCatalogState as v, updateEntryDate as w, modelCatalogReducer as x, type ModularUIState as y, modularUIReducer as z };