@eik/service 2.0.163 → 2.0.164

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.0.164](https://github.com/eik-lib/service/compare/v2.0.163...v2.0.164) (2024-07-31)
+
+
+### Bug Fixes
+
+* deprecate customSink and built-in sinks ([a1bd266](https://github.com/eik-lib/service/commit/a1bd2662d531994afcb9a591001d3100c97e8dcc))
+
 ## [2.0.163](https://github.com/eik-lib/service/compare/v2.0.162...v2.0.163) (2024-07-29)
 
 

package/README.md

@@ -1,2 +1,67 @@
-# service
-Eik REST API - As a standalone running HTTP service
+# Eik HTTP Service
+
+As a standalone running HTTP service exposing the Eik Service.
+
+## Installation
+
+```
+npm install @eik/service
+```
+
+## Usage
+
+This server can either be run as a Node executable, or as a Fastify plugin.
+
+### CLI
+
+This spins up the built-in Fastify server using configuration from your `config/` folder, or from environment variables.
+
+```sh
+npx @eik/service
+```
+
+### Fastify plugin
+
+For a production setup, the Fastify plugin method is recommended.
+
+```js
+import fastify from 'fastify';
+import Service from '@eik/service';
+import SinkGoogleCloudStorage from '@eik/sink-gcs';
+
+// Set up the Google Cloud Storage sink
+// https://github.com/eik-lib/sink-gcs?tab=readme-ov-file#example
+const sink = new SinkGoogleCloudStorage({
+    credentials: {
+        client_email: 'a@email.address',
+        private_key: '[ ...snip... ]',
+        projectId: 'myProject',
+    },
+});
+
+// Set up the Eik service as a plugin
+const service = new Service({ sink });
+
+// Set up Fastify
+const app = fastify({
+    ignoreTrailingSlash: true,
+    modifyCoreObjects: false,
+    trustProxy: true,
+});
+
+// Register the Eik service in Fastify
+app.register(service.api());
+
+// Start the server
+const run = async () => {
+    await service.health();
+    await app.listen(
+        service.config.get('http.port'),
+        service.config.get('http.address'),
+    );
+};
+
+run();
+```
+
+The example above shows the Google Cloud Storage sink. You can also use the [file system sink](https://github.com/eik-lib/sink-file-system), or implement the [sink interface](https://github.com/eik-lib/sink) for your own custom storage backend.

package/bin/eik-server.js

@@ -20,4 +20,7 @@ try {
     // Do accept errors
 }
 
-await app.listen(eik.config.get('http.port'), eik.config.get('http.address'));
+await app.listen({
+    port: eik.config.get('http.port'),
+    host: eik.config.get('http.address')
+});

package/lib/main.js

@@ -5,32 +5,48 @@ import pino from 'pino';
 import cors from '@fastify/cors';
 import jwt from '@fastify/jwt';
 import eik from '@eik/core';
+import SinkMemory from '@eik/sink-memory';
+import SinkFileSystem from '@eik/sink-file-system';
 
 
 import config from './config.js';
 import * as utils from './utils.js';
 
+/**
+ * @typedef {object} EikServiceOptions
+ * @property {import('@eik/sink').default} [sink]
+ * @property {import('@eik/sink').default} [customSink] [Deprecated] Use sink instead
+ * @property {string} [aliasCacheControl]
+ * @property {string} [notFoundCacheControl="public, max-age=5"]
+ */
+
 const EikService = class EikService {
-    constructor({
-        customSink,
-        notFoundCacheControl,
-        aliasCacheControl,
-    } = {}) {
+    /**
+     * @param {EikServiceOptions} [options={}]
+     */
+    constructor(options = {}) {
+        let { sink } = options;
+        const {
+            customSink,
+            notFoundCacheControl,
+            aliasCacheControl,
+        } = options;
         this._notFoundCacheControl = notFoundCacheControl || 'public, max-age=5';
         const logger = pino({
+            // @ts-ignore
             level: config.get('log.level'),
             name: config.get('name'),
         });
 
-        let sink;
         if (customSink) {
+            logger.warn('The `customSink` option is deprecated and will be removed at a later stage. Use `sink` to remove this warning.');
             sink = customSink;
         } else if (config.get('sink.type') === 'mem') {
             logger.info(`Server is running with a in memory sink. Uploaded files will be lost on restart!`);
-            sink = new eik.sink.MEM();
+            sink = new SinkMemory();
         } else {
             logger.info(`Server is running with the file system sink. Uploaded files will be stored under "${config.get('sink.path')}"`);
-            sink = new eik.sink.FS({ sinkFsRootPath: config.get('sink.path') });
+            sink = new SinkFileSystem({ sinkFsRootPath: config.get('sink.path') });
         }
 
         // Transform organization config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/service",
-  "version": "2.0.163",
+  "version": "2.0.164",
   "description": "Eik REST API as a standalone HTTP service",
   "type": "module",
   "main": "./lib/main.js",
@@ -33,7 +33,10 @@
   },
   "homepage": "https://github.com/eik-lib/service#readme",
   "dependencies": {
-    "@eik/core": "1.3.47",
+    "@eik/core": "1.3.48",
+    "@eik/sink": "1.2.5",
+    "@eik/sink-file-system": "1.0.1",
+    "@eik/sink-memory": "1.1.1",
     "@fastify/compress": "6.5.0",
     "@fastify/cors": "8.5.0",
     "@fastify/jwt": "7.2.4",