# trifid-core
## 6.1.0
### Minor Changes
- ae47ffc: Add support for serving an instance under a subpath.
Instances are served at the root of a domain by default. Deployments that only
have a subdomain, and already serve other things on it, can now mount Trifid
under a subpath instead:
```yaml
server:
subpath: /SUBPATH
```
A resource whose IRI is `http://example.org/path/resource` is then served as
`https://example.com/SUBPATH/path/resource`. The subpath is applied to the
routes of every plugin, to the static files, to the templates, and to the IRI
rewriting, so links and content negotiation keep pointing at the right place.
Endpoint URLs configured as root-relative paths (such as `url: /query`) refer to
a route of the instance itself, so they now resolve under the subpath too and do
not need to be adjusted.
Templates receive the subpath as the `subpath` variable, which always ends with a
slash so that it can be interpolated directly:
```handlebars
```
Plugins receive it as `subpath` on their argument, and `normalizeSubpath` /
`joinSubpath` are exported to help them mount their own static files.
The default value is `/`, which is exactly the previous behaviour, so existing
configurations and plugins are unaffected.
### Patch Changes
- e83a5ba: Report an unusable template file in the `view` plugin instead of failing on the
first request.
The template is only read when a request comes in, so a `path` pointing at a
file that does not exist, cannot be read, or is not a file at all stayed
unnoticed until the route was hit and answered with a 500. Those cases are now
reported as an error when the instance starts:
```
ERROR (welcome): the template file '/srv/trifid/welcome.hbs' does not exist
ERROR (welcome): the template file '/srv/trifid/welcome.hbs' cannot be read (permission denied)
ERROR (welcome): the template path '/srv/trifid/views' is not a file
```
A missing `path` field is now logged as well, in addition to the error that was
already thrown.
## 6.0.3
### Patch Changes
- 4c40e5d: Update `fastify` to `^5.12.1`.
## 6.0.2
### Patch Changes
- 967c329: Update dependencies: `fastify` to `^5.12.0`, `yaml` to `^2.9.0`, and
`@fontsource/playfair-display` / `@fontsource/roboto` to `^5.3.0`.
## 6.0.1
### Patch Changes
- b0af3b4: Fix module resolution in trifid-core.
## 6.0.0
### Major Changes
- 3c9ceba: Convert the whole codebase into TypeScript.
This is is marked as a major change, as some imports may need to be updated.
- 51ea8bc: New design ; this updates some styles and elements. For people that were doing some customizations, it may be a breaking change.
## 5.3.2
### Patch Changes
- cc82fa2: Do not show warnings for empty (but defined) environment variables.
## 5.3.1
### Patch Changes
- b3137cd: Include `otel.js` which was missing if using the npm module directly.
## 5.3.0
### Minor Changes
- c1b8591: Export OpenTelemetry metrics
### Patch Changes
- e124f78: Use default environment variables to configure OpenTelemetry
## 5.2.0
### Minor Changes
- 7d21f77: Add OpenTelemetry support.
Just start Trifid with the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable set to your OpenTelemetry endpoint, like `https://example.com/v1/traces`.
## 5.1.2
### Patch Changes
- 98fee3a: Upgrade `@fastify/compress` to 8.1.0 so that it supports zstd
## 5.1.1
### Patch Changes
- 51abb95: Bump `@fastify/cors` from 10.0.2 to 11.0.0.
This only adds CORS headers on `GET`, `POST` and `HEAD` methods.
## 5.1.0
### Minor Changes
- 007e201: Upgrade Fastify to v5.
### Patch Changes
- 080f5d8: Harmonize author and keywords fields
- a97a6a0: Use Apache 2.0 license
## 5.0.2
### Patch Changes
- b26b6e9: Add support for turtle compression
## 5.0.1
### Patch Changes
- 76c0832: Add compression support for additional content-types: n-triples, n-quads, trig and JSON SPARQL results.
## 5.0.0
### Major Changes
- 1cafa55: Support for compression by default.
This change is considered as a breaking change as the `routeHandler` now needs to return the `reply` object in order to be compatible with the support for compression. This is necessary to allow the server to handle the compression of the response.
Before migrating, make sure to update your custom plugins and upgrade all plugins to the latest version.
### Patch Changes
- 1cafa55: Return `reply` in the `routeHandler`, in order to be compatible with the support for compression.
## 4.1.0
### Minor Changes
- 27d3bc1: Introduce a `server.logFormat` configuration option, to either output JSON or pretty-formated logs.
## 4.0.7
### Patch Changes
- b03bdb5: Fix support of root path for the static plugin.
- eff233a: Export `getListenerURL` function that can be used for any test case for example.
## 4.0.6
### Patch Changes
- 2346a1c: Bump `pino` from 8.20.0 to 9.1.0
## 4.0.5
### Patch Changes
- 009d545: Upgrade `sparql-http-client` to v3.0.0
## 4.0.4
### Patch Changes
- 46e7670: Add support for `application/sparql-query` content type
## 4.0.3
### Patch Changes
- 2a6b31f: Add a `server.options` field to configure the Fastify instance with extra fields.
Here is a list of all supported options: https://fastify.dev/docs/latest/Reference/Server/#factory
- 2a6b31f: Remove old `server.express` configuration field, which was deprecated.
## 4.0.2
### Patch Changes
- 3f2271d: Allow to send custom headers to a SPARQL endpoint using the `query` function
## 4.0.1
### Patch Changes
- 6667f40: The locals plugins should use the cookies path set as `/`.
## 4.0.0
### Major Changes
- e8faa76: The `render` function requires the request as first argument.
## 3.0.0
### Major Changes
- 849fa3d: Health check is now exposed at `/healthz` instead of `/health`
- 4b515f8: Use 'plugins' instead of 'middlewares'
- 849fa3d: Trifid Plugins should return an object:
```js
/** @type {import('trifid-core/types/index.js').TrifidPlugin} */
const factory = async (trifid) => {
return {
defaultConfiguration: async () => {
return {
methods: ["GET"],
paths: ["/hello"],
// ...
};
},
routeHandler: async () => {
/**
* Route handler.
* @param {import('fastify').FastifyRequest} _request Request.
* @param {import('fastify').FastifyReply} reply Reply.
*/
const handler = async (_request, reply) => {
reply.send("Hello, world!");
};
return handler;
},
};
};
export default factory;
```
The factory should also be a promise.
Previously, the factory was a function that returned an Express middleware.
Since the move to Fastify, we are now returning an object with two methods: `defaultConfiguration` and `routeHandler`.
The `routeHandler` method should return a route handler function.
The `defaultConfiguration` method should return the default configuration for the plugin.
This allows the user to use the plugin with the default configuration or to override it.
This can be useful to simplify the Trifid configuration files.
- d9963cd: Remove the `rewrite` middleware
### Minor Changes
- a454dbb: Expose a `query` function that can be used in all plugins to perform a SPARQL query
- 1dd9ae7: Allow listening on a random port by using port `0`.
### Patch Changes
- 3ab5eb3: Add support for JSON-encoded and URL-encoded bodies by default
- 69d6ad0: Improve included TypeScript types.
## 2.7.1
### Patch Changes
- 371f4f8: Do not display a body in case of errors.
This is not possible without breaking components that are using hijackresponse for now.
## 2.7.0
### Minor Changes
- a94543c: Improve types in general.
`trifid.start` now returns a `Promise` instead of `void`.
This allows to wait for the server to be ready before doing anything else.
- 552ecf9: The errors middleware is now returning the description of the status code in the body.
## 2.6.3
### Patch Changes
- cb227a3: Use toString method to convert IRI URL into a string
- 141786b: Upgrade dependencies
## 2.6.2
### Patch Changes
- 735bf99: Import trifid-core into trifid mono-repo.
## 2.6.1
### Patch Changes
- 42a309f: Upgrade yaml to 2.2.2
- 42a309f: Upgrade some dev dependencies
- 42a309f: Upgrade pino to 8.14.1
- 42a309f: Upgrade commander to 10.0.1
## 2.6.0
### Minor Changes
- 6b895c8: Publish lock file and upgrade some dependencies
## 2.5.6
### Patch Changes
- 19979b7: Have more open CORS policy