@teipublisher/pb-components 2.17.0 → 2.18.0

package/dist/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",
@@ -9465,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",
@@ -9514,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/package.json

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

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",
@@ -9465,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",
@@ -9514,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-login.js

@@ -1,6 +1,7 @@
 import { LitElement, html, css } from 'lit-element';
 import { pbMixin, waitOnce } from './pb-mixin.js';
 import { translate } from "./pb-i18n.js";
+import { registry } from "./urls.js";
 import '@polymer/iron-ajax';
 import '@polymer/paper-dialog';
 import '@polymer/paper-dialog-scrollable';
@@ -250,6 +251,15 @@ export class PbLogin extends pbMixin(LitElement) {
             }
         }
         this.emitTo('pb-login', resp);
+
+        if (this.loggedIn) {
+            registry.currentUser = {
+                user: this.user,
+                groups: this.groups
+            }
+        } else {
+            registry.currentUser = null;
+        }
     }
 
     _handleError() {
@@ -266,6 +276,7 @@ export class PbLogin extends pbMixin(LitElement) {
             this._loginDialog.open();
         }
 
+        registry.currentUser = null;
         this.emitTo('pb-login', resp);
     }
 

package/src/pb-restricted.js

@@ -1,6 +1,41 @@
 import { LitElement, html, css } from 'lit-element';
 import { pbMixin } from './pb-mixin.js';
+import { registry } from './urls.js';
 
+/**
+ * 
+ * @param {Array<String>} arr array containg string values (name of groups)
+ * @param {String} val value to check if it's in the array
+ * @returns true if the checked values is in the array
+ */
+function _isItemInArray(arr, val) {
+    return arr.some((arrVal) => val === arrVal);
+}
+
+/**
+ * 
+ * @param {object} user user name returned by login function; 
+ * @param {object} groups contains groups (an array) the logged user is a member of
+ * @param {string} targetGroups string containing (optionally) space separated list of target groups
+ * @returns true if user is member of one of the target groups
+ */
+export function isLoggedIn(user, groups, targetGroups) {
+    if (user == null) {
+        return false;
+    }
+    if (targetGroups) {
+        if (!groups) {
+            return false;
+        }
+        const groupArray = targetGroups.split(/[\s+,]+/);
+        let exists = false;
+        groupArray.forEach(async (oneItem) => {
+            exists = _isItemInArray(groups, oneItem) || exists;
+        });
+        return exists;
+    }
+    return true;
+}
 
 /**
  * Show content if the user is logged in. Optionally requires the user
@@ -18,7 +53,9 @@ export class PbRestricted extends pbMixin(LitElement) {
     static get properties() {
         return {
             ...super.properties,
-            /** Id of the pb-login element to connect to */
+            /** Id of the pb-login element to connect to 
+             * @deprecated no longer used
+             */
             login: {
                 type: String
             },
@@ -50,15 +87,10 @@ export class PbRestricted extends pbMixin(LitElement) {
             this.classList.add('fallback');
         }
 
-        const login = document.getElementById(this.login);
-        if (!login) {
-            console.error('<pb-restricted> connected pb-login element not found!');
-            return;
-        }
         this.subscribeTo('pb-login', (ev) => {
             this.show = this._loggedIn(ev.detail.user, ev.detail.groups);
         }, []);
-        this.show = login.loggedIn && this._loggedIn(login.user, login.groups);
+        this.show = registry.currentUser && this._loggedIn(registry.currentUser.user, registry.currentUser.groups);
     }
 
     render() {
@@ -74,43 +106,13 @@ export class PbRestricted extends pbMixin(LitElement) {
             }
 
             :host(.fallback), :host([show]) {
-                display: block;
+                display: inherit;
             }
         `;
     }
 
-    /**
-     * 
-     * @param {Array<String>} arr array containg string values (name of groups)
-     * @param {String} val value to check if it's in the array
-     * @returns true if the checked values is in the array
-     */
-    _isItemInArray(arr, val) {
-        return arr.some((arrVal) => val === arrVal);
-    }
-
-    /**
-     * 
-     * @param {object} user user name returned by login function; 
-     * @param {object} groups contains groups (an array) the logged user is a member of
-     * @returns true if user is member of one of defined groups
-     */
     _loggedIn(user, groups) {
-        if (user == null) {
-            return false;
-        }
-        if (this.group) {
-            if (!groups) {
-                return false;
-            }
-            let groupArray = this.group.split(/[\s+,]+/);
-            let exists = false;
-            groupArray.forEach(async (oneItem) => {
-                exists = this._isItemInArray(groups, oneItem) || exists;
-            });
-            return exists;
-        }
-        return true;
+        return isLoggedIn(user, groups, this.group);
     }
 }
 customElements.define('pb-restricted', PbRestricted);

package/src/urls.js

@@ -69,6 +69,12 @@ class Registry {
 
         this.urlIgnore = new Set();
         this.pathParams = new Set();
+
+        /**
+         * Information about the user currently logged in or null. If a user is logged in
+         * this will be an object with two properties: `user` and `groups`.
+         */
+        this.currentUser = null;
     }
 
     configure(usePath = true, idHash = false, rootPath = '', urlPattern, ignoredParams) {