json-log-line 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export type Options = {
+    exclude?: string | string[];
+    include?: string | string[];
+    format?: Record<string, (value: any, parsedLogObject?: any, ...arguments_: any[]) => string>;
+};
+export declare function logLineFactory({ 
+/**
+ * include and exclude both take keys with dot notation
+ */
+exclude, 
+/**
+ * include always overrides exclude
+ */
+include, 
+/**
+ * Format functions for any given key, keys of the object are automatically included and cannot be excluded
+ */
+format, }?: Options): (inputData: string | Record<string, unknown>) => string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CACb,MAAM,EACN,CAAC,KAAK,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,MAAM,CACpE,CAAC;CACH,CAAC;AAMF,wBAAgB,cAAc,CAAC;AAC7B;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,MAAW,GACZ,GAAE,OAAY,IASI,WAAW,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAAM,CA0FtE"}

package/dist/index.js

@@ -0,0 +1,103 @@
+import jsonParse from 'fast-json-parse';
+import unset from 'unset-value';
+import get from 'get-value';
+import set from 'set-value';
+import deepMerge from '@fastify/deepmerge';
+import isObject from "./utils/is-object.js";
+import isEmpty from "./utils/is-empty.js";
+const nl = '\n';
+export function logLineFactory({ 
+/**
+ * include and exclude both take keys with dot notation
+ */
+exclude = [], 
+/**
+ * include always overrides exclude
+ */
+include = [], 
+/**
+ * Format functions for any given key, keys of the object are automatically included and cannot be excluded
+ */
+format = {}, } = {}) {
+    const logLineKeys = Object.keys(format);
+    const splitLogLineKeys = logLineKeys.flatMap((key) => key.split('|'));
+    format.extraFields ||= (object) => JSON.stringify(object) + nl;
+    /**
+     * @param inputData - The input data to be formatted can be a JSON stringified object or a plain object
+     */
+    return function (inputData) {
+        try {
+            let object = {};
+            if (typeof inputData === 'string') {
+                const parsedData = jsonParse(inputData);
+                if (!parsedData.value || parsedData.err) {
+                    return inputData + nl;
+                }
+                object = parsedData.value;
+            }
+            else if (isObject(inputData)) {
+                object = inputData;
+            }
+            else {
+                return nl;
+            }
+            // cache the whitelist
+            const whiteListObject = {};
+            for (const key of [...splitLogLineKeys, ...include]) {
+                const value = get(object, key);
+                if (value) {
+                    set(whiteListObject, key, value);
+                }
+            }
+            // remove the blacklist
+            for (const key of exclude) {
+                unset(object, key);
+            }
+            // add back in the whitelist
+            object = deepMerge()(object, whiteListObject);
+            const output = [];
+            for (const _key of logLineKeys) {
+                const keys = _key.split('|');
+                for (const key of keys) {
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    const value = get(object, key);
+                    if (!value) {
+                        continue;
+                    }
+                    const formatter = format[_key];
+                    if (formatter) {
+                        output.push(formatter(value, object));
+                    }
+                }
+            }
+            // remove the properties that were used to create the log-line
+            for (const key of splitLogLineKeys) {
+                unset(object, key);
+            }
+            // remove empty blacklist that may have had whitelisted properties
+            for (const key of exclude) {
+                if (isEmpty(get(object, key))) {
+                    unset(object, key);
+                }
+            }
+            let outputString = output.filter(Boolean).join(' ');
+            // after processing the rest of the object contains
+            // extra fields that were not in the logLine nor in the log line nor blacklisted
+            // so these are the ones we want to prettify and highlight
+            if (isObject(object) && !isEmpty(object) && format.extraFields) {
+                outputString = outputString.concat(format.extraFields(object)); // eslint-disable-line unicorn/prefer-spread
+            }
+            if (!outputString.endsWith(nl)) {
+                outputString += nl;
+            }
+            if (outputString === nl) {
+                return JSON.stringify(object) + nl;
+            }
+            return outputString;
+        }
+        catch (error) {
+            console.log(error);
+            return '';
+        }
+    };
+}

package/dist/utils/is-empty.d.ts

@@ -0,0 +1,3 @@
+declare function isEmpty(object: unknown): object is Record<string, never>;
+export default isEmpty;
+//# sourceMappingURL=is-empty.d.ts.map

package/dist/utils/is-empty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-empty.d.ts","sourceRoot":"","sources":["../../src/utils/is-empty.ts"],"names":[],"mappings":"AAEA,iBAAS,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAOjE;AAED,eAAe,OAAO,CAAC"}

package/dist/utils/is-empty.js

@@ -0,0 +1,8 @@
+import isObject from "./is-object.js";
+function isEmpty(object) {
+    return Boolean(isObject(object) &&
+        (object === undefined ||
+            object === null ||
+            Object.keys(object).length === 0));
+}
+export default isEmpty;

package/dist/utils/is-object.d.ts

@@ -0,0 +1,3 @@
+declare function isObject(input: unknown): input is object;
+export default isObject;
+//# sourceMappingURL=is-object.d.ts.map

package/dist/utils/is-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-object.d.ts","sourceRoot":"","sources":["../../src/utils/is-object.ts"],"names":[],"mappings":"AACA,iBAAS,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAIjD;AAED,eAAe,QAAQ,CAAC"}

package/dist/utils/is-object.js

@@ -0,0 +1,5 @@
+// eslint-disable-next-line @typescript-eslint/no-restricted-types
+function isObject(input) {
+    return Boolean(input && Object.prototype.toString.apply(input) === '[object Object]');
+}
+export default isObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-log-line",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A utility for building awesome log lines from JSON",
   "homepage": "https://github.com/spence-s/json-log-line",
   "bugs": {
@@ -36,6 +36,7 @@
     "clean": "rimraf dist",
     "lint": "npm run check && xo",
     "prepare": "husky",
+    "prepublish": "npm run build",
     "release": "np",
     "test": "c8 ava",
     "update": "ncu -i"