@beinformed/ui 1.65.29 → 2.0.0-beta.1

package/esm/modularui/ModularUIRequest.js

@@ -1,710 +0,0 @@
-import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
-import _globalThis from "@babel/runtime-corejs3/core-js/global-this";
-import _mapInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/map";
-import _JSON$stringify from "@babel/runtime-corejs3/core-js-stable/json/stringify";
-import _Object$keys from "@babel/runtime-corejs3/core-js-stable/object/keys";
-import _Promise from "@babel/runtime-corejs3/core-js-stable/promise";
-import _findInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/find";
-import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
-import _includesInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/includes";
-import deepmerge from "deepmerge";
-import { HTTP_METHODS, TIMEVERSION_FILTER_NAME } from "../constants/Constants";
-import { HIDE_WHEN_EMPTY } from "../constants/LayoutHints";
-import { getBasePathModularUI, getSetting } from "../constants/Settings";
-import Href from "../models/href/Href";
-import universalFetch from "../utils/fetch/universalFetch";
-import resolveModel from "../models/resolveModel";
-import FormModel from "../models/form/FormModel";
-import ContentModel from "../models/content/ContentModel";
-import ErrorResponse from "../models/error/ErrorResponse";
-import ModularUIResponse from "./ModularUIResponse";
-import ModularUIError from "./ModularUIError";
-import { IllegalArgumentException, IllegalStateException } from "../exceptions";
-import { isPlainObject } from "../utils/helpers/objects";
-/**
- * Helper for fetching data and contributions from the Be Informed modular ui
- * and merge it into a target or resolvable model.
- */
-class ModularUIRequest {
-  /**
-   */
-  constructor(href, options = {}) {
-    _defineProperty(this, "_response", void 0);
-    _defineProperty(this, "_href", void 0);
-    _defineProperty(this, "_options", void 0);
-    _defineProperty(this, "_targetModel", void 0);
-    _defineProperty(this, "_forceTargetModel", false);
-    _defineProperty(this, "_contributionsHref", void 0);
-    _defineProperty(this, "_locale", void 0);
-    _defineProperty(this, "_method", HTTP_METHODS.GET);
-    _defineProperty(this, "_progressEvent", void 0);
-    _defineProperty(this, "_origin", "");
-    _defineProperty(this, "_contextPath", getBasePathModularUI());
-    if (!href) {
-      throw new IllegalArgumentException("You must pass a href to the resource that is requested");
-    }
-    this.options = options;
-    this._response = new ModularUIResponse();
-    this.href = typeof href === "string" ? new Href(href) : href;
-    this.locale = this.getRequestLocale(options.locale);
-
-    // copy request parameters to response, to be able to use them in the models
-    // self links are missing the request parameters
-    this._response.parameters = this.href.parameters;
-    if (options.contextPath) {
-      this.contextPath = options.contextPath;
-    } else if (this.href.contextPath) {
-      this.contextPath = this.href.contextPath;
-    }
-    if (options.origin) {
-      this.origin = options.origin;
-    } else if (this.href.origin) {
-      this.origin = this.href.origin;
-    }
-    if (options.targetModel) {
-      this.targetModel = options.targetModel;
-    }
-    if (options.method) {
-      this.method = options.method;
-    } else {
-      this.method = this.href.method;
-    }
-  }
-
-  /**
-   * Retrieve the preferred language for this request, falls back to the browser language or english
-   */
-  getRequestLocale(optionLocale) {
-    if (optionLocale) {
-      return optionLocale;
-    }
-
-    // $FlowIssue
-    return _globalThis.navigator?.language?.split("-")[0] || "en";
-  }
-
-  /**
-   */
-  get origin() {
-    return this._origin;
-  }
-
-  /**
-   */
-  set origin(origin) {
-    this._origin = origin ?? "";
-    this._response.origin = origin ?? "";
-  }
-
-  /**
-   */
-  get contextPath() {
-    return this._contextPath;
-  }
-
-  /**
-   */
-  set contextPath(contextPath) {
-    this._contextPath = contextPath ?? getBasePathModularUI();
-    this._response.contextPath = contextPath ?? getBasePathModularUI();
-  }
-
-  /**
-   */
-  get contributionsHref() {
-    return this._contributionsHref;
-  }
-
-  /**
-   */
-  set contributionsHref(contributionsHref) {
-    this._contributionsHref = contributionsHref;
-  }
-
-  /**
-   */
-  set locale(locale) {
-    this._locale = locale;
-    this._response.locale = locale;
-  }
-
-  /**
-   */
-  get locale() {
-    return this._locale;
-  }
-
-  /**
-   */
-  get response() {
-    return this._response;
-  }
-
-  /**
-   */
-  set href(href) {
-    this._href = href;
-  }
-
-  /**
-   */
-  get href() {
-    return this._href;
-  }
-
-  /**
-   */
-  set method(method) {
-    this._method = method;
-  }
-
-  /**
-   */
-  get method() {
-    return this._method;
-  }
-
-  /**
-   */
-  get options() {
-    return {
-      ...this._options,
-      locale: this.locale,
-      method: this.method
-    };
-  }
-
-  /**
-   */
-  get requestOptions() {
-    /* eslint-disable no-unused-vars */
-    const {
-      targetModel,
-      forceTargetModel,
-      updateHandler,
-      childmodels,
-      isValidationRequest,
-      removeOnUnmount,
-      ...requestOptions
-    } = this.options;
-    /* eslint-enable no-unused-vars */
-    return requestOptions;
-  }
-
-  /**
-   */
-  set options(options) {
-    this._options = options;
-  }
-
-  /**
-   */
-  get withChildModels() {
-    return !("childmodels" in this.options) || this.options.childmodels === true;
-  }
-
-  /**
-   */
-  set targetModel(targetModel) {
-    this._targetModel = targetModel;
-  }
-
-  /**
-   */
-  get targetModel() {
-    return this._targetModel;
-  }
-
-  /**
-   */
-  set forceTargetModel(forceTargetModel) {
-    this._forceTargetModel = forceTargetModel ?? false;
-  }
-
-  /**
-   */
-  get forceTargetModel() {
-    return this._forceTargetModel;
-  }
-
-  /**
-   */
-  resolveModel() {
-    let availableModels;
-    if (this.targetModel) {
-      availableModels = Array.isArray(this.targetModel) ? [...this.targetModel] : [this.targetModel];
-      if (this.forceTargetModel) {
-        return availableModels[0];
-      }
-    }
-    const Model = resolveModel(this.response, availableModels);
-    if (Model?.isApplicableModel) {
-      return Model;
-    }
-    if (availableModels) {
-      throw new IllegalStateException(`data for ${this.href.toString()} is not applicable for model(s): ${_mapInstanceProperty(availableModels).call(availableModels, m => m.modelName).join(", ")}, received response: ${_JSON$stringify(this.response)}`);
-    }
-    throw new IllegalStateException(`no javascript model is applicable for received request of ${this.href.toString()}, with response: ${_JSON$stringify(this.response)}`);
-  }
-
-  /**
-   */
-  createModel() {
-    const Model = this.resolveModel();
-    return new Model(this.response);
-  }
-
-  /**
-   */
-  processContributionsService(contributionsData) {
-    if (!isPlainObject(contributionsData)) {
-      throw new IllegalArgumentException("Missing contributions data or contributions is not JSON");
-    }
-    const [contributionsKey] = _Object$keys(contributionsData);
-    if (contributionsData.error && contributionsKey === "error") {
-      this.handleContributionsError(contributionsData.error);
-    }
-
-    // The key of the data service is different from the contributions service for forms
-    if (!(this.response.key in contributionsData)) {
-      this.response.key = contributionsKey;
-    }
-    this.response.contributions = contributionsData[this.response.key];
-  }
-
-  /**
-   */
-  handleContributionsError(error) {
-    const errorMessage = error.properties?.message ?? "Error in contribution";
-    throw new ModularUIError(errorMessage, error, this.contributionsHref);
-  }
-
-  /**
-   */
-  handleDataError(error) {
-    if (error.properties) {
-      const errorMessage = error.properties?.message ?? "Error in data";
-      throw new ModularUIError(errorMessage, error, this.href.absolutepath.toString());
-    }
-    throw new IllegalArgumentException(error);
-  }
-
-  /**
-   */
-  handleData(key, data) {
-    this.response.key = key;
-    this.response.data = data;
-    const links = data._links;
-    if (links?.contributions) {
-      this.contributionsHref = links.contributions.href;
-    } else if (Array.isArray(links) && links[0].contributions) {
-      this.contributionsHref = links[0].contributions.href;
-    } else {
-      throw new IllegalArgumentException(`Contributions link not found for data with key ${key}`);
-    }
-  }
-
-  /**
-   */
-  processDataService(data) {
-    if (!isPlainObject(data)) {
-      throw new IllegalArgumentException("Missing data or data is not JSON");
-    }
-    if (data.error) {
-      this.handleDataError(data.error);
-    } else {
-      const [key] = _Object$keys(data);
-      this.handleData(key, data[key]);
-    }
-  }
-
-  /**
-   */
-  fetchContributionsService() {
-    if (!this.contributionsHref) {
-      throw new IllegalStateException("Missing a contributions href");
-    }
-    return universalFetch({
-      url: `${this.origin}${this.contextPath}${this.contributionsHref}`,
-      cache: true,
-      locale: this.options.locale
-    });
-  }
-
-  /**
-   */
-  fetchDataService() {
-    return universalFetch({
-      ...this.requestOptions,
-      url: `${this.origin}${this.contextPath}${this.href.path}`,
-      params: this.href.getQuerystringForModularUI(),
-      locale: this.options.locale,
-      onProgress: this.onProgress
-    });
-  }
-
-  /**
-   * 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
-   */
-  async processAsyncLayoutHints() {
-    if (getSetting("ALLOW_HIDE_WHEN_EMPTY_ON_TABS")) {
-      await this.processApplicationLinks();
-      await this.processTabLinks();
-    }
-    await this.processPanelLinks();
-  }
-
-  /**
-   * hide application links<br>
-   * _links on application data contains an extra level of tab links
-   */
-  processApplicationLinks() {
-    const contributionLinks = this.response.contributions._links;
-    const dataLinks = this.response.data._links;
-    if (!contributionLinks || !dataLinks) {
-      return _Promise.resolve();
-    }
-    if ("tab" in contributionLinks && "tab" in dataLinks) {
-      for (const contributionTabLink of contributionLinks.tab) {
-        if ("components" in contributionTabLink) {
-          var _context;
-          const dataTabLinks = _findInstanceProperty(_context = dataLinks.tab).call(_context, dataLink => dataLink.name === contributionTabLink.name);
-          if (dataTabLinks && "components" in dataTabLinks) {
-            return this.processLinks(dataTabLinks.components, contributionTabLink.components).then(newLinks => this.replaceApplicationLinks(contributionTabLink.name, newLinks));
-          }
-        }
-      }
-    }
-    return _Promise.resolve();
-  }
-
-  /**
-   * Replace hidden link in application link tree
-   */
-  replaceApplicationLinks(tabName, newLinks) {
-    var _context2;
-    this.response.data._links.tab = _mapInstanceProperty(_context2 = this.response.data._links.tab).call(_context2, tabLink => {
-      const key = tabLink.name;
-      if (tabName === key) {
-        tabLink.components = newLinks;
-      }
-      return tabLink;
-    });
-  }
-
-  /**
-   */
-  processTabLinks() {
-    const contributionLinks = this.response.contributions._links;
-    if (!contributionLinks) {
-      return _Promise.resolve();
-    }
-    if ("component" in contributionLinks) {
-      return this.processLinks(this.response.data._links.component, contributionLinks.component).then(newLinks => {
-        this.response.data._links.component = newLinks;
-      });
-    }
-    return _Promise.resolve();
-  }
-
-  /**
-   */
-  processPanelLinks() {
-    const contributionLinks = this.response.contributions._links;
-    if (!contributionLinks) {
-      return _Promise.resolve();
-    }
-    if ("panel" in contributionLinks) {
-      return this.processLinks(this.response.data._links, contributionLinks.panel).then(newLinks => {
-        this.response.data._links = newLinks;
-      });
-    }
-    return _Promise.resolve();
-  }
-
-  /**
-   * Retrieve an object of key: link
-   */
-  dataLinksPerName(dataLinks) {
-    if (Array.isArray(dataLinks)) {
-      const links = {};
-      for (const dataLink of dataLinks) {
-        links[dataLink.name] = dataLink;
-      }
-      return links;
-    }
-    return dataLinks;
-  }
-
-  /**
-   * Check if links are empty and hide them when hide-when-empty hint exists
-   */
-  processLinks(dataLinks, contributionLinks) {
-    const linksPerName = this.dataLinksPerName(dataLinks);
-    const hideWhenEmptyLinks = _filterInstanceProperty(contributionLinks).call(contributionLinks, contributionLink => {
-      var _context3;
-      return ((_context3 = contributionLink.layouthint) == null ? void 0 : Function.call.bind(_includesInstanceProperty(_context3), _context3))?.(HIDE_WHEN_EMPTY);
-    });
-    const isHiddenListChecks = [];
-    for (const contributionLink of hideWhenEmptyLinks) {
-      const dataLink = linksPerName[contributionLink.name];
-      if (dataLink?.href) {
-        isHiddenListChecks.push(this.isHiddenList(contributionLink.name, dataLink.href));
-      }
-    }
-    return _Promise.all(isHiddenListChecks).then(hiddenLinks => {
-      if (Array.isArray(dataLinks)) {
-        return _filterInstanceProperty(dataLinks).call(dataLinks, dataLink => !_includesInstanceProperty(hiddenLinks).call(hiddenLinks, dataLink.name));
-      }
-      const newDataLinks = {};
-      for (const dataLinkKey in dataLinks) {
-        if (!_includesInstanceProperty(hiddenLinks).call(hiddenLinks, dataLinkKey)) {
-          newDataLinks[dataLinkKey] = dataLinks[dataLinkKey];
-        }
-      }
-      return newDataLinks;
-    });
-  }
-
-  /**
-   */
-  isHiddenList(name, href) {
-    const HIDE_WHEN_EMPTY_IGNORE_TASKS = getSetting("HIDE_WHEN_EMPTY_IGNORE_TASKS", false);
-    return universalFetch({
-      ...this.requestOptions,
-      url: `${this.origin}${this.contextPath}${href}`
-    }).then(response => {
-      if (isPlainObject(response)) {
-        const [key] = _Object$keys(response);
-        const {
-          _embedded,
-          actions
-        } = response[key];
-        const noListItems = _embedded === null;
-        const noActions = actions == null || HIDE_WHEN_EMPTY_IGNORE_TASKS;
-        const isHidden = noListItems && noActions;
-        if (isHidden) {
-          return name;
-        }
-      }
-      return "";
-    }).catch(() => {
-      return "";
-    });
-  }
-
-  /**
-   */
-  set onProgress(progressEvent) {
-    this._progressEvent = progressEvent;
-  }
-
-  /**
-   */
-  get onProgress() {
-    return this._progressEvent || null;
-  }
-
-  /**
-   * 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) {
-    const prevData = typeof this.options.data === "string" ? JSON.parse(this.options.data) : this.options.data;
-    if (model instanceof FormModel) {
-      const newData = JSON.parse(model.validationData);
-      // $FlowFixMe incompatible-call
-      return _JSON$stringify(deepmerge(prevData || {}, newData));
-    }
-    return _JSON$stringify(prevData) ?? "{}";
-  }
-
-  /**
-   * First load of dynamic values when a form is loaded
-   */
-  loadDynamicValidations(model) {
-    if (!this.options.isValidationRequest && getSetting("USE_INSTANT_SERVER_VALIDATION") && model instanceof FormModel && model.currentFormObject?.hasDynamicValidations) {
-      const validationHref = this.href.setParameter("commit", "false");
-      return universalFetch({
-        ...this.requestOptions,
-        url: `${this.origin}${this.contextPath}${this.href.path}`,
-        params: validationHref.getQuerystringForModularUI(),
-        data: this.getDynamicValidationData(model)
-      }).then(data => {
-        if (data == null || typeof data !== "object" || Array.isArray(data)) {
-          return model;
-        }
-        const [key] = _Object$keys(data);
-        return model.updateValidations(data[key]);
-      });
-    }
-    return _Promise.resolve(model);
-  }
-
-  /**
-   */
-  fetch() {
-    return this.fetchDataService().then(data => {
-      if (data == null) {
-        throw new Error(`No data received for ${this.href.toString()}`);
-      }
-      this.processDataService(data);
-      return this.fetchContributionsService();
-    }).then(contributionsData => {
-      if (contributionsData == null) {
-        throw new Error(`No contributions data received for ${this.contributionsHref}`);
-      }
-      this.processContributionsService(contributionsData);
-      return this.processAsyncLayoutHints();
-    }).then(() => this.createModel()).then(model => this.loadDynamicValidations(model)).then(model => {
-      if (this.withChildModels) {
-        return this.fetchChildModels(model);
-      }
-      return model;
-    });
-  }
-
-  /**
-   */
-  fetchFromCache() {
-    this.options = {
-      ...this.options,
-      cache: true
-    };
-    return this.fetch();
-  }
-
-  /**
-   */
-  fetchChildModels(model) {
-    const childModelLinks = model.getInitialChildModelLinks();
-    const childModelRequests = _mapInstanceProperty(childModelLinks).call(childModelLinks, childModelLink => {
-      const request = new ModularUIRequest(childModelLink.href, {
-        locale: this.locale
-      });
-      if (childModelLink.targetModel) {
-        request.targetModel = childModelLink.targetModel;
-      }
-      if (childModelLink.isCacheable) {
-        return request.fetchFromCache();
-      }
-      return request.fetch();
-    });
-    return _Promise.allSettled(childModelRequests).then(childModels => {
-      const resolvedChildModels = [];
-      const errorChildModels = [];
-      childModels.forEach(childModel => {
-        if (childModel.status === "rejected") {
-          const {
-            reason
-          } = childModel;
-          if (reason.name !== "Error.ChangePasswordRequired") {
-            // eslint-disable-next-line no-console
-            console.debug("Unexpected error when retrieving child model:", reason);
-          }
-          errorChildModels.push(new ErrorResponse(reason, "", {
-            origin: this.origin,
-            contextPath: this.contextPath
-          }));
-        } else {
-          resolvedChildModels.push(childModel.value);
-        }
-      });
-      model.addChildModels(resolvedChildModels, errorChildModels);
-      return model;
-    });
-  }
-
-  /**
-   */
-  fetchContent(withChildSections) {
-    return this.fetchFromCache().then(model => {
-      if (withChildSections && model instanceof ContentModel && model.childSectionLinks.length > 0) {
-        return this.fetchContentChildSections(model);
-      }
-      return model;
-    });
-  }
-
-  /**
-   * Recursively return child sections defined on the content model
-   */
-  fetchContentChildSections(contentModel) {
-    var _context4;
-    const newContentModel = contentModel.clone();
-    return _Promise.all(_mapInstanceProperty(_context4 = contentModel.childSectionLinks).call(_context4, childSectionLink => {
-      const contentHrefWithEntryDate = childSectionLink.selfhref.addParameter(TIMEVERSION_FILTER_NAME, contentModel.entryDate);
-      const request = new ModularUIRequest(contentHrefWithEntryDate, {
-        locale: this.locale
-      });
-      return request.fetchContent(true);
-    })).then(sectionModels => {
-      newContentModel.childSections = sectionModels;
-      return newContentModel;
-    });
-  }
-
-  /**
-   * Make a post request with optionally data to send
-   * @param data
-   */
-  post(data) {
-    this.method = HTTP_METHODS.POST;
-    this.options = {
-      ...this.options,
-      data
-    };
-    return this.fetch();
-  }
-
-  /**
-   * Make a POST request using the form, an updated form is returned (merge of old and new form)
-   * @param form
-   * @returns {Promise<FormModel>}
-   */
-  postForm(form) {
-    this.method = HTTP_METHODS.POST;
-    this.options = {
-      ...this.options,
-      data: form.formdata
-    };
-    return this.fetch().then(response => {
-      return form.update(response);
-    });
-  }
-
-  /**
-   * 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() {
-    const options = {
-      headers: {
-        "Accept-Language": this.locale
-      }
-    };
-    const dataString = dataFetcher.fetch(this.href.toString(), options);
-    if (dataString == null) {
-      throw new Error(`No data received for ${this.href.toString()}`);
-    }
-    this.processDataService(JSON.parse(dataString));
-    const contributionsString = dataFetcher.fetch(this.contributionsHref.toString(), options);
-    if (contributionsString == null) {
-      throw new Error(`No constributions received for ${this.contributionsHref.toString()}`);
-    }
-    this.processContributionsService(JSON.parse(contributionsString));
-    const model = this.createModel();
-    const childModelLinks = model.getInitialChildModelLinks();
-    const childModels = _mapInstanceProperty(childModelLinks).call(childModelLinks, childModelLink => {
-      return new ModularUIRequest(childModelLink.href, {
-        locale: this.locale
-      }).fetchSync();
-    });
-    model.addChildModels(childModels, []);
-    return model;
-  }
-}
-export default ModularUIRequest;
-//# sourceMappingURL=ModularUIRequest.js.map