@teipublisher/pb-components 1.24.19 → 1.27.0

package/dist/pb-elements.json

@@ -151,10 +151,6 @@
           "name": "data",
           "type": "object"
         },
-        {
-          "name": "collection",
-          "type": "string"
-        },
         {
           "name": "page",
           "type": "number"
@@ -163,6 +159,11 @@
           "name": "perPage",
           "type": "number"
         },
+        {
+          "name": "collection",
+          "type": "string",
+          "default": "\"default\""
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -206,11 +207,6 @@
           "attribute": "data",
           "type": "object"
         },
-        {
-          "name": "collection",
-          "attribute": "collection",
-          "type": "string"
-        },
         {
           "name": "page",
           "attribute": "page",
@@ -221,6 +217,12 @@
           "attribute": "perPage",
           "type": "number"
         },
+        {
+          "name": "collection",
+          "attribute": "collection",
+          "type": "string",
+          "default": "\"default\""
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -290,6 +292,32 @@
           "name": "pagination",
           "description": "pagination area"
         }
+      ],
+      "cssParts": [
+        {
+          "name": "parent-link",
+          "description": "Link to parent collection"
+        },
+        {
+          "name": "collection-title",
+          "description": "Collection title"
+        },
+        {
+          "name": "title",
+          "description": "Member title"
+        },
+        {
+          "name": "author",
+          "description": "Author"
+        },
+        {
+          "name": "license",
+          "description": "License information"
+        },
+        {
+          "name": "link",
+          "description": "Links"
+        }
       ]
     },
     {
@@ -8895,6 +8923,190 @@
         }
       ]
     },
+    {
+      "name": "pb-table-column",
+      "path": "./src/pb-table-column.js",
+      "description": "Defines a column within `pb-table-grid`.",
+      "attributes": [
+        {
+          "name": "label",
+          "description": "Column heading to display",
+          "type": "string",
+          "default": "\"no-label\""
+        },
+        {
+          "name": "property",
+          "description": "Name of the JSON property containing the data",
+          "type": "string"
+        },
+        {
+          "name": "sort",
+          "description": "Should the column support sorting?",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "width",
+          "description": "Optional fixed width of the column (e.g. '200px' or '30%')",
+          "type": "string"
+        }
+      ],
+      "properties": [
+        {
+          "name": "label",
+          "attribute": "label",
+          "description": "Column heading to display",
+          "type": "string",
+          "default": "\"no-label\""
+        },
+        {
+          "name": "property",
+          "attribute": "property",
+          "description": "Name of the JSON property containing the data",
+          "type": "string"
+        },
+        {
+          "name": "sort",
+          "attribute": "sort",
+          "description": "Should the column support sorting?",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "width",
+          "attribute": "width",
+          "description": "Optional fixed width of the column (e.g. '200px' or '30%')",
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "pb-table-grid",
+      "path": "./src/pb-table-grid.js",
+      "description": "A table grid based on [gridjs](https://gridjs.io/), which loads its data from a server endpoint\nspecified in `source`. If `source` is a relative URI, it will be resolved relative to the\nTEI Publisher endpoint.\n\nThe JSON data returned by the endpoint should be an object with two properties:\n\n* `count`: the overall number of rows available on the server\n* `results`: an array containing each record as an object\n\nThe parameters send to the server are as follows:\n\n\nParameter | Description\n---------|----------\nlimit | number of records to return for each page\nstart | start offset from which to return records\norder | the id of the column to sort by\ndir | sort direction: either 'asc' or 'desc'\nsearch | an optional search string entered by the user\n\nTable columns are configured via nested `<pb-table-column>` elements:\n\n```html\n<pb-table-column label=\"Name\" property=\"name\" sort width=\"33%\"></pb-table-column>\n<pb-table-column label=\"Born\" property=\"birth\"></pb-table-column>\n<pb-table-column label=\"Died\" property=\"death\"></pb-table-column>\n```",
+      "attributes": [
+        {
+          "name": "source",
+          "description": "URI of the server-side endpoint to retrieve data from.\nRelative URIs are resolved relative to the configured TEI Publisher endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "css-path",
+          "description": "Path to the gridjs theme CSS files.",
+          "type": "string",
+          "default": "\"../css/gridjs\""
+        },
+        {
+          "name": "resizable",
+          "description": "If specified, columns (without a fixed width) will be resizable.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "search",
+          "description": "If specified, enable server-side search.",
+          "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.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "source",
+          "attribute": "source",
+          "description": "URI of the server-side endpoint to retrieve data from.\nRelative URIs are resolved relative to the configured TEI Publisher endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "cssPath",
+          "attribute": "css-path",
+          "description": "Path to the gridjs theme CSS files.",
+          "type": "string",
+          "default": "\"../css/gridjs\""
+        },
+        {
+          "name": "resizable",
+          "attribute": "resizable",
+          "description": "If specified, columns (without a fixed width) will be resizable.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "search",
+          "attribute": "search",
+          "description": "If specified, enable server-side search.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ]
+    },
     {
       "name": "pb-tabs",
       "path": "./src/pb-tabs.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "1.24.19",
+  "version": "1.27.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",
@@ -68,6 +68,7 @@
     "@webcomponents/webcomponentsjs": "latest",
     "animejs": "^3.2.0",
     "codemirror": "^5.58.1",
+    "gridjs": "^5.0.2",
     "hotkeys-js": "^3.8.1",
     "i18next": "19.8.1",
     "i18next-browser-languagedetector": "^6.0.1",

package/pb-elements.json

@@ -151,10 +151,6 @@
           "name": "data",
           "type": "object"
         },
-        {
-          "name": "collection",
-          "type": "string"
-        },
         {
           "name": "page",
           "type": "number"
@@ -163,6 +159,11 @@
           "name": "perPage",
           "type": "number"
         },
+        {
+          "name": "collection",
+          "type": "string",
+          "default": "\"default\""
+        },
         {
           "name": "subscribe",
           "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
@@ -206,11 +207,6 @@
           "attribute": "data",
           "type": "object"
         },
-        {
-          "name": "collection",
-          "attribute": "collection",
-          "type": "string"
-        },
         {
           "name": "page",
           "attribute": "page",
@@ -221,6 +217,12 @@
           "attribute": "perPage",
           "type": "number"
         },
+        {
+          "name": "collection",
+          "attribute": "collection",
+          "type": "string",
+          "default": "\"default\""
+        },
         {
           "name": "subscribe",
           "attribute": "subscribe",
@@ -290,6 +292,32 @@
           "name": "pagination",
           "description": "pagination area"
         }
+      ],
+      "cssParts": [
+        {
+          "name": "parent-link",
+          "description": "Link to parent collection"
+        },
+        {
+          "name": "collection-title",
+          "description": "Collection title"
+        },
+        {
+          "name": "title",
+          "description": "Member title"
+        },
+        {
+          "name": "author",
+          "description": "Author"
+        },
+        {
+          "name": "license",
+          "description": "License information"
+        },
+        {
+          "name": "link",
+          "description": "Links"
+        }
       ]
     },
     {
@@ -8895,6 +8923,190 @@
         }
       ]
     },
+    {
+      "name": "pb-table-column",
+      "path": "./src/pb-table-column.js",
+      "description": "Defines a column within `pb-table-grid`.",
+      "attributes": [
+        {
+          "name": "label",
+          "description": "Column heading to display",
+          "type": "string",
+          "default": "\"no-label\""
+        },
+        {
+          "name": "property",
+          "description": "Name of the JSON property containing the data",
+          "type": "string"
+        },
+        {
+          "name": "sort",
+          "description": "Should the column support sorting?",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "width",
+          "description": "Optional fixed width of the column (e.g. '200px' or '30%')",
+          "type": "string"
+        }
+      ],
+      "properties": [
+        {
+          "name": "label",
+          "attribute": "label",
+          "description": "Column heading to display",
+          "type": "string",
+          "default": "\"no-label\""
+        },
+        {
+          "name": "property",
+          "attribute": "property",
+          "description": "Name of the JSON property containing the data",
+          "type": "string"
+        },
+        {
+          "name": "sort",
+          "attribute": "sort",
+          "description": "Should the column support sorting?",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "width",
+          "attribute": "width",
+          "description": "Optional fixed width of the column (e.g. '200px' or '30%')",
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "pb-table-grid",
+      "path": "./src/pb-table-grid.js",
+      "description": "A table grid based on [gridjs](https://gridjs.io/), which loads its data from a server endpoint\nspecified in `source`. If `source` is a relative URI, it will be resolved relative to the\nTEI Publisher endpoint.\n\nThe JSON data returned by the endpoint should be an object with two properties:\n\n* `count`: the overall number of rows available on the server\n* `results`: an array containing each record as an object\n\nThe parameters send to the server are as follows:\n\n\nParameter | Description\n---------|----------\nlimit | number of records to return for each page\nstart | start offset from which to return records\norder | the id of the column to sort by\ndir | sort direction: either 'asc' or 'desc'\nsearch | an optional search string entered by the user\n\nTable columns are configured via nested `<pb-table-column>` elements:\n\n```html\n<pb-table-column label=\"Name\" property=\"name\" sort width=\"33%\"></pb-table-column>\n<pb-table-column label=\"Born\" property=\"birth\"></pb-table-column>\n<pb-table-column label=\"Died\" property=\"death\"></pb-table-column>\n```",
+      "attributes": [
+        {
+          "name": "source",
+          "description": "URI of the server-side endpoint to retrieve data from.\nRelative URIs are resolved relative to the configured TEI Publisher endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "css-path",
+          "description": "Path to the gridjs theme CSS files.",
+          "type": "string",
+          "default": "\"../css/gridjs\""
+        },
+        {
+          "name": "resizable",
+          "description": "If specified, columns (without a fixed width) will be resizable.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "search",
+          "description": "If specified, enable server-side search.",
+          "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.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "source",
+          "attribute": "source",
+          "description": "URI of the server-side endpoint to retrieve data from.\nRelative URIs are resolved relative to the configured TEI Publisher endpoint.",
+          "type": "string"
+        },
+        {
+          "name": "cssPath",
+          "attribute": "css-path",
+          "description": "Path to the gridjs theme CSS files.",
+          "type": "string",
+          "default": "\"../css/gridjs\""
+        },
+        {
+          "name": "resizable",
+          "attribute": "resizable",
+          "description": "If specified, columns (without a fixed width) will be resizable.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "search",
+          "attribute": "search",
+          "description": "If specified, enable server-side search.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ]
+    },
     {
       "name": "pb-tabs",
       "path": "./src/pb-tabs.js",

package/src/authority/connectors.js

@@ -3,6 +3,7 @@ import { GeoNames } from './geonames.js';
 import { Airtable } from './airtable.js';
 import { GND } from './gnd.js';
 import { KBGA } from './kbga.js';
+import { GF } from './gf.js';
 import { Custom } from './custom.js';
 
 export function createConnectors(endpoint, root) {
@@ -23,6 +24,9 @@ export function createConnectors(endpoint, root) {
       case 'KBGA':
         instance = new KBGA(configElem);
         break;
+      case 'GF':
+        instance = new GF(configElem);
+        break;
       case 'Custom':
         instance = new Custom(endpoint, configElem);
         break;