@eik/service 2.2.1 → 2.3.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [2.3.1](https://github.com/eik-lib/service/compare/v2.3.0...v2.3.1) (2024-08-19)
+
+
+### Bug Fixes
+
+* add support for windows hosts ([ed263d6](https://github.com/eik-lib/service/commit/ed263d6ed72cc21ad89d0fb3c27b06ca96c6d416))
+
+# [2.3.0](https://github.com/eik-lib/service/compare/v2.2.1...v2.3.0) (2024-08-14)
+
+
+### Bug Fixes
+
+* set defaults to max types ([a5b67e3](https://github.com/eik-lib/service/commit/a5b67e335d006c84d8796dc3b7ede7455caf9de9))
+* update @eik/core to v1.4.0 ([a09d12c](https://github.com/eik-lib/service/commit/a09d12c1f24ad2c2eadbfffbd0d47cf14ef3e2b6))
+
+
+### Features
+
+* add routes for /img/ with configurable upload limit ([0f6bda7](https://github.com/eik-lib/service/commit/0f6bda7a3b3c7ddc5f3f9959a9c1056616184981))
+
 ## [2.2.1](https://github.com/eik-lib/service/compare/v2.2.0...v2.2.1) (2024-08-12)
 
 

package/README.md

@@ -1,6 +1,7 @@
-# Eik HTTP Service
+# @eik/service
 
-As a standalone running HTTP service exposing the Eik Service.
+This is the [HTTP server](https://eik.dev/docs/server/) running the Eik service.
+The implementation for the different [HTTP endpoints](https://eik.dev/docs/server/http-api) are in [`@eik/core`](https://github.com/eik-lib/core#readme).
 
 ## Installation
 

package/lib/config.js

@@ -2,7 +2,7 @@
 import convict from 'convict';
 import yaml from 'js-yaml';
 import pino from 'pino';
-import path, { join } from 'path';
+import path from 'path';
 import fs from 'fs';
 import os from 'os';
 
@@ -10,7 +10,7 @@ const CWD = process.cwd();
 
 let pack = {};
 try {
-    pack = JSON.parse(fs.readFileSync(join(CWD, 'package.json'), 'utf-8'));
+    pack = JSON.parse(fs.readFileSync(path.join(CWD, 'package.json'), 'utf-8'));
 } catch (error) {
     /* empty */
 }
@@ -148,7 +148,7 @@ const conf = convict({
         path: {
             doc: 'Absolute path to store files in when using the "fs" sink',
             format: String,
-            default: path.join(os.tmpdir(), '/eik'),
+            default: path.join(os.tmpdir(), 'eik'),
             env: 'SINK_PATH',
         },
     },
@@ -163,7 +163,7 @@ const logger = pino({
 });
 
 try {
-    conf.loadFile(path.join(CWD, `/config/${env}.yaml`));
+    conf.loadFile(path.join(CWD, 'config', `${env}.yaml`));
 } catch (error) {
     logger.error(error);
 }

package/lib/main.js

@@ -20,6 +20,7 @@ import * as utils from './utils.js';
  * @property {string} [notFoundCacheControl="public, max-age=5"]
  * @property {number} [pkgMaxFileSize=10000000] The limit in bytes before PUT /pkg/ starts returning 413 Content Too Large
  * @property {number} [mapMaxFileSize=1000000] The limit in bytes before PUT /map/ starts returning 413 Content Too Large
+ * @property {number} [imgMaxFileSize=20000000] The limit in bytes before PUT /img/ starts returning 413 Content Too Large
  */
 
 const EikService = class EikService {
@@ -32,8 +33,9 @@ const EikService = class EikService {
             customSink,
             notFoundCacheControl,
             aliasCacheControl,
-            pkgMaxFileSize,
-            mapMaxFileSize,
+            pkgMaxFileSize = 10000000,
+            mapMaxFileSize = 1000000,
+            imgMaxFileSize = 20000000,
         } = options;
         this._notFoundCacheControl =
             notFoundCacheControl || 'public, max-age=5';
@@ -104,6 +106,12 @@ const EikService = class EikService {
             logger,
             pkgMaxFileSize,
         });
+        this._imgPut = new eik.http.PkgPut({
+            organizations,
+            sink,
+            logger,
+            pkgMaxFileSize: imgMaxFileSize,
+        });
         this._mapGet = new eik.http.MapGet({ organizations, sink, logger });
         this._mapPut = new eik.http.MapPut({
             organizations,
@@ -351,6 +359,21 @@ const EikService = class EikService {
                 reply.redirect(outgoing.location);
             };
 
+            const imgPutRoute = async (request, reply) => {
+                const params = utils.sanitizeParameters(request.raw.url);
+                const outgoing = await this._imgPut.handler(
+                    request.raw,
+                    request.user,
+                    params.type,
+                    params.name,
+                    params.version,
+                );
+                reply.header('cache-control', outgoing.cacheControl);
+                reply.type(outgoing.mimeType);
+                reply.code(outgoing.statusCode);
+                reply.redirect(outgoing.location);
+            };
+
             const mapGetRoute = async (request, reply) => {
                 const params = utils.sanitizeParameters(request.raw.url);
                 const outgoing = await this._mapGet.handler(
@@ -547,6 +570,56 @@ const EikService = class EikService {
                 pkgPutRoute,
             );
 
+            //
+            // Image Packages
+            //
+
+            // Get public IMG package - scoped
+            // curl -X GET http://localhost:4001/img/@cuz/fuzz/8.4.1/main/picture.jpg
+            app.get(
+                `/${eik.prop.base_img}/@:scope/:name/:version/*`,
+                pkgGetRoute,
+            );
+
+            // Get public IMG package - non-scoped
+            // curl -X GET http://localhost:4001/img/fuzz/8.4.1/main/picture.jpg
+            app.get(`/${eik.prop.base_img}/:name/:version/*`, pkgGetRoute);
+
+            // Get IMG package overview - scoped
+            // curl -X GET http://localhost:4001/img/@cuz/fuzz/8.4.1/
+            app.get(
+                `/${eik.prop.base_img}/@:scope/:name/:version`,
+                pkgLogRoute,
+            );
+
+            // Get IMG package overview - non-scoped
+            // curl -X GET http://localhost:4001/img/fuzz/8.4.1/
+            app.get(`/${eik.prop.base_img}/:name/:version`, pkgLogRoute);
+
+            // Get IMG package versions - scoped
+            // curl -X GET http://localhost:4001/img/@cuz/fuzz/
+            app.get(`/${eik.prop.base_img}/@:scope/:name`, versionsGetRoute);
+
+            // Get IMG package versions - non-scoped
+            // curl -X GET http://localhost:4001/img/fuzz/
+            app.get(`/${eik.prop.base_img}/:name`, versionsGetRoute);
+
+            // Put IMG package - scoped
+            // curl -X PUT -i -F filedata=@archive.tgz http://localhost:4001/img/@cuz/fuzz/8.4.1/
+            app.put(
+                `/${eik.prop.base_img}/@:scope/:name/:version`,
+                authOptions,
+                imgPutRoute,
+            );
+
+            // Put IMG package - non-scoped
+            // curl -X PUT -i -F filedata=@archive.tgz http://localhost:4001/img/fuzz/8.4.1/
+            app.put(
+                `/${eik.prop.base_img}/:name/:version`,
+                authOptions,
+                imgPutRoute,
+            );
+
             //
             // Import Maps
             //
@@ -714,6 +787,70 @@ const EikService = class EikService {
                 aliasDelRoute,
             );
 
+            //
+            // Alias Image Packages
+            //
+
+            // curl -X GET -L http://localhost:4001/img/@cuz/fuzz/v8
+            app.get(
+                `/${eik.prop.base_img}/@:scope/:name/v:alias`,
+                aliasGetRoute,
+            );
+
+            // curl -X GET -L http://localhost:4001/img/fuzz/v8
+            app.get(`/${eik.prop.base_img}/:name/v:alias`, aliasGetRoute);
+
+            // curl -X GET -L http://localhost:4001/img/@cuz/fuzz/v8/main/index.js
+            app.get(
+                `/${eik.prop.base_img}/@:scope/:name/v:alias/*`,
+                aliasGetRoute,
+            );
+
+            // curl -X GET -L http://localhost:4001/img/fuzz/v8/main/index.js
+            app.get(`/${eik.prop.base_img}/:name/v:alias/*`, aliasGetRoute);
+
+            // curl -X PUT -i -F version=8.4.1 http://localhost:4001/img/@cuz/fuzz/v8
+            app.put(
+                `/${eik.prop.base_img}/@:scope/:name/v:alias`,
+                authOptions,
+                aliasPutRoute,
+            );
+
+            // curl -X PUT -i -F version=8.4.1 http://localhost:4001/img/fuzz/v8
+            app.put(
+                `/${eik.prop.base_img}/:name/v:alias`,
+                authOptions,
+                aliasPutRoute,
+            );
+
+            // curl -X POST -i -F version=8.4.1 http://localhost:4001/img/@cuz/lit-html/v8
+            app.post(
+                `/${eik.prop.base_img}/@:scope/:name/v:alias`,
+                authOptions,
+                aliasPostRoute,
+            );
+
+            // curl -X POST -i -F version=8.4.1 http://localhost:4001/img/lit-html/v8
+            app.post(
+                `/${eik.prop.base_img}/:name/v:alias`,
+                authOptions,
+                aliasPostRoute,
+            );
+
+            // curl -X DELETE http://localhost:4001/img/@cuz/fuzz/v8
+            app.delete(
+                `/${eik.prop.base_img}/@:scope/:name/v:alias`,
+                authOptions,
+                aliasDelRoute,
+            );
+
+            // curl -X DELETE http://localhost:4001/img/fuzz/v8
+            app.delete(
+                `/${eik.prop.base_img}/:name/v:alias`,
+                authOptions,
+                aliasDelRoute,
+            );
+
             //
             // Alias Import Maps
             //

package/lib/utils.js

@@ -1,15 +1,19 @@
 import path from 'path';
 
+function doJoin(a, b) {
+    return path.join(a, b).replace(/\\/g, '/');
+}
+
 const sanitizeExtras = (extras, version) => {
     if (version && extras) {
-        return path.join(version, extras);
+        return doJoin(version, extras);
     }
     return extras || '';
 };
 
 const sanitizeName = (scope, name) => {
     if (scope && name) {
-        return path.join(scope, name);
+        return doJoin(scope, name);
     }
     return scope || '';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/service",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "Eik REST API as a standalone HTTP service",
   "type": "module",
   "main": "./lib/main.js",
@@ -15,8 +15,10 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "start": "node ./bin/eik-server.js | pino-pretty",
-    "test": "cross-env LOG_LEVEL=fatal tap ./test --disable-coverage --allow-empty-coverage --serial=test",
-    "test:snapshots": "cross-env LOG_LEVEL=fatal tap --snapshot --disable-coverage --allow-empty-coverage --serial=test",
+    "test": "cross-env LOG_LEVEL=fatal npm run test:tap",
+    "test:ci": "cross-env LOG_LEVEL=trace npm run test:tap",
+    "test:snapshots": "cross-env LOG_LEVEL=fatal npm run test:tap -- --snapshot",
+    "test:tap": "tap ./test/**/*.test.js --disable-coverage --allow-empty-coverage",
     "types": "run-s types:module types:test",
     "types:module": "tsc",
     "types:test": "tsc --project tsconfig.test.json"
@@ -39,10 +41,10 @@
   },
   "homepage": "https://github.com/eik-lib/service#readme",
   "dependencies": {
-    "@eik/core": "1.3.58",
+    "@eik/core": "1.4.2",
     "@eik/sink": "1.2.5",
     "@eik/sink-file-system": "1.0.1",
-    "@eik/sink-memory": "1.1.1",
+    "@eik/sink-memory": "1.1.2",
     "@fastify/compress": "6.5.0",
     "@fastify/cors": "8.5.0",
     "@fastify/jwt": "7.2.4",
@@ -57,16 +59,18 @@
     "@eik/prettier-config": "1.0.1",
     "@eik/semantic-release-config": "1.0.0",
     "@eik/typescript-config": "1.0.0",
+    "@types/mime": "3.0.4",
+    "@types/readable-stream": "4.0.15",
     "cross-env": "7.0.3",
     "eslint": "9.8.0",
     "form-data": "4.0.0",
-    "node-fetch": "3.3.1",
+    "node-fetch": "3.3.2",
     "npm-run-all": "4.1.5",
     "pino-pretty": "10.3.1",
     "prettier": "3.3.3",
     "rimraf": "6.0.1",
     "semantic-release": "24.0.0",
-    "tap": "18.8.0",
+    "tap": "21.0.1",
     "typescript": "5.5.4",
     "unique-slug": "4.0.0"
   }

package/types/main.d.ts

@@ -16,6 +16,10 @@ export type EikServiceOptions = {
      * The limit in bytes before PUT /map/ starts returning 413 Content Too Large
      */
     mapMaxFileSize?: number;
+    /**
+     * The limit in bytes before PUT /img/ starts returning 413 Content Too Large
+     */
+    imgMaxFileSize?: number;
 };
 /**
  * @typedef {object} EikServiceOptions
@@ -26,6 +30,7 @@ export type EikServiceOptions = {
  * @property {string} [notFoundCacheControl="public, max-age=5"]
  * @property {number} [pkgMaxFileSize=10000000] The limit in bytes before PUT /pkg/ starts returning 413 Content Too Large
  * @property {number} [mapMaxFileSize=1000000] The limit in bytes before PUT /map/ starts returning 413 Content Too Large
+ * @property {number} [imgMaxFileSize=20000000] The limit in bytes before PUT /img/ starts returning 413 Content Too Large
  */
 declare const EikService: {
     new (options?: EikServiceOptions): {
@@ -422,6 +427,90 @@ declare const EikService: {
                 readonly [Symbol.toStringTag]: string;
             }>;
         };
+        _imgPut: {
+            _pkgMaxFileSize: number;
+            _organizations: [string, string][];
+            _cacheControl: string;
+            _sink: import("@eik/sink").default;
+            _log: import("abslog").ValidLogger;
+            _metrics: import("@metrics/client");
+            _histogram: import("@metrics/client").MetricsHistogram;
+            _orgRegistry: Map<string, string>;
+            _multipart: {
+                _pkgMaxFileSize: number;
+                _legalFields: string[];
+                _legalFiles: string[];
+                _sink: import("@eik/sink").default;
+                _log: import("abslog").ValidLogger;
+                parse(incoming: any): Promise<any>;
+                _handleField({ name, value }: {
+                    name: any;
+                    value: any;
+                }): {
+                    _value: string;
+                    _name: string;
+                    readonly value: string;
+                    readonly name: string;
+                    toJSON(): {
+                        value: string;
+                        name: string;
+                    };
+                    readonly [Symbol.toStringTag]: string;
+                };
+                _handleFile({ fieldname, file, filename, incoming }: {
+                    fieldname: any;
+                    file: any;
+                    filename: any;
+                    incoming: any;
+                }): Promise<any>;
+                _persistFile({ incoming, entry }: {
+                    incoming: any;
+                    entry: any;
+                }): Promise<any>;
+                readonly [Symbol.toStringTag]: string;
+            };
+            readonly metrics: import("@metrics/client");
+            _parser(incoming: any): Promise<any>;
+            _readVersions(incoming: any): Promise<{
+                _versions: Map<any, any>;
+                _type: string;
+                _name: string;
+                _org: string;
+                readonly versions: [any, any][];
+                readonly type: string;
+                readonly name: string;
+                readonly org: string;
+                setVersion(version: any, integrity: any): void;
+                getVersion(major: any): any;
+                check(version: any): boolean;
+                toJSON(): {
+                    versions: [any, any][];
+                    type: string;
+                    name: string;
+                    org: string;
+                };
+                readonly [Symbol.toStringTag]: string;
+            }>;
+            _readVersion(incoming: any): Promise<boolean>;
+            _writeVersions(incoming: any, versions: any): Promise<void>;
+            handler(req: any, user: any, type: any, name: any, version: any): Promise<{
+                _cacheControl: string;
+                _statusCode: number;
+                _mimeType: string;
+                _location: string;
+                _stream: any;
+                _body: any;
+                _etag: string;
+                cacheControl: string;
+                statusCode: number;
+                location: string;
+                mimeType: string;
+                stream: any;
+                body: any;
+                etag: string;
+                readonly [Symbol.toStringTag]: string;
+            }>;
+        };
         _mapGet: {
             _organizations: [string, string][];
             _cacheControl: string;