@teipublisher/pb-components 2.8.0 → 2.10.0

package/i18n/common/cs.json

@@ -111,7 +111,10 @@
     "reset": "Obnovit",
     "placeholder": "Zadejte dotaz",
     "sections": "Hledat v oddílech",
-    "headings": "Hledat v nadpisech"
+    "headings": "Hledat v nadpisech",
+    "title": "Titul",
+    "content": "Text",
+    "scope": "Omezit hledání na"
   },
   "dts": {
     "endpoint": "Vybrat koncový bod",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",
@@ -38,7 +38,7 @@
   "dependencies": {
     "@babel/runtime": "7.11.2",
     "@cwmr/paper-autocomplete": "^4.0.0",
-    "@jinntec/jinn-codemirror": "^1.11.6",
+    "@jinntec/jinn-codemirror": "^1.13.4",
     "@lrnwebcomponents/es-global-bridge": "^2.7.10",
     "@polymer/app-layout": "^3.1.0",
     "@polymer/iron-ajax": "^3.0.1",
@@ -85,6 +85,7 @@
     "pagedjs": "^0.4.0",
     "path-to-regexp": "^6.2.1",
     "prismjs": "^1.21.0",
+    "tify": "^0.28.1",
     "tippy.js": "^6.2.7",
     "tom-select": "^2.0.2",
     "uniqolor": "^1.0.1",

package/pb-elements.json

@@ -3944,7 +3944,7 @@
           "name": "wait-for",
           "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
           "type": "string",
-          "default": "\"pb-facsimile,pb-image-strip\""
+          "default": "\"pb-facsimile,pb-image-strip,pb-tify\""
         },
         {
           "name": "disabled",
@@ -4025,7 +4025,7 @@
           "attribute": "wait-for",
           "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
           "type": "string",
-          "default": "\"pb-facsimile,pb-image-strip\""
+          "default": "\"pb-facsimile,pb-image-strip,pb-tify\""
         },
         {
           "name": "disabled",
@@ -10771,6 +10771,109 @@
         }
       ]
     },
+    {
+      "name": "pb-tify",
+      "path": "./src/pb-tify.js",
+      "description": "Viewer for IIIF presentation manifests based on https://tify.rocks/.\nRequires a proper manifest listing the resources to show. `pb-facs-link`\ncan be used to navigate to a page.",
+      "attributes": [
+        {
+          "name": "manifest",
+          "description": "URL pointing to a IIIF presentation manifest. Relative paths\nare interpreted relative to the API endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "manifest",
+          "attribute": "manifest",
+          "description": "URL pointing to a IIIF presentation manifest. Relative paths\nare interpreted relative to the API endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "cssPath",
+          "type": "string",
+          "default": "\"../css/tify\""
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "events": [
+        {
+          "name": "pb-refresh",
+          "description": "if user opens another page and the corresponding canvas\nhas an extension property \"https://teipublisher.com/page\", listing the parameters\nto be passed to the event."
+        },
+        {
+          "name": "pb-load-facsimile",
+          "description": "when received, opens the page denoted by the\n`order` property in the event (see `pb-facs-link`). Page counts start at 1."
+        }
+      ]
+    },
     {
       "name": "pb-timeline",
       "path": "./src/pb-timeline.js",

package/src/authority/anton.js

@@ -138,6 +138,7 @@ export class Anton extends Registry {
         case 'organization':
           register = 'actors';
           break;
+        case 'origPlace':
         case 'place':
           register = 'places';
           break;
@@ -152,4 +153,4 @@ export class Anton extends Registry {
       }
       return register;
     }
-}
+}

package/src/pb-facs-link.js

@@ -47,7 +47,7 @@ export class PbFacsLink extends pbMixin(LitElement) {
         this.trigger = 'mouseover';
         this.label = '';
         this.order = Number.POSITIVE_INFINITY;
-        this.waitFor = 'pb-facsimile,pb-image-strip';
+        this.waitFor = 'pb-facsimile,pb-image-strip,pb-tify';
         this.default = '';
     }
 
@@ -109,6 +109,7 @@ export class PbFacsLink extends pbMixin(LitElement) {
         this.emitTo('pb-show-annotation', {
             element: this,
             file: this.facs,
+            order: this.getOrder(),
             coordinates: this.coordinates
         });
     }

package/src/pb-tify.js

@@ -0,0 +1,113 @@
+import { LitElement } from 'lit-element';
+import "tify";
+import { pbMixin, waitOnce } from './pb-mixin.js';
+import { resolveURL } from './utils.js';
+
+function _injectStylesheet(path) {
+    const style = document.querySelector(`link#pb-tify`);
+    if (!style) {
+        const elem = document.createElement('link');
+        elem.type = 'text/css';
+        elem.rel = 'stylesheet';
+        elem.id = `pb-tify`;
+        elem.href = `${resolveURL(path)}/tify.css`;
+        document.head.appendChild(elem);
+    }
+}
+
+/**
+ * Viewer for IIIF presentation manifests based on https://tify.rocks/.
+ * Requires a proper manifest listing the resources to show. `pb-facs-link`
+ * can be used to navigate to a page.
+ *
+ * @fires pb-refresh - if user opens another page and the corresponding canvas
+ * has an extension property "https://teipublisher.com/page", listing the parameters
+ * to be passed to the event.
+ * @fires pb-load-facsimile - when received, opens the page denoted by the
+ * `order` property in the event (see `pb-facs-link`). Page counts start at 1.
+ */
+export class PbTify extends pbMixin(LitElement) {
+    static get properties() {
+        return {
+            /**
+             * URL pointing to a IIIF presentation manifest. Relative paths
+             * are interpreted relative to the API endpoint.
+             */
+            manifest: {
+                type: String
+            },
+            ...super.properties
+        };
+    }
+
+    constructor() {
+        super();
+        this.cssPath = '../css/tify';
+        this._initialPages = null;
+    }
+
+    async connectedCallback() {
+        super.connectedCallback();
+
+        _injectStylesheet(this.cssPath);
+
+        this.subscribeTo('pb-load-facsimile', (ev) => {
+            if (ev.detail && ev.detail.order && this._tify) {
+                // check if tify is already initialized
+                if (this._setPage) {
+                    this._setPage(parseInt(ev.detail.order, 10));
+                } else {
+                    // remember page and wait for tify
+                    this._initialPages = parseInt(ev.detail.order, 10);
+                }
+            }
+        });
+    }
+
+    firstUpdated() {
+        super.firstUpdated();
+
+        waitOnce('pb-page-ready', () => {
+            this._tify = new Tify({
+                manifestUrl: this.toAbsoluteURL(this.manifest, this.getEndpoint())
+            });
+            this._tify.ready.then(() => { 
+                this.signalReady();
+                // open initial page if set earlier via pb-load-facsimile event
+                this._tify.setPage(this._initialPages);
+
+                // extend tify's setPage function to allow emitting an event
+                const {app} = this._tify;
+                this._setPage = app.setPage;
+
+                app.setPage = (pages) => {
+                    const page = Array.isArray(pages) ? pages[0] : pages;
+                    const canvas = app.$root.canvases[page - 1];
+                    
+                    this._switchPage(canvas);
+                    this._setPage(pages);
+                };
+            });
+
+            const container = document.createElement('div');
+            container.style.height = '100%';
+            container.style.width = '100%';
+            this.appendChild(container);
+
+            this._tify.mount(container);
+        });
+    }
+
+    _switchPage(canvas) {
+        const renderLink = canvas['https://teipublisher.com/page'];
+        if (renderLink) {
+            console.log('<pb-tify> page changed, emitting refresh with params %o', renderLink);
+            this.emitTo('pb-refresh', renderLink);
+        }
+    }
+
+    createRenderRoot() {
+        return this;
+    }
+}
+customElements.define('pb-tify', PbTify);