Merge branch 'master' of gitlab.tugraz.at:dbp/web-components/toolkit

packages/auth/README.md

@@ -60,6 +60,14 @@ The component emits a `dbp-set-property` event for the attribute `auth`:
 <script type="module" src="node_modules/@dbp-toolkit/auth/dist/dbp-auth.js"></script>
 ```
 
+### Attributes
+
+- `lang` (optional, default: `de`): set to `de` or `en` for German or English
+  - example `<dbp-auth-keycloak lang="de" </dbp-auth-keycloak>`
+- `auth` object: you need to set that object property for the auth token
+  - example auth property: `{token: "THE_BEARER_TOKEN"}`
+  - note: most often this should be an attribute that is not set directly, but subscribed at a provider
+
 ## Local development
 
 ```bash

packages/auth/assets/index.html

@@ -19,7 +19,7 @@
                        try-login></dbp-auth-keycloak>
     <dbp-login-button subscribe="auth" lang="de" show-image></dbp-login-button>
 
-    <dbp-auth-demo lang="de" entry-point-url="http://127.0.0.1:8000" subscribe="auth:auth"></dbp-auth-demo>
+    <dbp-auth-demo lang="de" entry-point-url="http://127.0.0.1:8000" subscribe="auth"></dbp-auth-demo>
 </dbp-provider>
 
 </body>

packages/auth/src/auth-keycloak.js

@@ -45,7 +45,7 @@ export class AuthKeycloak extends AdapterLitElement {
     }
 
     update(changedProperties) {
-        console.log("changedProperties", changedProperties);
+        // console.log("changedProperties", changedProperties);
         changedProperties.forEach((oldValue, propName) => {
             switch (propName) {
                 case 'lang':

packages/check-in-place-select/README.md

@@ -34,6 +34,7 @@ npm i @dbp-toolkit/check-in-place-select
     - example `<dbp-check-in-place-select show-reload-button reload-button-text="Reload result list"></dbp-check-in-place-select>`
 - `auth` object: you need to set that object property for the auth token
     - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - note: most often this should be an attribute that is not set directly, but subscribed at a provider
 
 ## Local development
 

packages/check-in-place-select/src/dbp-check-in-place-select-demo.js

@@ -75,13 +75,13 @@ export class CheckInPlaceSelectDemo extends ScopedElementsMixin(DBPLitElement) {
                         <div class="field">
                             <label class="label">Check-In-Place 1</label>
                             <div class="control">
-                                <dbp-check-in-place-select lang="${this.lang}" entry-point-url="${this.entryPointUrl}" subscribe="auth:auth"></dbp-check-in-place-select>
+                                <dbp-check-in-place-select lang="${this.lang}" entry-point-url="${this.entryPointUrl}" subscribe="auth"></dbp-check-in-place-select>
                             </div>
                         </div>
                         <div class="field">
                             <label class="label">Check-In-Place 2</label>
                             <div class="control">
-                                <dbp-check-in-place-select lang="${this.lang}" entry-point-url="${this.entryPointUrl}" subscribe="auth:auth" show-reload-button reload-button-title="Click me"></dbp-check-in-place-select>
+                                <dbp-check-in-place-select lang="${this.lang}" entry-point-url="${this.entryPointUrl}" subscribe="auth" show-reload-button reload-button-title="Click me"></dbp-check-in-place-select>
                             </div>
                         </div>
                     </form>

packages/common/src/eventbus.js

+/**
+ * EventBus system
+ *
+ * DEPRECATED: Migrated to provider
+ */
 
 const OPERATION_FETCH_RETAINED = 'fetch-retained';
 

packages/knowledge-base-web-page-element-view/README.md

@@ -24,7 +24,8 @@ npm i @dbp-toolkit/knowledge-base-web-page-element-view
 - `text` (optional): text to click to show the information loaded from the webpage
     - example `<dbp-knowledge-base-web-page-element-view text="Click me to show more information"></dbp-knowledge-base-web-page-element-view>`
 - `auth` object: you need to set that object property for the auth token
-  - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - note: most often this should be an attribute that is not set directly, but subscribed at a provider
 
 ## Local development
 

packages/knowledge-base-web-page-element-view/src/dbp-knowledge-base-web-page-element-view-demo.js

@@ -86,23 +86,23 @@ export class KnowledgeBaseWebPageElementViewDemo extends ScopedElementsMixin(DBP
                 <div class="container">
                     <h2 class="subtitle">Deutsch</h2>
                     <p>Ein erster Schritt</p>
-                    <dbp-knowledge-base-web-page-element-view subscribe="auth:auth" lang="de" entry-point-url="${this.entryPointUrl}" value="bedienstete/bibliothek/buch-ausleihen" text="Ein Buch ausleihen"></dbp-knowledge-base-web-page-element-view>
+                    <dbp-knowledge-base-web-page-element-view subscribe="auth" lang="de" entry-point-url="${this.entryPointUrl}" value="bedienstete/bibliothek/buch-ausleihen" text="Ein Buch ausleihen"></dbp-knowledge-base-web-page-element-view>
                 </div>
                 <div class="container">
                     <h2 class="subtitle">Englisch</h2>
                     <p>A first step</p>
-                    <dbp-knowledge-base-web-page-element-view subscribe="auth:auth" lang="en" entry-point-url="${this.entryPointUrl}" value="bedienstete/bibliothek/buch-ausleihen" text="Borrow a book"></dbp-knowledge-base-web-page-element-view>
+                    <dbp-knowledge-base-web-page-element-view subscribe="auth" lang="en" entry-point-url="${this.entryPointUrl}" value="bedienstete/bibliothek/buch-ausleihen" text="Borrow a book"></dbp-knowledge-base-web-page-element-view>
                 </div>
                 <hr>
                 <div class="container">
                     <p>mit Text in der WebComponent:</p>
-                    <dbp-knowledge-base-web-page-element-view subscribe="auth:auth" lang="${this.lang}" value="abc/def/xyz" text="FAQ"></dbp-knowledge-base-web-page-element-view>
+                    <dbp-knowledge-base-web-page-element-view subscribe="auth" lang="${this.lang}" value="abc/def/xyz" text="FAQ"></dbp-knowledge-base-web-page-element-view>
                 </div>
                 <hr>
                 <div class="container">
                     <p>ohne Text in der WebComponent:</p>
                     Kontaktieren Sie uns unter...
-                    <dbp-knowledge-base-web-page-element-view subscribe="auth:auth" class="opt" lang="${this.lang}" value="abc/def/klm"></dbp-knowledge-base-web-page-element-view>
+                    <dbp-knowledge-base-web-page-element-view subscribe="auth" class="opt" lang="${this.lang}" value="abc/def/klm"></dbp-knowledge-base-web-page-element-view>
                 </div>
             </section>
         `;

packages/person-profile/README.md

@@ -22,7 +22,8 @@ npm i @dbp-toolkit/person-profile
 - `value` (optional): api path of person to preload the selector with
     - example `<dbp-person-profile value="/people/testuser"></dbp-person-profile>`
 - `auth` object: you need to set that object property for the auth token
-  - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - note: most often this should be an attribute that is not set directly, but subscribed at a provider
 
 ## Local development
 

packages/person-select/README.md

@@ -34,7 +34,8 @@ npm i @dbp-toolkit/person-select
 - `reload-button-title` (optional): sets a title text on the reload button
     - example `<dbp-person-select show-reload-button reload-button-text="Reload result list"></dbp-person-select>`
 - `auth` object: you need to set that object property for the auth token
-  - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - example auth property: `{token: "THE_BEARER_TOKEN"}`
+    - note: most often this should be an attribute that is not set directly, but subscribed at a provider
 
 ## Local development
 

packages/provider/assets/index.html.ejs

@@ -20,7 +20,7 @@
 
 <body>
     <dbp-provider id="root" root="1" availability="global" lang="de" entry-point-url="http://127.0.0.1:8000" auth requested-login-status>
-        <dbp-provider-demo id="provider-demo" subscribe="lang:lang:entry-point-url:entry-point-url"></dbp-provider-demo>
+        <dbp-provider-demo id="provider-demo" subscribe="lang:entry-point-url"></dbp-provider-demo>
     </dbp-provider>
     <p>version: <span style="color: white; background-color: black;"><%= buildInfo.info %></span></p>
 </body>

packages/provider/src/dbp-provider-demo.js

@@ -97,14 +97,14 @@ class ProviderDemo extends ScopedElementsMixin(DBPLitElement) {
                             <h2>${i18n.t('demo.consumer')}</h2>
                             <p>${i18n.t('demo.consumer_description', {id: "c1", subscriptions: "border-color"})}</p>
                             <pre>&lt;dbp-consumer  id="c1"  subscribe="border-color:bc" &gt;&lt;/dbp-consumer&gt;</pre>
-                            <dbp-consumer id="c1" subscribe="border-color:bc,lang:lang"></dbp-consumer>
+                            <dbp-consumer id="c1" subscribe="border-color:bc,lang"></dbp-consumer>
                             <p>${i18n.t('demo.consumer_description', {id: "c2", subscriptions: "foo"})}</p>
                             <pre>&lt;dbp-consumer  id="c2"  subscribe="foo:foo" &gt;&lt;/dbp-consumer&gt;</pre>
-                            <dbp-consumer id="c2" subscribe="foo:foo,lang:lang"></dbp-consumer>
+                            <dbp-consumer id="c2" subscribe="foo:foo,lang"></dbp-consumer>
                             <p>${i18n.t('demo.consumer_description', {id: "c3", subscriptions: "availability:status"})}</p>
                             <p>Local <em>status</em> is provided as <em>availability</em></p>
                             <pre>&lt;dbp-consumer  id="c3"  subscribe="status:availability"  border-color="orange" &gt;&lt;/dbp-consumer&gt;</pre>
-                            <dbp-consumer id="c3" subscribe="status:availability,lang:lang" border-color="orange"></dbp-consumer>
+                            <dbp-consumer id="c3" subscribe="status:availability,lang" border-color="orange"></dbp-consumer>
                             <p>${i18n.t('demo.consumer_description', {id: "c4", subscriptions: "unknown-name:status"})}</p>
                             <p>Remote <em>unknown-name</em> does not exist, the default value is overwritten by <em>undefined</em></i></p>
                             <pre>&lt;dbp-consumer  id="c4"  subscribe="status:unknown-name"  border-color="darkgray" &gt;&lt;/dbp-consumer&gt;</pre>

toolkit-showcase/assets/auth.metadata.json

@@ -14,5 +14,5 @@
     "de": "Web Komponente zur Authentifikation",
     "en": "Auth web component"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/check-in-place-select.metadata.json

@@ -14,5 +14,5 @@
     "de": "Ort Web Component",
     "en": "Check-in place select web component"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/common.metadata.json

@@ -14,5 +14,5 @@
     "de": "Gemeinsame Web Components",
     "en": "Common web components"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/data-table-view.metadata.json

@@ -14,5 +14,5 @@
     "de": "DataTable: mit Daten, Paginierung, Such- und Exportfunktion",
     "en": "DataTable: with data, paging and searching AND exportable"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/file-handling.metadata.json

@@ -14,5 +14,5 @@
     "de": "Web Komponenten für file sink und file source. Für mehrere verschiedenen Quellen.",
     "en": "Web components for file sink and file source. For several different sources."
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url,nextcloud-auth-url:nextcloud-auth-url,nextcloud-web-dav-url:nextcloud-web-dav-url,nextcloud-name:nextcloud-name,nextcloud-file-url:nextcloud-file-url,show-nextcloud-file-picker:show-nextcloud-file-picker"
+  "subscribe": "lang,entry-point-url,nextcloud-auth-url:nextcloud-auth-url,nextcloud-web-dav-url:nextcloud-web-dav-url,nextcloud-name:nextcloud-name,nextcloud-file-url:nextcloud-file-url,show-nextcloud-file-picker:show-nextcloud-file-picker"
 }

toolkit-showcase/assets/knowledge-base-web-page-element-view.metadata.json

@@ -14,5 +14,5 @@
     "de": "Erlaubt das Einfügen von Webinhalten",
     "en": "Allows the inserting of web content"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/language-select.metadata.json

@@ -14,5 +14,5 @@
     "de": "Sprachauswahl Web Component",
     "en": "Language select web component"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }

toolkit-showcase/assets/matomo.metadata.json

@@ -14,5 +14,5 @@
     "de": "Matomo Web Component",
     "en": "Matomo web component"
   },
-  "subscribe": "lang:lang,entry-point-url:entry-point-url"
+  "subscribe": "lang,entry-point-url"
 }