@eik/service 5.0.53 → 5.1.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.1.0](https://github.com/eik-lib/service/compare/v5.0.54...v5.1.0) (2025-10-13)
+
+
+### Features
+
+* add variant of alias GET routes that use stale-while-revalidate ([#688](https://github.com/eik-lib/service/issues/688)) ([b94cb4e](https://github.com/eik-lib/service/commit/b94cb4ec7146d916f96adfbcd7eb6bc7eb5b4924))
+
+## [5.0.54](https://github.com/eik-lib/service/compare/v5.0.53...v5.0.54) (2025-10-13)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @eik/core to v2.1.2 ([#687](https://github.com/eik-lib/service/issues/687)) ([d9fd353](https://github.com/eik-lib/service/commit/d9fd353b96c6d47375a7d8f7e18ddfe20c8d3d2a))
+
 ## [5.0.53](https://github.com/eik-lib/service/compare/v5.0.52...v5.0.53) (2025-10-06)
 
 

package/lib/main.js

@@ -18,6 +18,7 @@ import * as utils from "./utils.js";
  * @property {import('pino').Logger} [logger]
  * @property {import('@eik/sink').default} [customSink] [Deprecated] Use sink instead
  * @property {string} [aliasCacheControl]
+ * @property {string} [staleWhileRevalidateCacheControl] Set the cache-control header used by the stale-while-revalidate alias GET URLs
  * @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
@@ -33,6 +34,7 @@ const EikService = class EikService {
 		const {
 			customSink,
 			notFoundCacheControl,
+			staleWhileRevalidateCacheControl,
 			aliasCacheControl,
 			pkgMaxFileSize = 10000000,
 			mapMaxFileSize = 1000000,
@@ -92,6 +94,12 @@ const EikService = class EikService {
 			logger,
 			cacheControl: aliasCacheControl,
 		});
+		this._aliasGetSWR = new eik.http.AliasGetV2({
+			organizations,
+			sink,
+			logger,
+			cacheControl: staleWhileRevalidateCacheControl,
+		});
 		this._aliasPut = new eik.http.AliasPut({ organizations, sink, logger });
 		this._authPost = new eik.http.AuthPost({
 			organizations,
@@ -420,6 +428,23 @@ const EikService = class EikService {
 				reply.redirect(outgoing.location);
 			};
 
+			// Relies on stale-while-revalidate to serve the aliased asset without a redirect
+			const aliasGetSWRRoute = async (request, reply) => {
+				const params = utils.sanitizeParameters(request.raw.url);
+				const outgoing = await this._aliasGetSWR.handler(
+					request.raw,
+					params.type,
+					params.name,
+					params.alias,
+					params.extras,
+				);
+				reply.header("cache-control", outgoing.cacheControl);
+				reply.header("etag", outgoing.etag);
+				reply.type(outgoing.mimeType);
+				reply.code(outgoing.statusCode);
+				return reply.send(outgoing.stream);
+			};
+
 			const aliasPutRoute = async (request, reply) => {
 				const params = utils.sanitizeParameters(request.raw.url);
 				const outgoing = await this._aliasPut.handler(
@@ -641,6 +666,23 @@ const EikService = class EikService {
 			// curl -X GET -L http://localhost:4001/pkg/fuzz/v8/main/index.js
 			app.get(`/${eik.prop.base_pkg}/:name/v:alias/*`, aliasGetRoute);
 
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8
+			app.get(`/${eik.prop.base_pkg}/@:scope/:name/~:alias`, aliasGetRoute);
+
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8
+			app.get(`/${eik.prop.base_pkg}/:name/~:alias`, aliasGetRoute);
+
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8/main/index.js
+			app.get(
+				`/${eik.prop.base_pkg}/@:scope/:name/~:alias/*`,
+				aliasGetSWRRoute,
+			);
+
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8/main/index.js
+			app.get(`/${eik.prop.base_pkg}/:name/~:alias/*`, aliasGetSWRRoute);
+
 			// curl -X PUT -i -F version=8.4.1 http://localhost:4001/pkg/@cuz/fuzz/v8
 			app.put(
 				`/${eik.prop.base_pkg}/@:scope/:name/v:alias`,
@@ -699,6 +741,23 @@ const EikService = class EikService {
 			// curl -X GET -L http://localhost:4001/npm/fuzz/v8/main/index.js
 			app.get(`/${eik.prop.base_npm}/:name/v:alias/*`, aliasGetRoute);
 
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8
+			app.get(`/${eik.prop.base_npm}/@:scope/:name/~:alias`, aliasGetRoute);
+
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8
+			app.get(`/${eik.prop.base_npm}/:name/~:alias`, aliasGetRoute);
+
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8/main/index.js
+			app.get(
+				`/${eik.prop.base_npm}/@:scope/:name/~:alias/*`,
+				aliasGetSWRRoute,
+			);
+
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8/main/index.js
+			app.get(`/${eik.prop.base_npm}/:name/~:alias/*`, aliasGetSWRRoute);
+
 			// curl -X PUT -i -F version=8.4.1 http://localhost:4001/npm/@cuz/fuzz/v8
 			app.put(
 				`/${eik.prop.base_npm}/@:scope/:name/v:alias`,
@@ -757,6 +816,23 @@ const EikService = class EikService {
 			// curl -X GET -L http://localhost:4001/img/fuzz/v8/main/index.js
 			app.get(`/${eik.prop.base_img}/:name/v:alias/*`, aliasGetRoute);
 
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8
+			app.get(`/${eik.prop.base_img}/@:scope/:name/~:alias`, aliasGetRoute);
+
+			// Redirect these as usual, just a dev nicety
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8
+			app.get(`/${eik.prop.base_img}/:name/~:alias`, aliasGetRoute);
+
+			// curl -X GET -L http://localhost:4001/pkg/@cuz/fuzz/~8/main/index.js
+			app.get(
+				`/${eik.prop.base_img}/@:scope/:name/~:alias/*`,
+				aliasGetSWRRoute,
+			);
+
+			// curl -X GET -L http://localhost:4001/pkg/fuzz/~8/main/index.js
+			app.get(`/${eik.prop.base_img}/:name/~:alias/*`, aliasGetSWRRoute);
+
 			// 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`,

package/lib/utils.js

@@ -19,19 +19,26 @@ const sanitizeName = (scope, name) => {
 };
 
 const sanitizeAlias = (alias = "") => {
-	if (alias.startsWith("v")) {
+	if (alias.startsWith("v") || alias.startsWith("~")) {
 		return alias.slice(1);
 	}
 	return alias;
 };
 
+const sanitizeVersion = (version = "") => {
+	if (version.startsWith("~")) {
+		return `v${version.slice(1)}`;
+	}
+	return version;
+};
+
 const sanitizeParameters = (url = "") => {
 	const { pathname } = new URL(url, "http://localhost/");
 	const paths = pathname.split("/");
 
 	if (paths[2] && paths[2].startsWith("@")) {
 		return {
-			version: paths[4] || "",
+			version: sanitizeVersion(paths[4]),
 			extras: sanitizeExtras(paths.slice(5).join("/")),
 			alias: sanitizeAlias(paths[4]),
 			name: sanitizeName(paths[2] || "", paths[3] || ""),
@@ -40,7 +47,7 @@ const sanitizeParameters = (url = "") => {
 	}
 
 	return {
-		version: paths[3] || "",
+		version: sanitizeVersion(paths[3]),
 		extras: sanitizeExtras(paths.slice(4).join("/")),
 		alias: sanitizeAlias(paths[3]),
 		name: sanitizeName(paths[2] || ""),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/service",
-  "version": "5.0.53",
+  "version": "5.1.0",
   "description": "Eik REST API as a standalone HTTP service",
   "type": "module",
   "main": "./lib/main.js",
@@ -44,7 +44,7 @@
   },
   "homepage": "https://github.com/eik-lib/service#readme",
   "dependencies": {
-    "@eik/core": "2.1.0",
+    "@eik/core": "2.1.2",
     "@eik/sink": "1.2.5",
     "@eik/sink-file-system": "2.0.13",
     "@eik/sink-memory": "2.0.12",

package/types/main.d.ts

@@ -7,6 +7,10 @@ export type EikServiceOptions = {
      */
     customSink?: import("@eik/sink").default;
     aliasCacheControl?: string;
+    /**
+     * Set the cache-control header used by the stale-while-revalidate alias GET URLs
+     */
+    staleWhileRevalidateCacheControl?: string;
     notFoundCacheControl?: string;
     /**
      * The limit in bytes before PUT /pkg/ starts returning 413 Content Too Large
@@ -27,6 +31,7 @@ export type EikServiceOptions = {
  * @property {import('pino').Logger} [logger]
  * @property {import('@eik/sink').default} [customSink] [Deprecated] Use sink instead
  * @property {string} [aliasCacheControl]
+ * @property {string} [staleWhileRevalidateCacheControl] Set the cache-control header used by the stale-while-revalidate alias GET URLs
  * @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
@@ -164,6 +169,34 @@ declare const EikService: {
                 readonly [Symbol.toStringTag]: string;
             }>;
         };
+        _aliasGetSWR: {
+            _organizations: [string, string][];
+            _cacheControl: string;
+            _sink: import("@eik/sink").default;
+            _etag: boolean;
+            _log: import("abslog").ValidLogger;
+            _metrics: import("@metrics/client");
+            _histogram: import("@metrics/client").MetricsHistogram;
+            _orgRegistry: Map<string, string>;
+            readonly metrics: import("@metrics/client");
+            handler(req: any, type: any, name: any, alias: any, extra: 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;
+            }>;
+        };
         _aliasPut: {
             _organizations: [string, string][];
             _cacheControl: string;