@dalet-oss/express-http-context 1.2.1 → 1.2.2

package/lib/cjs/index.js

@@ -6,7 +6,11 @@ if (!global.expressHttpContextStorage) {
     global.expressHttpContextStorage = new async_hooks_1.AsyncLocalStorage();
 }
 /**
- * Express.js middleware that is responsible for initializing the context for each request.
+ * Express.js middleware that is responsible for initializing the context for
+ * each request.
+ *
+ * Declared as type 'any' because otherwise Typescript consumers can get tie
+ * themselves in knots.
  */
 const middleware = (_req, _res, next) => {
     global.expressHttpContextStorage.run(new Map(), () => next());
@@ -14,8 +18,9 @@ const middleware = (_req, _res, next) => {
 exports.middleware = middleware;
 /**
  * Gets a value from the context by key.
- * Will return undefined if the context has not yet been initialized for this request
- * or if a value is not found for the specified key.
+ *
+ * Will return undefined if the context has not yet been initialized for this
+ * request, or if a value is not found for the specified key.
  */
 function get(key) {
     const store = global.expressHttpContextStorage.getStore();
@@ -24,12 +29,20 @@ function get(key) {
 exports.get = get;
 /**
  * Adds a value to the context by key.
+ *
  * If the key already exists, its value will be overwritten.
- * No value will persist if the context has not yet been initialized.
+ * No value will be persisted if the context has not yet been initialized.
+ *
+ * Returns the value that was set, or undefined if the context has not yet been
+ * initialized for this request.
  */
 function set(key, value) {
     const store = global.expressHttpContextStorage.getStore();
-    store?.set(key, value);
+    if (store) {
+        store.set(key, value);
+        return value;
+    }
+    return undefined;
 }
 exports.set = set;
 exports.default = { get, middleware: exports.middleware, set };

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA+C;AAS/C,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,+BAAiB,EAAoB,CAAA;CAC5E;AAID;;GAEG;AACI,MAAM,UAAU,GAAmB,CACzC,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AANY,QAAA,UAAU,cAMtB;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AALD,kBAKC;AAED;;;;GAIG;AACH,SAAgB,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AALD,kBAKC;AAED,kBAAe,EAAE,GAAG,EAAE,UAAU,EAAV,kBAAU,EAAE,GAAG,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAUhD,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,+BAAiB,EAAoB,CAAC;CAC7E;AAGD;;;;;;GAMG;AACI,MAAM,UAAU,GAAQ,CAC9B,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAA;AANY,QAAA,UAAU,cAMtB;AAGD;;;;;GAKG;AACH,SAAgB,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AALD,kBAKC;AAGD;;;;;;;;GAQG;AACH,SAAgB,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAEvD,IAAI,KAAK,EAAE;QACP,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAVD,kBAUC;AAGD,kBAAe,EAAE,GAAG,EAAE,UAAU,EAAV,kBAAU,EAAE,GAAG,EAAE,CAAA"}

package/lib/esm/index.js

@@ -3,15 +3,20 @@ if (!global.expressHttpContextStorage) {
     global.expressHttpContextStorage = new AsyncLocalStorage();
 }
 /**
- * Express.js middleware that is responsible for initializing the context for each request.
+ * Express.js middleware that is responsible for initializing the context for
+ * each request.
+ *
+ * Declared as type 'any' because otherwise Typescript consumers can get tie
+ * themselves in knots.
  */
 export const middleware = (_req, _res, next) => {
     global.expressHttpContextStorage.run(new Map(), () => next());
 };
 /**
  * Gets a value from the context by key.
- * Will return undefined if the context has not yet been initialized for this request
- * or if a value is not found for the specified key.
+ *
+ * Will return undefined if the context has not yet been initialized for this
+ * request, or if a value is not found for the specified key.
  */
 export function get(key) {
     const store = global.expressHttpContextStorage.getStore();
@@ -19,12 +24,20 @@ export function get(key) {
 }
 /**
  * Adds a value to the context by key.
+ *
  * If the key already exists, its value will be overwritten.
- * No value will persist if the context has not yet been initialized.
+ * No value will be persisted if the context has not yet been initialized.
+ *
+ * Returns the value that was set, or undefined if the context has not yet been
+ * initialized for this request.
  */
 export function set(key, value) {
     const store = global.expressHttpContextStorage.getStore();
-    store?.set(key, value);
+    if (store) {
+        store.set(key, value);
+        return value;
+    }
+    return undefined;
 }
 export default { get, middleware, set };
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAS/C,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,iBAAiB,EAAoB,CAAA;CAC5E;AAID;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAmB,CACzC,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;AAC9D,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AAED,eAAe,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAUhD,IAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE;IACtC,MAAM,CAAC,yBAAyB,GAAG,IAAI,iBAAiB,EAAoB,CAAC;CAC7E;AAGD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAQ,CAC9B,IAAa,EACb,IAAc,EACd,IAAkB,EACX,EAAE;IACT,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAA;AAGD;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW;IAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAE1D,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAGD;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CAAU,GAAW,EAAE,KAAQ;IAEjD,MAAM,KAAK,GAAG,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC;IAEvD,IAAI,KAAK,EAAE;QACP,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAGD,eAAe,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAA"}

package/lib/types/index.d.ts

@@ -1,29 +1,36 @@
 /// <reference types="node" />
-/// <reference types="qs" />
 import { AsyncLocalStorage } from 'async_hooks';
-import type { RequestHandler } from 'express';
 declare global {
     var expressHttpContextStorage: AsyncLocalStorage<Map<string, any>>;
 }
 /**
- * Express.js middleware that is responsible for initializing the context for each request.
+ * Express.js middleware that is responsible for initializing the context for
+ * each request.
+ *
+ * Declared as type 'any' because otherwise Typescript consumers can get tie
+ * themselves in knots.
  */
-export declare const middleware: RequestHandler;
+export declare const middleware: any;
 /**
  * Gets a value from the context by key.
- * Will return undefined if the context has not yet been initialized for this request
- * or if a value is not found for the specified key.
+ *
+ * Will return undefined if the context has not yet been initialized for this
+ * request, or if a value is not found for the specified key.
  */
 export declare function get<T = any>(key: string): T | undefined;
 /**
  * Adds a value to the context by key.
+ *
  * If the key already exists, its value will be overwritten.
- * No value will persist if the context has not yet been initialized.
+ * No value will be persisted if the context has not yet been initialized.
+ *
+ * Returns the value that was set, or undefined if the context has not yet been
+ * initialized for this request.
  */
-export declare function set<T = any>(key: string, value: T): void;
+export declare function set<T = any>(key: string, value: T): T | undefined;
 declare const _default: {
     get: typeof get;
-    middleware: RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+    middleware: any;
     set: typeof set;
 };
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dalet-oss/express-http-context",
-    "version": "1.2.1",
+    "version": "1.2.2",
     "description": "Modern request-scoped storage support for Express.js based on Asynchronous Local Storage.",
     "author": {
         "name": "Dalet OSS",

package/src/index.ts

@@ -1,5 +1,6 @@
-import { AsyncLocalStorage } from 'async_hooks'
-import type { NextFunction, RequestHandler, Request, Response } from 'express'
+import { AsyncLocalStorage } from 'async_hooks';
+import type { NextFunction, Request, Response } from 'express';
+
 
 declare global {
 	// eslint-disable-next-line no-var
@@ -8,44 +9,60 @@ declare global {
 
 
 if (!global.expressHttpContextStorage) {
-	global.expressHttpContextStorage = new AsyncLocalStorage<Map<string, any>>()
+	global.expressHttpContextStorage = new AsyncLocalStorage<Map<string, any>>();
 }
 
 
-
 /**
- * Express.js middleware that is responsible for initializing the context for each request.
+ * Express.js middleware that is responsible for initializing the context for
+ * each request.
+ *
+ * Declared as type 'any' because otherwise Typescript consumers can get tie
+ * themselves in knots.
  */
-export const middleware: RequestHandler = (
+export const middleware: any = (
 	_req: Request,
 	_res: Response,
 	next: NextFunction
 ): void => {
-	global.expressHttpContextStorage.run(new Map(), () => next())
+	global.expressHttpContextStorage.run(new Map(), () => next());
 }
 
+
 /**
  * Gets a value from the context by key.
- * Will return undefined if the context has not yet been initialized for this request
- * or if a value is not found for the specified key.
+ *
+ * Will return undefined if the context has not yet been initialized for this
+ * request, or if a value is not found for the specified key.
  */
 export function get<T = any>(key: string): T | undefined {
 
 	const store = global.expressHttpContextStorage.getStore();
 
-	return store?.get(key)
+	return store?.get(key);
 }
 
+
 /**
  * Adds a value to the context by key.
+ *
  * If the key already exists, its value will be overwritten.
- * No value will persist if the context has not yet been initialized.
+ * No value will be persisted if the context has not yet been initialized.
+ *
+ * Returns the value that was set, or undefined if the context has not yet been
+ * initialized for this request.
  */
-export function set<T = any>(key: string, value: T): void {
+export function set<T = any>(key: string, value: T): T | undefined {
 
 	const store = global.expressHttpContextStorage.getStore();
 
-	store?.set(key, value)
+    if (store) {
+        store.set(key, value);
+        return value;
+    }
+
+    return undefined;
 }
 
+
 export default { get, middleware, set }