epic: CLI + plugins

.changeset/dirty-mugs-bow.md

@@ -0,0 +1,6 @@
+---
+"@kopflos-cms/plugin-deploy-resources": minor
+"@kopflos-cms/plugin-express": minor
+---
+
+First version

.changeset/dry-moose-applaud.md

@@ -0,0 +1,6 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Extracted logger to a new package `@kopflos-cms/core`
+

.changeset/five-avocados-impress.md

@@ -0,0 +1,6 @@
+---
+"@kopflos-cms/core": patch
+"@kopflos-cms/express": patch
+---
+
+Support for direct stream, using Web Streams

.changeset/friendly-geese-eat.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Revert dependency on `anylogger` to stable v1 branch

.changeset/gentle-apes-serve.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/vite": patch
+---
+
+Ensure the the `outDir` setting is also used for serving files in in production mode

.changeset/odd-hounds-float.md

@@ -0,0 +1,30 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Added support for templated resource shapes. Use `kl:regex` a pattern to match the request URL path. 
+Additionally, named capturing groups can be used to extract values from the URL path. They will be 
+accessible as `HandlerArgs#subjectVariables` and included when resolving `code:EcmaScriptTemplateLiteral`.
+
+```turtle
+<#WebPage>
+  a kl:ResourceShape ;
+  kl:api <> ;
+  sh:target
+    [
+      a kl:PatternedTarget ;
+      kl:regex "/(?<type>[^/]+).+\\.html$" ;
+    ] ;
+  kl:handler
+    [
+      a kl:Handler ;
+      kl:method "GET" ;
+      code:implementedBy
+        [
+          a code:EcmaScriptModule ;
+          code:link <node:@kopflos-cms/serve-file#default> ;
+          code:arguments ( "pages/${type}.html"^^code:EcmaScriptTemplateLiteral ) ;
+        ] ;
+    ] ;
+.
+```

.changeset/pink-eggs-collect.md

@@ -0,0 +1,29 @@
+---
+"@kopflos-cms/core": minor
+---
+
+Handlers: Added support for `code:arguments`. Please refer to [rdf-loader-code](https://github.com/zazuko/rdf-loader-code?tab=readme-ov-file#loading-function-arguments) for more information.
+
+```turtle
+[
+  a kl:Handler ;
+  code:implementedBy [
+    a code:EcmaScriptModule ;
+    code:link <...> ;
+    code:arguments ("foo" "bar") ;
+  ] ;
+] .
+```
+
+Implementors must now return a factory function that returns the handler function.
+
+```diff
+import type { Handler } from "@kopflos-cms/core";
+
+- export default function handler() {
++ export default function handler(foo, bar): Handler {
+  return async function handlerFunction() {
+    // ...
+  };
+}
+```

.changeset/real-numbers-visit.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/express": minor
+---
+
+The main export now returns `Promise<{ middleware: RequestHandler; instance: Kopflos }>`

.changeset/red-bottles-drum.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/serve-file": minor
+---
+
+First version: serve files directly, with an option to stream directly

.changeset/shy-rivers-smoke.md

@@ -0,0 +1,5 @@
+---
+"kopflos": patch
+---
+
+Added `--variable <key=value>` option to override config variables

.changeset/sixty-suns-melt.md

@@ -0,0 +1,6 @@
+---
+"@kopflos-labs/html-template": minor
+"@kopflos-labs/handlebars": minor
+---
+
+First version

.changeset/stupid-ads-destroy.md

@@ -0,0 +1,7 @@
+---
+"@kopflos-cms/express": patch
+"@kopflos-cms/core": patch
+"kopflos": patch
+---
+
+Added plugin with `onStart` hook

.changeset/tame-cobras-leave.md

@@ -0,0 +1,6 @@
+---
+"@kopflos-cms/plugin-express": minor
+"@kopflos-cms/express": minor
+---
+
+Added express-only middleware hooks

.changeset/tender-countries-worry.md

@@ -0,0 +1,5 @@
+---
+"sparql-path-parser": minor
+---
+
+First version

.changeset/thick-socks-juggle.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-labs/lit": minor
+---
+
+First version - Server-Side rendering

.changeset/thin-buses-remember.md

@@ -0,0 +1,5 @@
+---
+"kopflos": minor
+---
+
+First version

.changeset/thin-penguins-greet.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Added `./env.js` to package exports

.changeset/tiny-eels-smoke.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/express": patch
+---
+
+Ensure that middlewares from multiple plugins are registered in order

.changeset/tough-peas-wink.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Added support for `code:EcmaScriptTemplateLiteral`

.changeset/wet-shirts-watch.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/logger": minor
+---
+
+Extracted package from `@kopflos-cms/core`

.changeset/wild-cooks-leave.md

@@ -0,0 +1,5 @@
+---
+"kopflos": patch
+---
+
+Added `--mode (development|production)` option

.eslintrc.json

@@ -5,5 +5,8 @@
   },
   "env": {
     "mocha": true
-  }
+  },
+  "ignorePatterns": [
+    "packages/sparql-path-parser/"
+  ]
 }

.github/workflows/tests.yml

@@ -6,19 +6,38 @@ jobs:
   unit-tests:
     runs-on: [ ubuntu-latest ]
     strategy:
+      fail-fast: false
       matrix:
         node: [ 18, 20, "lts/*" ]
+        package:
+          - name: "@kopflos-cms/core"
+            path: packages/core
+          - name: "@kopflos-cms/express"
+            path: packages/express
+          - name: "@kopflos-cms/plugin-deploy-resources"
+            path: packages/plugin-deploy-resources
+          - name: "@kopflos-cms/serve-file"
+            path: packages/serve-file
+          - name: "@kopflos-cms/vite"
+            path: packages/vite
+          - name: "@kopflos-labs/html-template"
+            path: labs/html-template
+          - name: "@kopflos-labs/handlebars"
+            path: labs/handlebars
+          - name: sparql-path-parser
+            path: packages/sparql-path-parser
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       - run: npm ci
-      - run: npx c8 --all --reporter lcovonly npm run --ws --if-present test
+      - run: npx c8 --all --src ${{ matrix.package.path }} --reporter lcovonly --reporter text npm run -w ${{ matrix.package.path }} test
       - name: Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+          flags: ${{ matrix.package.name }}
 
   lint:
     runs-on: ubuntu-latest

.gitignore

@@ -2,3 +2,4 @@ coverage
 node_modules
 *.d.ts
 *.js
+*.js.map

codecov.yml

@@ -1,2 +1,3 @@
 ignore:
-  - packages/mocha-chai-rdf
+  - example
+  - packages/sparql-path-parser/src/grammar

example/.gitignore

@@ -0,0 +1,2 @@
+oxigraph/
+dist/

example/README.md

@@ -0,0 +1,35 @@
+# Kopflos example
+
+API inspired by [Read the Plaque](https://readtheplaque.com/).
+
+## Start
+
+1. Start the database:
+   ```bash
+   docker compose up -d
+   ```   
+2. Start the server in development mode:
+   ```bash
+   npx kopflos serve --mode development
+   ```
+
+The API is running on http://localhost:1429
+
+## Details
+
+When starting, `kopflos` automatically seeds the database wit resource from directories `resources` and
+`resources.dev` (configured in `kopflos.config.ts`).
+
+## Building for production
+
+First run the build command which uses vite to transform and bundle HTML templates.
+
+```bash
+npx kopflos build
+```
+
+Then start the server in production mode:
+
+```bash
+npx kopflos serve
+```

example/docker-compose.yaml

@@ -0,0 +1,10 @@
+version: '2'
+services:
+  oxigraph:
+    image: ghcr.io/oxigraph/oxigraph:0.4.1
+    user: root
+    command: serve --location /data --bind 0.0.0.0:7878
+    ports:
+      - 7878:7878
+    volumes:
+      - ./oxigraph:/data

example/kopflos.config.ts

@@ -0,0 +1,32 @@
+import * as url from 'node:url'
+import type { KopflosConfig } from '@kopflos-cms/core'
+
+export default <KopflosConfig> {
+  baseIri: 'http://localhost:1429',
+  apiGraphs: ['http://localhost:1429/api'],
+  sparql: {
+    default: {
+      endpointUrl: 'http://localhost:7878/query?union-default-graph',
+      updateUrl: 'http://localhost:7878/update',
+    },
+  },
+  variables: {
+    uiRoot: 'ui',
+  },
+  plugins: {
+    '@kopflos-cms/plugin-deploy-resources': {
+      paths: ['resources', 'resources.dev'],
+    },
+    '@kopflos-cms/express/middleware': {
+      before: [
+        'cors',
+        ['compression', { level: 9 }],
+        url.fileURLToPath(new URL('lib/static.js', import.meta.url)),
+      ],
+    },
+    '@kopflos-cms/vite': {
+      root: 'ui',
+      entrypoints: ['ui/*.html'],
+    },
+  },
+}

example/lib/static.ts

@@ -0,0 +1,5 @@
+import express from 'express'
+
+export default (): express.RequestHandler => {
+  return express.static('public')
+}

example/lib/templateData.ts

@@ -0,0 +1,7 @@
+import type { TemplateDataFunc } from '@kopflos-labs/html-template'
+
+export const describe = (resourcePath: string): TemplateDataFunc => ({ env }) => {
+  return env.sparql.default.stream.query.construct(`
+BASE <${env.kopflos.config.baseIri}>
+DESCRIBE <${resourcePath}>`)
+}

example/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "example",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "kopflos build",
+    "start": "kopflos serve --mode development --trust-proxy",
+    "prestart:prod": "npm run build",
+    "start:prod": "kopflos serve --trust-proxy --variable uiRoot=dist"
+  },
+  "dependencies": {
+    "@kopflos-cms/vite": "*",
+    "@kopflos-cms/serve-file": "*",
+    "@kopflos-labs/html-template": "*",
+    "@kopflos-labs/handlebars": "*",
+    "@kopflos-labs/lit": "*",
+    "@openlayers-elements/core": "^0.3.0",
+    "@openlayers-elements/maps": "^0.3.0",
+    "@shoelace-style/shoelace": "^2.17.1",
+    "@webcomponents/template-shadowroot": "^0.2.1",
+    "express": "^5.0.1",
+    "kopflos": "*",
+    "lit-element": "^4.1.1",
+    "cors": "^2.8.5",
+    "compression": "^1.7.4"
+  },
+  "devDependencies": {
+    "@types/express": "^5"
+  }
+}

example/public/foo.txt

@@ -0,0 +1 @@
+bar