@teipublisher/pb-components 2.16.0 → 2.18.0

package/pb-elements.json

@@ -642,6 +642,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "group",
+          "description": "A list of space- or comma-separated group names, whose members will be\nallowed to add or edit entries in the local register (if enabled).",
+          "type": "string",
+          "default": "\"\\\"tei\\\"\""
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -698,6 +704,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "group",
+          "attribute": "group",
+          "description": "A list of space- or comma-separated group names, whose members will be\nallowed to add or edit entries in the local register (if enabled).",
+          "type": "string",
+          "default": "\"\\\"tei\\\"\""
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -5436,7 +5449,7 @@
     {
       "name": "pb-leaflet-map",
       "path": "./src/pb-leaflet-map.js",
-      "description": "A wrapper component for [leaflet](https://leafletjs.com/) displaying a map.\r\n\r\nThe map layers displayed can be configured via nested `pb-map-layer` (see docs) elements,\r\nicons via `pb-map-icon`.",
+      "description": "A wrapper component for [leaflet](https://leafletjs.com/) displaying a map.\n\nThe map layers displayed can be configured via nested `pb-map-layer` (see docs) elements,\nicons via `pb-map-icon`.",
       "attributes": [
         {
           "name": "latitude",
@@ -5475,7 +5488,7 @@
         },
         {
           "name": "toggle",
-          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\r\nIn this case the map also offers a close button to hide it again.",
+          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\nIn this case the map also offers a close button to hide it again.",
           "type": "boolean",
           "default": "false"
         },
@@ -5487,7 +5500,7 @@
         },
         {
           "name": "cluster",
-          "description": "If set, combine markers into clusters if they are located too close together\r\nto display as single markers",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
           "type": "boolean",
           "default": "false"
         },
@@ -5499,9 +5512,15 @@
         },
         {
           "name": "disable-clustering-at",
-          "description": "Limits up to which zoom level markers are arranged into clusters.\r\nUsing a higher zoom level here will result in more markers to be shown.\r\n\r\nRequires `cluster` option to be enabled.",
+          "description": "Limits up to which zoom level markers are arranged into clusters.\nUsing a higher zoom level here will result in more markers to be shown.\n\nRequires `cluster` option to be enabled.",
           "type": "number"
         },
+        {
+          "name": "geo-coding",
+          "description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: single clicking on the map will request information\nabout the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
+          "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.",
@@ -5537,7 +5556,7 @@
       "properties": [
         {
           "name": "map",
-          "description": "The underlying leafletjs map. Can be used for custom scripts.\r\n\r\nWill be null until the component is fully loaded. Listen to `pb-ready` on the component to\r\nbe sure it has initialized."
+          "description": "The underlying leafletjs map. Can be used for custom scripts.\n\nWill be null until the component is fully loaded. Listen to `pb-ready` on the component to\nbe sure it has initialized."
         },
         {
           "name": "latitude",
@@ -5584,7 +5603,7 @@
         {
           "name": "toggle",
           "attribute": "toggle",
-          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\r\nIn this case the map also offers a close button to hide it again.",
+          "description": "If enabled, the map will remain invisible until an event is received from `pb-geolocation`.\nIn this case the map also offers a close button to hide it again.",
           "type": "boolean",
           "default": "false"
         },
@@ -5598,7 +5617,7 @@
         {
           "name": "cluster",
           "attribute": "cluster",
-          "description": "If set, combine markers into clusters if they are located too close together\r\nto display as single markers",
+          "description": "If set, combine markers into clusters if they are located too close together\nto display as single markers",
           "type": "boolean",
           "default": "false"
         },
@@ -5612,9 +5631,16 @@
         {
           "name": "disableClusteringAt",
           "attribute": "disable-clustering-at",
-          "description": "Limits up to which zoom level markers are arranged into clusters.\r\nUsing a higher zoom level here will result in more markers to be shown.\r\n\r\nRequires `cluster` option to be enabled.",
+          "description": "Limits up to which zoom level markers are arranged into clusters.\nUsing a higher zoom level here will result in more markers to be shown.\n\nRequires `cluster` option to be enabled.",
           "type": "number"
         },
+        {
+          "name": "geoCoding",
+          "attribute": "geo-coding",
+          "description": "Enables geocoding: an additional control will allow users to search for a place.\nReverse geocoding is also possible: single clicking on the map will request information\nabout the current location.\n\nIn both cases, a `pb-geocode` event will be emitted containing additional information\nabout the place in the event details (see demo).\n\nFor lookups the free OSM/Nominatim service is used.",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -5660,7 +5686,7 @@
         },
         {
           "name": "pb-update-map",
-          "description": "When received, redraws the map to fit markers passed in with the event.\rEvent details should include an array of locations, see `pb-geolocation` event below."
+          "description": "When received, redraws the map to fit markers passed in with the event.\nEvent details should include an array of locations, see `pb-geolocation` event below."
         },
         {
           "name": "pb-update",
@@ -5668,7 +5694,11 @@
         },
         {
           "name": "pb-geolocation",
-          "description": "When received, focuses the map on the geocoordinates passed in with the event.\rThe event details should include an object:\r```\r{\rcoordinates: {\r latitude: Number,\r longitude: Number\r},\rlabel: string - the label to show on mouseover,\rzoom: Number - fixed zoom level to zoom to,\rfitBounds: Boolean - if true, recompute current zoom level to show all markers\r}\r```"
+          "description": "When received, focuses the map on the geocoordinates passed in with the event.\nThe event details should include an object:\n```\n{\ncoordinates: {\n latitude: Number,\n longitude: Number\n},\nlabel: string - the label to show on mouseover,\nzoom: Number - fixed zoom level to zoom to,\nfitBounds: Boolean - if true, recompute current zoom level to show all markers\n}\n```"
+        },
+        {
+          "name": "pb-geocode",
+          "description": "emitted if geocoding is enabled and the user searches or selects a location from the map"
         }
       ],
       "slots": [
@@ -9448,7 +9478,8 @@
         {
           "name": "login",
           "description": "Id of the pb-login element to connect to",
-          "type": "string"
+          "type": "string",
+          "deprecatedMessage": "no longer used"
         },
         {
           "name": "group",
@@ -9497,7 +9528,8 @@
           "name": "login",
           "attribute": "login",
           "description": "Id of the pb-login element to connect to",
-          "type": "string"
+          "type": "string",
+          "deprecatedMessage": "no longer used"
         },
         {
           "name": "group",

package/src/pb-authority-lookup.js

@@ -3,6 +3,7 @@ import { unsafeHTML } from 'lit-html/directives/unsafe-html.js';
 import { pbMixin, waitOnce } from './pb-mixin.js';
 import { translate } from "./pb-i18n.js";
 import { createConnectors } from "./authority/connectors.js";
+import "./pb-restricted.js";
 import '@polymer/paper-input/paper-input';
 import '@polymer/paper-icon-button';
 
@@ -41,6 +42,15 @@ export class PbAuthorityLookup extends pbMixin(LitElement) {
       stopwords: {
         type: String
       },
+      /**
+       * A list of space- or comma-separated group names, whose members will be
+       * allowed to add or edit entries in the local register (if enabled).
+       * 
+       * @default "tei"
+       */
+      group: {
+        type: String
+      },
       _results: {
         type: Array,
       },
@@ -55,6 +65,7 @@ export class PbAuthorityLookup extends pbMixin(LitElement) {
     this.sortByLabel = false;
     this._results = [];
     this._authorities = {};
+    this.group = 'tei';
   }
 
   connectedCallback() {
@@ -92,8 +103,11 @@ export class PbAuthorityLookup extends pbMixin(LitElement) {
         <iron-icon icon="icons:search" slot="prefix"></iron-icon>
         ${
           this._authorities[this.type] && this._authorities[this.type].editable ?
-            html`<paper-icon-button icon="icons:add" @click="${this._addEntity}" title="${translate('annotations.add-entity')}" slot="suffix"></paper-icon-button>` :
-            null
+          html`
+            <pb-restricted group="${this.group}" slot="suffix">
+              <paper-icon-button icon="icons:add" @click="${this._addEntity}" title="${translate('annotations.add-entity')}"></paper-icon-button>
+            </pb-restricted>
+            ` : null
         }
       </paper-input>
       <slot name="authform"></slot>
@@ -144,13 +158,16 @@ export class PbAuthorityLookup extends pbMixin(LitElement) {
 
         ${ 
           this._authorities[this.type] && this._authorities[this.type].editable ?
-            html`<div class="icons">
-                <paper-icon-button
-                    icon="editor:mode-edit"
-                    @click="${() => this._editEntity(item)}"
-                    title="${translate('annotations.edit-entity')}"
-                ></paper-icon-button>
-            </div>` : null 
+            html`
+            <pb-restricted group="${this.group}">
+              <div class="icons">
+                  <paper-icon-button
+                      icon="editor:mode-edit"
+                      @click="${() => this._editEntity(item)}"
+                      title="${translate('annotations.edit-entity')}"
+                  ></paper-icon-button>
+              </div>
+            </pb-restricted>` : null 
         }
         ${item.details ? html`<div class="details" part="details">${item.details}</div>` : null}
 
@@ -260,6 +277,11 @@ export class PbAuthorityLookup extends pbMixin(LitElement) {
         flex-direction: column;
       }
 
+      header {
+        display: flex;
+        align-items: center;
+      }
+
       .link {
         flex-grow: 2;
       }

package/src/pb-events.js

@@ -78,6 +78,44 @@ export class PbEvents {
         });
         document.dispatchEvent(ev);
     }
+
+    /**
+     * Wait for one or more TEI Publisher web components to become ready (by waiting for their `pb-ready` event).
+     * 
+     * @param {HTMLElement|HTMLElement[]} targets element or array of elements to check for ready state
+     * @returns Promise which resolves when all components are ready
+     */
+    static ifReady(targets) {
+        if (!Array.isArray(targets)) {
+            targets = [targets];
+        }
+        // const targets = Array.from(document.querySelectorAll(selector));
+        return new Promise((resolve) => {
+            const targetCount = targets.length;
+            if (targetCount === 0) {
+                // selector did not return any targets
+                resolve();
+                return;
+            }
+            let count = targetCount;
+            targets.forEach((target) => {
+                if (target._isReady) {
+                    count -= 1;
+                    if (count === 0) {
+                        resolve();
+                    }
+                    return;
+                }
+                const handler = target.addEventListener('pb-ready', () => {
+                    count -= 1;
+                    if (count === 0) {
+                        target.removeEventListener('pb-ready', handler);
+                        resolve();
+                    }
+                });
+            });
+        });
+    }
 }
 
 if (!window.pbEvents) {