@beinformed/ui 1.59.21 → 1.59.22

package/lib/models/href/Href.d.cts

@@ -0,0 +1,218 @@
+type HrefInput = any;
+export default Href;
+/**
+ * Defines a Href with the parameters
+ */
+declare class Href {
+    /**
+     * check if the path is referencing a camel route
+     */
+    static isCamelRoute(path: string): boolean;
+    /**
+     */
+    static checkAbsoluteUrl(href: string): boolean;
+    /**
+     * Retrieve the relative path part of a href string, e.g. https://www.beinformed.com/BeInformed/tab/view?q=url => /tab/view
+     */
+    static getPathFromString(href: string): string;
+    /**
+     * Retrieve hash of href string
+     */
+    static getHashFromString(href?: string): string;
+    /**
+     * Create a Href
+     */
+    constructor(href?: HrefInput, resourcetype?: string, modelOptions?: ModelOptions | null);
+    _path: string;
+    _hash: string;
+    _parameters: Array<Parameter>;
+    _resourcetype: string;
+    _method: $Keys<typeof HTTP_METHODS>;
+    _state: any;
+    _referenceHash: number | null;
+    _origin: string;
+    _contextPath: string;
+    /**
+     * Set resourctype
+     */
+    set resourcetype(resourcetype: string);
+    /**
+     * Retrieve resourceType
+     */
+    get resourcetype(): string;
+    /**
+     * Set the origin (e.g. http://example.com:18080)
+     */
+    set origin(origin: string);
+    /**
+     * Retrieve the origin (e.g. http://example.com:18080)<br>
+     * Empty when the default must be used
+     */
+    get origin(): string;
+    /**
+     * Set the context path if different from default
+     */
+    set contextPath(contextPath: string);
+    /**
+     * Get the context path
+     */
+    get contextPath(): string;
+    /**
+     * Set parameters from Href model input
+     */
+    setFromHref(href: Href): void;
+    /**
+     * Set the path of the Href, the part before the querystring question mark
+     */
+    set path(path: string);
+    /**
+     * Retrieve the path
+     */
+    get path(): string;
+    /**
+     * Replace parameters of Href
+     */
+    set parameters(parameters: Array<Parameter>);
+    /**
+     * Retrieve all paremters
+     */
+    get parameters(): Array<Parameter>;
+    /**
+     * Set hash
+     */
+    set hash(hash: string);
+    /**
+     * Retrieve hash
+     */
+    get hash(): string;
+    /**
+     */
+    set state(state: any);
+    /**
+     */
+    get state(): any;
+    /**
+     */
+    setFromLocationOrObject(href: LocationShape | HrefObject): void;
+    /**
+     */
+    setStateFromLocationOrObject(state?: any): void;
+    /**
+     * Set parameters from string input
+     */
+    setFromString(href: string): void;
+    /**
+     */
+    get isChangePassword(): boolean;
+    /**
+     */
+    get isExternal(): boolean;
+    /**
+     * Add a parameter for each parameter found in the querystring of an URL string, e.g. https://www.beinformed.com?q=url => q=url
+     */
+    addParametersFromString(href: string): Href;
+    /**
+     * Add a querystring parameter to the parameter collection of this Href, skips parameters that have a value of null
+     */
+    addParameter(name: string, value: string | null, prefix: string | null): Href;
+    /**
+     * Adds or overwrites a parameter when it exists and value is not null.
+     * Removes the parameter when the value is null
+     */
+    setParameter(name: string, value: string | null, prefix: string | null): Href;
+    /**
+     * Retrieve a parameter by it's name and (optionally) prefix
+     */
+    getParameter(name: string, prefix: string | null): Parameter | null;
+    /**
+     */
+    hasParameter(name: string, prefix: string | null): boolean;
+    /**
+     * Set request method
+     */
+    set method(method: $Keys<typeof HTTP_METHODS>);
+    /**
+     * Get request method
+     */
+    get method(): $Keys<typeof HTTP_METHODS>;
+    /**
+     * Remove a parameter from the parameter collection
+     */
+    removeParameter(name: string, prefix: string | null, value: string | null): Href;
+    /**
+     * Get the parameters as a querystring, e.g. param1=value1&param2=value2, optionally with prefix
+     */
+    getQuerystring(withPrefix?: boolean): string;
+    /**
+     * Retrieve a querystring that only contains parameter that can be send to the modular ui, parameters are filtered by prefix
+     */
+    getQuerystringForModularUI(prefix?: string): string;
+    /**
+     * Retrieve all parameters from the parameter collection in a querystring style name1=value1&name2=value2, without the prefix
+     */
+    get querystring(): string;
+    /**
+     */
+    setState(state: any): Href;
+    /**
+     * Retrieve the path combined with the base path (context-path) of the application, e.g. /BeInformed
+     */
+    get absolutepath(): string;
+    /**
+     * Retrieves the combination of the path and the querystring
+     */
+    get href(): string;
+    /**
+     * Getting the URL including the base path, querystring is prefixed
+     */
+    get absolutehref(): string;
+    /**
+     * Getting the URL including the base path, the querystring is prefixed
+     */
+    get absolutehrefPrefixedQuerystring(): string;
+    /**
+     * Checks if the URL starts within the given href
+     */
+    startsWith(href: Href | string): boolean;
+    /**
+     * Checks if the given Href equals this Href
+     */
+    equals(href: Href | string | null): boolean;
+    /**
+     */
+    equalsWithParameters(other: Href | string | null): boolean;
+    /**
+     * Indicates if the link is a content link
+     */
+    get isContent(): boolean;
+    /**
+     */
+    getReferenceHash(): number | null;
+    /**
+     */
+    setReferenceHash(referenceHash: number): void;
+    /**
+     * Returns a complete url from the Href
+     */
+    toString(): string;
+    /**
+     */
+    toLocation(): LocationShape;
+}
+import Parameter from "../parameter/Parameter";
+import { HTTP_METHODS } from "../../constants";
+type HrefObject = {
+    _path: string;
+    _hash: string;
+    _parameters: Parameter[];
+    _resourcetype: string;
+    _method: $Keys<{
+        POST: string;
+        GET: string;
+    }>;
+    _state: {
+        [key: string]: any;
+    } | null;
+    pathname: string | null;
+};
+import { ModelOptions } from "../types";

package/lib/models/href/ListHref.cjs

@@ -0,0 +1,135 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
+var _Href = _interopRequireDefault(require("./Href"));
+/**
+ * Class representing the href of a list. It adds paging, sorting and filter parameters where necessary
+ *
+ * @augments Href
+ */
+class ListHref extends _Href.default {
+  /**
+   * Create a ListHref
+   */
+  constructor(href, list) {
+    let isPrefixed = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+    super(href, undefined);
+    (0, _defineProperty2.default)(this, "_isPrefixed", void 0);
+    (0, _defineProperty2.default)(this, "_prefix", void 0);
+    (0, _defineProperty2.default)(this, "_pagingName", void 0);
+    (0, _defineProperty2.default)(this, "_pagesizeName", void 0);
+    (0, _defineProperty2.default)(this, "_sortingName", void 0);
+    this._isPrefixed = isPrefixed;
+    if (list != null) {
+      this.setParameterNamesFromListModel(list);
+    } else if (href != null && href instanceof ListHref) {
+      this.setParameterNamesFromHref(href);
+    }
+  }
+
+  /**
+   * Retrieve parameter names from Href
+   */
+  setParameterNamesFromHref(href) {
+    this._prefix = this._isPrefixed ? href.prefix : null;
+    this._pagingName = href.pagingName;
+    this._pagesizeName = href.pagesizeName;
+    this._sortingName = href.sortingName;
+  }
+
+  /**
+   * Retrieve parameter names and settings from List model
+   */
+  setParameterNamesFromListModel(list) {
+    this._prefix = this._isPrefixed ? list.key : null;
+    this._pagingName = list.paging ? list.paging.name : "";
+    this._pagesizeName = list.paging && list.paging.pagesize ? list.paging.pagesize.name : "";
+    this._sortingName = list.sorting ? list.sorting.name : "";
+    this.page = list.paging ? list.paging.page : null;
+    this.pagesize = list.paging && list.paging.pagesize.options.length > 0 ? list.paging.pagesize.value : null;
+    this.sort = list.sorting && list.sorting.param ? list.sorting.param : null;
+    this.filterCollection = list.filterCollection;
+  }
+
+  /**
+   * Getting prefix
+   */
+  get prefix() {
+    return this._prefix;
+  }
+
+  /**
+   * Getting paging name
+   */
+  get pagingName() {
+    return this._pagingName;
+  }
+
+  /**
+   * Getting pagesize name
+   */
+  get pagesizeName() {
+    return this._pagesizeName;
+  }
+
+  /**
+   * Getting sorting name
+   */
+  get sortingName() {
+    return this._sortingName;
+  }
+
+  /**
+   * Setting the current page
+   */
+  set page(page) {
+    const pageValue = page == null ? null : page.toString();
+    this.setParameter(this.pagingName, pageValue, this.prefix);
+  }
+
+  /**
+   */
+  get page() {
+    return this.getParameter(this.pagingName, this.prefix);
+  }
+
+  /**
+   * Setting the sort value
+   */
+  set sort(sort) {
+    this.setParameter(this.sortingName, sort, this.prefix);
+  }
+
+  /**
+   * Setting the page size
+   */
+  set pagesize(pagesize) {
+    const pageSizeValue = pagesize == null ? null : pagesize.toString();
+    this.setParameter(this.pagesizeName, pageSizeValue, this.prefix);
+  }
+
+  /**
+   * Add filter parameters to the parameter collection
+   */
+  set filterCollection(filters) {
+    if (!filters) {
+      return;
+    }
+    filters.forEach(filter => {
+      filter.params.forEach(param => {
+        if (param.value != null) {
+          this.setParameter(param.name, param.value, this.prefix);
+        } else {
+          this.removeParameter(param.name, this.prefix);
+        }
+      });
+    });
+  }
+}
+exports.default = ListHref;
+//# sourceMappingURL=ListHref.cjs.map

package/lib/models/href/ListHref.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListHref.cjs","names":["_Href","_interopRequireDefault","require","ListHref","Href","constructor","href","list","isPrefixed","arguments","length","undefined","_defineProperty2","default","_isPrefixed","setParameterNamesFromListModel","setParameterNamesFromHref","_prefix","prefix","_pagingName","pagingName","_pagesizeName","pagesizeName","_sortingName","sortingName","key","paging","name","pagesize","sorting","page","options","value","sort","param","filterCollection","pageValue","toString","setParameter","getParameter","pageSizeValue","filters","forEach","filter","params","removeParameter","exports"],"sources":["../../../src/models/href/ListHref.js"],"sourcesContent":["// @flow\nimport Href from \"./Href\";\n\nimport type FilterCollection from \"../filters/FilterCollection\";\nimport type ListModel from \"../list/ListModel\";\nimport type { HrefInput } from \"./Href\";\nimport type Parameter from \"../parameter/Parameter\";\n\n/**\n * Class representing the href of a list. It adds paging, sorting and filter parameters where necessary\n *\n * @augments Href\n */\nexport default class ListHref extends Href {\n  _isPrefixed: boolean;\n  _prefix: ?string;\n  _pagingName: string;\n  _pagesizeName: string;\n  _sortingName: string;\n\n  /**\n   * Create a ListHref\n   */\n  constructor(href?: HrefInput, list?: ListModel, isPrefixed: boolean = true) {\n    super(href, undefined);\n\n    this._isPrefixed = isPrefixed;\n\n    if (list != null) {\n      this.setParameterNamesFromListModel(list);\n    } else if (href != null && href instanceof ListHref) {\n      this.setParameterNamesFromHref(href);\n    }\n  }\n\n  /**\n   * Retrieve parameter names from Href\n   */\n  setParameterNamesFromHref(href: ListHref) {\n    this._prefix = this._isPrefixed ? href.prefix : null;\n    this._pagingName = href.pagingName;\n    this._pagesizeName = href.pagesizeName;\n    this._sortingName = href.sortingName;\n  }\n\n  /**\n   * Retrieve parameter names and settings from List model\n   */\n  setParameterNamesFromListModel(list: ListModel) {\n    this._prefix = this._isPrefixed ? list.key : null;\n\n    this._pagingName = list.paging ? list.paging.name : \"\";\n    this._pagesizeName =\n      list.paging && list.paging.pagesize ? list.paging.pagesize.name : \"\";\n\n    this._sortingName = list.sorting ? list.sorting.name : \"\";\n\n    this.page = list.paging ? list.paging.page : null;\n    this.pagesize =\n      list.paging && list.paging.pagesize.options.length > 0\n        ? list.paging.pagesize.value\n        : null;\n\n    this.sort = list.sorting && list.sorting.param ? list.sorting.param : null;\n\n    this.filterCollection = list.filterCollection;\n  }\n\n  /**\n   * Getting prefix\n   */\n  get prefix(): ?string {\n    return this._prefix;\n  }\n\n  /**\n   * Getting paging name\n   */\n  get pagingName(): string {\n    return this._pagingName;\n  }\n\n  /**\n   * Getting pagesize name\n   */\n  get pagesizeName(): string {\n    return this._pagesizeName;\n  }\n\n  /**\n   * Getting sorting name\n   */\n  get sortingName(): string {\n    return this._sortingName;\n  }\n\n  /**\n   * Setting the current page\n   */\n  set page(page: ?number) {\n    const pageValue = page == null ? null : page.toString();\n\n    this.setParameter(this.pagingName, pageValue, this.prefix);\n  }\n\n  /**\n   */\n  get page(): ?Parameter {\n    return this.getParameter(this.pagingName, this.prefix);\n  }\n\n  /**\n   * Setting the sort value\n   */\n  set sort(sort: ?string) {\n    this.setParameter(this.sortingName, sort, this.prefix);\n  }\n\n  /**\n   * Setting the page size\n   */\n  set pagesize(pagesize: ?number) {\n    const pageSizeValue = pagesize == null ? null : pagesize.toString();\n\n    this.setParameter(this.pagesizeName, pageSizeValue, this.prefix);\n  }\n\n  /**\n   * Add filter parameters to the parameter collection\n   */\n  set filterCollection(filters: FilterCollection) {\n    if (!filters) {\n      return;\n    }\n\n    filters.forEach((filter) => {\n      filter.params.forEach((param) => {\n        if (param.value != null) {\n          this.setParameter(param.name, param.value, this.prefix);\n        } else {\n          this.removeParameter(param.name, this.prefix);\n        }\n      });\n    });\n  }\n}\n"],"mappings":";;;;;;;;AACA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AAOA;AACA;AACA;AACA;AACA;AACe,MAAMC,QAAQ,SAASC,aAAI,CAAC;EAOzC;AACF;AACA;EACEC,WAAWA,CAACC,IAAgB,EAAEC,IAAgB,EAA8B;IAAA,IAA5BC,UAAmB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,IAAI;IACxE,KAAK,CAACH,IAAI,EAAEK,SAAS,CAAC;IAAC,IAAAC,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAEvB,IAAI,CAACC,WAAW,GAAGN,UAAU;IAE7B,IAAID,IAAI,IAAI,IAAI,EAAE;MAChB,IAAI,CAACQ,8BAA8B,CAACR,IAAI,CAAC;IAC3C,CAAC,MAAM,IAAID,IAAI,IAAI,IAAI,IAAIA,IAAI,YAAYH,QAAQ,EAAE;MACnD,IAAI,CAACa,yBAAyB,CAACV,IAAI,CAAC;IACtC;EACF;;EAEA;AACF;AACA;EACEU,yBAAyBA,CAACV,IAAc,EAAE;IACxC,IAAI,CAACW,OAAO,GAAG,IAAI,CAACH,WAAW,GAAGR,IAAI,CAACY,MAAM,GAAG,IAAI;IACpD,IAAI,CAACC,WAAW,GAAGb,IAAI,CAACc,UAAU;IAClC,IAAI,CAACC,aAAa,GAAGf,IAAI,CAACgB,YAAY;IACtC,IAAI,CAACC,YAAY,GAAGjB,IAAI,CAACkB,WAAW;EACtC;;EAEA;AACF;AACA;EACET,8BAA8BA,CAACR,IAAe,EAAE;IAC9C,IAAI,CAACU,OAAO,GAAG,IAAI,CAACH,WAAW,GAAGP,IAAI,CAACkB,GAAG,GAAG,IAAI;IAEjD,IAAI,CAACN,WAAW,GAAGZ,IAAI,CAACmB,MAAM,GAAGnB,IAAI,CAACmB,MAAM,CAACC,IAAI,GAAG,EAAE;IACtD,IAAI,CAACN,aAAa,GAChBd,IAAI,CAACmB,MAAM,IAAInB,IAAI,CAACmB,MAAM,CAACE,QAAQ,GAAGrB,IAAI,CAACmB,MAAM,CAACE,QAAQ,CAACD,IAAI,GAAG,EAAE;IAEtE,IAAI,CAACJ,YAAY,GAAGhB,IAAI,CAACsB,OAAO,GAAGtB,IAAI,CAACsB,OAAO,CAACF,IAAI,GAAG,EAAE;IAEzD,IAAI,CAACG,IAAI,GAAGvB,IAAI,CAACmB,MAAM,GAAGnB,IAAI,CAACmB,MAAM,CAACI,IAAI,GAAG,IAAI;IACjD,IAAI,CAACF,QAAQ,GACXrB,IAAI,CAACmB,MAAM,IAAInB,IAAI,CAACmB,MAAM,CAACE,QAAQ,CAACG,OAAO,CAACrB,MAAM,GAAG,CAAC,GAClDH,IAAI,CAACmB,MAAM,CAACE,QAAQ,CAACI,KAAK,GAC1B,IAAI;IAEV,IAAI,CAACC,IAAI,GAAG1B,IAAI,CAACsB,OAAO,IAAItB,IAAI,CAACsB,OAAO,CAACK,KAAK,GAAG3B,IAAI,CAACsB,OAAO,CAACK,KAAK,GAAG,IAAI;IAE1E,IAAI,CAACC,gBAAgB,GAAG5B,IAAI,CAAC4B,gBAAgB;EAC/C;;EAEA;AACF;AACA;EACE,IAAIjB,MAAMA,CAAA,EAAY;IACpB,OAAO,IAAI,CAACD,OAAO;EACrB;;EAEA;AACF;AACA;EACE,IAAIG,UAAUA,CAAA,EAAW;IACvB,OAAO,IAAI,CAACD,WAAW;EACzB;;EAEA;AACF;AACA;EACE,IAAIG,YAAYA,CAAA,EAAW;IACzB,OAAO,IAAI,CAACD,aAAa;EAC3B;;EAEA;AACF;AACA;EACE,IAAIG,WAAWA,CAAA,EAAW;IACxB,OAAO,IAAI,CAACD,YAAY;EAC1B;;EAEA;AACF;AACA;EACE,IAAIO,IAAIA,CAACA,IAAa,EAAE;IACtB,MAAMM,SAAS,GAAGN,IAAI,IAAI,IAAI,GAAG,IAAI,GAAGA,IAAI,CAACO,QAAQ,CAAC,CAAC;IAEvD,IAAI,CAACC,YAAY,CAAC,IAAI,CAAClB,UAAU,EAAEgB,SAAS,EAAE,IAAI,CAAClB,MAAM,CAAC;EAC5D;;EAEA;AACF;EACE,IAAIY,IAAIA,CAAA,EAAe;IACrB,OAAO,IAAI,CAACS,YAAY,CAAC,IAAI,CAACnB,UAAU,EAAE,IAAI,CAACF,MAAM,CAAC;EACxD;;EAEA;AACF;AACA;EACE,IAAIe,IAAIA,CAACA,IAAa,EAAE;IACtB,IAAI,CAACK,YAAY,CAAC,IAAI,CAACd,WAAW,EAAES,IAAI,EAAE,IAAI,CAACf,MAAM,CAAC;EACxD;;EAEA;AACF;AACA;EACE,IAAIU,QAAQA,CAACA,QAAiB,EAAE;IAC9B,MAAMY,aAAa,GAAGZ,QAAQ,IAAI,IAAI,GAAG,IAAI,GAAGA,QAAQ,CAACS,QAAQ,CAAC,CAAC;IAEnE,IAAI,CAACC,YAAY,CAAC,IAAI,CAAChB,YAAY,EAAEkB,aAAa,EAAE,IAAI,CAACtB,MAAM,CAAC;EAClE;;EAEA;AACF;AACA;EACE,IAAIiB,gBAAgBA,CAACM,OAAyB,EAAE;IAC9C,IAAI,CAACA,OAAO,EAAE;MACZ;IACF;IAEAA,OAAO,CAACC,OAAO,CAAEC,MAAM,IAAK;MAC1BA,MAAM,CAACC,MAAM,CAACF,OAAO,CAAER,KAAK,IAAK;QAC/B,IAAIA,KAAK,CAACF,KAAK,IAAI,IAAI,EAAE;UACvB,IAAI,CAACM,YAAY,CAACJ,KAAK,CAACP,IAAI,EAAEO,KAAK,CAACF,KAAK,EAAE,IAAI,CAACd,MAAM,CAAC;QACzD,CAAC,MAAM;UACL,IAAI,CAAC2B,eAAe,CAACX,KAAK,CAACP,IAAI,EAAE,IAAI,CAACT,MAAM,CAAC;QAC/C;MACF,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;AACF;AAAC4B,OAAA,CAAAjC,OAAA,GAAAV,QAAA","ignoreList":[]}

package/lib/models/href/ListHref.d.cts

@@ -0,0 +1,64 @@
+/**
+ * Class representing the href of a list. It adds paging, sorting and filter parameters where necessary
+ *
+ * @augments Href
+ */
+export default class ListHref extends Href {
+    /**
+     * Create a ListHref
+     */
+    constructor(href?: HrefInput, list?: ListModel, isPrefixed?: boolean);
+    _isPrefixed: boolean;
+    _prefix: string | null;
+    _pagingName: string;
+    _pagesizeName: string;
+    _sortingName: string;
+    /**
+     * Retrieve parameter names from Href
+     */
+    setParameterNamesFromHref(href: ListHref): void;
+    /**
+     * Retrieve parameter names and settings from List model
+     */
+    setParameterNamesFromListModel(list: ListModel): void;
+    /**
+     * Setting the current page
+     */
+    set page(page: number | null);
+    /**
+     */
+    get page(): Parameter | null;
+    /**
+     * Setting the page size
+     */
+    set pagesize(pagesize: number | null);
+    /**
+     * Setting the sort value
+     */
+    set sort(sort: string | null);
+    /**
+     * Add filter parameters to the parameter collection
+     */
+    set filterCollection(filters: FilterCollection);
+    /**
+     * Getting prefix
+     */
+    get prefix(): string | null;
+    /**
+     * Getting paging name
+     */
+    get pagingName(): string;
+    /**
+     * Getting pagesize name
+     */
+    get pagesizeName(): string;
+    /**
+     * Getting sorting name
+     */
+    get sortingName(): string;
+}
+import Href from "./Href";
+import ListModel from "../list/ListModel";
+import Parameter from "../parameter/Parameter";
+import FilterCollection from "../filters/FilterCollection";
+import { HrefInput } from "./Href";