@beinformed/ui 1.65.12 → 1.65.14

package/src/models/detail/DetailModel.js

@@ -1,241 +0,0 @@
-// @flow
-import { has } from "../../utils/helpers/objects";
-
-import ActionCollection from "../actions/ActionCollection";
-import AttributeCollection from "../attributes/AttributeCollection";
-import ResourceModel from "../base/ResourceModel";
-
-import { AVATAR, AVATAR_IN_TITLE, TITLE } from "../../constants/LayoutHints";
-
-import type { ModularUIResponse } from "../../modularui";
-import type { ModularUIModel, AttributeType } from "../types";
-import type LinkModel from "../links/LinkModel";
-import type ErrorResponse from "../error/ErrorResponse";
-
-/**
- * Base class for details<br/>
- * For instance the details of case 1<br/>
- * For instance the details of record 12<br/>
- */
-export default class DetailModel extends ResourceModel {
-  _attributeCollection: AttributeCollection;
-  _metadataCollection: AttributeCollection;
-  _actionCollection: ActionCollection;
-
-  /**
-   */
-  constructor(modularuiResponse: ModularUIResponse) {
-    super(modularuiResponse);
-
-    this.createAttributeCollection();
-    this.createMetadataCollection();
-    this.createActionCollection();
-  }
-
-  /**
-   */
-  get type(): string {
-    return "Detail";
-  }
-
-  /**
-   */
-  static get modelName(): string {
-    return "DetailModel";
-  }
-
-  /**
-   */
-  static isApplicableModel(data: ModularUIResponse): boolean {
-    const resourceType = data.contributions?.resourcetype;
-    return (
-      resourceType &&
-      (resourceType.endsWith("DetailPanel") ||
-        ["Detail", "CasePropertiesPanel", "CasePropertiesPanelDetail"].includes(
-          resourceType,
-        ))
-    );
-  }
-
-  /**
-   */
-  getInitialChildModelLinks(): Array<LinkModel> {
-    return this._attributeCollection.getInitialChildModelLinks();
-  }
-
-  /**
-   */
-  setChildModels(models: Array<ModularUIModel>, errors: Array<ErrorResponse>) {
-    this._attributeCollection.setChildModels(models, errors);
-  }
-
-  /**
-   * Getting the unique identifier of the details
-   */
-  get id(): string {
-    return this.getData("_id", this.key);
-  }
-
-  /**
-   */
-  get label(): string {
-    return this.getContribution("label", "");
-  }
-
-  /**
-   * Attribute collection
-   */
-  createAttributeCollection() {
-    const attributeContributions = this.contributions.attributes
-      ? this.contributions.attributes.filter((contribution) => {
-          const [key] = Object.keys(contribution);
-          return has(this.data, key);
-        })
-      : [];
-
-    this.attributeCollection = new AttributeCollection(
-      this.data,
-      attributeContributions,
-      { ...this.modelOptions, isReadonly: true },
-    );
-  }
-
-  /**
-   */
-  get attributeCollection(): AttributeCollection {
-    return this._attributeCollection;
-  }
-
-  /**
-   */
-  set attributeCollection(collection: AttributeCollection) {
-    this._attributeCollection = collection;
-  }
-
-  /**
-   * Retrieve list of visible attributes
-   */
-  get attributes(): Array<AttributeType> {
-    return this.attributeCollection.all.filter((attribute) => {
-      const hasTitle = attribute.layouthint.hasExact(TITLE);
-      const hasAvatar = attribute.layouthint.hasExact(AVATAR);
-      const hasAvatarForTitle = attribute.layouthint.hasExact(AVATAR_IN_TITLE);
-      return (
-        !attribute.isHidden &&
-        (!hasTitle || (hasTitle && hasAvatar)) &&
-        (!hasAvatarForTitle || (hasAvatarForTitle && !hasAvatar))
-      );
-    });
-  }
-
-  /**
-   * Retrieve an attribute by it's key
-   */
-  getAttributeByKey(key: string): AttributeType | null {
-    return this._attributeCollection.getAttributeByKey(key);
-  }
-
-  /**
-   * Metadata collection
-   */
-  createMetadataCollection() {
-    const metadataContributions = this.contributions.metadata
-      ? Object.keys(this.contributions.metadata).map((metadataKey) => ({
-          [metadataKey]: this.contributions.metadata[metadataKey],
-        }))
-      : [];
-
-    this.metadataCollection = new AttributeCollection(
-      this.data,
-      metadataContributions,
-      { ...this.modelOptions, isReadonly: true },
-    );
-  }
-
-  /**
-   */
-  get metadataCollection(): AttributeCollection {
-    return this._metadataCollection;
-  }
-
-  /**
-   */
-  set metadataCollection(collection: AttributeCollection) {
-    this._metadataCollection = collection;
-  }
-
-  /**
-   * Action collection
-   */
-  createActionCollection() {
-    this._actionCollection = new ActionCollection(
-      this.data.actions,
-      this.contributions.actions,
-      this.modelOptions,
-    );
-  }
-
-  /**
-   */
-  get actionCollection(): ActionCollection {
-    return this._actionCollection;
-  }
-
-  /**
-   */
-  set actionCollection(actionCollection: ActionCollection) {
-    this._actionCollection = actionCollection;
-  }
-
-  /**
-   * Determines if this is a case
-   */
-  get isCase(): boolean {
-    return this.contributions.resourcetype === "CaseView";
-  }
-
-  /**
-   * Getting the attribute that has as layout hint 'avatar-for-title'
-   */
-  get avatarForTitleAttribute(): ?AttributeType {
-    return this._attributeCollection.find(
-      (attribute) =>
-        attribute.layouthint.hasExact(AVATAR_IN_TITLE) &&
-        attribute.layouthint.hasExact(AVATAR),
-    );
-  }
-
-  /**
-   * Getting the attribute that has as layout hint 'title'
-   */
-  get titleAttribute(): ?AttributeType {
-    return this._attributeCollection.find(
-      (attribute) =>
-        attribute.layouthint.has(TITLE) &&
-        !attribute.layouthint.hasExact(AVATAR),
-    );
-  }
-
-  /**
-   * Update current detail with a new detail model and return a cloned version of the model
-   */
-  update(model: ModularUIModel): DetailModel {
-    if (model instanceof DetailModel) {
-      const clonedModel = this.clone();
-
-      clonedModel.attributeCollection = model._attributeCollection;
-      clonedModel.metadataCollection = model._metadataCollection;
-      clonedModel.actionCollection = model._actionCollection;
-
-      return clonedModel;
-    }
-
-    return this;
-  }
-
-  /**
-   */
-  equals(model: DetailModel): boolean {
-    return this.id.toString() === model.id.toString();
-  }
-}

package/src/models/detail/__tests__/DetailModel.spec.js

@@ -1,41 +0,0 @@
-import DetailModel from "../DetailModel";
-
-import Href from "../../href/Href";
-
-import mockDetail from "./detail.json";
-import mockDetailContributions from "./detailContributions.json";
-
-describe("models", () => {
-  describe("details", () => {
-    describe("detailModel", () => {
-      it("should be able to create an empty detail", () => {
-        const detail = new DetailModel({});
-
-        expect(detail).toBeInstanceOf(DetailModel);
-      });
-
-      it("should be able to create a detail from a typical modular UI json structure", () => {
-        const detail = new DetailModel({
-          request: {
-            href: new Href("/books/book/24", "CaseView"),
-          },
-          key: "Book",
-          data: mockDetail.Book,
-          contributions: mockDetailContributions.Book,
-        });
-
-        expect(detail).toBeInstanceOf(DetailModel);
-
-        expect(detail.key).toBe("Book");
-
-        expect(detail.id).toBe(24);
-
-        const selfLink = new Href("/books/book/24", "CaseView");
-
-        expect(detail.selfhref).toStrictEqual(selfLink);
-
-        expect(detail.attributeCollection.size).toBe(5);
-      });
-    });
-  });
-});

package/src/models/detail/__tests__/detail.json

@@ -1,37 +0,0 @@
-{
-  "Book": {
-    "_links": {
-      "self": {
-        "href": "/books/book/24"
-      },
-      "api_doc": {
-        "href": "/api-docs/books/book/24"
-      },
-      "contributions": {
-        "href": "/contributions/books/book/24"
-      },
-      "Creator": {
-        "href": "/books/book/24/creator"
-      },
-      "Editions": {
-        "href": "/books/book/24/editions"
-      },
-      "taskgroup": [
-        {
-          "href": "/books/book/24/Tasks",
-          "name": "Tasks"
-        }
-      ]
-    },
-    "_id": 24,
-    "CaseName": "The safety of objects",
-    "CaseType": "Book",
-    "Owner": "Arnold",
-    "Format": "Paperback",
-    "ISBN10": "1847087302",
-    "ISBN13": "9781847087300",
-    "Language": "EN",
-    "NumberOfPages": 176,
-    "CaseState": "Registered"
-  }
-}

package/src/models/detail/__tests__/detailContributions.json

@@ -1,124 +0,0 @@
-{
-  "Book": {
-    "label": "Book",
-    "resourcetype": "CaseView",
-    "texts": [
-      {
-        "type": "master",
-        "text": "<p>This view contains all the data about this book. It contains a list of the creators and editions. A person can be an author(1) or an illustrator(2)<br /><br />This is a list of books that is ordered by the role (author (1), co-author, illustrator(2)) of the person that contributed to the book.<br /><br />1) An author is broadly defined as &quot;the person who originated or gave existence to anything&quot; and whose authorship determines responsibility for what was created. Narrowly defined, an author is the originator of any written work and can also be described as a writer.<br /><br />2) An illustrator is an artist who specializes in enhancing writing or elucidating concepts by providing a visual representation that corresponds to the content of the associated text or idea. The illustration may be intended to clarify complicated concepts or objects that are difficult to describe textually, which is the reason illustrations are often found in children&#39;s books.<br /></p>"
-      }
-    ],
-    "_links": {
-      "panel": [
-        {
-          "name": "Creator",
-          "label": "Creator",
-          "resourcetype": "CaseRelationListPanel"
-        },
-        {
-          "name": "Editions",
-          "label": "Editions",
-          "resourcetype": "RecordListPanel"
-        }
-      ],
-      "taskgroup": [
-        {
-          "name": "Tasks",
-          "label": "Tasks",
-          "resourcetype": "TaskGroup"
-        }
-      ]
-    },
-    "metadata": {
-      "_id": {
-        "label": "Id",
-        "type": "integer"
-      },
-      "CaseName": {
-        "label": "Case name",
-        "type": "string"
-      },
-      "CaseType": {
-        "label": "Case type",
-        "type": "string"
-      },
-      "Owner": {
-        "label": "Case owner",
-        "type": "string"
-      },
-      "CaseState": {
-        "label": "State",
-        "type": "string",
-        "options": [
-          {
-            "code": "Registered",
-            "label": "Registered"
-          }
-        ]
-      }
-    },
-    "attributes": [
-      {
-        "Format": {
-          "label": "Format",
-          "type": "string",
-          "layouthint": ["combobox"],
-          "options": [
-            {
-              "code": "Hardcover",
-              "label": "Hardcover"
-            },
-            {
-              "code": "Paperback",
-              "label": "Paperback"
-            },
-            {
-              "code": "Ebook",
-              "label": "Ebook"
-            },
-            {
-              "code": "Audio",
-              "label": "Audio book"
-            }
-          ]
-        }
-      },
-      {
-        "ISBN10": {
-          "label": "ISBN10",
-          "type": "string"
-        }
-      },
-      {
-        "ISBN13": {
-          "label": "ISBN13",
-          "type": "string"
-        }
-      },
-      {
-        "Language": {
-          "label": "Language",
-          "type": "string",
-          "layouthint": ["radiobutton"],
-          "options": [
-            {
-              "code": "EN",
-              "label": "English"
-            },
-            {
-              "code": "DU",
-              "label": "Dutch"
-            }
-          ]
-        }
-      },
-      {
-        "NumberOfPages": {
-          "label": "Number of pages",
-          "type": "number",
-          "format": "0"
-        }
-      }
-    ]
-  }
-}

package/src/models/error/ErrorCollection.js

@@ -1,127 +0,0 @@
-// @flow
-import BaseCollection from "../base/BaseCollection";
-import ErrorModel from "./ErrorModel";
-
-import type { MessageParameters } from "../../i18n/types";
-import type { IConstraintModel } from "../types";
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-
-/**
- * Form Objects
- */
-export default class ErrorCollection extends BaseCollection<ErrorModel> {
-  _type: string;
-
-  /**
-   * constructor
-   */
-  constructor(type: string, errorCollection?: ErrorCollection) {
-    super();
-
-    this._type = type;
-    this.collection = [];
-
-    if (errorCollection) {
-      this.collection = [...errorCollection.collection];
-    }
-  }
-
-  /**
-   */
-  get serverErrors(): Array<ErrorModel> {
-    return this.collection.filter((error) => !error.isClientConstraint);
-  }
-
-  /**
-   */
-  findById(id: string): number {
-    return this.collection.findIndex((item) => item.id === id);
-  }
-
-  /**
-   * Add an error to the collection
-   */
-  addError(
-    id: string,
-    defaultMessage?: string,
-    parameters?: MessageParameters,
-    layouthint?: LayoutHintCollection,
-  ) {
-    const itemIdx = this.findById(id);
-
-    if (itemIdx > -1) {
-      this.removeByIndex(itemIdx);
-    }
-
-    this.add(new ErrorModel(id, defaultMessage, parameters, false, layouthint));
-  }
-
-  /**
-   */
-  removeError(id: string) {
-    const itemIdx = this.findById(id);
-    this.removeByIndex(itemIdx);
-  }
-
-  /**
-   * Add a server error to the collection
-   */
-  addServerError(
-    id: string,
-    defaultMessage?: string,
-    parameters?: MessageParameters,
-    layouthint?: LayoutHintCollection,
-  ) {
-    if (parameters) {
-      this.addError(id, defaultMessage, parameters, layouthint);
-    } else {
-      this.addError(id, defaultMessage, undefined, layouthint);
-    }
-  }
-
-  /**
-   */
-  removeServerError(id: string) {
-    this.removeError(id);
-  }
-
-  /**
-   */
-  removeServerErrors() {
-    this.serverErrors.forEach((error) => {
-      this.removeError(error.id);
-    });
-  }
-
-  /**
-   */
-  addErrors(errors: Array<ErrorModel>) {
-    this.collection = [...this.collection, ...errors];
-  }
-
-  /**
-   * Add constraints to error collection
-   */
-  addConstraints(constraints: Array<IConstraintModel>) {
-    this.collection = [
-      ...this.collection,
-      ...constraints.map(
-        (constraint) =>
-          new ErrorModel(
-            constraint.id,
-            constraint.defaultMessage,
-            constraint.parameters,
-            true,
-          ),
-      ),
-    ];
-  }
-
-  /**
-   * Indicates if a mandatory constraint is available and if it is in error.
-   * Rationale: When a mandatory constraint is in error other constraint probably don't mather because there is no value to check
-   */
-  hasMandatoryError(): boolean {
-    return this.collection.some((error) => error.isMandatoryConstraint);
-  }
-}

package/src/models/error/ErrorModel.js

@@ -1,83 +0,0 @@
-// @flow
-import type { MessageObject, MessageParameters } from "../../i18n/types";
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-
-/**
- * Wrapper around an error message / object
- */
-class ErrorModel {
-  _id: string;
-  _defaultMessage: ?string;
-  _parameters: ?MessageParameters;
-  _isClientConstraint: boolean;
-  _layouthint: LayoutHintCollection;
-
-  /**
-   * Contruct
-   */
-  constructor(
-    id: string,
-    defaultMessage: ?string,
-    parameters: ?MessageParameters,
-    isClientConstraint: boolean = false,
-    layouthint: LayoutHintCollection = new LayoutHintCollection(),
-  ) {
-    this._id = id;
-    this._parameters = parameters;
-    this._defaultMessage = defaultMessage;
-    this._isClientConstraint = isClientConstraint;
-    this._layouthint = Array.isArray(layouthint)
-      ? new LayoutHintCollection(layouthint)
-      : layouthint;
-  }
-
-  /**
-   * Get id of error
-   */
-  get id(): string {
-    return this._id;
-  }
-
-  /**
-   */
-  get defaultMessage(): ?string {
-    return this._defaultMessage;
-  }
-
-  /**
-   */
-  get parameters(): ?MessageParameters {
-    return this._parameters;
-  }
-
-  /**
-   */
-  get isClientConstraint(): boolean {
-    return this._isClientConstraint || false;
-  }
-
-  /**
-   */
-  get layouthint(): LayoutHintCollection {
-    return this._layouthint;
-  }
-
-  /**
-   */
-  get isMandatoryConstraint(): boolean {
-    return this.id === "Constraint.Mandatory";
-  }
-
-  /**
-   * Returns a message object from the error
-   */
-  getMessage(): MessageObject {
-    return {
-      id: this.id,
-      defaultMessage: this.defaultMessage ?? "",
-      parameters: this.parameters ?? {},
-    };
-  }
-}
-
-export default ErrorModel;