From a7fc4ef8bbb642cc6533ac55d9c776634caf1f5d Mon Sep 17 00:00:00 2001 From: Tomasz Pluskiewicz Date: Thu, 28 Mar 2024 12:27:06 +0100 Subject: [PATCH] chore: rename to @kopflos/core --- CHANGELOG.md | 7 +++---- README.md | 6 +++--- examples/blog/README.md | 4 ++-- examples/blog/api.ttl | 4 ++-- lib/log.ts | 2 +- package-lock.json | 8 ++++---- package.json | 23 +++++++++++++++-------- test/middleware.test.js | 2 +- 8 files changed, 31 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0724892..802f4ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,7 @@ -# hydra-box +# @kopflos/core -## 0.7.0 +## 0.1.0 ### Minor Changes -- edc3783: Convert package to ESM -- 2643a0a: Source changes to TypeScript +- First release, renamed from `hydra-box` diff --git a/README.md b/README.md index 6176ab1..836c601 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# hydra-box +# @kopflos/core [Hydra](http://www.hydra-cg.com/spec/latest/core/) is a machine readable description for APIs. Hydra Box extends the API description with links to the actual code, which provides the API. @@ -8,7 +8,7 @@ Hydra Box will use such an API description to create an express middleware which ### Application -Hydra-Box uses an object that implements the [RDF/JS Store interface](http://rdf.js.org/stream-spec/#store-interface) to read resources and find types of resources to identify matching operations. +`@kopflos/core` uses an object that implements the [RDF/JS Store interface](http://rdf.js.org/stream-spec/#store-interface) to read resources and find types of resources to identify matching operations. The resource is read using the IRI as named graph filter. Here an example for a store on the local file system using `rdf-store-fs`: @@ -43,7 +43,7 @@ app.listen(9000) ### Operation The operations must implement a [Express routing handler](http://expressjs.com/en/starter/basic-routing.html) interface (`(req, res, next) => {}`). -Hydra-Box adds the [@rdfjs/express-handler](https://github.com/rdfjs-base/express-handler) to handle incoming and outgoing RDF data. +@kopflos/core adds the [@rdfjs/express-handler](https://github.com/rdfjs-base/express-handler) to handle incoming and outgoing RDF data. For `GET` requests with a matching IRI Template, the `.dataset()` and `.quadStream()` as defined by `express-handler` are also available to read the given variables. Additionally there is a `hydra` property assigned to `req` that contains more data about the request: diff --git a/examples/blog/README.md b/examples/blog/README.md index 9f571e8..1d8806a 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -1,6 +1,6 @@ -# Hydra-Box - Blog Example +# kopflos - Blog Example -Simple hydra-box blog application that stores the RDF data in a file store in the local file system. +Simple blog application that stores the RDF data in a file store in the local file system. Before you can run the example, you need to create an initial store. Run the following command in the directory `examples/blog/`: diff --git a/examples/blog/api.ttl b/examples/blog/api.ttl index 5546b48..8ae0a96 100644 --- a/examples/blog/api.ttl +++ b/examples/blog/api.ttl @@ -2,7 +2,7 @@ @prefix hydra: . @prefix code: . -@prefix hydrabox: . +@prefix kopflos: . @prefix rdf: . @prefix rdfs: . @prefix xml: . @@ -15,7 +15,7 @@ . a hydra:SupportedOperation; - hydrabox:variables ; + kopflos:variables ; hydra:expects ; hydra:method "GET"; hydra:returns ; diff --git a/lib/log.ts b/lib/log.ts index 4781008..2e74fd1 100644 --- a/lib/log.ts +++ b/lib/log.ts @@ -1,6 +1,6 @@ import debug0 from 'debug' -const debug = debug0('hydra-box') +const debug = debug0('kopflos:core') export default (ns: string) => { if (ns) { diff --git a/package-lock.json b/package-lock.json index 146e2b8..3cd823d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "hydra-box", - "version": "0.7.0", + "name": "@kopflos/core", + "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "hydra-box", - "version": "0.7.0", + "name": "@kopflos/core", + "version": "0.1.0", "license": "MIT", "dependencies": { "@rdfjs/express-handler": "^2.0.0", diff --git a/package.json b/package.json index d6e241a..44de9f4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "hydra-box", - "description": "Hydra Box middleware", - "version": "0.7.0", + "name": "@kopflos/core", + "description": "Hydra middleware for web APIs", + "version": "0.1.0", "main": "index.js", "type": "module", "scripts": { @@ -9,20 +9,27 @@ "test": "c8 --all --reporter lcovonly --reporter text mocha", "build": "tsc", "preblog": "npm run build", - "blog": "(cd examples/blog; bash init.sh --keep; DEBUG=hydra-box* nodemon --ext ttl,js,json --exec node --inspect=0.0.0.0:9001 server.js)", + "blog": "(cd examples/blog; bash init.sh --keep; DEBUG=kopflos:core* nodemon --ext ttl,js,json --exec node --inspect=0.0.0.0:9001 server.js)", "prepack": "npm run build", "release": "changeset publish" }, - "author": "Thomas Bergwinkl (https://www.bergnet.org/people/bergi/card#me)", + "author": "Zazuko GmbH", + "contributors": [ + { + "name": "Thomas Bergwinkl", + "email": "bergi@axolotlfarm.org", + "url": "https://www.bergnet.org/people/bergi/card#me" + } + ], "license": "MIT", "repository": { "type": "git", - "url": "git://github.com/zazuko/hydra-box.git" + "url": "git://github.com/zazuko/kopflos.git" }, "bugs": { - "url": "https://github.com/zazuko/hydra-box/issues" + "url": "https://github.com/zazuko/kopflos/issues" }, - "homepage": "https://github.com/zazuko/hydra-box", + "homepage": "https://github.com/zazuko/kopflos", "dependencies": { "@rdfjs/express-handler": "^2.0.0", "@zazuko/env-node": "^2.1.1", diff --git a/test/middleware.test.js b/test/middleware.test.js index 2a1591c..2ef34a0 100644 --- a/test/middleware.test.js +++ b/test/middleware.test.js @@ -12,7 +12,7 @@ import hydraBox from '../middleware.js' const example = RDF.namespace('http://example.org/') -describe('hydra-box', () => { +describe('@kopflos/core', () => { let api beforeEach(() => {