@internetarchive/bookreader 5.0.0-24-sortingstate-2 → 5.0.0-24-sortingstate-3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/bookreader",
-  "version": "5.0.0-24-sortingstate-2",
+  "version": "5.0.0-24-sortingstate-3",
   "description": "The Internet Archive BookReader.",
   "repository": {
     "type": "git",

package/src/plugins/plugin.url.js

@@ -212,7 +212,7 @@ export class UrlPlugin {
     ];
 
     this.urlState = {};
-    this.urlMode = 'hash';
+    this.urlMode = 'hash' || this.options.urlMode;
     this.urlHistoryBasePath = '/';
     this.urlLocationPollId = null;
     this.oldLocationHash = null;
@@ -222,18 +222,17 @@ export class UrlPlugin {
   /**
    * Parse JSON object URL state to string format
    * Arrange path names in an order that it is positioned on the urlSchema
-   * @param {object} urlSchema
    * @param {string} urlState
    * @returns {string}
    */
-  urlStateToUrlString(urlSchema, urlState) {
+  urlStateToUrlString(urlState) {
     const searchParams = new URLSearchParams();
     const pathParams = {};
 
     Object.keys(urlState).forEach(key => {
-      let schema = urlSchema.find(schema => schema.name === key);
+      let schema = this.urlSchema.find(schema => schema.name === key);
       if (schema?.deprecated_for) {
-        schema = urlSchema.find(schemaKey => schemaKey.name === schema.deprecated_for);
+        schema = this.urlSchema.find(schemaKey => schemaKey.name === schema.deprecated_for);
       }
       if (schema?.position == 'path') {
         pathParams[schema?.name] = urlState[key];
@@ -242,7 +241,7 @@ export class UrlPlugin {
       }
     });
 
-    const strPathParams = urlSchema
+    const strPathParams = this.urlSchema
       .filter(s => s.position == 'path')
       .map(schema => pathParams[schema.name] ? `${schema.name}/${pathParams[schema.name]}` : '')
       .join('/');
@@ -257,11 +256,10 @@ export class UrlPlugin {
    * Example:
    *  /page/n7/mode/2up => {page: 'n7', mode: '2up'}
    *  /page/n7/mode/2up/search/hello => {page: 'n7', mode: '2up', q: 'hello'}
-   * @param {array} urlSchema
    * @param {string} urlString
    * @returns {object}
    */
-  urlStringToUrlState(urlSchema, urlString) {
+  urlStringToUrlState(urlString) {
     const urlState = {};
 
     // Fetch searchParams from given {urlString}
@@ -277,7 +275,7 @@ export class UrlPlugin {
     };
 
     // Add path objects to urlState
-    urlSchema
+    this.urlSchema
       .filter(schema => schema.position == 'path')
       .forEach(schema => {
         if (!urlStrSplitSlashObj[schema.name] && schema.default) {
@@ -384,6 +382,7 @@ export class UrlPlugin {
     const path = this.urlMode === 'history'
       ? (location.pathname.substr(this.urlHistoryBasePath.length) + location.search)
       : location.hash.substr(1);
+    console.log('path: ', path);
     this.urlState = this.urlStringToUrlState(this.urlSchema, path);
   }
 }

package/tests/jest/plugins/plugin.url.test.js

@@ -17,15 +17,6 @@ afterEach(() => {
 
 describe.only('UrlPlugin tests', () => {
   const urlPlugin = new UrlPlugin();
-  const urlSchema = [
-    { name: 'page', position: 'path', default: 'n0' },
-    { name: 'mode', position: 'path', default: '2up' },
-    { name: 'search', position: 'path', deprecated_for: 'q' },
-    { name: 'q', position: 'query_param' },
-    { name: 'sort', position: 'query_param' },
-    { name: 'view', position: 'query_param' },
-    { name: 'admin', position: 'query_param' },
-  ];
 
   describe('urlStateToUrlString tests', () => {
     test('urlStateToUrlString with known states in schema', () => {
@@ -35,8 +26,8 @@ describe.only('UrlPlugin tests', () => {
       const expectedUrlFromState = '/page/n7/mode/1up?q=foo';
       const expectedUrlFromStateWithQueries = '/page/n7/mode/1up?q=hello&view=theater&sort=title_asc';
 
-      expect(urlPlugin.urlStateToUrlString(urlSchema, urlState)).toBe(expectedUrlFromState);
-      expect(urlPlugin.urlStateToUrlString(urlSchema, urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
     });
 
     test('urlStateToUrlString with unknown states in schema', () => {
@@ -46,15 +37,15 @@ describe.only('UrlPlugin tests', () => {
       const expectedUrlFromState = '/page/n7/mode/1up';
       const expectedUrlFromStateWithQueries = '/page/n7/mode/1up?q=hello&viewer=theater&sortBy=title_asc';
 
-      expect(urlPlugin.urlStateToUrlString(urlSchema, urlState)).toBe(expectedUrlFromState);
-      expect(urlPlugin.urlStateToUrlString(urlSchema, urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
     });
 
     test('urlStateToUrlString with boolean value', () => {
       const urlState = { page: 'n7', mode: '1up', search: 'foo', view: 'theater', wrapper: false };
       const expectedUrlFromState = '/page/n7/mode/1up?q=foo&view=theater&wrapper=false';
 
-      expect(urlPlugin.urlStateToUrlString(urlSchema, urlState)).toBe(expectedUrlFromState);
+      expect(urlPlugin.urlStateToUrlString(urlState)).toBe(expectedUrlFromState);
     });
   });
 
@@ -63,24 +54,24 @@ describe.only('UrlPlugin tests', () => {
       const url = '/page/n7/mode/2up';
       const url1 = '/page/n7/mode/1up';
 
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url)).toEqual({page: 'n7', mode: '2up'});
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url1)).toEqual({page: 'n7', mode: '1up'});
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up'});
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
     });
 
     test('urlStringToUrlState with deprecated_for', () => {
       const url = '/page/n7/mode/2up/search/hello';
 
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
     });
 
     test('urlStringToUrlState with query string', () => {
       const url = '/page/n7/mode/2up/search/hello?view=theather&foo=bar&sort=title_asc';
       const url1 = '/mode/2up?ref=ol&ui=embed&wrapper=false&view=theater';
 
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url)).toEqual(
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual(
         {page: 'n7', mode: '2up', q: 'hello', view: 'theather', foo: 'bar', sort: 'title_asc'}
       );
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url1)).toEqual(
+      expect(urlPlugin.urlStringToUrlState(url1)).toEqual(
         {page: 'n0', mode: '2up', ref: 'ol', ui: 'embed', wrapper: false, view: 'theater'}
       );
     });
@@ -89,7 +80,7 @@ describe.only('UrlPlugin tests', () => {
       const url = '/page/n7/mode/2up/search/hello';
       urlPlugin.urlState = { q: 'hello' };
 
-      expect(urlPlugin.urlStringToUrlState(urlSchema, url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
+      expect(urlPlugin.urlStringToUrlState(url)).toEqual({page: 'n7', mode: '2up', q: 'hello'});
     });
   });