@beinformed/ui 1.65.12 → 1.65.14

package/src/models/base/BaseCollection.js

@@ -1,191 +0,0 @@
-// @flow
-import { klona } from "klona/full";
-
-/**
- * Base class for collections of models
- */
-class BaseCollection<T> {
-  _collection: Array<T>;
-
-  /**
-   * Construct base collection
-   */
-  constructor(initCollection: Array<T> = []) {
-    this.collection = initCollection;
-  }
-
-  /**
-   * Retrieve current collection
-   */
-  get collection(): Array<T> {
-    return this._collection;
-  }
-
-  /**
-   * Replace current collection with a new collection
-   */
-  set collection(collection: Array<T>) {
-    this._collection = collection;
-  }
-
-  /**
-   * Add an other collection, array of items or single item to this collection;
-   */
-  add(items: BaseCollection<T> | Array<T> | T): BaseCollection<T> {
-    if (items instanceof BaseCollection) {
-      this.collection = [...this.collection, ...items.all];
-    } else if (Array.isArray(items)) {
-      // $FlowExpectedError[incompatible-type]
-      this.collection = [...this.collection, ...items];
-    } else {
-      this.collection = [...this.collection, items];
-    }
-
-    return this;
-  }
-
-  /**
-   * Remove an item from the collection by it's index.
-   */
-  removeByIndex(itemIndex: number) {
-    if (itemIndex > -1) {
-      this.collection = [
-        ...this.collection.slice(0, itemIndex),
-        ...this.collection.slice(itemIndex + 1),
-      ];
-    }
-  }
-
-  /**
-   * Indicates if the collection has items
-   */
-  get hasItems(): boolean {
-    return this.length > 0;
-  }
-
-  /**
-   * Indicates if collection is empty
-   */
-  get isEmpty(): boolean {
-    return !this.hasItems;
-  }
-
-  /**
-   * Retrieve all items in collection
-   */
-  get all(): Array<T> {
-    return this.collection;
-  }
-
-  /**
-   * Get the size of this collection
-   */
-  get size(): number {
-    return this.length;
-  }
-
-  /**
-   * Get the size of this collection
-   */
-  get length(): number {
-    return this.collection.length;
-  }
-
-  /**
-   * Return first link in collection
-   */
-  get first(): T | null {
-    return this.collection[0] ?? null;
-  }
-
-  /**
-   */
-  get last(): T | null {
-    return this.collection[this.collection.length - 1] ?? null;
-  }
-
-  /**
-   */
-  get(index: number): T | null {
-    return this.collection[index] ?? null;
-  }
-
-  /**
-   * Find item
-   */
-  find(
-    callbackfn: (value: T, index: number, array: Array<T>) => any,
-    thisArg?: any,
-  ): T | null {
-    return this.collection.find(callbackfn, thisArg) ?? null;
-  }
-
-  /**
-   * Filter items
-   */
-  filter(
-    callbackfn: (value: T, index: number, array: Array<T>) => any,
-    thisArg?: any,
-  ): Array<T> {
-    return this.collection.filter(callbackfn, thisArg);
-  }
-
-  /**
-   * Check if at least one item occurs
-   */
-  some(
-    callbackfn: (value: T, index: number, array: Array<T>) => any,
-    thisArg?: any,
-  ): boolean {
-    return this.collection.some(callbackfn, thisArg);
-  }
-
-  /**
-   */
-  every(
-    callbackfn: (value: T, index: number, array: Array<T>) => any,
-    thisArg?: any,
-  ): boolean {
-    return this.collection.every(callbackfn, thisArg);
-  }
-
-  /**
-   */
-  map<U>(
-    callbackfn: (value: T, index: number, array: Array<T>) => U,
-    thisArg?: T,
-  ): Array<U> {
-    return this.collection.map<U, ?T>(callbackfn, thisArg);
-  }
-
-  /**
-   */
-  forEach(
-    callbackfn: (value: T, index: number, array: Array<T>) => any,
-    thisArg?: any,
-  ) {
-    this.collection.forEach(callbackfn, thisArg);
-  }
-
-  /**
-   */
-  sort(compareFn?: (a: T, b: T) => number): Array<T> {
-    return this.collection.sort(compareFn);
-  }
-
-  /**
-   * Retrieve an alphabetically sorted array of items
-   */
-  get sorted(): Array<T> {
-    return this.collection.sort();
-  }
-
-  /**
-   * Returns a clone of the model
-   */
-  clone(): this {
-    return klona(this);
-  }
-}
-
-export default BaseCollection;

package/src/models/base/BaseModel.js

@@ -1,155 +0,0 @@
-// @flow
-import { klona } from "klona/full";
-
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-import type { ModelOptions } from "../types";
-import { getBasePathModularUI } from "../../constants";
-
-export type BaseDehydrateData = {
-  +data: Object,
-  +contributions: Object,
-  connectKey: string,
-  ...
-};
-
-/**
- * Base model, this is the foundation of a model,
- * it contains data that is needed for all models like, data, contributions and layout hint
- *
- * Extend this for non modular ui resources, for modular ui resource start with the resourceModel
- */
-class BaseModel {
-  _data: Object;
-  _contributions: Object;
-  _layouthint: LayoutHintCollection;
-  _connectKey: string;
-  _modelOptions: ModelOptions;
-
-  /**
-   * constructor
-   */
-  constructor(
-    data: Object,
-    contributions: Object,
-    modelOptions: ModelOptions = {
-      origin: "",
-      contextPath: getBasePathModularUI(),
-    },
-  ) {
-    this._data = data;
-    this._contributions = contributions;
-    this._layouthint = new LayoutHintCollection(
-      this.getContribution("layouthint", []),
-    );
-    this._modelOptions = modelOptions;
-  }
-
-  /**
-   * Retrieve data
-   */
-  get data(): Object {
-    return this._data || {};
-  }
-
-  /**
-   * Retrieve property from the data object of the model, mostly used internal
-   */
-  getData(propName: string, defaultValue: any = null): any {
-    return this.data[propName] ?? defaultValue;
-  }
-
-  /**
-   * Retrieve contributions
-   */
-  get contributions(): Object {
-    return this._contributions || {};
-  }
-
-  /**
-   * Retrieve property from the contributions of the model, mostly used internal
-   */
-  getContribution(propName: string, defaultValue: any = null): any {
-    return this.contributions[propName] ?? defaultValue;
-  }
-
-  /**
-   */
-  get modelOptions(): ModelOptions {
-    return this._modelOptions;
-  }
-
-  /**
-   */
-  get origin(): string {
-    return this.modelOptions.origin || "";
-  }
-
-  /**
-   */
-  get contextPath(): string {
-    return this.modelOptions.contextPath || getBasePathModularUI();
-  }
-
-  /**
-   * Getting the layouthint
-   */
-  get layouthint(): LayoutHintCollection {
-    return this._layouthint;
-  }
-
-  /**
-   * Set the layouthint
-   */
-  set layouthint(layouthint: Array<string>) {
-    this._layouthint = new LayoutHintCollection(layouthint);
-  }
-
-  /**
-   * Indicates if the model has data
-   */
-  get hasData(): boolean {
-    return Object.keys(this.data).length > 0;
-  }
-
-  /**
-   * Set the unique key for this model
-   */
-  set connectKey(key: string) {
-    this._connectKey = key;
-  }
-
-  /**
-   * Get the unique key of this model
-   */
-  get connectKey(): string {
-    return this._connectKey;
-  }
-
-  /**
-   * Dehydrate internal data, returns the information that is needed to recreate the model
-   */
-  dehydrate(): BaseDehydrateData {
-    return {
-      data: this._data,
-      contributions: this._contributions,
-      connectKey: this._connectKey,
-      options: this._modelOptions,
-    };
-  }
-
-  /**
-   * Recreate the model with the given data
-   */
-  rehydrate(data: BaseDehydrateData) {
-    this._connectKey = data.connectKey;
-  }
-
-  /**
-   * Returns a clone of the model
-   */
-  clone(): any {
-    return klona(this);
-  }
-}
-
-export default BaseModel;

package/src/models/base/ResourceCollection.js

@@ -1,42 +0,0 @@
-// @flow
-import BaseCollection from "./BaseCollection";
-
-import type { ModularUIModel, IModelWithChildModels } from "../types";
-import type ErrorResponse from "../error/ErrorResponse";
-import type LinkModel from "../links/LinkModel";
-
-/**
- * The ResourceCollection makes it possible to add child models to a collection of models
- * These child models are fetched using the ModularUI util
- */
-class ResourceCollection<T: IModelWithChildModels> extends BaseCollection<T> {
-  /**
-   * Retrieve all child model links and flatten it into an array with single entries, removing all undefined items
-   */
-  getInitialChildModelLinks(): Array<LinkModel> {
-    const initialChildModelLinks = [];
-
-    this.collection.forEach((item: T) => {
-      // $FlowFixMe[method-unbinding]
-      if (typeof item?.getInitialChildModelLinks === "function") {
-        initialChildModelLinks.push(...item.getInitialChildModelLinks());
-      }
-    });
-
-    return initialChildModelLinks;
-  }
-
-  /**
-   * Pass through models for setchildmodels to items of this collection
-   */
-  setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>) {
-    this.collection.forEach((item) => {
-      // $FlowFixMe[prop-missing]
-      if (typeof item["setChildModels"] === "function") {
-        item.setChildModels(models, errors);
-      }
-    });
-  }
-}
-
-export default ResourceCollection;

package/src/models/base/ResourceModel.js

@@ -1,246 +0,0 @@
-// @flow
-import ModularUIResponse from "../../modularui/ModularUIResponse";
-
-import BaseModel from "./BaseModel";
-import LinkCollection from "../links/LinkCollection";
-
-import {
-  IllegalArgumentException,
-  IllegalStateException,
-} from "../../exceptions";
-
-import type LinkModel from "../links/LinkModel";
-import type Href from "../href/Href";
-import type { ModularUIModel, IModelWithChildModels } from "../types";
-import type ErrorResponse from "../error/ErrorResponse";
-
-/**
- * Base model, this the foundation for models that represent modular ui services, e.g. application, tab, caseview, etc
- */
-class ResourceModel extends BaseModel implements IModelWithChildModels {
-  _key: string;
-  _locale: string;
-  _childModels: Array<ModularUIModel>;
-  _links: LinkCollection;
-  _lastServerUpdate: number;
-
-  /**
-   * constructor
-   */
-  constructor(modularuiResponse: ModularUIResponse = new ModularUIResponse()) {
-    super(
-      modularuiResponse.data,
-      modularuiResponse.contributions,
-      modularuiResponse.modelOptions,
-    );
-
-    this._key = modularuiResponse.key;
-    this._locale = modularuiResponse.locale;
-    this._childModels = [];
-
-    this._lastServerUpdate = Date.now();
-  }
-
-  /**
-   * Property to render name of a model, is original name after transpilation
-   */
-  static get modelName(): string {
-    throw new IllegalStateException(`No modelName set on the resource model`);
-  }
-
-  /**
-   * Returns true when the model is supported based on configuration found in contributions
-   *
-   * @abstract
-   */
-  static isApplicableModel(data: ModularUIResponse): boolean {
-    if (!(data instanceof ModularUIResponse)) {
-      throw new IllegalArgumentException(
-        "Given argument for isApplicableModel is not a ModularUIResponse",
-      );
-    }
-
-    throw new Error("No isApplicableModel condition set on resourcemodel");
-  }
-
-  /**
-   */
-  get lastServerUpdate(): number {
-    return this._lastServerUpdate;
-  }
-
-  /**
-   */
-  set lastServerUpdate(lastServerUpdate: number) {
-    this._lastServerUpdate = lastServerUpdate;
-  }
-
-  /**
-   */
-  get locale(): string {
-    return this._locale;
-  }
-
-  /**
-   * Retrieve key
-   */
-  get key(): string {
-    return this._key;
-  }
-
-  /**
-   * Get type of model
-   *
-   * @abstract
-   */
-  get type(): string {
-    throw new IllegalStateException(
-      `No type set on the resource model with key ${this.key}`,
-    );
-  }
-
-  /**
-   * Retrieve type of resource
-   */
-  get resourcetype(): string {
-    return this.getContribution("resourcetype", "unknown");
-  }
-
-  /**
-   */
-  get label(): string {
-    return this.getContribution("label", "");
-  }
-
-  /**
-   * Getting the links of the resource
-   */
-  get links(): LinkCollection {
-    if (!this._links) {
-      const linksData = Array.isArray(this.data._links)
-        ? this.data._links[0]
-        : this.data._links;
-
-      const linksContrubtions = {
-        self: {
-          resourcetype: this.resourcetype,
-        },
-        ...this.contributions._links,
-      };
-
-      this._links = new LinkCollection(
-        linksData,
-        linksContrubtions,
-        this.modelOptions,
-      );
-    }
-    return this._links;
-  }
-
-  /**
-   */
-  set links(links: LinkCollection) {
-    this._links = links;
-  }
-
-  /**
-   *
-   */
-  get downloadLink(): ?LinkModel {
-    const downloadLink = this.links.getLinksByGroup("download").first;
-    if (downloadLink) {
-      return downloadLink;
-    }
-
-    return null;
-  }
-
-  /**
-   * Get self link of model
-   */
-  get selflink(): LinkModel {
-    const selflink = this.links.getLinkByKey("self");
-
-    if (selflink === null) {
-      throw new IllegalStateException(
-        `Could not find self link for ${
-          this.key === null ? "unknown" : this.key
-        }`,
-      );
-    }
-
-    return selflink;
-  }
-
-  /**
-   * Return default self link of resource
-   */
-  get selfhref(): Href {
-    return this.selflink.href;
-  }
-
-  /**
-   * Add links to expand on initialization of this model
-   *
-   * @abstract
-   */
-  getInitialChildModelLinks(): Array<LinkModel> {
-    return [];
-  }
-
-  /**
-   * Retrieve links of expanded child models
-   */
-  get childModels(): Array<ModularUIModel> {
-    return this._childModels;
-  }
-
-  /**
-   * Add child models to this model
-   */
-  addChildModels(
-    models: Array<ModularUIModel>,
-    errors: Array<ErrorResponse>,
-  ): this {
-    const flattenModels = [].concat(...models);
-    const flattenErrors = [].concat(errors);
-
-    this._childModels = flattenModels;
-
-    this.setChildModels(flattenModels, flattenErrors);
-
-    return this;
-  }
-
-  /**
-   * Template to set expanded child models
-   * Use this hook to separate the retrieved child models into the correct models.
-   *
-   * @abstract
-   * @example <caption>Put all models of instance List and GroupingPanel into the panels property</caption>
-   */
-  setChildModels(
-    models: Array<ModularUIModel>,
-    errors: Array<ErrorResponse>,
-  ): void {
-    if (!models && !errors) {
-      throw new IllegalArgumentException("No models send to setChildModels");
-    }
-  }
-
-  /**
-   */
-  dehydrate(): Object {
-    return {
-      ...super.dehydrate(),
-      key: this._key,
-      locale: this._locale,
-      // $FlowFixMe[missing-type-arg]
-      childModels: this._childModels.map<ModularUIModel>(
-        (childModel: ModularUIModel) => childModel.dehydrate(),
-      ),
-    };
-  }
-}
-
-export default ResourceModel;