@beinformed/ui 1.56.0 → 1.57.0-contextpath.0

package/src/modularui/ModularUIRequest.js

@@ -46,7 +46,8 @@ class ModularUIRequest {
 
   _progressEvent: ProgressEventHandler;
 
-  _basePath: string = "/BeInformed";
+  _origin: string = "";
+  _contextPath: string = getBasePath();
 
   /**
    */
@@ -60,8 +61,6 @@ class ModularUIRequest {
       );
     }
 
-    this._basePath = getBasePath();
-
     this.options = options;
 
     this._response = new ModularUIResponse();
@@ -73,6 +72,18 @@ class ModularUIRequest {
     // 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;
     }
@@ -84,6 +95,32 @@ class ModularUIRequest {
     }
   }
 
+  /**
+   */
+  get origin(): string {
+    return this._origin;
+  }
+
+  /**
+   */
+  set origin(origin: ?string) {
+    this._origin = origin ?? "";
+    this._response.origin = origin ?? "";
+  }
+
+  /**
+   */
+  get contextPath(): string {
+    return this._contextPath;
+  }
+
+  /**
+   */
+  set contextPath(contextPath: ?string) {
+    this._contextPath = contextPath ?? getBasePath();
+    this._response.contextPath = contextPath ?? getBasePath();
+  }
+
   /**
    */
   get contributionsHref(): string {
@@ -284,7 +321,11 @@ class ModularUIRequest {
   handleDataError(error: Object): void {
     if (error.properties) {
       const errorMessage = error.properties?.message ?? "Error in data";
-      throw new ModularUIError(errorMessage, error, this.href.path.toString());
+      throw new ModularUIError(
+        errorMessage,
+        error,
+        this.href.absolutepath.toString(),
+      );
     }
 
     throw new IllegalArgumentException(error);
@@ -332,7 +373,7 @@ class ModularUIRequest {
     }
 
     return universalFetch({
-      url: `${this._basePath}${this.contributionsHref}`,
+      url: `${this.origin}${this.contextPath}${this.contributionsHref}`,
       cache: true,
       locale: this.options.locale,
     });
@@ -343,7 +384,7 @@ class ModularUIRequest {
   fetchDataService(): Promise<any> {
     return universalFetch({
       ...this.requestOptions,
-      url: `${this._basePath}${this.href.path}`,
+      url: `${this.origin}${this.contextPath}${this.href.path}`,
       params: this.href.getQuerystringForModularUI(),
       locale: this.options.locale,
       onProgress: this.onProgress,
@@ -520,7 +561,7 @@ class ModularUIRequest {
 
     return universalFetch({
       ...this.requestOptions,
-      url: `${this._basePath}${href}`,
+      url: `${this.origin}${this.contextPath}${href}`,
     })
       .then((response: Object) => {
         if (isPlainObject(response)) {
@@ -588,7 +629,7 @@ class ModularUIRequest {
       const validationHref = this.href.setParameter("commit", "false");
       return universalFetch({
         ...this.requestOptions,
-        url: `${this._basePath}${this.href.path}`,
+        url: `${this.origin}${this.contextPath}${this.href.path}`,
         params: validationHref.getQuerystringForModularUI(),
         data: this.getDynamicValidationData(model),
       }).then((data) => {

package/src/modularui/ModularUIResponse.js

@@ -1,5 +1,6 @@
 // @flow
 import { has } from "../utils/helpers/objects";
+import { getBasePath } from "../constants";
 
 import type Parameter from "../models/parameter/Parameter";
 
@@ -11,6 +12,8 @@ class ModularUIResponse {
   _contributions: Object;
   _locale: string = "en";
   _parameters: Array<Parameter> = [];
+  _contextPath: string = getBasePath();
+  _origin: string = "";
 
   /**
    */
@@ -18,6 +21,8 @@ class ModularUIResponse {
     key: string,
     data: Object,
     contributions: Object,
+    origin?: string,
+    contextPath?: string,
   }): ModularUIResponse {
     const response = new ModularUIResponse();
 
@@ -28,11 +33,37 @@ class ModularUIResponse {
       response.key = input.key ?? contributionsKey;
       response.data = input.data?.[dataKey];
       response.contributions = input.contributions?.[contributionsKey];
+      response.origin = input.origin;
+      response.contextPath = input.contextPath;
     }
 
     return response;
   }
 
+  /**
+   */
+  set origin(origin: ?string) {
+    this._origin = origin ?? "";
+  }
+
+  /**
+   */
+  get origin(): string {
+    return this._origin;
+  }
+
+  /**
+   */
+  set contextPath(contextPath: ?string) {
+    this._contextPath = contextPath ?? getBasePath();
+  }
+
+  /**
+   */
+  get contextPath(): string {
+    return this._contextPath;
+  }
+
   /**
    */
   set locale(locale: string) {
@@ -100,9 +131,13 @@ class ModularUIResponse {
     locale: string,
     data: Object,
     contributions: Object,
+    origin?: string,
+    contextPath?: string,
   }): ModularUIResponse {
     const modelData = new ModularUIResponse();
 
+    modelData.origin = data.origin;
+    modelData.contextPath = data.contextPath;
     modelData.locale = data.locale;
     modelData.key = data.key;
     modelData.data = data.data;

package/src/modularui/__tests__/CustomContextPath.spec.js

@@ -0,0 +1,61 @@
+import xhrMock from "xhr-mock";
+
+import ModularUIRequest from "../ModularUIRequest";
+
+import dataJSON from "./data.json";
+import contributionsJSON from "./contributions.json";
+
+import ApplicationModel from "../../models/application/ApplicationModel";
+
+const JSON_TYPE = "application/json";
+
+describe("modularUIRequest", () => {
+  // replace the real XHR object with the mock XHR object before each test
+  // eslint-disable-next-line jest/no-hooks
+  beforeEach(() => xhrMock.setup());
+
+  // put the real XHR object back and clear the mocks after each test
+  // eslint-disable-next-line jest/no-hooks
+  afterEach(() => xhrMock.teardown());
+
+  it("creates a model from a response with custom origin and contextPath", async () => {
+    expect.assertions(12);
+    xhrMock.get("http://www.example.com/custom-path/", (req, res) => {
+      expect(req.header("accept")).toBe(JSON_TYPE);
+      expect(req.header("Content-Type")).toBe(JSON_TYPE);
+      expect(req.header("accept-language")).toBe("en");
+
+      return res.status(200).body(dataJSON);
+    });
+    xhrMock.get(
+      "http://www.example.com/custom-path/contributions/",
+      (req, res) => {
+        expect(req.header("accept")).toBe(JSON_TYPE);
+        expect(req.header("Content-Type")).toBe(JSON_TYPE);
+        expect(req.header("accept-language")).toBe("en");
+
+        return res.status(200).body(contributionsJSON);
+      },
+    );
+
+    const request = new ModularUIRequest("/", {
+      origin: "http://www.example.com",
+      contextPath: "/custom-path",
+      childmodels: false,
+    });
+
+    const model = await request.fetch();
+    expect(model).toBeInstanceOf(ApplicationModel);
+    expect(model.origin).toBe("http://www.example.com");
+    expect(model.contextPath).toBe("/custom-path");
+    expect(model.selfhref.absolutehref).toBe(
+      "http://www.example.com/custom-path/",
+    );
+    expect(model.modelcatalog.href.absolutehref).toBe(
+      "http://www.example.com/custom-path/modelcatalog",
+    );
+    expect(model.tabs.first.href.absolutehref).toBe(
+      "http://www.example.com/custom-path/books",
+    );
+  });
+});

package/src/modularui/__tests__/contributions.json

@@ -0,0 +1,312 @@
+{
+  "webapplication": {
+    "label": "Webapp",
+    "resourcetype": "Application",
+    "_links": {
+      "tab": [
+        {
+          "name": "Books",
+          "label": "Books",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "Books",
+              "label": "Books",
+              "layouthint": ["CardView", "ListView", "TableView"],
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPersonRole",
+              "label": "Books by person role",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BookPrints",
+              "label": "Book prints",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "LatestBooks",
+              "label": "Latest books",
+              "resourcetype": "DatastoreList"
+            }
+          ]
+        },
+        {
+          "name": "Persons",
+          "label": "Persons",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "Persons",
+              "label": "Persons",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsAndCo_authors",
+              "label": "Authors and co-authors",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "InformationAboutAuthors",
+              "label": "Information about authors",
+              "resourcetype": "DatastoreList"
+            }
+          ]
+        },
+        {
+          "name": "PublishingHouses",
+          "label": "Publishing houses",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "PublishingHouses",
+              "label": "Publishing houses",
+              "resourcetype": "CaseList"
+            }
+          ]
+        },
+        {
+          "name": "UT_Books",
+          "label": "UT_Books",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "Books",
+              "label": "Books",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPerson",
+              "label": "Books by person",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPersonAndFormat",
+              "label": "Books by person and format",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPersonRoleAndFormat",
+              "label": "Books by person role and format",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPersonByLanguage",
+              "label": "Books by person by language",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByFormat",
+              "label": "Books by format",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByPublishingHouse",
+              "label": "Books by publishing house",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByYoungAuthors",
+              "label": "Books by young authors",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByYoungAuthorsNamedCoupland",
+              "label": "Books by young authors named Coupland",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksPublishedByPublishingHouseLocatedInLondon",
+              "label": "Books published by publishing house located in London",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksWithPublishingHouseCategoryYoungAdults",
+              "label": "Books with publishing house category Young adults",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByDeceasedAuthors",
+              "label": "Books by deceased authors",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksWithLargeEditions",
+              "label": "Books with large editions",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksWithPrintAssignments",
+              "label": "Books with print assignments",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksFromAuthorsFromNewYork",
+              "label": "Books from authors from New York",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksByAuthorFromNewYork",
+              "label": "Books by author from New York",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BookPrints",
+              "label": "Book prints",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "LatestBooks",
+              "label": "Latest books",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "LatestBooksMultipleRecordTypes",
+              "label": "Latest books multiple record types",
+              "resourcetype": "DatastoreList"
+            }
+          ]
+        },
+        {
+          "name": "UT_Persons",
+          "label": "UT_Persons",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "Persons",
+              "label": "Persons",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "PersonsWithDetails",
+              "label": "Persons with details",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "PersonsByBookIndividual",
+              "label": "Persons by book (individual)",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "PersonsByBookDistinct",
+              "label": "Persons by book (distinct)",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsByBookIndividual",
+              "label": "Authors by book (individual)",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "PersonsWithBooks",
+              "label": "Persons with books",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "PersonsLivingInLondon",
+              "label": "Persons living in London",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsLivingInNewYork",
+              "label": "Authors living in New York",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "BooksAndPersonsRestrictedToNewYork",
+              "label": "Books and Persons restricted to New York",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsByPublishingHouseFromLonden",
+              "label": "Authors by Publishing house from Londen",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsByPublishingHouseFromLondenOrNrOfPages350",
+              "label": "Authors by Publishing house from Londen or Nr of Pages > 350",
+              "resourcetype": "CaseList"
+            },
+            {
+              "name": "AuthorsWithBooksWithEditionPublishedAfter2013",
+              "label": "Authors with books with edition published after 2013",
+              "resourcetype": "CaseList"
+            }
+          ]
+        },
+        {
+          "name": "UT_PublishingHouses",
+          "label": "UT_Publishing houses",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "PublishingHouses",
+              "label": "Publishing houses",
+              "resourcetype": "CaseList"
+            }
+          ]
+        },
+        {
+          "name": "UTBookPrints",
+          "label": "UT Book prints",
+          "resourcetype": "Tab",
+          "components": [
+            {
+              "name": "BookPrints",
+              "label": "Book prints",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "BookPrintsOnePerPage",
+              "label": "Book prints (one per page)",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "BookPrintsMaxOneResultInDetailMode",
+              "label": "Book prints (max one result in detail mode)",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "BookPrintsMaxOneResultInTableMode",
+              "label": "Book prints (max one result in table mode)",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "BookPrintsSortedByPrintingHouse",
+              "label": "Book prints (sorted by printing house)",
+              "resourcetype": "DatastoreList"
+            },
+            {
+              "name": "BookPrintsGroupedByBooksPrintedPrintingHouse",
+              "label": "Book prints (grouped by BooksPrinted, Printing house)",
+              "resourcetype": "DatastoreList"
+            }
+          ]
+        },
+        {
+          "name": "UsersAndOrganizations",
+          "label": "Users and organizations",
+          "resourcetype": "Tab"
+        },
+        {
+          "name": "RebuildDB",
+          "label": "Rebuild DB",
+          "resourcetype": "Tab"
+        }
+      ],
+      "authentication": [
+        {
+          "name": "login",
+          "label": "Login",
+          "resourcetype": null
+        },
+        {
+          "name": "UserServices",
+          "label": "Gebruikerservices",
+          "resourcetype": "user_services"
+        }
+      ]
+    }
+  }
+}