Collection paging

.changeset/four-baboons-protect.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/vite": patch
+---
+
+Add inline `config` to plugin config

.changeset/short-lemons-agree.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": minor
+---
+
+Changed plugin setup to require classes

.changeset/shy-bobcats-reply.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Added helper to easily access plugin instance

.changeset/tall-maps-thank.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/hydra": minor
+---
+
+Created extensible method for collection paging strategies

.changeset/tidy-mice-tell.md

@@ -0,0 +1,7 @@
+---
+"@kopflos-cms/express": patch
+"@kopflos-cms/vite": patch
+"kopflos": patch
+---
+
+Plugins are now implemented as classes

.github/workflows/tests.yml

@@ -33,6 +33,7 @@ jobs:
             path: packages/sparql-path-parser
     steps:
       - uses: actions/checkout@v4
+      - uses: fabasoad/setup-prolog-action@v1
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
@@ -48,6 +49,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: fabasoad/setup-prolog-action@v1
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
@@ -58,8 +60,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: fabasoad/setup-prolog-action@v1
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
       - run: npm ci
       - run: npm run -ws --if-present build
+
+  smoke-test-example:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: fabasoad/setup-prolog-action@v1
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - run: npm ci
+      - run: docker compose up -d
+        working-directory: example
+      - run: npm run -w example start &
+      - run: npx wait-on http://localhost:1429/plaque/newton-s-apple-tree-monash-university -t 30000
+
+      - run: npx api-tuner example/tests/*.n3 --base-iri http://localhost:1429/

.lando.yml

@@ -0,0 +1,34 @@
+name: read-the-plaque
+services:
+  oxigraph:
+    api: 3
+    type: lando
+    entrypoint: /usr/local/bin/oxigraph
+    app_mount: false
+    scanner: false
+    ssl: true
+    services:
+      image: ghcr.io/oxigraph/oxigraph:0.4.6
+      user: root
+      command: serve --location /data --bind 0.0.0.0:7878
+      ports:
+        - 7878
+      volumes:
+        - ./example/oxigraph:/data
+  app:
+    type: node:20
+    ssl: true
+    scanner: false
+    build:
+      - npm i
+    command: cd example; kopflos serve --mode development --trust-proxy
+    overrides:
+      environment:
+        API_BASE: https://read-the-plaque.lndo.site
+        DB_URI: http://db.read-the-plaque.lndo.site
+
+proxy:
+  oxigraph:
+    - db.read-the-plaque.lndo.site:7878
+  app:
+    - read-the-plaque.lndo.site:1429

example/docker-compose.yaml

@@ -1,6 +1,6 @@
 services:
   oxigraph:
-    image: ghcr.io/oxigraph/oxigraph:0.4.4
+    image: ghcr.io/oxigraph/oxigraph:0.4.6
     user: root
     command: serve --location /data --bind 0.0.0.0:7878
     ports:

example/kopflos.config.ts

@@ -1,14 +1,17 @@
 import * as url from 'node:url'
 import type { KopflosConfig } from '@kopflos-cms/core'
 
+const baseIri = process.env.API_BASE || 'http://localhost:1429'
+const dbUri = process.env.DB_URI || 'http://localhost:7878'
+
 export default <KopflosConfig> {
-  baseIri: 'http://localhost:1429',
-  apiGraphs: ['http://localhost:1429/api'],
+  baseIri,
+  apiGraphs: [baseIri + '/api'],
   sparql: {
     default: {
-      endpointUrl: 'http://localhost:7878/query?union-default-graph',
-      updateUrl: 'http://localhost:7878/update',
-      storeUrl: 'http://localhost:7878/store',
+      endpointUrl: dbUri + '/query?union-default-graph',
+      updateUrl: dbUri + '/update',
+      storeUrl: dbUri + '/store',
     },
     lindas: 'https://lindas.admin.ch/query',
   },
@@ -27,9 +30,14 @@ export default <KopflosConfig> {
     '@kopflos-cms/vite': {
       root: 'ui',
       entrypoints: ['ui/*.html'],
+      config: {
+        server: {
+          allowedHosts: ['read-the-plaque.lndo.site'],
+        },
+      },
     },
     '@kopflos-cms/hydra': {
-      apis: ['http://localhost:1429/api'],
+      apis: [baseIri + '/api'],
     },
   },
 }

example/package.json

@@ -12,22 +12,23 @@
   },
   "dependencies": {
     "@kopflos-cms/hydra": "0.0.0",
-    "@kopflos-cms/vite": "0.1.1",
     "@kopflos-cms/serve-file": "0.1.0",
-    "@kopflos-labs/html-template": "0.1.0",
+    "@kopflos-cms/vite": "0.1.1",
     "@kopflos-labs/handlebars": "0.1.0",
+    "@kopflos-labs/html-template": "0.1.0",
     "@kopflos-labs/lit": "0.1.0",
     "@openlayers-elements/core": "^0.3.0",
     "@openlayers-elements/maps": "^0.3.0",
     "@shoelace-style/shoelace": "^2.17.1",
     "@webcomponents/template-shadowroot": "^0.2.1",
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
     "express": "^5.0.1",
     "kopflos": "0.1.3",
-    "lit-element": "^4.1.1",
-    "cors": "^2.8.5",
-    "compression": "^1.7.4"
+    "lit-element": "^4.1.1"
   },
   "devDependencies": {
-    "@types/express": "^5"
+    "@types/express": "^5",
+    "api-tuner": "github:zazuko/api-tuner"
   }
 }

example/resources/countries.ttl

@@ -18,4 +18,26 @@ prefix kl-hydra: <https://kopflos.described.at/hydra#>
       sh:property [ sh:path schema:name ; sh:languageIn ("en" "de") ] ;
       sh:property [ sh:path schema:identifier ] ;
     ] ;
+  hydra:limit 10 ;
+  sh:orderBy
+    [
+      sh:nodes [ sh:path schema:name ; ] ;
+      sh:filterShape
+        [
+          sh:languageIn ( "en" ) ;
+        ] ;
+    ] ;
+  hydra:search
+    [
+      hydra:template "{?limit,offset}" ;
+      hydra:mapping
+        [
+          hydra:variable "limit" ;
+          hydra:property hydra:limit ;
+        ],
+        [
+          hydra:variable "offset" ;
+          hydra:property hydra:offset ;
+        ] ;
+    ] ;
 .

example/tests/collection-iterate.n3

@@ -0,0 +1,57 @@
+PREFIX lg: <https://purl.org/lg/>
+base <http://localhost:1429/>
+PREFIX log: <http://www.w3.org/2000/10/swap/log#>
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+PREFIX earl: <http://www.w3.org/ns/earl#>
+prefix : <https://always-read-the-plaque.tests/plaques/>
+prefix tuner: <https://api-tuner.described.at/>
+prefix hydra:<http://www.w3.org/ns/hydra/core#>
+prefix schema: <http://schema.org/>
+
+:fetchEntireCollection
+  a earl:TestCase ;
+  rdfs:label "Check chaining requests to fetch entire collection" ;
+  :fetch <countries?limit=50> ;
+.
+
+{
+  :fetchEntireCollection :fetch ?page .
+} => {
+  ?page a tuner:Request ;
+    tuner:method "GET" ;
+    tuner:url ?page ;
+  .
+} .
+
+{
+  ?req tuner:response ?res .
+
+  ?res tuner:http_code 200 .
+  ?res tuner:body ?body .
+  ?body log:includes {
+    <countries> hydra:member ?member .
+    ?member schema:name ?name .
+  } .
+
+  (
+    {
+      ?body log:includes {
+        <countries>!hydra:view hydra:next ?nextPage .
+      } .
+    }
+    {
+      ?body log:includes {
+        <countries>!hydra:view hydra:next ?nextPage .
+      } .
+      true log:becomes {
+        :fetchEntireCollection :fetch ?nextPage
+      }
+    }
+    {
+      true log:becomes { :fetchEntireCollection earl:outcome earl:passed }
+    }
+  ) log:ifThenElseIn [] .
+} => {
+  <countries> hydra:member ?member .
+  ?member schema:name ?name .
+} .

example/tests/html-served.n3

@@ -0,0 +1,26 @@
+base <http://localhost:1429/>
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+PREFIX earl: <http://www.w3.org/ns/earl#>
+PREFIX tuner: <https://api-tuner.described.at/>
+prefix : <https://always-read-the-plaque.tests/html/>
+prefix string: <http://www.w3.org/2000/10/swap/string#>
+
+:fetchHTML
+  a earl:TestCase ;
+  rdfs:label "Check HTML is served" ;
+.
+
+:getPage
+  a tuner:Request ;
+  tuner:method "GET" ;
+  tuner:url <plaque/newton-s-apple-tree-monash-university.html> ;
+.
+
+{
+  :getPage tuner:response ?res .
+
+  ?res tuner:http_code 200 .
+  ?res tuner:header ( "content-type" "text/html.*" string:matches ) .
+} => {
+  :fetchHTML earl:outcome earl:passed .
+} .