@teipublisher/pb-components 1.44.2 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,63 @@
+# [2.0.0](https://github.com/eeditiones/tei-publisher-components/compare/v1.44.2...v2.0.0) (2023-03-16)
+
+
+### Bug Fixes
+
+* **pb-ajax:** partial fix for test failure ([2699c4c](https://github.com/eeditiones/tei-publisher-components/commit/2699c4c684068f4384811b724e4dbd4c380f85cd))
+* **pb-browse:** respect history property to disable pushing to history ([b5f8c28](https://github.com/eeditiones/tei-publisher-components/commit/b5f8c28a3ad343f0f1f18bbbba593414eb2de33e))
+* **pb-browse-docs:** add history support ([5698237](https://github.com/eeditiones/tei-publisher-components/commit/569823737cf4d40c992eaae5b70776ec222b957a))
+* **pb-browse-docs:** pick up facets when connected ([a4eb4f2](https://github.com/eeditiones/tei-publisher-components/commit/a4eb4f238d569c5d94a4d1327307f0f773364c44))
+* **pb-events:** defaultChannel handling ([a16ce6f](https://github.com/eeditiones/tei-publisher-components/commit/a16ce6f87fe017497076044074da894d820f2d45))
+* **pb-events:** subscribe to defaultChannel if channel is null or empty array ([5c59613](https://github.com/eeditiones/tei-publisher-components/commit/5c5961377891419ea5027420195b28bc78c7a1c4))
+* **pb-grid:** do not use es6 operator ([dedbf14](https://github.com/eeditiones/tei-publisher-components/commit/dedbf14edb8007fa47be6ddc0767be0c6aa96428))
+* **pb-load:** also pass content in pb-results-received ([2947281](https://github.com/eeditiones/tei-publisher-components/commit/2947281c13da3c374522d08cd5a8aeb68db73916))
+* **pb-load:** subscribe to browser history only if enabled by user ([3771c27](https://github.com/eeditiones/tei-publisher-components/commit/3771c27c86027910253d1447497c69954e97a3c7))
+* **pb-mixin:** add defaultChannel constant ([ab84bea](https://github.com/eeditiones/tei-publisher-components/commit/ab84beaca9bbd1b5487269ab41f0dab838e74c06))
+* **pb-search:** browser history navigation ([4aa9b76](https://github.com/eeditiones/tei-publisher-components/commit/4aa9b76d88c907c780960c005dc28ad6e6b02ab6))
+* **pb-search:** strip out the 'autocomplete-custom-template' parameter added by the autcomplete subcomponent ([12e1e5c](https://github.com/eeditiones/tei-publisher-components/commit/12e1e5c0cc09712b6e711a0422d387616f4f7e61))
+* **pb-search,pb-paginate:** pb-search now keeps track of pagination position ([1700af0](https://github.com/eeditiones/tei-publisher-components/commit/1700af053dc0227de41bfcf6782014cf3d78c8fa))
+* **pb-select:** use correct string function ([13ebfbb](https://github.com/eeditiones/tei-publisher-components/commit/13ebfbbbd9e49a0b5360c14744069a24e03729df))
+* **pb-select-feature:** (re-)allow state to be toggled on elements which reside in the HTML context, but are not part of a pb-view or pb-load ([1260e9b](https://github.com/eeditiones/tei-publisher-components/commit/1260e9bb1f4aa8107cfa173c74dac12300cb1240))
+* **pb-select-feature:** update to mirror pb-toggle-feature ([9606688](https://github.com/eeditiones/tei-publisher-components/commit/96066880d4fafd99f7b629f7a1cf50695dfca62a))
+* **pb-split-list,pb-table-grid:** update to support browser history ([1b72351](https://github.com/eeditiones/tei-publisher-components/commit/1b723516a97c15ce93a3dc308f397beb5983e51d))
+* **pb-tabs:** update to support browser history ([e205279](https://github.com/eeditiones/tei-publisher-components/commit/e20527914037addd6a49040d79f76105c3202633))
+* **pb-toggle-feature:** refactor for history support ([27d7638](https://github.com/eeditiones/tei-publisher-components/commit/27d7638c78bcfb62be9fb10a23001a373ab44cb8))
+* **pb-view:** fix on-update ([814f4bb](https://github.com/eeditiones/tei-publisher-components/commit/814f4bbf08bd0bdb34c00782dbdd58fd6b607892))
+* **pb-view:** ignore external params if property is specified as attribute ([77851d2](https://github.com/eeditiones/tei-publisher-components/commit/77851d2f038c97c1050b9dfa5fad79f517d37a02))
+* **theming:** add polyfill for constructable stylesheets ([0056e94](https://github.com/eeditiones/tei-publisher-components/commit/0056e94bc29bd46b4c7183704b74a2f4ca12d9c9))
+* **theming:** line endings ([cf029ed](https://github.com/eeditiones/tei-publisher-components/commit/cf029ede1490c283627ffef9a799e9d410ad5875))
+* **urls:** improve warning message ([9832a53](https://github.com/eeditiones/tei-publisher-components/commit/9832a53150dd46f619b03dbf0d88b4b82c72b4f1))
+* drop url-templates in favour of simpler mechanism ([d0f6d01](https://github.com/eeditiones/tei-publisher-components/commit/d0f6d01d920220147d53a70e511ede14ad4a2b7f))
+* state should be saved by subscribed, not emitted channels ([1f93be9](https://github.com/eeditiones/tei-publisher-components/commit/1f93be9a19e6678e2e6f0f8d3fa57e1e2ae31a1f))
+
+
+### Code Refactoring
+
+* **pb-mixin:** remove unused methods ([b21bfae](https://github.com/eeditiones/tei-publisher-components/commit/b21bfae717052167ac3e539216e4de20cc73ab57))
+
+
+### Features
+
+* **dts-client:** use URL registry ([cea7336](https://github.com/eeditiones/tei-publisher-components/commit/cea733680aaf3d52b9fc42445eca8d26bf0b1b86))
+* **dts-select-endpoint:** use URL registry ([b6df38f](https://github.com/eeditiones/tei-publisher-components/commit/b6df38f4cb4064eb105a424ef9070d7ffd129eba))
+* **pb-browse-docs:** use URL registry ([07a20ff](https://github.com/eeditiones/tei-publisher-components/commit/07a20ffd83e49468acfb62e3d93a8c3af4a9fc82))
+* **pb-load:** use new URL registry ([5e8030d](https://github.com/eeditiones/tei-publisher-components/commit/5e8030de30d634ea37812b3731bf0f67f0b6ebe8))
+* **pb-select-template:** use URL registry ([82fc98b](https://github.com/eeditiones/tei-publisher-components/commit/82fc98b85b42ec576a5b8e1bae3a5607b7567410))
+* **pb-upload:** make the event emitted on finish configurable ([f1a0aca](https://github.com/eeditiones/tei-publisher-components/commit/f1a0aca552324ef972443c890ffa50d2372c1dcb))
+
+
+### BREAKING CHANGES
+
+* **pb-mixin:** Several methods are no longer used since the
+introduction of the URL registry.
+
+- getParameterValues
+- setParameter
+- setParameters
+- getParametersMatching
+- setPath
+- pushHistory
+
 ## [1.44.2](https://github.com/eeditiones/tei-publisher-components/compare/v1.44.1...v1.44.2) (2023-03-15)
 
 

package/dist/demo/demos.json

@@ -2,7 +2,8 @@
   "pb-view": {
     "demo/pb-view.html": "View TEI document",
     "demo/pb-view2.html": "Docbook document",
-    "demo/pb-view3.html": "Manipulating content via JS"
+    "demo/pb-view3.html": "Manipulating content via JS",
+    "demo/pb-view4.html": "Navigating links"
   },
   "pb-document": {
     "demo/pb-document.html": "Demo"

package/dist/demo/pb-browse-docs.html

@@ -69,7 +69,8 @@
                     border-bottom: 1px solid #a0a0a0;
                 }
             </style>
-            <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
+            <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher" 
+                url-doc="path|query" url-skip="lang," url-id="query|hash">
                 <div class="toolbar">
                     <pb-login id="login" group="tei"></pb-login>
                     <pb-lang label="language" selected="en">

package/dist/demo/pb-combo-box.html

@@ -9,7 +9,7 @@
         <pb-demo-snippet>
             <template>
                 <pb-page locales="../i18n/{{ns}}/{{lng}}.json" endpoint="https://teipublisher.com/exist/apps/tei-publisher">
-                    <h2>Using pb-multi-select with a standard HTML form</h2>
+                    <h2>Using pb-combo-box with a standard HTML form</h2>
                     <form id="form" action="">
                         <fieldset>
                             <p>Select single option from a remote data source</p>

package/dist/demo/pb-document.html

@@ -24,12 +24,12 @@
                 }
                 </style>
                 <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
-                    <pb-document id="document1" path="test/kant_rvernunft_1781.TEI-P5.xml" odd="dta" view="page"></pb-document>
+                    <pb-document id="document1" path="test/kant_rvernunft_1781.TEI-P5.xml" odd="dta" view="page" disable-history></pb-document>
                     <pb-document id="document2" path="doc/documentation.xml" odd="docbook" view="div"></pb-document>
 
                     <!-- Display two document views side by side -->
                     <main>
-                        <pb-view id="view1" src="document1"></pb-view>
+                        <pb-view id="view1" src="document1" disable-history></pb-view>
                         <pb-view id="view2" src="document2"></pb-view>
                     </main>
                 </pb-page>

package/dist/demo/pb-load.html

@@ -43,13 +43,13 @@
             }
             </style>
             <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
-                <pb-document id="document1" path="test/kant_rvernunft_1781.TEI-P5.xml" odd="dta"></pb-document>
+                <pb-document id="document1" path="test/kant_rvernunft_1781.TEI-P5.xml" odd="dta" view="page"></pb-document>
 
                 <main>
                     <pb-load url="api/document/{doc}/contents?target=transcription&icons=true" expand src="document1" auto>Loading table of
                         contents...</pb-load>
                     <div class="transcription">
-                        <pb-view src="document1" subscribe="transcription" view="page"></pb-view>
+                        <pb-view src="document1" subscribe="transcription"></pb-view>
                     </div>
                 </main>
             </pb-page>

package/dist/demo/pb-select-feature.html

@@ -38,7 +38,7 @@
                 <div class="toolbar">
                     <pb-select-feature id="select-view1" name="view1" label="View" items='[
                     {"name": "Diplomatic View", "properties": {"mode": "diplomatic", "view": "page"}}, 
-                    {"name": "Normalized View", "properties": {"mode": "norm", "view": "single"}}
+                    {"name": "Normalized View", "properties": {"mode": "norm", "view": "single", "root": null}}
                     ]'></pb-select-feature>
                     <pb-navigation direction="backward" keyboard="left">
                         <paper-icon-button icon="icons:chevron-left"></paper-icon-button>

package/dist/demo/pb-select-feature2.html

@@ -28,6 +28,12 @@
                 padding: 10px;
                 background-color: #E0E0E0;
             }
+            .message {
+                display: none;
+            }
+            .message.toggle {
+                display: block;
+            }
             pb-toggle-feature {
                 display: block;
             }
@@ -35,11 +41,12 @@
             <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
                 <pb-document id="document1" path="test/cortes_to_dantiscus.xml" odd="dantiscus"></pb-document>
 
+                <p class="message">You are viewing the text in plain reading view.</p>
                 <div class="toolbar">
                     <pb-select-feature id="select-view1" name="view1" label="View" items='[
-                    {"name": "Diplomatic View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": false},{"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable"}]},
-                    {"name": "Normalized View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": true},{"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable"}]},
-                    {"name": "Plain Reading View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": true}, {"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable", "state": true}]}
+                    {"name": "Diplomatic View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": false},{"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable"}, {"selector": ".message", "state": false, "global": true}]},
+                    {"name": "Normalized View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": true},{"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable"}, {"selector": ".message", "state": false, "global": true}]},
+                    {"name": "Plain Reading View", "selectors": [{"selector": ".choice,.choice-alternate,br", "state": true}, {"selector": ".tei-foreign,pb-highlight,pb-popover", "command": "disable", "state": true}, {"selector": ".message", "state": true, "global": true}]}
                     ]' emit="ex2" subscribe="ex2"></pb-select-feature>
                     <!-- Navigate to previous page -->
                     <pb-navigation direction="backward" keyboard="left" emit="ex2" subscribe="ex2">

package/dist/demo/pb-select-feature3.html

@@ -49,7 +49,7 @@
                 </div>
                 <main>
                     <pb-load id="load" url="api/parts/{doc}/html?xpath=//text[@type='source']&view=single" expand
-                        src="document1" auto subscribe="loader" emit="loader">Loading document ...</pb-load>
+                        src="document1" auto subscribe="loader" emit="loader" history>Loading document ...</pb-load>
                 </main>
             </pb-page>
         </template>

package/dist/demo/pb-select-odd.html

@@ -32,4 +32,4 @@
     </pb-demo-snippet>
 </body>
 
-</html>
+</html>

package/dist/demo/pb-table-grid.html

@@ -6,7 +6,7 @@
     <body>
         <h1>Using pb-table-grid</h1>
 
-        <pb-page theme="components.css">
+        <pb-page theme="components.css" url-path="query">
             <pb-table-grid class="table-grid" source="./people.json" css-path="/css/gridjs" resizable>
                 <pb-table-column label="Name" property="name"></pb-table-column>
                 <pb-table-column label="Born" property="birth"></pb-table-column>

package/dist/demo/pb-tabs.html

@@ -12,9 +12,11 @@
             <template>
                 <!-- Display two document views side by side -->
                 <main>
+                    <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
                     <pb-tabs>
-                        <paper-tab slot="tab">Local Collection</paper-tab>
-                        <paper-tab slot="tab">Distributed Text Services (Experimental)</paper-tab>
+                        <paper-tab slot="tab">Tab 1</paper-tab>
+                        <paper-tab slot="tab">Tab 2</paper-tab>
+                        <paper-tab slot="tab">Tab 3</paper-tab>
 
                         <div slot="page">
                             <p>This is the first tab.</p>
@@ -22,7 +24,11 @@
                         <div slot="page">
                             <p>And a second tab.</p>
                         </div>
+                        <div slot="page">
+                            <p>The third tab.</p>
+                        </div>
                     </pb-tabs>
+                    </pb-page>
                 </main>
             </template>
         </pb-demo-snippet>

package/dist/demo/pb-toggle-feature.html

@@ -55,13 +55,13 @@
                 <pb-document id="document1" path="test/cortes_to_dantiscus.xml" odd="dantiscus"></pb-document>
 
                 <div class="toolbar">
-                    <pb-toggle-feature name="highlight1" selector=".tei-foreign,pb-highlight,pb-popover"
+                    <pb-toggle-feature name="plain" selector=".tei-foreign,pb-highlight,pb-popover"
                         action="disable" default="off">Plain Reading View</pb-toggle-feature>
                     <!-- pass a parameter 'mode'. pb-view will forward this to the ODD as a user-defined parameter-->
                     <pb-toggle-feature name="mode" on="diplomatic" off="norm">Diplomatic View</pb-toggle-feature>
                     <!-- directly change properties of the pb-view -->
                     <pb-toggle-feature name="view" on="page" off="single" default="off">Page View</pb-toggle-feature>
-                    <pb-toggle-feature name="xpath" default="off"
+                    <pb-toggle-feature name="translation" default="off"
                         properties-on='{"xpath": "//text[@type=&apos;translation&apos;]", "odd": "teipublisher", "nodeId": null, "view": "single"}'
                         properties-off='{"xpath": "//text[@type=&apos;source&apos;]", "odd": "dantiscus"}'>
                         Translation

package/dist/demo/pb-toggle-feature2.html

@@ -54,9 +54,9 @@
             <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
                 <pb-document id="document2" path="test/cortes_to_dantiscus.xml" odd="dantiscus"></pb-document>
                 <div class="toolbar">
-                    <pb-toggle-feature name="highlight2" selector=".tei-foreign,pb-highlight,pb-popover"
+                    <pb-toggle-feature name="plain" selector=".tei-foreign,pb-highlight,pb-popover"
                         action="disable" default="off" emit="ex2" subscribe="ex2">Plain Reading View</pb-toggle-feature>
-                    <pb-toggle-feature name="norm2" selector=".choice,.choice-alternate,br" emit="ex2" subscribe="ex2">
+                    <pb-toggle-feature name="norm" selector=".choice,.choice-alternate,br" emit="ex2" subscribe="ex2">
                         Normalized View</pb-toggle-feature>
                     <!-- Navigate to previous page -->
                     <pb-navigation direction="backward" keyboard="left" emit="ex2" subscribe="ex2">

package/dist/demo/pb-toggle-feature3.html

@@ -47,12 +47,12 @@
                     <!-- pass a parameter 'mode'. pb-view will forward this to the ODD as a user-defined parameter -->
                     <!-- note that we have to prefix the parameter with 'user.' because that's how components.xql expects it -->
                     <pb-toggle-feature id="toggle2" emit="loader" subscribe="loader" name="user.mode"
-                        on="diplomatic" off="norm" default="on">Diplomatic View</pb-toggle-feature>
+                        on="diplomatic" off="norm" default="diplomatic">Diplomatic View</pb-toggle-feature>
                 </div>
                 <main>
                     <!-- call components.xql to retrieve the full source text -->
                     <pb-load url="api/parts/{doc}/html?xpath=//text[@type='source']&view=single" expand
-                        src="document3" auto subscribe="loader" emit="loader">Loading document ...</pb-load>
+                        src="document3" auto subscribe="loader" emit="loader" history="history">Loading document ...</pb-load>
                 </main>
             </pb-page>
         </template>

package/dist/demo/pb-view.html

@@ -54,7 +54,7 @@
                     <pb-progress subscribe="transcription"></pb-progress>
                     <!-- Output the document title -->
                     <pb-view src="document1" xpath="//teiHeader/fileDesc/titleStmt/title"
-                        subscribe="transcription">
+                        subscribe="transcription" view="single">
                         <pb-param name="header" value="short"/>
                     </pb-view>
                     <pb-view id="view1" src="document1" view="page" append-footnotes animation

package/dist/demo/pb-view4.html

@@ -0,0 +1,86 @@
+<html>
+    <head>
+        <meta charset="utf-8"/>
+        <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes"/>
+
+        <title>pb-view Demo</title>
+        <script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.4.3/webcomponents-loader.js"></script><script type="module" src="../pb-components-bundle.js"></script>
+    </head>
+
+    <body>
+        <pb-demo-snippet>
+            <template>
+                <style type="text/css">
+                pb-page {
+                    position: relative;
+                }
+
+                main {
+                    display: grid;
+                    height: calc(100vh - 128px);
+                    grid-template-columns: 360px 1fr;
+                    grid-template-rows: 1fr auto;
+                }
+
+                ul {
+                    grid-row: 1 / 2;
+                }
+
+                #view1 {
+                    grid-column: 2 / 2;
+                    grid-row: 1 / 1;
+                    overflow: auto;
+                    font-family: var(--pb-base-font-family);
+                    font-size: 20px;
+                    padding: 0;
+                }
+
+                footer {
+                    grid-column: 2 / 2;
+                    grid-row: 2 / 2;
+                    background-color: var(--pb-toolbar-background-color);
+                }
+
+                footer pb-navigation[direction=forward] {
+                    float: right;
+                }
+                </style>
+                <pb-page endpoint="https://teipublisher.com/exist/apps/tei-publisher">
+                    <pb-document id="document1" path="doc/documentation.xml" odd="docbook" view="div"></pb-document>
+
+                    <pb-progress></pb-progress>
+                    <main>
+                        <ul>
+                            <li>
+                                <pb-link class="docs" path="doc/documentation.xml" odd="docbook" view="div">Documentation</pb-link>
+                            </li>
+                            <li>
+                                <pb-link path="test/kant_rvernunft_1781.TEI-P5.xml" odd="dta" view="page">Kant chapter</pb-link>
+                            </li>
+                            <li>
+                                <pb-link class="docs" path="doc/documentation.xml" xml-id="pi-config" odd="docbook" view="div">Link by xml:id
+                                </pb-link>
+                            </li>
+                        </ul>
+                        <pb-view id="view1" src="document1" append-footnotes fix-links
+                            load-css="odd/docbook.css"></pb-view>
+                        <footer>
+                            <!-- Navigate to next page -->
+                            <pb-navigation direction="forward" keyboard="right">
+                                <paper-button>
+                                    <iron-icon icon="icons:chevron-right"></iron-icon>
+                                </paper-button>
+                            </pb-navigation>
+                            <!-- Navigate to previous page -->
+                            <pb-navigation direction="backward" keyboard="left">
+                                <paper-button>
+                                    <iron-icon icon="icons:chevron-left"></iron-icon>
+                                </paper-button>
+                            </pb-navigation>
+                        </footer>
+                    </main>
+                </pb-page>
+            </template>
+        </pb-demo-snippet>
+    </body>
+</html>

package/dist/pb-code-editor.js

@@ -1,4 +1,4 @@
-import{p as e,L as t,h as i,c as r}from"./pb-mixin-88125cb2.js";import{t as o}from"./pb-i18n-3963b098.js";import"./jinn-codemirror-9718e0e0.js";class s extends(e(t)){static get properties(){return Object.assign(Object.assign({},super.properties),{},{code:{type:String,reflect:!0},mode:{type:String},label:{type:String},placeholder:{type:String},tabSize:{type:Number},linter:{attribute:!0}})}constructor(){super(),this.code="",this.mode="xml",this.placeholder="odd.editor.model.empty",this.tabSize=2,this.label="",this.linter="",this._editor=null}connectedCallback(){super.connectedCallback()}firstUpdated(){super.firstUpdated(),this._editor=this.shadowRoot.getElementById("editor")}render(){return i`
+import{p as e,L as t,h as i,c as r}from"./pb-mixin-8a593923.js";import{t as o}from"./pb-i18n-8a90c591.js";import"./jinn-codemirror-9718e0e0.js";class s extends(e(t)){static get properties(){return Object.assign(Object.assign({},super.properties),{},{code:{type:String,reflect:!0},mode:{type:String},label:{type:String},placeholder:{type:String},tabSize:{type:Number},linter:{attribute:!0}})}constructor(){super(),this.code="",this.mode="xml",this.placeholder="odd.editor.model.empty",this.tabSize=2,this.label="",this.linter="",this._editor=null}connectedCallback(){super.connectedCallback()}firstUpdated(){super.firstUpdated(),this._editor=this.shadowRoot.getElementById("editor")}render(){return i`
             <div class="label">${this.label}</div>
             <jinn-codemirror id="editor" mode="${this.mode}" code="${this.code}" placeholder="${o(this.placeholder)}"></jinn-codemirror>
         `}getSource(){return this._editor?this._editor.value:""}_setCode(){this.dispatchEvent(new CustomEvent("code-changed",{composed:!0,bubbles:!0,detail:{code:this.getSource()}}))}refresh(){}static get styles(){return r`