@teipublisher/pb-components 1.33.1 → 1.34.0

package/dist/pb-elements.json

@@ -1328,6 +1328,12 @@
           "type": "string",
           "default": "\"title\""
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "url",
           "description": "The URL for the AJAX request. If a relative URL is passed, it will be resolved\nagainst the current API endpoint.",
@@ -1497,6 +1503,13 @@
           "type": "string",
           "default": "\"title\""
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "url",
           "attribute": "url",
@@ -10209,6 +10222,12 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -10404,6 +10423,13 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -10660,6 +10686,12 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -10838,6 +10870,13 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "1.33.1",
+  "version": "1.34.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",

package/pb-elements.json

@@ -1328,6 +1328,12 @@
           "type": "string",
           "default": "\"title\""
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "url",
           "description": "The URL for the AJAX request. If a relative URL is passed, it will be resolved\nagainst the current API endpoint.",
@@ -1497,6 +1503,13 @@
           "type": "string",
           "default": "\"title\""
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "url",
           "attribute": "url",
@@ -10209,6 +10222,12 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -10404,6 +10423,13 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -10660,6 +10686,12 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -10838,6 +10870,13 @@
           "description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
           "type": "string"
         },
+        {
+          "name": "static",
+          "attribute": "static",
+          "description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",

package/src/pb-browse-docs.js

@@ -87,6 +87,13 @@ export class PbBrowseDocs extends PbLoad {
             subforms: {
                 type: String
             },
+            /**
+             * If set, rewrite URLs to load pages as static HTML files,
+             * so no TEI Publisher instance is required
+             */
+            static: {
+                type: Boolean
+            },
             _file: {
                 type: String
             },
@@ -120,6 +127,8 @@ export class PbBrowseDocs extends PbLoad {
         this.filterBy = 'title';
         this._allowModification = false;
         this._suggestions = [];
+
+        this.static = false;
     }
 
     connectedCallback() {
@@ -177,14 +186,16 @@ export class PbBrowseDocs extends PbLoad {
         });
         this.shadowRoot.getElementById('autocomplete').addEventListener('autocomplete-change', this._autocomplete.bind(this));
 
-        const login = document.getElementById(this.login);
-        if (!login) {
-            console.error('<pb-browse-docs> connected pb-login element not found!');
-        } else {
-            this.subscribeTo('pb-login', (ev) => {
-                this._allowModification = this._loggedIn(ev.detail.user, ev.detail.group);
-            }, []);
-            this._allowModification = login.loggedIn && this._loggedIn(login.user, login.groups);
+        if (this.login) {
+            const login = document.getElementById(this.login);
+            if (!login) {
+                console.error('<pb-browse-docs> connected pb-login element not found!');
+            } else {
+                this.subscribeTo('pb-login', (ev) => {
+                    this._allowModification = this._loggedIn(ev.detail.user, ev.detail.group);
+                }, []);
+                this._allowModification = login.loggedIn && this._loggedIn(login.user, login.groups);
+            }
         }
 
         this.shadowRoot.getElementById('sort-list').addEventListener('selected-item-changed', this._sort.bind(this));
@@ -313,6 +324,10 @@ export class PbBrowseDocs extends PbLoad {
     }
 
     getURL(params) {
+        if (this.static) {
+            // use a static URL
+            return `collections/${this.collection}/${params.start || '1'}.html`;
+        }
         const url = super.getURL(params);
         return this.collection ? `${url}/${this.collection}` : url;
     }

package/src/pb-load.js

@@ -288,13 +288,12 @@ export class PbLoad extends pbMixin(LitElement) {
     }
 
     _handleContent(ev) {
-        this._parseHeaders(ev.detail.xhr);
-
         const resp = this.shadowRoot.getElementById('loadContent').lastResponse;
         if (this.container) {
             this.style.display = 'none';
             document.querySelectorAll(this.container).forEach((elem) => {
-                elem.innerHTML = resp
+                elem.innerHTML = resp;
+                this._parseHeaders(ev.detail.xhr, elem);
                 this._fixLinks(elem);
                 this._onLoad(elem);
             });
@@ -304,6 +303,7 @@ export class PbLoad extends pbMixin(LitElement) {
 
             const div = document.createElement('div');
             div.innerHTML = resp;
+            this._parseHeaders(ev.detail.xhr, div);
             div.slot = '';
             this.appendChild(div);
             this._fixLinks(div);
@@ -338,9 +338,20 @@ export class PbLoad extends pbMixin(LitElement) {
         dialog.open();
     }
 
-    _parseHeaders(xhr) {
-        const total = xhr.getResponseHeader('pb-total');
-        const start = xhr.getResponseHeader('pb-start');
+    _parseHeaders(xhr, content) {
+        // Try to determine number of pages and current position
+        // Search for data-pagination-* attributes first and if they
+        // can't be found, check HTTP headers
+        function getPaginationParam(type) {
+            const elem = content.querySelector(`[data-pagination-${type}]`);
+            if (elem) {
+                return elem.getAttribute(`data-pagination-${type}`);
+            }
+            return xhr.getResponseHeader(`pb-${type}`);
+        }
+
+        const total = getPaginationParam('total');
+        const start = getPaginationParam('start');
 
         if (this.start !== start) {
             this.start = parseInt(start);

package/src/pb-view.js

@@ -161,6 +161,14 @@ export class PbView extends pbMixin(LitElement) {
             url: {
                 type: String
             },
+            /**
+             * If set, rewrite URLs to load pages as static HTML files,
+             * so no TEI Publisher instance is required. Use this in combination with
+             * [tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).
+             */
+            static: {
+                type: Boolean
+            },
             /**
             * The server returns footnotes separately. Set this property
             * if you wish to append them to the main text.
@@ -328,6 +336,7 @@ export class PbView extends pbMixin(LitElement) {
         this._selector = new Map();
         this._chunks = [];
         this._scrollTarget = null;
+        this.static = false;
     }
 
     attributeChangedCallback(name, oldVal, newVal) {
@@ -584,20 +593,56 @@ export class PbView extends pbMixin(LitElement) {
 
         const loadContent = this.shadowRoot.getElementById('loadContent');
         
-        if (!this.url) {
+        if (this.static) {
+            this._staticUrl(params).then((url) => {
+                loadContent.url = url;
+                loadContent.generateRequest();
+            });
+        } else {
+            if (!this.url) {
+                if (this.minApiVersion('1.0.0')) {
+                    this.url = "api/parts";
+                } else {
+                    this.url = "modules/lib/components.xql";
+                }
+            }
             if (this.minApiVersion('1.0.0')) {
-                this.url = "api/parts";
+                loadContent.url = `${this.getEndpoint()}/${this.url}/${encodeURIComponent(this.getDocument().path)}/json`;
             } else {
-                this.url = "modules/lib/components.xql";
+                loadContent.url = `${this.getEndpoint()}/${this.url}`;
             }
+            loadContent.params = params;
+            loadContent.generateRequest();
         }
-        if (this.minApiVersion('1.0.0')) {
-            loadContent.url = `${this.getEndpoint()}/${this.url}/${encodeURIComponent(this.getDocument().path)}/json`;
-        } else {
-            loadContent.url = `${this.getEndpoint()}/${this.url}`;
+    }
+
+    /**
+     * Use a static URL to load pre-generated content.
+     */
+    async _staticUrl(params) {
+        function createKey(paramNames) {
+            const urlComponents = [];
+            paramNames.sort().forEach(key => {
+                if (params[key]) {
+                    urlComponents.push(`${key}=${params[key]}`);
+                }
+            });
+            return urlComponents.join('&');
         }
-        loadContent.params = params;
-        loadContent.generateRequest();
+        
+        const index = await fetch(`index.json`)
+            .then((response) => response.json());
+        const paramNames = ['odd', 'view', 'xpath'];
+        this.querySelectorAll('pb-param').forEach((param) => paramNames.push(`user.${param.getAttribute('name')}`));
+        let url = createKey([...paramNames, 'root']);
+        let file = index[url];
+        if (!file) {
+            url = createKey(paramNames);
+            file = index[url];
+        }
+
+        console.log('<pb-view> Static lookup %s: %s', url, file);
+        return `${file}`;
     }
 
     _clear() {
@@ -838,7 +883,11 @@ export class PbView extends pbMixin(LitElement) {
         let link = document.createElement('link');
         link.setAttribute('rel', 'stylesheet');
         link.setAttribute('type', 'text/css');
-        link.setAttribute('href', `${this.getEndpoint()}/transform/${this.getOdd()}.css`);
+        if (this.static) {
+            link.setAttribute('href', `/css/${this.getOdd()}.css`);
+        } else {
+            link.setAttribute('href', `${this.getEndpoint()}/transform/${this.getOdd()}.css`);
+        }
         links.push(link);
 
         if (this.loadCss) {