@beinformed/ui 1.25.6 → 1.27.0-beta.0

package/src/redux/_modularui/types.js

@@ -36,6 +36,14 @@ export type SetModelAction = {
   },
 };
 
+export type InitModelAction = {
+  type: "MODULARUI/INIT",
+  payload: Array<{
+    key: string,
+    model: ModularUIModel,
+  }>,
+};
+
 export type UpdateModelAction = {
   type: "MODULARUI/UPDATE",
   payload: ModularUIModel,
@@ -54,7 +62,7 @@ export type ModularUIAction = {
   payload: {
     href: Href,
     method?: $Keys<HTTP_METHODS>,
-    data?: string | { [key: string]: string },
+    data?: any,
     locale: string,
     childmodels?: boolean,
     targetModel?: TargetModel,

package/src/redux/store/configureStore.js

@@ -49,7 +49,7 @@ const configureStore = (
     enhancers
   );
 
-  if (!initialState) {
+  if (!initialState?.router) {
     store.dispatch(locationChange(history.location, "PUSH"));
   }
   return { history, store };

package/src/redux/types.js

@@ -23,6 +23,7 @@ import type {
   UpdateModelAction,
   RemoveModelByKeyAction,
   ResetModularUIAction,
+  InitModelAction,
 } from "./_modularui/types";
 import type {
   RouterState,
@@ -135,6 +136,7 @@ export type UpdateAutosaveAction = {
 export type ReduxAction =
   | UpdateStatusAction
   | SetModelAction
+  | InitModelAction
   | UpdateModelAction
   | RemoveModelByKeyAction
   | ResetModularUIAction

package/src/utils/browser/Cookies.js

@@ -1,7 +1,7 @@
 // @flow
 import Cookies from "js-cookie";
 
-import { BASE } from "../../constants/Constants";
+import { getBasePath } from "../../constants/Settings";
 
 type CookieOptions = {
   days?: number,
@@ -18,14 +18,18 @@ type CookieAttributes = {
 
 /**
  */
-const getCookie = (name: string): null | string => {
+export const getCookie = (name: string): null | string => {
   return Cookies.get(name);
 };
 
 /**
  */
-const setCookie = (name: string, value: any, options?: CookieOptions) => {
-  const attributes: CookieAttributes = { path: BASE };
+export const setCookie = (
+  name: string,
+  value: any,
+  options?: CookieOptions
+) => {
+  const attributes: CookieAttributes = { path: getBasePath() };
   attributes.expires = options?.days;
   attributes.sameSite = options?.sameSite ?? "Strict";
   attributes.secure = options?.secure;
@@ -35,8 +39,6 @@ const setCookie = (name: string, value: any, options?: CookieOptions) => {
 
 /**
  */
-const clearCookie = (name: string) => {
-  Cookies.remove(name, { path: BASE });
+export const clearCookie = (name: string) => {
+  Cookies.remove(name, { path: getBasePath() });
 };
-
-export { getCookie, setCookie, clearCookie };

package/src/utils/fetch/serverFetch.js

@@ -1,5 +1,5 @@
 // @flow
-import { BASE } from "../../constants/Constants";
+import { getBasePath } from "../../constants/Settings";
 import { FetchException } from "../../exceptions";
 
 import type { RequestOptions } from "./types";
@@ -11,7 +11,7 @@ export default function serverFetch(args: RequestOptions): Promise<any> {
   // remove contextPath of url, when the request is internal the context path is not needed
   const urlNoBase = args.url.includes("http")
     ? args.url
-    : args.url.replace(BASE, "");
+    : args.url.replace(getBasePath(), "");
   const params = args.params
     ? args.params.replace("includeContext=true", "")
     : "";

package/src/utils/fetch/types.js

@@ -10,7 +10,7 @@ export type RequestURLOptions = {
 export type RequestBaseOptions = {
   method?: $Keys<HTTP_METHODS>,
   params?: string,
-  data?: string | { [key: string]: string },
+  data?: any,
   timeout?: number,
   responseType?: string,
   headers?: {

package/src/utils/fetch/universalFetch.js

@@ -1,7 +1,9 @@
 // @flow
 import { isPlainObject } from "../helpers/objects";
 
-import { IS_SYNC, USE_CACHE } from "../../constants/Constants";
+import { IS_SYNC } from "../../constants/Constants";
+import { cacheContributions } from "../../constants";
+
 import serverFetch from "./serverFetch";
 import xhr from "./xhr";
 import Cache from "../browser/Cache";
@@ -45,7 +47,7 @@ const waitForCachedItem = (cacheKey: string) => {
  * @private
  */
 const browserFetch = (args: RequestOptions) => {
-  if (USE_CACHE && args.cache) {
+  if (cacheContributions() && args.cache) {
     const cacheKey = Cache.createResourceKey(args);
 
     if (Cache.hasItem(cacheKey)) {
@@ -64,7 +66,7 @@ const browserFetch = (args: RequestOptions) => {
   }
 
   return xhr(args).then((response) => {
-    if (USE_CACHE && args.cache) {
+    if (cacheContributions() && args.cache) {
       const cacheKey = Cache.createResourceKey(args);
 
       Cache.addItem(cacheKey, response);

package/src/utils/fetch/xhr.js

@@ -105,7 +105,7 @@ class XHR {
 
   /**
    */
-  get data(): string | { [key: string]: string } | null {
+  get data(): any | null {
     return this.options.data || null;
   }
 

package/src/utils/helpers/checkResource.js

@@ -11,8 +11,6 @@ import Href from "../../models/href/Href";
 export const resourceExists = (url: string | Href): boolean => {
   const fullUrl = new Href(url).absolutehref;
 
-  // const fullUrl = `${BASE}/${url}`.replace(/\/\//g, "/");
-
   const xhr = new XMLHttpRequest();
   xhr.open("HEAD", fullUrl, false);
   xhr.setRequestHeader("Accept", "application/json");

package/src/utils/helpers/index.js

@@ -0,0 +1,8 @@
+// @flow
+export * from "./createHash";
+export { default as createUUID } from "./createUUID";
+export * from "./sanitizeHtml";
+export * from "./objects";
+export * from "./text";
+export * from "./checkResource";
+export * from "./repositoryResource";

package/src/utils/helpers/repositoryResource.js

@@ -0,0 +1,20 @@
+// @flow
+import { getBasePath, RESOURCE_PATH } from "../../constants";
+
+/**
+ * Creates an url to a resource in the Be Informed repository
+ * Only possible when serving using the UI Servlet of Be Informed
+ */
+export const getRepositoryResourceUrl = (resourceUrl: string): string => {
+  const basePath = getBasePath();
+
+  if (resourceUrl.startsWith(basePath)) {
+    return resourceUrl;
+  }
+
+  if (resourceUrl.startsWith(RESOURCE_PATH)) {
+    return `${basePath}${resourceUrl}`;
+  }
+
+  return `${basePath}${RESOURCE_PATH}${resourceUrl}`;
+};

package/src/utils/index.js

@@ -14,12 +14,7 @@ export { default as xhr } from "./fetch/xhr";
 export type * from "./fetch/types";
 
 // helpers
-export * from "./helpers/createHash";
-export { default as createUUID } from "./helpers/createUUID";
-export * from "./helpers/sanitizeHtml";
-export * from "./helpers/objects";
-export * from "./helpers/text";
-export * from "./helpers/checkResource";
+export * from "./helpers";
 
 // number
 export { default as DecimalFormat } from "./number/DecimalFormat";

package/types/constants/Constants.d.ts

@@ -1,35 +1,15 @@
-/**
- * Indicates if contributions should be cached
- */
-export const USE_CACHE: true;
-/**
- * Base path
- * This uses contextPath set from property from server
- * When requesting a remote server with CORS enabled, add the origin, for example:
- * export const BEINFORMED_PATH = 'http://192.168.128.61:8080/BeInformed';
- */
-export const BASE: string;
-/**
- * Path to the contributions api end point
- * /contributions uri part is added through the _links in the data service
- */
-export const MODULARUI_CONTRIBUTIONS: "/contributions";
-/**
- * Base Path
- */
-export const APPLICATION_PATH: string;
 /**
  * path to content service
  */
-export const CONTENT_PATH: string;
+export const CONTENT_PATH: "/content";
 /**
  * Upload Path
  */
-export const UPLOAD_PATH: string;
+export const UPLOAD_PATH: "/uploadFile";
 /**
  * Captcha Path
  */
-export const CAPTCHA_PATH: string;
+export const CAPTCHA_PATH: "/captchaServices";
 /**
  * Path to change password page / component
  */
@@ -38,6 +18,10 @@ export const CHANGEPASSWORD_PATH: "/change-password";
  * Path to user profile page / component
  */
 export const USERPROFILE_PATH: "/user";
+/**
+ * Path to resources in the Be Informed repository
+ */
+export const RESOURCE_PATH: "/resource";
 /**
  * Separator for parameters of a list, makes it possible to render multiple lists on a page in a non-js environment
  */
@@ -149,7 +133,7 @@ export const LOGIN_PATH_SETTING: "FormClient.login_url";
 export const LOGIN_USERNAME_SETTING: "FormClient.username_field_name";
 export const LOGIN_PASSWORD_SETTING: "FormClient.password_field_name";
 export const LOGOUT_PATH_SETTING: "FormClient.logout_url";
-export namespace fallbackDefaultAuthenticationType {
+export namespace DEFAULT_AUTHENTICATION_TYPE {
     const name: string;
     const authentication: string;
     const isPrimary: boolean;

package/types/constants/Settings.d.ts

@@ -4,6 +4,10 @@ export function setSetting(key: string, value: any): void;
 export function allSettings(): {
     [name: string]: Setting;
 };
+export function cacheContributions(): boolean;
+export function getBasePath(): string;
+export function getUploadPath(): string;
+export function getCaptchaPath(): string;
 export function hasAllContentInData(): boolean;
 export function loginType(): string;
 export function loginPath(): string;
@@ -12,5 +16,13 @@ export function loginPasswordField(): string;
 export function logoutPath(): string;
 export const LOGIN_PATH: string;
 export const LOGOUT_PATH: string;
+/**
+ * Model overview swim lane configuration
+ */
+export const getSwimLaneDiagramConfiguration: Object;
+/**
+ * Backwards compatible export of BASE constant
+ */
+export const BASE: string;
 type Setting = string | number | boolean | string[];
 export {};

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

@@ -30,9 +30,6 @@ declare class ChoiceAttributeOptionCollection extends ResourceCollection<ChoiceA
     /**
      */
     addBooleanOption(code: "true" | "false", defaultLabel: string, data: string | Array<string>, options?: Array<Object>): void;
-    /**
-     */
-    getDefaultValueForOption(value: any, contributions: Object): string;
     /**
      * Create two static options for true and false,
      * there might be alternative labels configured for each option value

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

@@ -36,7 +36,13 @@ export default class UploadAttributeModel extends StringAttributeModel {
     get uploadConstraints(): {
         fileTypes: FiletypeConstraintsType;
         maxFileSize: FilesizeConstraintsType;
+        acceptedFiles: Array<string>;
     };
+    /**
+     * Array of accepted file extensions and mime types.
+     * Convenience method for accept attribute of file input html control
+     */
+    get acceptedFiles(): string[];
     /**
      */
     set files(arg: FilesType);

package/types/models/error/ErrorModel.d.ts

@@ -31,6 +31,11 @@ declare class ErrorModel {
     /**
      */
     get isMandatoryConstraint(): boolean;
+    /**
+     * Returns a message object from the error
+     */
+    getMessage(): MessageObject;
 }
 import { MessageParameters } from "../../i18n/types";
 import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import { MessageObject } from "../../i18n/types";

package/types/models/href/Href.d.ts

@@ -141,7 +141,7 @@ declare class Href {
      */
     setState(state: any): Href;
     /**
-     * Retrieve the path combined with the BASE of the application, e.g. /BeInformed
+     * Retrieve the path combined with the base path (context-path) of the application, e.g. /BeInformed
      */
     get absolutepath(): string;
     /**

package/types/modularui/CaptchaRequest.d.ts

@@ -0,0 +1,17 @@
+export default CaptchaRequest;
+/**
+ */
+declare class CaptchaRequest {
+    /**
+     */
+    init(): Promise<CaptchaResponse>;
+    /**
+     */
+    send(answer: string): Promise<CaptchaResponse>;
+    #private;
+}
+type CaptchaResponse = {
+    tokenId: string;
+    image: any;
+    valid: boolean;
+};

package/types/modularui/ModularUIRequest.d.ts

@@ -11,6 +11,7 @@ declare class ModularUIRequest {
     _href: Href;
     _options: RequestModularUIOptions;
     _targetModel: TargetModel | null;
+    _forceTargetModel: boolean;
     _contributionsHref: string;
     _locale: string;
     _method: $Keys<{
@@ -69,6 +70,12 @@ declare class ModularUIRequest {
     /**
      */
     get withChildModels(): boolean;
+    /**
+     */
+    set forceTargetModel(arg: boolean);
+    /**
+     */
+    get forceTargetModel(): boolean;
     /**
      */
     resolveModel(): Class<ModularUIModel>;
@@ -174,6 +181,12 @@ declare class ModularUIRequest {
      * @returns {Promise<FormModel>}
      */
     postForm(form: FormModel): Promise<FormModel>;
+    /**
+     * Simplified synchronous version of fetch (returns the model, not a Promise)
+     * This can be used on the server to retrieve a model. It only loads the request url and it's child models
+     */
+    fetchSync(): ModularUIModel;
+    #private;
 }
 import ModularUIResponse from "./ModularUIResponse";
 import Href from "../models/href/Href";

package/types/modularui/UploadRequest.d.ts

@@ -0,0 +1,29 @@
+export default UploadRequest;
+/**
+ * Upload a file to the upload file service of Be Informed
+ */
+declare class UploadRequest {
+    constructor(uploadConstraints: {
+        fileTypes: FiletypeConstraintsType;
+        maxFileSize: FilesizeConstraintsType;
+    }, progressHandler: ProgressHandler);
+    /**
+     */
+    getFileExtension(file: File): string;
+    /**
+     */
+    isNotAllowedFileType(file: File): boolean;
+    /**
+     */
+    exceedsMaxFileSize(file: File): boolean;
+    /**
+     */
+    uploadFile(file: File): Promise<UploadResponse>;
+    #private;
+}
+type UploadResponse = {
+    token: string;
+};
+import { FiletypeConstraintsType } from "../models/types";
+import { FilesizeConstraintsType } from "../models/types";
+type ProgressHandler = (file: File, uploadInfo: Object) => void;

package/types/modularui/index.d.ts

@@ -1,3 +1,5 @@
 export { default as Authenticate } from "./Authenticate";
 export { default as ModularUIRequest } from "./ModularUIRequest";
 export { default as ModularUIResponse } from "./ModularUIResponse";
+export { default as UploadRequest } from "./UploadRequest";
+export { default as CaptchaRequest } from "./CaptchaRequest";

package/types/redux/_modularui/types.d.ts

@@ -12,6 +12,13 @@ type SetModelAction = {
         model: ModularUIModel;
     };
 };
+type InitModelAction = {
+    type: "MODULARUI/INIT";
+    payload: {
+        key: string;
+        model: ModularUIModel;
+    }[];
+};
 type UpdateModelAction = {
     type: "MODULARUI/UPDATE";
     payload: ModularUIModel;
@@ -23,12 +30,11 @@ type ModularUIAction = {
     payload: {
         href: Href;
         method?: $Keys<HTTP_METHODS>;
-        data?: string | {
-            [key: string]: string;
-        };
+        data?: any;
         locale: string;
         childmodels?: boolean;
         targetModel?: any;
+        forceTargetModel?: boolean;
         successAction: (model: ModularUIModel) => SetModelAction | UpdateModelAction;
         errorAction?: ErrorAction;
     };

package/types/redux/types.d.ts

@@ -84,7 +84,7 @@ type UpdateAutosaveAction = {
         model: FormModel;
     };
 };
-type ReduxAction = UpdateLocaleAction | SetLocalesAction | SetModelAction | UpdateModelAction | UpdateStatusAction | RemoveModelByKeyAction | NoAction | ModularUIAction | ResetModularUIAction | LocationChangeAction | PushAction | ReplaceAction | GoAction | GoBackAction | GoForwardAction | SaveErrorAction | ShowModalAction | CloseModalAction | DismissNotificationAction | ShowNotificationAction | SetPreferenceAction | SetPreferencesAction | StartProgressAction | FinishProgressAction | ResetProgressAction | UpdateProgressAction | SendAuthenticationErrorAction | ResetAuthErrorsAction | LoginSuccessAction | ChangePasswordAction | LogoutSuccessAction | UpdateAutosaveAction;
+type ReduxAction = UpdateLocaleAction | SetLocalesAction | SetModelAction | InitModelAction | UpdateModelAction | UpdateStatusAction | RemoveModelByKeyAction | NoAction | ModularUIAction | ResetModularUIAction | LocationChangeAction | PushAction | ReplaceAction | GoAction | GoBackAction | GoForwardAction | SaveErrorAction | ShowModalAction | CloseModalAction | DismissNotificationAction | ShowNotificationAction | SetPreferenceAction | SetPreferencesAction | StartProgressAction | FinishProgressAction | ResetProgressAction | UpdateProgressAction | SendAuthenticationErrorAction | ResetAuthErrorsAction | LoginSuccessAction | ChangePasswordAction | LogoutSuccessAction | UpdateAutosaveAction;
 type AuthState = {};
 type ErrorState = ErrorResponse;
 type ModalState = {};

package/types/utils/browser/Cookies.d.ts

@@ -1,11 +1,5 @@
-/**
- */
 export function getCookie(name: string): null | string;
-/**
- */
 export function setCookie(name: string, value: any, options?: CookieOptions): void;
-/**
- */
 export function clearCookie(name: string): void;
 type CookieOptions = {
     days?: number;

package/types/utils/fetch/types.d.ts

@@ -4,9 +4,7 @@ type RequestURLOptions = {
 type RequestBaseOptions = {
     method?: $Keys<HTTP_METHODS>;
     params?: string;
-    data?: string | {
-        [key: string]: string;
-    };
+    data?: any;
     timeout?: number;
     responseType?: string;
     headers?: {
@@ -33,6 +31,7 @@ type RequestOptions = {
 type RequestModularUIOptions = {
     RequestBaseOptions: any;
     targetModel?: any;
+    forceTargetModel?: boolean;
     updateModel?: ModularUIModel;
     childmodels?: boolean;
     isValidationRequest?: boolean;

package/types/utils/helpers/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./createHash";
+export * from "./sanitizeHtml";
+export * from "./objects";
+export * from "./text";
+export * from "./checkResource";
+export * from "./repositoryResource";
+export { default as createUUID } from "./createUUID";

package/types/utils/helpers/repositoryResource.d.ts

@@ -0,0 +1 @@
+export function getRepositoryResourceUrl(resourceUrl: string): string;

package/types/utils/index.d.ts

@@ -2,15 +2,10 @@ export { default as Cache } from "./browser/Cache";
 export * from "./browser/Cookies";
 export * from "./datetime/DateTimeUtil";
 export * from "./fetch/types";
-export * from "./helpers/createHash";
-export * from "./helpers/sanitizeHtml";
-export * from "./helpers/objects";
-export * from "./helpers/text";
-export * from "./helpers/checkResource";
+export * from "./helpers";
 export * from "./number/parseNumbers";
 export { default as serverFetch } from "./fetch/serverFetch";
 export { default as universalFetch } from "./fetch/universalFetch";
 export { default as xhr } from "./fetch/xhr";
-export { default as createUUID } from "./helpers/createUUID";
 export { default as DecimalFormat } from "./number/DecimalFormat";
 export { default as formatValue } from "./number/formatValue";