@alanszp/shared-context 6.0.0

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/SharedContextNotInitializedException.d.ts

@@ -0,0 +1,4 @@
+import { BaseError } from "@alanszp/errors";
+export declare class SharedContextNotInitializedException extends BaseError {
+    constructor();
+}

package/dist/SharedContextNotInitializedException.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedContextNotInitializedException = void 0;
+const errors_1 = require("@alanszp/errors");
+class SharedContextNotInitializedException extends errors_1.BaseError {
+    constructor() {
+        super("Shared context wasn't initialized correctly.");
+    }
+}
+exports.SharedContextNotInitializedException = SharedContextNotInitializedException;
+//# sourceMappingURL=SharedContextNotInitializedException.js.map

package/dist/SharedContextNotInitializedException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharedContextNotInitializedException.js","sourceRoot":"","sources":["../src/SharedContextNotInitializedException.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAE5C,MAAa,oCAAqC,SAAQ,kBAAS;IACjE;QACE,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACxD,CAAC;CACF;AAJD,oFAIC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./sharedContext";
+export * from "./SharedContextNotInitializedException";

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./sharedContext"), exports);
+__exportStar(require("./SharedContextNotInitializedException"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,yEAAuD"}

package/dist/sharedContext.d.ts

@@ -0,0 +1,19 @@
+import { ILogger } from "@alanszp/logger";
+import { AuditWithState } from "@alanszp/audit";
+export interface SharedInternalContext {
+    audit: AuditWithState;
+    logger: ILogger;
+    lifecycleId: string;
+    lifecycleChain: string;
+    contextId: string;
+}
+export declare class SharedContext {
+    private context;
+    run<R>(executable: () => R, internalContext: SharedInternalContext): R;
+    getLogger(): ILogger | undefined;
+    getAudit(): AuditWithState | undefined;
+    getLifecycleId(): string | undefined;
+    getLifecycleChain(): string | undefined;
+    getContextId(): string | undefined;
+    private getFromContext;
+}

package/dist/sharedContext.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedContext = void 0;
+const async_hooks_1 = require("async_hooks");
+class SharedContext {
+    constructor() {
+        this.context = new async_hooks_1.AsyncLocalStorage();
+    }
+    run(executable, internalContext) {
+        const { audit, logger, contextId, lifecycleId, lifecycleChain } = internalContext;
+        return this.context.run(Object.assign(Object.assign({}, internalContext), { logger: logger.child({
+                lifecycleId,
+                lifecycleChain,
+            }) }), executable);
+    }
+    getLogger() {
+        return this.getFromContext("logger");
+    }
+    getAudit() {
+        return this.getFromContext("audit");
+    }
+    getLifecycleId() {
+        return this.getFromContext("lifecycleId");
+    }
+    getLifecycleChain() {
+        return this.getFromContext("lifecycleChain");
+    }
+    getContextId() {
+        return this.getFromContext("getContextId");
+    }
+    getFromContext(propertyName) {
+        const context = this.context.getStore();
+        return context ? context[propertyName] : undefined;
+    }
+}
+exports.SharedContext = SharedContext;
+//# sourceMappingURL=sharedContext.js.map

package/dist/sharedContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedContext.js","sourceRoot":"","sources":["../src/sharedContext.ts"],"names":[],"mappings":";;;AAEA,6CAAgD;AAShD,MAAa,aAAa;IAA1B;QACU,YAAO,GAAG,IAAI,+BAAiB,EAAyB,CAAC;IA4CnE,CAAC;IA1CQ,GAAG,CACR,UAAmB,EACnB,eAAsC;QAEtC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,GAC7D,eAAe,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,iCAEhB,eAAe,KAClB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC;gBACnB,WAAW;gBACX,cAAc;aACf,CAAC,KAEJ,UAAU,CACX,CAAC;IACJ,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,cAAc;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC/C,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC;IAEO,cAAc,CAAO,YAAoB;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACxC,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;CACF;AA7CD,sCA6CC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@alanszp/shared-context",
+  "version": "6.0.0",
+  "description": "Alan's shared context util.",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "dependencies": {
+    "@alanszp/audit": "^6.0.0",
+    "@alanszp/errors": "^6.0.0",
+    "@alanszp/logger": "^6.0.0",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "75b34d763277366fdf93146cd1d20084ff469273"
+}

package/src/SharedContextNotInitializedException.ts

@@ -0,0 +1,7 @@
+import { BaseError } from "@alanszp/errors";
+
+export class SharedContextNotInitializedException extends BaseError {
+  constructor() {
+    super("Shared context wasn't initialized correctly.");
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./sharedContext";
+export * from "./SharedContextNotInitializedException";

package/src/sharedContext.ts

@@ -0,0 +1,57 @@
+import { ILogger } from "@alanszp/logger";
+import { Audit, AuditWithState } from "@alanszp/audit";
+import { AsyncLocalStorage } from "async_hooks";
+
+export interface SharedInternalContext {
+  audit: AuditWithState;
+  logger: ILogger;
+  lifecycleId: string;
+  lifecycleChain: string;
+  contextId: string;
+}
+export class SharedContext {
+  private context = new AsyncLocalStorage<SharedInternalContext>();
+
+  public run<R>(
+    executable: () => R,
+    internalContext: SharedInternalContext
+  ): R {
+    const { audit, logger, contextId, lifecycleId, lifecycleChain } =
+      internalContext;
+    return this.context.run(
+      {
+        ...internalContext,
+        logger: logger.child({
+          lifecycleId,
+          lifecycleChain,
+        }),
+      },
+      executable
+    );
+  }
+
+  public getLogger(): ILogger | undefined {
+    return this.getFromContext("logger");
+  }
+
+  public getAudit(): AuditWithState | undefined {
+    return this.getFromContext("audit");
+  }
+
+  public getLifecycleId(): string | undefined {
+    return this.getFromContext("lifecycleId");
+  }
+
+  public getLifecycleChain(): string | undefined {
+    return this.getFromContext("lifecycleChain");
+  }
+
+  public getContextId(): string | undefined {
+    return this.getFromContext("getContextId");
+  }
+
+  private getFromContext<Type>(propertyName: string): Type | undefined {
+    const context = this.context.getStore();
+    return context ? context[propertyName] : undefined;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}