@alanszp/express-common-fn 10.0.0 → 10.0.1

package/node_modules/@alanszp/logger/src/logger.ts

@@ -0,0 +1,54 @@
+import * as BunyanLogger from "bunyan";
+import { Context, ILogger, LogLevel } from "./interfaces";
+import { serialize } from "./serializer";
+
+export class Logger implements ILogger {
+  public baseLogger: BunyanLogger;
+  public serializers?: BunyanLogger.Serializers;
+
+  constructor(
+    baseLogger: BunyanLogger,
+    serializers?: BunyanLogger.Serializers
+  ) {
+    this.baseLogger = baseLogger;
+    this.serializers = serializers;
+  }
+
+  public trace(code: string, context?: Context): void {
+    this.log(LogLevel.TRACE, code, context);
+  }
+
+  public debug(code: string, context?: Context) {
+    this.log(LogLevel.DEBUG, code, context);
+  }
+
+  public info(code: string, context?: Context) {
+    this.log(LogLevel.INFO, code, context);
+  }
+
+  public warn(code: string, context?: Context) {
+    this.log(LogLevel.WARN, code, context);
+  }
+
+  public error(code: string, context?: Context) {
+    this.log(LogLevel.ERROR, code, context);
+  }
+
+  public child(context?: Context): Logger {
+    return new Logger(this.baseLogger.child(context || {}));
+  }
+
+  private log(level: LogLevel, code: string, context: Context = {}): void {
+    if (this.serializers) {
+      context = { ...context };
+      for (const key in this.serializers) {
+        try {
+          if (context[key]) {
+            context[key] = this.serializers[key](context[key]);
+          }
+        } catch {}
+      }
+    }
+    this.baseLogger[level](serialize(context), code);
+  }
+}

package/node_modules/@alanszp/logger/src/mock.ts

@@ -0,0 +1,35 @@
+import { Context, ILogger, LogLevel } from "./interfaces";
+
+export function createMockLogger(config: any): ILogger {
+  return new MockLogger();
+}
+
+export class MockLogger implements ILogger {
+  public log(level: LogLevel, code: string, context: Context = {}) {
+    return;
+  }
+
+  public trace(code: string, context?: Context) {
+    return;
+  }
+
+  public debug(code: string, context?: Context) {
+    return;
+  }
+
+  public info(code: string, context?: Context) {
+    return;
+  }
+
+  public warn(code: string, context?: Context) {
+    return;
+  }
+
+  public error(code: string, context?: Context) {
+    return;
+  }
+
+  public child(context?: Context) {
+    return this;
+  }
+}

package/node_modules/@alanszp/logger/src/serializer.ts

@@ -0,0 +1,65 @@
+import JSON5 from "json5";
+import { isString, keys, mapValues } from "lodash";
+import { Context } from "./interfaces";
+
+export function stringify(obj: unknown): string {
+  if (isString(obj)) {
+    return obj;
+  }
+
+  if (obj instanceof Error) {
+    obj = errorSerializer(obj);
+  }
+
+  try {
+    return JSON5.stringify(obj);
+  } catch (e) {
+    // If we cant stringify we will let the bunyan serializer to make the magic.
+    // This is just to detect the logs that are having trouble and then fix it
+    // in the log statement. (The error this may produce is due to circular
+    // reference, so this is a dev issue, who is not logging in a proper way)
+    return stringify({
+      parsing_error: e.message,
+      object_keys: keys(obj),
+    });
+  }
+}
+
+export function serialize(obj: Context) {
+  return mapValues(obj, stringify);
+}
+
+/* Based on Bunyan error serializer */
+function getFullErrorStack(ex): string {
+  let ret = ex.stack || ex.toString();
+  if (ex.cause && typeof ex.cause === "function") {
+    const cex = ex.cause();
+    if (cex) {
+      ret += `\nCaused by: ${getFullErrorStack(cex)}`;
+    }
+  }
+  return ret;
+}
+
+/* Based on Bunyan error serializer */
+function errorSerializer(err) {
+  if (!err || !err.stack) {
+    return err;
+  }
+  return {
+    name: err.name,
+    message: err.message,
+    code: functionOrPropValue(err, "code"),
+    context: functionOrPropValue(err, "context"),
+    response: err.name === "Non200ResponseError" ? err.response : undefined,
+    renderMessage: functionOrPropValue(err, "renderMessage"),
+    status: err.status,
+    signal: err.signal,
+    stack: getFullErrorStack(err),
+    subError: errorSerializer(err.error),
+  };
+}
+
+function functionOrPropValue(elem, key) {
+  return typeof elem[key] === "function" ? elem[key]() : elem[key];
+}

package/node_modules/@alanszp/logger/src/slackBunyan.ts

@@ -0,0 +1,133 @@
+import AxiosGlobal from "axios";
+import { isDate, reduce } from "lodash";
+import { serialize, stringify } from "./serializer";
+
+const axios = AxiosGlobal.create();
+
+const COLOR_FROM_LEVEL = {
+  10: "#c4c4c4",
+  20: "#00ab00",
+  30: "#0066E7",
+  40: "#F18009",
+  50: "#D4070F",
+};
+
+const REMOVABLE_FIELDS = {
+  v: true,
+  name: true,
+  level: true,
+  msg: true,
+  time: true,
+};
+
+export interface SlackStreamOptions {
+  webhookUrl: string;
+  channel?: string;
+  username?: string;
+  emojiIcon?: string;
+  onError?: (error: Error, record: unknown) => void;
+}
+
+export class SlackStream {
+  private webhookUrl: string;
+  private onError: (error: Error, record: unknown) => void;
+  private channel?: string;
+  private username?: string;
+  private emojiIcon?: string;
+
+  constructor(options: SlackStreamOptions) {
+    if (!options?.webhookUrl) {
+      throw new Error("webhookUrl and channel must be given");
+    }
+
+    this.channel = options.channel;
+    this.webhookUrl = options.webhookUrl;
+    this.username = options.username || "Logger";
+    this.emojiIcon = options.emojiIcon || ":warning:";
+    this.onError =
+      options.onError ||
+      function (error, record) {
+        console.log(
+          JSON.stringify(
+            serialize({
+              level: 50,
+              msg: "_slack_serializer.error",
+              error,
+              record,
+            })
+          )
+        );
+      };
+  }
+
+  public write(record: any): void {
+    record = record || {};
+    try {
+      const color = COLOR_FROM_LEVEL[record.level];
+      const log = reduce(
+        record,
+        (acc, value, key) => {
+          if (!REMOVABLE_FIELDS[key]) {
+            acc[key] = value;
+          }
+          return acc;
+        },
+        {}
+      );
+
+      const body = {
+        channel: this.channel,
+        username: this.username,
+        icon_emoji: this.emojiIcon,
+        attachments: [
+          {
+            color,
+            blocks: [
+              {
+                type: "section",
+                fields: [
+                  {
+                    type: "mrkdwn",
+                    text: `*Message*\n${record.msg}`,
+                  },
+                  {
+                    type: "mrkdwn",
+                    text: `*Application:*\n${record.name}:${process.env.NODE_ENV}`,
+                  },
+                  {
+                    type: "mrkdwn",
+                    text: `*Lifecycle ID*\n${record.lid || "-"}`,
+                  },
+                  {
+                    type: "mrkdwn",
+                    text: `*Time:*\n${
+                      isDate(record.time)
+                        ? record.time.toISOString()
+                        : record.time
+                    }`,
+                  },
+                ],
+              },
+              {
+                type: "section",
+                text: {
+                  type: "mrkdwn",
+                  text: "```" + stringify(serialize(log)) + "```",
+                },
+              },
+            ],
+          },
+        ],
+      };
+
+      axios.post(this.webhookUrl, body).catch((error) =>
+        this.onError(error, {
+          slackResponse: error.response ? error.response.data : null,
+          record,
+        })
+      );
+    } catch (err) {
+      this.onError(err, record);
+    }
+  }
+}

package/node_modules/@alanszp/logger/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"]
+}

package/node_modules/@types/node/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    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/node_modules/@types/node/README.md

@@ -0,0 +1,15 @@
+# Installation
+> `npm install --save @types/node`
+
+# Summary
+This package contains type definitions for node (https://nodejs.org/).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
+
+### Additional Details
+ * Last updated: Thu, 08 Feb 2024 20:35:44 GMT
+ * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
+
+# Credits
+These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [Alberto Schiabel](https://github.com/jkomyno), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Victor Perin](https://github.com/victorperin), [Yongsheng Zhang](https://github.com/ZYSzys), [NodeJS Contributors](https://github.com/NodeJS), [Linus Unnebäck](https://github.com/LinusU), [wafuwafu13](https://github.com/wafuwafu13), [Matteo Collina](https://github.com/mcollina), and [Dmitry Semigradsky](https://github.com/Semigradsky).

package/node_modules/@types/node/assert/strict.d.ts

@@ -0,0 +1,8 @@
+declare module "assert/strict" {
+    import { strict } from "node:assert";
+    export = strict;
+}
+declare module "node:assert/strict" {
+    import { strict } from "node:assert";
+    export = strict;
+}