@beinformed/ui 1.24.0 → 1.24.1-beta.3

package/types/models/tab/TabModel.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Describes a TabModel
+ */
+export default class TabModel extends ResourceModel {
+    _actionCollection: ActionCollection;
+    _taskGroupCollection: TaskGroupCollection;
+    /**
+     */
+    get searchLink(): LinkModel;
+    /**
+     */
+    createTaskGroupCollection(): void;
+    /**
+     * Setting the taskgroup panel collection
+     */
+    set taskGroupCollection(arg: TaskGroupCollection);
+    /**
+     * Getting the taskgrouppanels on the tab
+     */
+    get taskGroupCollection(): TaskGroupCollection;
+    /**
+     * Getting the component links on the tab
+     */
+    get components(): LinkCollection;
+    /**
+     */
+    get actionCollection(): ActionCollection;
+    /**
+     * Has component links
+     */
+    hasComponents(): boolean;
+    /**
+     * Has taskgroups
+     */
+    hasTaskGroups(): boolean;
+    /**
+     */
+    hasActions(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import ActionCollection from "../actions/ActionCollection";
+import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
+import LinkModel from "../links/LinkModel";
+import LinkCollection from "../links/LinkCollection";

package/types/models/taskgroup/TaskGroupCollection.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Collection of taskgroup models
+ */
+export default class TaskGroupCollection extends BaseCollection<TaskGroupModel> {
+    constructor(initCollection?: TaskGroupModel[]);
+    /**
+     * Indicates if the taskgroup collection has has tasks
+     */
+    hasTasks(): boolean;
+}
+import TaskGroupModel from "../taskgroup/TaskGroupModel";
+import BaseCollection from "../base/BaseCollection";

package/types/models/taskgroup/TaskGroupModel.d.ts

@@ -0,0 +1,15 @@
+/**
+ * TaskGroupModel
+ */
+export default class TaskGroupModel extends ResourceModel {
+    /**
+     */
+    static create(key: string, data: Object, contributions: Object): TaskGroupModel;
+    _actionCollection: ActionCollection;
+    /**
+     * Retrieve actions of taskgroup
+     */
+    get actionCollection(): ActionCollection;
+}
+import ResourceModel from "../base/ResourceModel";
+import ActionCollection from "../actions/ActionCollection";

package/types/models/types.d.ts

@@ -0,0 +1,147 @@
+type ModularUIModel = ApplicationModel | CaseSearchModel | CaseViewModel | ListDetailModel | DetailModel | FormModel | GroupingPanelModel | ListModel | TabModel | TaskGroupModel | UserModel | UserServicesModel | ModelCatalogModel | ConceptIndexModel | ConceptDetailModel | BusinessScenarioModel | ConceptTypeDetailModel | ContentIndexModel | ContentTOCModel | ContentModel | ContentTypeModel | LookupOptionsModel;
+type AttributeType = BooleanAttributeModel | CaptchaAttributeModel | ChoiceAttributeModel | DatetimeAttributeModel | HelptextAttributeModel | LabelAttributeModel | MemoAttributeModel | MoneyAttributeModel | NumberAttributeModel | PasswordAttributeModel | CompositeAttributeModel | StringAttributeModel | UploadAttributeModel | XMLAttributeModel;
+type RangeChildAttributeType = DatetimeAttributeModel | NumberAttributeModel;
+type FilterType = BaseFilterModel | FilterModel | AssignmentFilterModel | RangeFilterModel | ConceptIndexFilterModel;
+type FormErrorAnchor = {
+    id: string;
+    properties?: {
+        [propertyName: string]: string | number;
+    };
+    anchor?: {
+        objectid: string;
+        elementid?: string;
+        _links?: Object;
+        index?: number;
+        "index-identifier"?: string;
+    };
+    layouthint: LayoutHintCollection;
+    message: string;
+    param?: {
+        name: string;
+    };
+};
+type labelsJSON = any;
+type propertyJSON = any;
+type textfragmentJSON = any;
+export interface IConstraintModel {
+}
+export interface ILayoutHintRule {
+    process(attribute: AttributeModel, attributes: AttributeCollection): void;
+}
+export interface IModelWithChildModels {
+    getInitialChildModelLinks(): Array<LinkModel>;
+    setChildModels(models: Array<ModularUIModel>): void;
+}
+type AuthenticationType = {
+    name: string;
+    authentication: string;
+    redirectUri: string;
+    isPrimary: boolean;
+};
+type FileEntryType = {
+    name: string;
+    size?: number;
+    progress: number;
+    error?: string;
+    token?: string;
+};
+type FilesType = {
+    [filename: string]: FileEntryType;
+};
+type FiletypeConstraintsType = any[];
+type FilesizeConstraintsType = {
+    fileSize: number;
+    maxTotalFileSize: number;
+    isMaxTotal: boolean;
+};
+type PropertyData = {
+    type: string;
+    label: string;
+    value: string;
+};
+type TextFragmentData = {
+    type: string;
+    label: string;
+    text: string | {
+        id?: string;
+        message: string;
+        properties?: Object;
+    };
+};
+type SectionData = {
+    id: string;
+    type: string;
+    label?: string;
+    number?: string;
+    body: string | {
+        id?: string;
+        message: string;
+        properties?: Object;
+    };
+    _links: {
+        self: {
+            href: string;
+        };
+    };
+    childSections: SectionData[];
+    subSections: SectionData[];
+};
+type PropertyElement = {
+    propertyElement: {
+        label: string;
+        layouthint: string[];
+        properties: PropertyData[];
+    };
+};
+type TextFragmentElement = {
+    textFragmentElement: {
+        label: string;
+        layouthint: string[];
+        textfragments: TextFragmentData[];
+    };
+};
+type ContentElement = {
+    contentElement: {
+        label: string;
+        layouthint: string[];
+        sections: SectionData[];
+    };
+};
+type PropertyElementMapped = {
+    propertyElement: {
+        label: string;
+        layouthint: LayoutHintCollection;
+        properties: PropertyData[];
+    };
+};
+type TextFragmentElementMapped = {
+    textFragmentElement: {
+        label: string;
+        layouthint: LayoutHintCollection;
+        textfragments: TextFragmentData[];
+    };
+};
+type ContentElementMapped = {
+    contentElement: {
+        label: string;
+        layouthint: LayoutHintCollection;
+        sections: SectionModel[];
+    };
+};
+type ContentAll = (PropertyElementMapped | TextFragmentElementMapped | ContentElementMapped)[];
+type ContentData = {
+    header: {
+        label?: string;
+        description?: {
+            id?: string;
+            message: string;
+            properties?: Object;
+        };
+    };
+    label?: string;
+    elements: (PropertyElement | TextFragmentElement | ContentElement)[];
+};
+import AttributeModel from "./attributes/AttributeModel";
+import AttributeCollection from "./attributes/AttributeCollection";
+import LinkModel from "./links/LinkModel";
+export {};

package/types/models/user/UserModel.d.ts

@@ -0,0 +1,14 @@
+/**
+ * User model
+ */
+export default class UserModel extends ResourceModel {
+    /**
+     * Retrieve username of user
+     */
+    get username(): string;
+    /**
+     * retrieve the fullname of the user
+     */
+    get fullname(): string;
+}
+import ResourceModel from "../base/ResourceModel";

package/types/models/user/UserProfileModel.d.ts

@@ -0,0 +1,12 @@
+/**
+ * User model
+ */
+export default class UserProfileModel extends UserModel {
+    _attributeCollection: AttributeCollection;
+    /**
+     * returns all the attributes from the attribute collection
+     */
+    get attributeCollection(): AttributeCollection;
+}
+import UserModel from "./UserModel";
+import AttributeCollection from "../attributes/AttributeCollection";

package/types/models/user/UserServicesModel.d.ts

@@ -0,0 +1,28 @@
+export default UserServicesModel;
+/**
+ * UserServicesModel model
+ */
+declare class UserServicesModel extends ResourceModel {
+    _user: UserModel | null;
+    /**
+     * Set user data
+     */
+    set user(arg: UserModel);
+    /**
+     * return the user model for the current user
+     */
+    get user(): UserModel;
+    /**
+     */
+    get userLink(): LinkModel;
+    /**
+     */
+    get changePassword(): Href;
+    /**
+     */
+    get isLoggedIn(): boolean;
+}
+import ResourceModel from "../base/ResourceModel";
+import UserModel from "../user/UserModel";
+import LinkModel from "../links/LinkModel";
+import Href from "../href/Href";

package/types/modularui/Authenticate.d.ts

@@ -0,0 +1,42 @@
+export default Authenticate;
+/**
+ */
+declare class Authenticate {
+    _isBasic: boolean;
+    /**
+     */
+    get authenticationType(): "JAAS" | "PAC4J_FORM" | "PAC4J_BASIC";
+    /**
+     */
+    set isBasicAuthentication(arg: boolean);
+    /**
+     */
+    get isBasicAuthentication(): boolean;
+    /**
+     */
+    requestLogin(): Promise<any>;
+    /**
+     */
+    initLogin(initLogin: boolean): Promise<any>;
+    /**
+     */
+    login(username: string, password: string): Promise<any>;
+    /**
+     */
+    getFormLoginUrl(): string;
+    /**
+     */
+    getFormLoginData(username: string, password: string): string;
+    /**
+     */
+    doFormLogin(username: string, password: string): Promise<any>;
+    /**
+     */
+    doBasicAuthentication(username: string, password: string): Promise<any>;
+    /**
+     */
+    doJaasAuthentication(username: string, password: string): Promise<any>;
+    /**
+     */
+    logout(): Promise<any>;
+}

package/types/modularui/ModularUIError.d.ts

@@ -0,0 +1,10 @@
+export default ModularUIError;
+/**
+ */
+declare class ModularUIError extends Error {
+    /**
+     */
+    constructor(message: string, response: Object, resource: string);
+    response: Object;
+    resource: string;
+}

package/types/modularui/ModularUIRequest.d.ts

@@ -0,0 +1,170 @@
+export default ModularUIRequest;
+/**
+ * Helper for fetching data and contributions from the Be Informed modular ui
+ * and merge it into a target or resolvable model.
+ */
+declare class ModularUIRequest {
+    /**
+     */
+    constructor(href: Href | string, options?: $Shape<RequestBaseOptions>);
+    _response: ModularUIResponse;
+    _href: Href;
+    _options: RequestBaseOptions;
+    _targetModel: Class<ModularUIModel>;
+    _contributionsHref: string;
+    _locale: string;
+    _method: $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    _progressEvent: ProgressEventHandler;
+    /**
+     */
+    set options(arg: RequestBaseOptions);
+    /**
+     */
+    get options(): RequestBaseOptions;
+    /**
+     */
+    set href(arg: Href);
+    /**
+     */
+    get href(): Href;
+    /**
+     */
+    set locale(arg: string);
+    /**
+     */
+    get locale(): string;
+    /**
+     */
+    set targetModel(arg: Class<ModularUIModel>);
+    /**
+     */
+    get targetModel(): Class<ModularUIModel>;
+    /**
+     */
+    set method(arg: $Keys<{
+        POST: string;
+        GET: string;
+    }>);
+    /**
+     */
+    get method(): $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    /**
+     */
+    set contributionsHref(arg: string);
+    /**
+     */
+    get contributionsHref(): string;
+    /**
+     */
+    get response(): ModularUIResponse;
+    /**
+     */
+    get withChildModels(): boolean;
+    /**
+     */
+    createModel(): ModularUIModel;
+    /**
+     */
+    processContributionsService(contributionsData: Object): void;
+    /**
+     */
+    handleContributionsError(error: Object): void;
+    /**
+     */
+    handleDataError(error: Object): void;
+    /**
+     */
+    handleData(key: string, data: Object): void;
+    /**
+     */
+    processDataService(data: Object): void;
+    /**
+     */
+    fetchContributionsService(): Promise<any>;
+    /**
+     */
+    fetchDataService(): Promise<any>;
+    /**
+     * Check if links contain a 'hide-when-empty' layout hint and remove the link from
+     * the component when it exists and no results are available
+     */
+    processAsyncLayoutHints(): Promise<void>;
+    /**
+     * hide application links<br>
+     * _links on application data contains an extra level of tab links
+     */
+    processApplicationLinks(): Promise<void>;
+    /**
+     * Replace hidden link in application link tree
+     */
+    replaceApplicationLinks(tabName: string, newLinks: Array<Object>): void;
+    /**
+     */
+    processTabLinks(): Promise<void>;
+    /**
+     */
+    processPanelLinks(): Promise<void>;
+    /**
+     * Retrieve an object of key: link
+     */
+    dataLinksPerName(dataLinks: any): {
+        [linkName: string]: any;
+    };
+    /**
+     * Check if links are empty and hide them when hide-when-empty hint exists
+     */
+    processLinks(dataLinks: any, contributionLinks: any): Promise<Object | Array<Object>>;
+    /**
+     */
+    isHiddenList(name: string, href: string): Promise<string>;
+    /**
+     */
+    set onProgress(arg: ProgressEventHandler);
+    /**
+     */
+    get onProgress(): ProgressEventHandler;
+    /**
+     * Combine previous send request data with new validation data to create a complete request object
+     * The received model is new FormModel containing ONLY the current question, not the previously entered questions
+     * to create a complete request we append the originally send form objects
+     */
+    getDynamicValidationData(model: ModularUIModel): string;
+    /**
+     * First load of dynamic values when a form is loaded
+     */
+    loadDynamicValidations(model: ModularUIModel): Promise<ModularUIModel>;
+    /**
+     */
+    fetch(): Promise<ModularUIModel>;
+    /**
+     */
+    fetchFromCache(): Promise<ModularUIModel>;
+    /**
+     */
+    fetchChildModels(model: ModularUIModel): Promise<ModularUIModel>;
+    /**
+     */
+    fetchContent(withChildSections: boolean): Promise<mixed>;
+    /**
+     * Recursively return child sections defined on the content model
+     */
+    fetchContentChildSections(contentModel: ContentModel): Promise<mixed>;
+    /**
+     * Make a post request with optionally data to send
+     * @param data
+     */
+    post(data?: string | {
+        [key: string]: string;
+    }): Promise<ModularUIModel>;
+}
+import ModularUIResponse from "./ModularUIResponse";
+import Href from "../models/href/Href";
+import { RequestBaseOptions } from "../utils/fetch/types";
+import { ModularUIModel } from "../models/types";
+import ContentModel from "../models/content/ContentModel";

package/types/modularui/ModularUIResponse.d.ts

@@ -0,0 +1,56 @@
+export default ModularUIResponse;
+/**
+ */
+declare class ModularUIResponse {
+    /**
+     */
+    static create(input: {
+        key: string;
+        data: Object;
+        contributions: Object;
+    }): ModularUIResponse;
+    /**
+     */
+    static rehydrate(data: {
+        key: string;
+        locale: string;
+        data: Object;
+        contributions: Object;
+    }): ModularUIResponse;
+    _key: string;
+    _data: Object;
+    _contributions: Object;
+    _locale: string;
+    _parameters: Array<Parameter>;
+    /**
+     */
+    set locale(arg: string);
+    /**
+     */
+    get locale(): string;
+    /**
+     */
+    set key(arg: string);
+    /**
+     */
+    get key(): string;
+    /**
+     */
+    set data(arg: Object);
+    /**
+     */
+    get data(): Object;
+    /**
+     */
+    set contributions(arg: Object);
+    /**
+     */
+    get contributions(): Object;
+    /**
+     */
+    set parameters(arg: Parameter[]);
+    /**
+     */
+    get parameters(): Parameter[];
+}
+import Parameter from "../models/parameter/Parameter";

package/types/modularui/index.d.ts

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

package/types/redux/_i18n/types.d.ts

@@ -0,0 +1,13 @@
+type I18nState = {};
+type UpdateLocaleAction = {
+    type: "UPDATE_LOCALE";
+    payload: string;
+};
+type SetLocalesAction = {
+    type: "SET_LOCALES";
+    payload: {
+        locales: Locales;
+        locale: string;
+    };
+};
+export {};

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

@@ -0,0 +1,49 @@
+type ModularUIOptions = {
+    propName?: string;
+    removeOnUnmount?: boolean;
+    RequestBaseOptions: any;
+};
+type ModelEntry = {};
+type ModularUIState = {};
+type SetModelAction = {
+    type: "MODULARUI/SET";
+    payload: {
+        key: string;
+        model: ModularUIModel;
+    };
+};
+type UpdateModelAction = {
+    type: "MODULARUI/UPDATE";
+    payload: ModularUIModel;
+};
+type ModularUIAction = {
+    type: "MODULARUI/FETCH";
+    payload: {
+        href: Href;
+        method?: $Keys<HTTP_METHODS>;
+        data?: string | {
+            [key: string]: string;
+        };
+        locale: string;
+        childmodels?: boolean;
+        targetModel?: Class<ModularUIModel>;
+        successAction: (model: ModularUIModel) => SetModelAction | UpdateModelAction;
+        errorAction?: (error: FetchException) => UpdateStatusAction | RemoveModelByKeyAction | NoAction;
+    };
+};
+type RemoveModelByKeyAction = {
+    type: "MODULARUI/REMOVE_KEY";
+    payload: string;
+};
+type ResetModularUIAction = {
+    type: "MODULARUI/RESET";
+};
+type UpdateStatusAction = {
+    type: "MODULARUI/STATUS";
+    payload: {
+        key: string;
+        status: $Keys<MODULARUI_STATUS>;
+    };
+};
+type ModularUIConnector = (Component: ComponentType<any>) => ComponentType<any>;
+export {};

package/types/redux/_router/types.d.ts

@@ -0,0 +1,35 @@
+type RouterState = {};
+type LocationChangeAction = {
+    type: "ROUTER/LOCATION_CHANGE";
+    payload: {
+        location: Location;
+        action: HistoryAction;
+    };
+};
+type PushAction = {
+    type: "ROUTER/PUSH";
+    payload: {
+        location: any;
+        state?: {};
+    };
+};
+type ReplaceAction = {
+    type: "ROUTER/REPLACE";
+    payload: {
+        location: any;
+        state?: {};
+    };
+};
+type GoAction = {
+    type: "ROUTER/GO";
+    payload: {
+        delta: number;
+    };
+};
+type GoBackAction = {
+    type: "ROUTER/GOBACK";
+};
+type GoForwardAction = {
+    type: "ROUTER/GOFORWARD";
+};
+export {};

package/types/redux/selectors/i18n.d.ts

@@ -0,0 +1,4 @@
+export function getLocale(state: ReduxState): string;
+export function getLocales(state: ReduxState): Locales;
+import { ReduxState } from "../types";
+import Locales from "../../i18n/Locales";