@beinformed/ui 1.59.21-beta.2 → 1.59.21-beta.4

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [1.59.21-beta.4](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.21-beta.3...v1.59.21-beta.4) (2025-02-18)
+
+
+### Bug Fixes
+
+* **types:** improve typescript declaration files to prevent deep imports ([68e0c5d](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/commit/68e0c5d7b6f45a248c96c29b758cdbeea1ba0c8f))
+
+## [1.59.21-beta.3](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.21-beta.2...v1.59.21-beta.3) (2025-02-13)
+
+
+### Bug Fixes
+
+* **dependencies:** force the use of esm bundles when building for browsers ([7a1e2b0](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/commit/7a1e2b0a483e9ddfd3b19178a034241922b6e6b0))
+
 ## [1.59.21-beta.2](https://git.beinformed.com/public/nl.beinformed.bi.layout.lib.ui/compare/v1.59.21-beta.1...v1.59.21-beta.2) (2025-02-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beinformed/ui",
-  "version": "1.59.21-beta.2",
+  "version": "1.59.21-beta.4",
   "description": "Toolbox for be informed javascript layouts",
   "license": "SEE LICENSE IN LICENSE.md",
   "bugs": "http://support.beinformed.com",
@@ -11,22 +11,16 @@
     "node": "^14.13.1 || >=16.0.0"
   },
   "sideEffects": false,
-  "exports": {
-    "import": "./esm/index.js",
-    "require": "./lib/index.js",
-    "default": "./esm/index.js"
-  },
   "scripts": {
     "start": "npm run watch:esm",
     "watch:lib": "babel src --watch --out-dir lib --ignore \"**/__tests__/**\" --ignore \"**/__mock__/**\" --ignore \"**/__mocks__/**\"",
     "watch:esm": "cross-env BABEL_ENV=esm babel --watch src --out-dir esm --ignore \"**/__tests__/**\" --ignore \"**/__mock__/**\" --ignore \"**/__mocks__/**\"",
     "quality": "npm run lint && npm run flow && npm run test",
-    "dev": "npm run clean && npm run build:lib && npm run build:flow && npm run build:proxies && npm run build:esm && npm run build:fixup",
-    "build": "npm run quality && npm run clean && npm run build:lib && npm run build:flow && npm run build:proxies && npm run build:esm && npm run build:fixup",
+    "dev": "npm run clean && npm run build:lib && npm run build:flow && npm run build:proxies && npm run build:esm",
+    "build": "npm run quality && npm run clean && npm run build:lib && npm run build:flow && npm run build:proxies && npm run build:esm",
     "build:lib": "babel src --out-dir lib --ignore \"**/__tests__/**\" --ignore \"**/__mock__/**\" --ignore \"**/__mocks__/**\" --source-maps",
     "build:esm": "cross-env BABEL_ENV=esm babel src --out-dir esm --ignore \"**/__tests__/**\" --ignore \"**/__mock__/**\" --ignore \"**/__mocks__/**\" --source-maps",
     "build:proxies": "node .build/proxies.js",
-    "build:fixup": "node .build/fixup.js",
     "build:flow": "flow-copy-source ./src ./lib",
     "clean": "rimraf lib dist esm coverage && npm run clean:proxies",
     "clean:proxies": "node .build/proxies.js --clean",
@@ -42,10 +36,10 @@
     "release": "commit-and-tag-version",
     "beta-release": "commit-and-tag-version --prerelease beta",
     "prepublishOnly": "npm run build",
-    "docs": "node ./.build/docs.mjs",
+    "docs": "rimraf docs && node ./.build/docs.mjs",
     "prepare": "husky",
     "security-audit": "auditjs ossi --xml > npm-audit.xml",
-    "generate-ts": "npx -p typescript tsc src/index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
+    "generate-ts": "rimraf types && npx -p typescript tsc"
   },
   "repository": {
     "type": "git",
@@ -88,7 +82,7 @@
     "styled-components": "^5.0.0"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.26.7",
+    "@babel/runtime-corejs3": "^7.26.9",
     "@date-fns/tz": "^1.2.0",
     "big.js": "^6.2.2",
     "date-fns": "^4.1.0",
@@ -107,13 +101,13 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",
-    "@babel/core": "^7.26.8",
+    "@babel/core": "^7.26.9",
     "@babel/eslint-parser": "^7.26.8",
     "@babel/eslint-plugin": "^7.25.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.26.8",
-    "@babel/preset-env": "^7.26.8",
+    "@babel/plugin-transform-runtime": "^7.26.9",
+    "@babel/preset-env": "^7.26.9",
     "@babel/preset-flow": "^7.25.9",
     "@babel/preset-react": "^7.26.3",
     "@commitlint/cli": "^19.7.1",
@@ -149,7 +143,7 @@
     "jscodeshift": "^17.1.2",
     "lint-staged": "^15.4.3",
     "polished": "^4.0.0",
-    "prettier": "^3.5.0",
+    "prettier": "^3.5.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-helmet-async": "^2.0.5",
@@ -170,5 +164,77 @@
     "*.js": "eslint --cache --fix",
     "*.{js,css,md}": "prettier --write"
   },
-  "types": "./types/index.d.ts"
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./lib/index.js",
+      "default": "./esm/index.js"
+    },
+    "./builder": {
+      "import": "./esm/builder/index.js",
+      "require": "./lib/builder/index.js",
+      "default": "./esm/builder/index.js"
+    },
+    "./constants": {
+      "import": "./esm/constants/index.js",
+      "require": "./lib/constants/index.js",
+      "default": "./esm/constants/index.js"
+    },
+    "./exceptions": {
+      "import": "./esm/exceptions/index.js",
+      "require": "./lib/exceptions/index.js",
+      "default": "./esm/exceptions/index.js"
+    },
+    "./hooks": {
+      "import": "./esm/hooks/index.js",
+      "require": "./lib/hooks/index.js",
+      "default": "./esm/hooks/index.js"
+    },
+    "./i18n": {
+      "import": "./esm/i18n/index.js",
+      "require": "./lib/i18n/index.js",
+      "default": "./esm/i18n/index.js"
+    },
+    "./models": {
+      "import": "./esm/models/index.js",
+      "require": "./lib/models/index.js",
+      "default": "./esm/models/index.js"
+    },
+    "./modularui": {
+      "import": "./esm/modularui/index.js",
+      "require": "./lib/modularui/index.js",
+      "default": "./esm/modularui/index.js"
+    },
+    "./react": {
+      "import": "./esm/react/index.js",
+      "require": "./lib/react/index.js",
+      "default": "./esm/react/index.js"
+    },
+    "./react-client": {
+      "import": "./esm/react-client/index.js",
+      "require": "./lib/react-client/index.js",
+      "default": "./esm/react-client/index.js"
+    },
+    "./react-server": {
+      "import": "./esm/react-server/index.js",
+      "require": "./lib/react-server/index.js",
+      "default": "./esm/react-server/index.js"
+    },
+    "./react-theme": {
+      "import": "./esm/react-theme/index.js",
+      "require": "./lib/react-theme/index.js",
+      "default": "./esm/react-theme/index.js"
+    },
+    "./redux": {
+      "import": "./esm/redux/index.js",
+      "require": "./lib/redux/index.js",
+      "default": "./esm/redux/index.js"
+    },
+    "./utils": {
+      "import": "./esm/utils/index.js",
+      "require": "./lib/utils/index.js",
+      "default": "./esm/utils/index.js"
+    }
+  }
 }

package/types/builder/index.d.ts

@@ -0,0 +1 @@
+export * from "./mergeLayoutHintConfigurations";

package/types/builder/mergeLayoutHintConfigurations.d.ts

@@ -0,0 +1 @@
+export function mergeLayoutHintConfigurations(srcFolder: string, outputFolder: string): Promise<void>;

package/types/exceptions/ConfigurationException.d.ts

@@ -3,4 +3,5 @@ export default ConfigurationException;
  * ConfigurationException
  */
 declare class ConfigurationException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/IllegalArgumentException.d.ts

@@ -3,4 +3,5 @@ export default IllegalArgumentException;
  * IllegalArgumentException
  */
 declare class IllegalArgumentException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/IllegalReturnException.d.ts

@@ -2,4 +2,5 @@ export default IllegalReturnException;
 /**
  */
 declare class IllegalReturnException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/IllegalStateException.d.ts

@@ -3,4 +3,5 @@ export default IllegalStateException;
  * IllegalStateException
  */
 declare class IllegalStateException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/JsonParseException.d.ts

@@ -3,4 +3,5 @@ export default JsonParseException;
  * JsonParseException
  */
 declare class JsonParseException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/MissingPropertyException.d.ts

@@ -3,4 +3,5 @@ export default MissingPropertyException;
  * MissingPropertyException
  */
 declare class MissingPropertyException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/NotAllowedUriException.d.ts

@@ -3,4 +3,5 @@ export default NotAllowedUriException;
  * NotAllowedUriException
  */
 declare class NotAllowedUriException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/ServerRequestException.d.ts

@@ -3,4 +3,5 @@ export default ServerRequestException;
  * ServerRequestException
  */
 declare class ServerRequestException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/ThemePropertyException.d.ts

@@ -3,4 +3,5 @@ export default ThemePropertyException;
  * ThemePropertyException
  */
 declare class ThemePropertyException extends Error {
+    constructor(message: string);
 }

package/types/exceptions/UnsupportedOperationException.d.ts

@@ -3,4 +3,5 @@ export default UnsupportedOperationException;
  * UnsupportedOperationException
  */
 declare class UnsupportedOperationException extends Error {
+    constructor(message: string);
 }

package/types/hooks/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./useAuthentication";
+export * from "./useContent";
+export * from "./useForm";
+export * from "./useI18n";
+export * from "./useModal";
+export * from "./useModelCatalog";
+export * from "./useModels";
+export * from "./useModularUI";
+export * from "./useModularUIBasic";
+export * from "./useModularUIModel";
+export * from "./useModularUIRequest";
+export * from "./useNotification";
+export * from "./usePreference";
+export * from "./useProgressIndicator";
+export * from "./useRouter";
+export * from "./useAllFormsOnModel";

package/types/hooks/useAllFormsOnModel.d.ts

@@ -0,0 +1,7 @@
+export function useRetrieveFormsOnModel(model: ListModel | DetailModel | TabModel): null | {
+    [actionName: string]: FormModel;
+};
+import ListModel from "../models/list/ListModel";
+import DetailModel from "../models/detail/DetailModel";
+import TabModel from "../models/tab/TabModel";
+import FormModel from "../models/form/FormModel";

package/types/hooks/useAuthentication.d.ts

@@ -0,0 +1,16 @@
+export function useLogin(): LoginHook;
+export function useLogout(): LogoutHook;
+type LoginHook = {
+    isAuthenticated: boolean;
+    authenticationTypes: AuthenticationType[];
+    errorMessage: string | null;
+    resetErrors: () => ResetAuthErrorsAction;
+    login: (username: string, password: string) => void;
+    redirectLogin: (authenticationType: AuthenticationType) => void;
+};
+type LogoutHook = {
+    isAuthenticated: boolean;
+    authenticationTypes: AuthenticationType[];
+    logout: () => void;
+};
+export {};

package/types/hooks/useContent.d.ts

@@ -0,0 +1,3 @@
+export function useContentFromSourceReferences(sourceReferences: SourceReferenceCollection, renderChildSections: boolean): Array<ContentModel>;
+import SourceReferenceCollection from "../models/concepts/SourceReferenceCollection";
+import ContentModel from "../models/content/ContentModel";

package/types/hooks/useDeepCompareEffect.d.ts

@@ -0,0 +1,6 @@
+/**
+ */
+export function useDeepCompareEffect(callback: Callback, dependencies: DependencyList): void;
+export default useDeepCompareEffect;
+type Callback = () => void | (() => void);
+type DependencyList = mixed[];

package/types/hooks/useForm.d.ts

@@ -0,0 +1,21 @@
+export function useForm(href: string | Href, data?: Object): FormModel | null;
+export function useFormNavigation(): FormNavigationHook;
+export function useAttributeUpdate(form: FormModel, object: FormObjectModel): AttributeUpdateHook;
+export function useAttributeSet(form: FormModel): AttributeSetHook;
+import Href from "../models/href/Href";
+import FormModel from "../models/form/FormModel";
+type FormNavigationHook = {
+    previous: (form: FormModel) => UpdateFormAction;
+    cancel: (form: FormModel) => void;
+    submit: (form: FormModel) => void;
+    showFormNotification: (form: FormModel) => void;
+    remove: (form: FormModel) => RemoveModelByKeyAction;
+};
+import { FormObjectModel } from "../models";
+type AttributeUpdateHook = (attribute: AttributeType, value: string, options: UpdateFormOptions) => void;
+type AttributeSetHook = {
+    save: () => UpdateFormAction;
+    cancel: (object: FormObjectModel) => UpdateFormAction;
+    remove: (object: FormObjectModel) => UpdateFormAction;
+};
+export {};

package/types/hooks/useModal.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Manage modals
+ */
+export const useModal: ModalHook;
+type ModalHook = (modalId: string) => {
+    key: string | null;
+    size: string | null;
+    visible: boolean;
+    show: () => void;
+    close: () => void;
+};
+export {};

package/types/hooks/useModelCatalog.d.ts

@@ -0,0 +1,31 @@
+type SearchFilter = {
+    index?: string | undefined;
+    label?: string | undefined;
+    type?: string | string[] | undefined;
+    modelCategory?: string | string[] | undefined;
+    entryDate?: string | undefined;
+};
+export function useModelCatalog(options?: any): ModelCatalogModel | null;
+export function useConceptIndex(href: string | Href, key?: string, options?: any): ConceptIndexModel | null;
+export function useConceptDetail(concept: string | Href, key?: string, options?: any): (ConceptDetailModel | (BusinessScenarioModel | null)) | null;
+export function useContentIndex(href: string | Href, key?: string, options?: any): ContentIndexModel | null;
+export function useContentTOC(content: string | Href, key?: string, options?: any): ContentTOCModel | null;
+export function useContent(contentSection: string | Href, key?: string, options?: any): ContentModel | null;
+export function useContentType(contentType: string | Href, key?: string, options?: any): ContentTypeModel | null;
+export function useConceptSearch(filters: SearchFilter, key?: string, options?: any): ConceptIndexModel | null;
+export function useContentSearch(filters: SearchFilter, key?: string, options?: any): ContentIndexModel | null;
+export function useEntryDate(): ({
+    entryDate: ISO_DATE;
+    setEntryDate: (entryDate: ISO_DATE) => UpdateEntryDateAction;
+});
+import ModelCatalogModel from "../models/modelcatalog/ModelCatalogModel";
+import Href from "../models/href/Href";
+import ConceptIndexModel from "../models/concepts/ConceptIndexModel";
+import ConceptDetailModel from "../models/concepts/ConceptDetailModel";
+import { default as BusinessScenarioModel } from "../models/concepts/BusinessScenarioModel";
+import ContentIndexModel from "../models/content/ContentIndexModel";
+import ContentTOCModel from "../models/content/ContentTOCModel";
+import ContentModel from "../models/content/ContentModel";
+import { ContentTypeModel } from "../models";
+import { UpdateEntryDateAction } from "../redux";
+export {};

package/types/hooks/useModels.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Hook that contains the reload property that can be used to reload a model
+ */
+export const useModels: UseModels;
+type UseModels = () => {
+    reload: (model: ModularUIModel, options?: any) => void;
+    reloadWithFilter: (callbackFn: ReloadCallback, options?: any) => void;
+};
+type ReloadCallback = (model: ModularUIModel) => boolean;
+export {};

package/types/hooks/useModularUI.d.ts

@@ -0,0 +1,3 @@
+export function useModularUI(modelKey: string, url: string | Href, options?: RequestModularUIOptions): any;
+import Href from "../models/href/Href";
+import { RequestModularUIOptions } from "../utils";

package/types/hooks/useModularUIBasic.d.ts

@@ -0,0 +1,9 @@
+type UseModularUIBasicOptions<T, ModularUIModel> = {
+    expectedModels?: string[] | undefined;
+    targetModel?: any;
+    forceTargetModel?: boolean | undefined;
+    origin?: string | undefined;
+    contextPath?: string | undefined;
+    cache?: boolean | undefined;
+};
+export {};

package/types/hooks/useModularUIModel.d.ts

@@ -0,0 +1,27 @@
+export function useApplication(options?: HookOptions): ApplicationModel | null;
+export function useTab(href: string | Href, options?: HookOptions): TabModel | null;
+export function useCaseView(href: string | Href, options?: HookOptions): CaseViewModel | null;
+export function usePanel(href: string | Href, options?: HookOptions): ListModel | GroupingPanelModel | DetailModel | null;
+export function useList(href: string | Href, options?: HookOptions): ListModel | null;
+export function useListOrDetail(href: string | Href, options?: HookOptions): ListModel | DetailModel | null;
+export function useListDetail(href: string | Href, options?: HookOptions): ListDetailModel | null;
+export function useGroupingPanel(href: string | Href, options?: HookOptions): GroupingPanelModel | null;
+export function useDetailPanel(href: string | Href, options?: HookOptions): DetailModel | null;
+export function useQuicksearch(href: string | Href, options?: HookOptions): CaseSearchModel | null;
+export function useSearch(href: string | Href, options?: HookOptions): CaseSearchModel | null;
+export function useUserProfile(href: string | Href, options?: HookOptions): UserProfileModel | null;
+type HookOptions = {
+    origin?: string | undefined;
+    contextPath?: string | undefined;
+};
+import ApplicationModel from "../models/application/ApplicationModel";
+import Href from "../models/href/Href";
+import TabModel from "../models/tab/TabModel";
+import CaseViewModel from "../models/caseview/CaseViewModel";
+import ListModel from "../models/list/ListModel";
+import GroupingPanelModel from "../models/panels/GroupingPanelModel";
+import DetailModel from "../models/detail/DetailModel";
+import ListDetailModel from "../models/list/ListDetailModel";
+import CaseSearchModel from "../models/search/CaseSearchModel";
+import UserProfileModel from "../models/user/UserProfileModel";
+export {};

package/types/hooks/useModularUIRequest.d.ts

@@ -0,0 +1,4 @@
+export function useModularUIRequest(): ((href: Href, options?: $Shape<RequestModularUIOptions>) => ModularUIRequest);
+import Href from "../models/href/Href";
+import { RequestModularUIOptions } from "../utils";
+import ModularUIRequest from "../modularui/ModularUIRequest";

package/types/hooks/useNotification.d.ts

@@ -0,0 +1,8 @@
+export function useNotification(): NotificationHook;
+export function useErrorNotification(): ErrorNotificationHook;
+type NotificationHook = {
+    NotificationState: any;
+    dismiss: () => DismissNotificationAction;
+};
+type ErrorNotificationHook = (message: MessageObject, error?: ErrorResponse | null | undefined) => ShowNotificationAction;
+export {};

package/types/hooks/usePreference.d.ts

@@ -0,0 +1,2 @@
+export function usePreference(preferenceNames: string | Array<string>): PreferencesState;
+import { PreferencesState } from "../redux/types";

package/types/hooks/useProgressIndicator.d.ts

@@ -0,0 +1,9 @@
+export function useProgressIndicator(): ProgressIndicatorHook;
+type ProgressIndicatorHook = {
+    ProgressIndicatorState: any;
+    start: () => void;
+    finish: () => void;
+    reset: () => void;
+    update: (percentComplete: number) => void;
+};
+export {};

package/types/hooks/useRouter.d.ts

@@ -0,0 +1,23 @@
+/**
+ */
+export const useLocation: UseLocationHook;
+/**
+ */
+export const useLocationKey: UseLocationKeyHook;
+/**
+ */
+export const useQuerystring: UseQuerystringHook;
+/**
+ */
+export const usePathname: UsePathnameHook;
+/**
+ */
+export const useNavigation: UseNavigationHook;
+type UseLocationHook = () => Location;
+type UseLocationKeyHook = () => string;
+type UseQuerystringHook = () => string;
+type UsePathnameHook = () => string;
+type UseNavigationHook = () => {
+    push: (location: any, state?: {} | undefined, ...: any[]) => any;
+};
+export {};

package/types/i18n/types.d.ts

@@ -5,7 +5,7 @@ type MessageObject = {};
 type LocaleConfiguration = {
     code: string;
     messages: Object;
-    errors?: Object;
-    nativeName?: string;
+    errors?: Object | undefined;
+    nativeName?: string | undefined;
 };
 export {};

package/types/models/actions/ActionModel.d.ts

@@ -69,7 +69,7 @@ export default class ActionModel extends BaseModel {
     get isProcessTask(): boolean;
     /**
      */
-    get processStatus(): ProcessStatusSettingsModel;
+    get processStatus(): ProcessStatusSettingsModel | null;
     /**
      */
     set icon(icon: string);

package/types/models/application/ApplicationModel.d.ts

@@ -9,11 +9,11 @@ export default class ApplicationModel extends ResourceModel {
     /**
      * Set the userservices for this application
      */
-    set userServices(model: UserServicesModel);
+    set userServices(model: UserServicesModel | null);
     /**
      * returns the userservices configured for this application
      */
-    get userServices(): UserServicesModel;
+    get userServices(): UserServicesModel | null;
     /**
      * Getting the authentication types of the application
      */
@@ -34,7 +34,7 @@ export default class ApplicationModel extends ResourceModel {
      * Retrieve link to the user information,
      * only available when the user services are available
      */
-    get userHref(): Href;
+    get userHref(): Href | null;
     /**
      */
     get userMustChangePassword(): boolean;

package/types/models/attributes/AttributeCollection.d.ts

@@ -82,7 +82,7 @@ declare class AttributeCollection extends ResourceCollection<AttributeType, any>
      * Generate formdata object for current collection based on formdata of attributes
      * Skip attributes that are readonly, the confirmation password or null
      */
-    get formdata(): {};
+    get formdata(): {} | null;
     /**
      */
     getFormData(validationData?: boolean): {

package/types/models/attributes/AttributeContent.d.ts

@@ -18,7 +18,7 @@ declare class AttributeContent {
     get elements(): ContentAll;
     /**
      */
-    get label(): string;
+    get label(): string | null;
     /**
      */
     getContentElements<T>(elementName: string): T[];