From e728b2a0094aaa18cecc3b081238f8e189871c35 Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Mon, 22 Mar 2021 08:07:25 +0100
Subject: [PATCH] Refactor dbp-knowledge-base-organization-select to
dbp-organization-select
---
packages/organization-select/README.md | 12 ++++++------
packages/organization-select/assets/index.html | 4 ++--
packages/organization-select/package.json | 2 +-
packages/organization-select/rollup.config.js | 2 +-
...elect-demo.js => dbp-organization-select-demo.js} | 8 ++++----
...nization-select.js => dbp-organization-select.js} | 2 +-
packages/organization-select/src/demo.js | 2 +-
packages/organization-select/test/unit.js | 10 +++++-----
.../assets/organization-select.metadata.json | 2 +-
.../src/dbp-organization-select-demo-activity.js | 8 ++++----
10 files changed, 26 insertions(+), 26 deletions(-)
rename packages/organization-select/src/{dbp-knowledge-base-organization-select-demo.js => dbp-organization-select-demo.js} (84%)
rename packages/organization-select/src/{dbp-knowledge-base-organization-select.js => dbp-organization-select.js} (55%)
diff --git a/packages/organization-select/README.md b/packages/organization-select/README.md
index ce7ef6de..4bd463aa 100644
--- a/packages/organization-select/README.md
+++ b/packages/organization-select/README.md
@@ -9,21 +9,21 @@ npm i @dbp-toolkit/organization-select
## Usage
```html
-<dbp-knowledge-base-organization-select></dbp-knowledge-base-organization-select>
-<script type="module" src="node_modules/@dbp-toolkit/organization-select/dist/dbp-knowledge-base-organization-select.js"></script>
+<dbp-organization-select></dbp-organization-select>
+<script type="module" src="node_modules/@dbp-toolkit/organization-select/dist/dbp-organization-select.js"></script>
```
## Attributes
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
- - example `<dbp-knowledge-base-organization-select lang="de"></dbp-knowledge-base-organization-select>`
+ - example `<dbp-organization-select lang="de"></dbp-organization-select>`
- `entry-point-url` (optional, default is the TU Graz entry point url): entry point url to access the api
- - example `<dbp-knowledge-base-organization-select entry-point-url="http://127.0.0.1:8000"></dbp-knowledge-base-organization-select>`
+ - example `<dbp-organization-select entry-point-url="http://127.0.0.1:8000"></dbp-organization-select>`
- `value` (optional): api path of organization to preload the selector with
- - example `<dbp-knowledge-base-organization-select value="/people/testuser"></dbp-knowledge-base-organization-select>`
+ - example `<dbp-organization-select value="/people/testuser"></dbp-organization-select>`
- the `value` will also be set automatically when an organization is chosen in the selector
- `data-object` (read-only): when an organization is selected the organization object will be set as json string
- - example `<dbp-knowledge-base-organization-select data-object="{"@id":"/organizations/1190-F2050","@type":"http://schema.org/Organization","identifier":"1190-F2050","name":"Institut für Stahlbau","url":"https://online.tugraz.at/tug_online/wborg.display?pOrgNr=1190","alternateName":"F2050"}"></dbp-knowledge-base-organization-select>`
+ - example `<dbp-organization-select data-object="{"@id":"/organizations/1190-F2050","@type":"http://schema.org/Organization","identifier":"1190-F2050","name":"Institut für Stahlbau","url":"https://online.tugraz.at/tug_online/wborg.display?pOrgNr=1190","alternateName":"F2050"}"></dbp-organization-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
diff --git a/packages/organization-select/assets/index.html b/packages/organization-select/assets/index.html
index 6c5171cd..38416697 100644
--- a/packages/organization-select/assets/index.html
+++ b/packages/organization-select/assets/index.html
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="UTF-8">
- <script type="module" src="dbp-knowledge-base-organization-select-demo.js"></script>
+ <script type="module" src="dbp-organization-select-demo.js"></script>
</head>
<body>
-<dbp-knowledge-base-organization-select-demo auth requested-login-status lang="de" entry-point-url="http://127.0.0.1:8000"></dbp-knowledge-base-organization-select-demo>
+<dbp-organization-select-demo auth requested-login-status lang="de" entry-point-url="http://127.0.0.1:8000"></dbp-organization-select-demo>
</body>
</html>
diff --git a/packages/organization-select/package.json b/packages/organization-select/package.json
index bbed8d76..2d9b2c59 100644
--- a/packages/organization-select/package.json
+++ b/packages/organization-select/package.json
@@ -1,7 +1,7 @@
{
"name": "@dbp-toolkit/organization-select",
"homepage": "https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/master/packages/organization-select",
- "version": "0.2.0",
+ "version": "0.2.1",
"main": "src/index.js",
"license": "LGPL-2.1-or-later",
"repository": {
diff --git a/packages/organization-select/rollup.config.js b/packages/organization-select/rollup.config.js
index 2cd9a756..e7682903 100644
--- a/packages/organization-select/rollup.config.js
+++ b/packages/organization-select/rollup.config.js
@@ -14,7 +14,7 @@ console.log("build: " + build);
export default (async () => {
return {
- input: (build != 'test') ? ['src/dbp-knowledge-base-organization-select.js', 'src/dbp-knowledge-base-organization-select-demo.js'] : glob.sync('test/**/*.js'),
+ input: (build != 'test') ? ['src/dbp-organization-select.js', 'src/dbp-organization-select-demo.js'] : glob.sync('test/**/*.js'),
output: {
dir: 'dist',
entryFileNames: '[name].js',
diff --git a/packages/organization-select/src/dbp-knowledge-base-organization-select-demo.js b/packages/organization-select/src/dbp-organization-select-demo.js
similarity index 84%
rename from packages/organization-select/src/dbp-knowledge-base-organization-select-demo.js
rename to packages/organization-select/src/dbp-organization-select-demo.js
index b4d6f44b..6960e575 100644
--- a/packages/organization-select/src/dbp-knowledge-base-organization-select-demo.js
+++ b/packages/organization-select/src/dbp-organization-select-demo.js
@@ -19,7 +19,7 @@ export class OrganizationSelectDemo extends ScopedElementsMixin(DBPLitElement) {
return {
'dbp-auth-keycloak': AuthKeycloak,
'dbp-login-button': LoginButton,
- 'dbp-knowledge-base-organization-select': OrganizationSelect,
+ 'dbp-organization-select': OrganizationSelect,
};
}
@@ -75,13 +75,13 @@ export class OrganizationSelectDemo extends ScopedElementsMixin(DBPLitElement) {
<div class="field">
<label class="label">Organization 1</label>
<div class="control">
- <dbp-knowledge-base-organization-select subscribe="auth" lang="${this.lang}" entry-point-url="${this.entryPointUrl}"></dbp-knowledge-base-organization-select>
+ <dbp-organization-select subscribe="auth" lang="${this.lang}" entry-point-url="${this.entryPointUrl}"></dbp-organization-select>
</div>
</div>
<div class="field">
<label class="label">Organization 2</label>
<div class="control">
- <dbp-knowledge-base-organization-select subscribe="auth" lang="${this.lang}" entry-point-url="${this.entryPointUrl}"></dbp-knowledge-base-organization-select>
+ <dbp-organization-select subscribe="auth" lang="${this.lang}" entry-point-url="${this.entryPointUrl}"></dbp-organization-select>
</div>
</div>
</form>
@@ -91,4 +91,4 @@ export class OrganizationSelectDemo extends ScopedElementsMixin(DBPLitElement) {
}
}
-commonUtils.defineCustomElement('dbp-knowledge-base-organization-select-demo', OrganizationSelectDemo);
+commonUtils.defineCustomElement('dbp-organization-select-demo', OrganizationSelectDemo);
diff --git a/packages/organization-select/src/dbp-knowledge-base-organization-select.js b/packages/organization-select/src/dbp-organization-select.js
similarity index 55%
rename from packages/organization-select/src/dbp-knowledge-base-organization-select.js
rename to packages/organization-select/src/dbp-organization-select.js
index 0e3396ee..d7a4724a 100644
--- a/packages/organization-select/src/dbp-knowledge-base-organization-select.js
+++ b/packages/organization-select/src/dbp-organization-select.js
@@ -1,4 +1,4 @@
import * as commonUtils from '@dbp-toolkit/common/utils';
import {OrganizationSelect} from './organization-select.js';
-commonUtils.defineCustomElement('dbp-knowledge-base-organization-select', OrganizationSelect);
+commonUtils.defineCustomElement('dbp-organization-select', OrganizationSelect);
diff --git a/packages/organization-select/src/demo.js b/packages/organization-select/src/demo.js
index fbce7ff6..6fb1ad80 100644
--- a/packages/organization-select/src/demo.js
+++ b/packages/organization-select/src/demo.js
@@ -1 +1 @@
-import './dbp-knowledge-base-organization-select-demo.js';
+import './dbp-organization-select-demo.js';
diff --git a/packages/organization-select/test/unit.js b/packages/organization-select/test/unit.js
index b4843069..a403d71e 100644
--- a/packages/organization-select/test/unit.js
+++ b/packages/organization-select/test/unit.js
@@ -1,13 +1,13 @@
import {assert} from 'chai';
-import '../src/dbp-knowledge-base-organization-select.js';
+import '../src/dbp-organization-select.js';
import '../src/demo.js';
-suite('dbp-knowledge-base-organization-select basics', () => {
+suite('dbp-organization-select basics', () => {
let node;
setup(async () => {
- node = document.createElement('dbp-knowledge-base-organization-select');
+ node = document.createElement('dbp-organization-select');
document.body.appendChild(node);
await node.updateComplete;
});
@@ -21,11 +21,11 @@ suite('dbp-knowledge-base-organization-select basics', () => {
});
});
-suite('dbp-knowledge-base-organization-select-demo basics', () => {
+suite('dbp-organization-select-demo basics', () => {
let node;
setup(async () => {
- node = document.createElement('dbp-knowledge-base-organization-select-demo');
+ node = document.createElement('dbp-organization-select-demo');
document.body.appendChild(node);
await node.updateComplete;
});
diff --git a/toolkit-showcase/assets/organization-select.metadata.json b/toolkit-showcase/assets/organization-select.metadata.json
index d8278666..93afba10 100644
--- a/toolkit-showcase/assets/organization-select.metadata.json
+++ b/toolkit-showcase/assets/organization-select.metadata.json
@@ -1,5 +1,5 @@
{
- "element": "dbp-knowledge-base-organization-select-demo-activity",
+ "element": "dbp-organization-select-demo-activity",
"module_src": "dbp-organization-select-demo-activity.js",
"routing_name": "organization-select",
"name": {
diff --git a/toolkit-showcase/src/dbp-organization-select-demo-activity.js b/toolkit-showcase/src/dbp-organization-select-demo-activity.js
index fb49de40..f1c1c469 100644
--- a/toolkit-showcase/src/dbp-organization-select-demo-activity.js
+++ b/toolkit-showcase/src/dbp-organization-select-demo-activity.js
@@ -1,6 +1,6 @@
import {css, html, LitElement} from 'lit-element';
import {ScopedElementsMixin} from '@open-wc/scoped-elements';
-import {OrganizationSelectDemo} from '@dbp-toolkit/organization-select/src/dbp-knowledge-base-organization-select-demo';
+import {OrganizationSelectDemo} from '@dbp-toolkit/organization-select/src/dbp-organization-select-demo';
import * as commonUtils from '@dbp-toolkit/common/utils';
import * as commonStyles from '@dbp-toolkit/common/styles';
import {unsafeHTML} from 'lit-html/directives/unsafe-html.js';
@@ -18,7 +18,7 @@ class DbpOrganizationSelectDemoActivity extends ScopedElementsMixin(AdapterLitEl
static get scopedElements() {
return {
- 'dbp-knowledge-base-organization-select-demo': OrganizationSelectDemo,
+ 'dbp-organization-select-demo': OrganizationSelectDemo,
};
}
@@ -59,9 +59,9 @@ class DbpOrganizationSelectDemoActivity extends ScopedElementsMixin(AdapterLitEl
render() {
return html`
${unsafeHTML(readme)}
- <dbp-knowledge-base-organization-select-demo id="demo" lang="${this.lang}" entry-point-url="${this.entryPointUrl}" no-auth></dbp-knowledge-base-organization-select-demo>
+ <dbp-organization-select-demo id="demo" lang="${this.lang}" entry-point-url="${this.entryPointUrl}" no-auth></dbp-organization-select-demo>
`;
}
}
-commonUtils.defineCustomElement('dbp-knowledge-base-organization-select-demo-activity', DbpOrganizationSelectDemoActivity);
+commonUtils.defineCustomElement('dbp-organization-select-demo-activity', DbpOrganizationSelectDemoActivity);
--
GitLab