@eik/service 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [4.0.0](https://github.com/eik-lib/service/compare/v3.0.0...v4.0.0) (2024-11-13)
+
+
+### Bug Fixes
+
+* add content type parser for multipart/form-data ([b629f76](https://github.com/eik-lib/service/commit/b629f762da4e7ad916efd61d73fbebffef67cfeb))
+
+
+### chore
+
+* upgrade pino ([ec4ecde](https://github.com/eik-lib/service/commit/ec4ecdea4ba0069d9c6d38a322a17a15df5259a3))
+* upgrade to Fastify 5 ([37ec354](https://github.com/eik-lib/service/commit/37ec3541c1b2764b71cc74ec14f37ab2feca1ea1))
+
+
+### BREAKING CHANGES
+
+* no longer supports the content type `multipart`.
+* Requires Node 20
+* requires fastify 5.x
+
 # [3.0.0](https://github.com/eik-lib/service/compare/v2.3.2...v3.0.0) (2024-08-22)
 
 

package/bin/eik-server.js

@@ -1,26 +1,26 @@
 #!/usr/bin/env node
 /* eslint-disable no-unused-vars */
-import Fastify from 'fastify';
-import Eik from '../lib/main.js';
+import Fastify from "fastify";
+import Eik from "../lib/main.js";
 
 const eik = new Eik();
 
 const app = Fastify({
-    ignoreTrailingSlash: true,
-    modifyCoreObjects: false,
-    trustProxy: true,
-    http2: eik.config.get('http.http2'),
+	ignoreTrailingSlash: true,
+	modifyCoreObjects: false,
+	trustProxy: true,
+	http2: eik.config.get("http.http2"),
 });
 
 await app.register(eik.api());
 
 try {
-    await eik.health();
+	await eik.health();
 } catch (error) {
-    // Do accept errors
+	// Do accept errors
 }
 
 await app.listen({
-    port: eik.config.get('http.port'),
-    host: eik.config.get('http.address'),
+	port: eik.config.get("http.port"),
+	host: eik.config.get("http.address"),
 });

package/lib/config.js

@@ -1,171 +1,169 @@
 /* eslint-disable no-unused-vars */
-import convict from 'convict';
-import yaml from 'js-yaml';
-import pino from 'pino';
-import path from 'path';
-import fs from 'fs';
-import os from 'os';
+import convict from "convict";
+import yaml from "js-yaml";
+import pino from "pino";
+import path from "path";
+import fs from "fs";
+import os from "os";
 
 const CWD = process.cwd();
 
 let pack = {};
 try {
-    pack = JSON.parse(fs.readFileSync(path.join(CWD, 'package.json'), 'utf-8'));
+	pack = JSON.parse(fs.readFileSync(path.join(CWD, "package.json"), "utf-8"));
 } catch (error) {
-    /* empty */
+	/* empty */
 }
 
-convict.addParser({ extension: ['yml', 'yaml'], parse: yaml.load });
+convict.addParser({ extension: ["yml", "yaml"], parse: yaml.load });
 
 convict.addFormat({
-    name: 'secret-string',
-    validate: (value) => {
-        if (typeof value !== 'string') {
-            throw new Error('Value must be a String');
-        }
-    },
-    coerce: (value) => {
-        if (path.isAbsolute(value)) {
-            try {
-                const file = fs.readFileSync(value);
-                return file.toString();
-            } catch (error) {
-                throw new Error(
-                    `Config could not load secret from path: ${value}`,
-                );
-            }
-        }
-        return value;
-    },
+	name: "secret-string",
+	validate: (value) => {
+		if (typeof value !== "string") {
+			throw new Error("Value must be a String");
+		}
+	},
+	coerce: (value) => {
+		if (path.isAbsolute(value)) {
+			try {
+				const file = fs.readFileSync(value);
+				return file.toString();
+			} catch (error) {
+				throw new Error(`Config could not load secret from path: ${value}`);
+			}
+		}
+		return value;
+	},
 });
 
 const conf = convict({
-    name: {
-        doc: 'Name of the apllication',
-        default: pack.name,
-        format: String,
-    },
-    env: {
-        doc: 'Applicaton environments',
-        format: ['development', 'production'],
-        default: 'development',
-        env: 'NODE_ENV',
-        arg: 'node-env',
-    },
-    metrics: {
-        format: Boolean,
-        default: true,
-        env: 'METRICS',
-    },
-    log: {
-        level: {
-            doc: 'Log level to log at',
-            format: ['trace', 'debug', 'info', 'warn', 'error', 'fatal'],
-            default: 'info',
-            env: 'LOG_LEVEL',
-            arg: 'log-level',
-        },
-    },
-    http: {
-        http2: {
-            doc: 'Enable http2 for the server',
-            format: Boolean,
-            default: false,
-            env: 'HTTP_HTTP2',
-        },
-        address: {
-            doc: 'The address the http server should bind to',
-            format: String,
-            default: 'localhost',
-            env: 'HTTP_ADDRESS',
-        },
-        port: {
-            doc: 'The port the http server should bind to',
-            format: 'port',
-            default: 4001,
-            env: 'HTTP_PORT',
-        },
-    },
-    compression: {
-        global: {
-            doc: 'Enable global compression for all http routes',
-            format: Boolean,
-            default: true,
-            env: 'COMPRESSION_GLOBAL',
-        },
-    },
-    jwt: {
-        secret: {
-            doc: 'Secret used for JWT signing',
-            format: 'secret-string',
-            default: 'change_me',
-            env: 'AUTH_JWT_SECRET',
-            sensitive: true,
-        },
-        expire: {
-            doc: 'Expire time for JWT',
-            format: String,
-            default: '60d',
-            env: 'AUTH_JWT_EXPIRE',
-        },
-    },
-    basicAuth: {
-        type: {
-            doc: 'Type of basic auth to use',
-            format: ['key', 'disabled'],
-            default: 'key',
-            env: 'BASIC_AUTH_TYPE',
-        },
-        key: {
-            doc: 'Key used for basic authorization',
-            format: 'secret-string',
-            default: 'change_me',
-            env: 'BASIC_AUTH_KEY',
-            sensitive: true,
-        },
-    },
-    organization: {
-        name: {
-            doc: 'Organization name - Used as a folder name in the storage of files',
-            format: String,
-            default: 'local',
-            env: 'ORG_NAME',
-        },
-        hostnames: {
-            doc: 'Hostnames the organization maps to',
-            format: Array,
-            default: ['localhost', '127.0.0.1'],
-            env: 'ORG_HOSTNAMES',
-        },
-    },
-    sink: {
-        type: {
-            doc: 'Type of sink to use',
-            format: ['fs', 'mem', 'test'],
-            default: 'fs',
-            env: 'SINK_TYPE',
-        },
-        path: {
-            doc: 'Absolute path to store files in when using the "fs" sink',
-            format: String,
-            default: path.join(os.tmpdir(), 'eik'),
-            env: 'SINK_PATH',
-        },
-    },
+	name: {
+		doc: "Name of the apllication",
+		default: pack.name,
+		format: String,
+	},
+	env: {
+		doc: "Applicaton environments",
+		format: ["development", "production"],
+		default: "development",
+		env: "NODE_ENV",
+		arg: "node-env",
+	},
+	metrics: {
+		format: Boolean,
+		default: true,
+		env: "METRICS",
+	},
+	log: {
+		level: {
+			doc: "Log level to log at",
+			format: ["trace", "debug", "info", "warn", "error", "fatal"],
+			default: "info",
+			env: "LOG_LEVEL",
+			arg: "log-level",
+		},
+	},
+	http: {
+		http2: {
+			doc: "Enable http2 for the server",
+			format: Boolean,
+			default: false,
+			env: "HTTP_HTTP2",
+		},
+		address: {
+			doc: "The address the http server should bind to",
+			format: String,
+			default: "localhost",
+			env: "HTTP_ADDRESS",
+		},
+		port: {
+			doc: "The port the http server should bind to",
+			format: "port",
+			default: 4001,
+			env: "HTTP_PORT",
+		},
+	},
+	compression: {
+		global: {
+			doc: "Enable global compression for all http routes",
+			format: Boolean,
+			default: true,
+			env: "COMPRESSION_GLOBAL",
+		},
+	},
+	jwt: {
+		secret: {
+			doc: "Secret used for JWT signing",
+			format: "secret-string",
+			default: "change_me",
+			env: "AUTH_JWT_SECRET",
+			sensitive: true,
+		},
+		expire: {
+			doc: "Expire time for JWT",
+			format: String,
+			default: "60d",
+			env: "AUTH_JWT_EXPIRE",
+		},
+	},
+	basicAuth: {
+		type: {
+			doc: "Type of basic auth to use",
+			format: ["key", "disabled"],
+			default: "key",
+			env: "BASIC_AUTH_TYPE",
+		},
+		key: {
+			doc: "Key used for basic authorization",
+			format: "secret-string",
+			default: "change_me",
+			env: "BASIC_AUTH_KEY",
+			sensitive: true,
+		},
+	},
+	organization: {
+		name: {
+			doc: "Organization name - Used as a folder name in the storage of files",
+			format: String,
+			default: "local",
+			env: "ORG_NAME",
+		},
+		hostnames: {
+			doc: "Hostnames the organization maps to",
+			format: Array,
+			default: ["localhost", "127.0.0.1"],
+			env: "ORG_HOSTNAMES",
+		},
+	},
+	sink: {
+		type: {
+			doc: "Type of sink to use",
+			format: ["fs", "mem", "test"],
+			default: "fs",
+			env: "SINK_TYPE",
+		},
+		path: {
+			doc: 'Absolute path to store files in when using the "fs" sink',
+			format: String,
+			default: path.join(os.tmpdir(), "eik"),
+			env: "SINK_PATH",
+		},
+	},
 });
 
-const env = conf.get('env');
+const env = conf.get("env");
 
 // @ts-expect-error This is in fact callable
 const logger = pino({
-    level: conf.get('log.level'),
-    name: conf.get('name'),
+	level: conf.get("log.level"),
+	name: conf.get("name"),
 });
 
 try {
-    conf.loadFile(path.join(CWD, 'config', `${env}.yaml`));
+	conf.loadFile(path.join(CWD, "config", `${env}.yaml`));
 } catch (error) {
-    logger.error(error);
+	logger.error(error);
 }
 
 conf.validate();