@koralabs/kora-labs-common 6.4.16 → 6.4.18

package/logger/index.d.ts

@@ -6,7 +6,8 @@ export declare enum LogCategory {
     WARN = "WARN",
     ERROR = "ERROR",
     FATAL = "FATAL",
-    NOTIFY = "NOTIFY"
+    NOTIFY = "NOTIFY",
+    USER_ISSUE = "USER_ISSUE"
 }
 export declare class Logger {
     static application: string;
@@ -23,6 +24,7 @@ export declare class Logger {
         milliseconds?: number;
         count?: number;
         dimensions?: string[];
+        context?: Record<string, unknown>;
     } | string): void;
     static log(args: {
         message: string;
@@ -31,6 +33,7 @@ export declare class Logger {
         milliseconds?: number;
         count?: number;
         dimensions?: string[];
+        context?: Record<string, unknown>;
     } | string): void;
     private static log_entry;
     private static colorize;

package/logger/index.js

@@ -25,6 +25,7 @@ var LogCategory;
     LogCategory["ERROR"] = "ERROR";
     LogCategory["FATAL"] = "FATAL";
     LogCategory["NOTIFY"] = "NOTIFY";
+    LogCategory["USER_ISSUE"] = "USER_ISSUE";
 })(LogCategory = exports.LogCategory || (exports.LogCategory = {}));
 const ANSI_RESET = '\x1b[0m';
 const ANSI_BLUE = '\x1b[34m';
@@ -96,10 +97,10 @@ class Logger {
             this.log_entry(LogCategory.INFO, args);
             return;
         }
-        const { message, category, event, milliseconds, count, dimensions } = args;
-        this.log_entry(category !== null && category !== void 0 ? category : LogCategory.INFO, message, event, milliseconds, count, dimensions);
+        const { message, category, event, milliseconds, count, dimensions, context } = args;
+        this.log_entry(category !== null && category !== void 0 ? category : LogCategory.INFO, message, event, milliseconds, count, dimensions, context);
     }
-    static log_entry(category, message, event, milliseconds, count, dimensions) {
+    static log_entry(category, message, event, milliseconds, count, dimensions, context) {
         const now = new Date().toISOString();
         message = message.replace(/\\/g, '\\\\').replace(/"/g, '\\"'); // escape double quotes and already escaped escapes
         const logCategory = category !== null && category !== void 0 ? category : LogCategory.INFO;
@@ -109,6 +110,7 @@ class Logger {
         const log_milliseconds = milliseconds != undefined && milliseconds != null ? `, "milliseconds": ${milliseconds}` : '';
         const log_count = count != undefined && count != null ? `, "count": ${count}` : '';
         const log_dimensions = dimensions && Object.keys(dimensions).length ? `, "dimensions": ${JSON.stringify(dimensions)}` : '';
+        const log_context = context ? `, "context": ${JSON.stringify(context)}` : '';
         let logFunc = console.log;
         switch (category) {
             case LogCategory.DEBUG:
@@ -124,7 +126,7 @@ class Logger {
                 break;
         }
         // PLEASE KEEP THIS ALL ON ONE LINE SO LOGS AREN'T BROKEN UP
-        logFunc(`{"network": "${Logger.network}", "application": "${Logger.application}", "category": "${displayCategory}", "message": "${message}"${log_event}, "timestamp": "${now}"${log_milliseconds}${log_count}${log_dimensions} }`);
+        logFunc(`{"network": "${Logger.network}", "application": "${Logger.application}", "category": "${displayCategory}", "message": "${message}"${log_event}, "timestamp": "${now}"${log_milliseconds}${log_count}${log_dimensions}${log_context} }`);
         // PLEASE KEEP THIS ALL ON ONE LINE SO LOGS AREN'T BROKEN UP
     }
     static colorize(value, ansiColor) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@koralabs/kora-labs-common",
-    "version": "6.4.16",
+    "version": "6.4.18",
     "description": "Kora Labs Common Utilities",
     "main": "index.js",
     "types": "index.d.ts",
@@ -46,5 +46,8 @@
         "cbor": "^9.0.2",
         "crc": "^4.3.2",
         "pluralize-esm": "^9.0.5"
+    },
+    "overrides": {
+        "minimatch": "10.2.2"
     }
 }

package/utils/cbor/index.js

@@ -248,6 +248,12 @@ const getAddressHexFromObject = (obj) => {
     return `0x${addressType}${network}${paymentHash}${stakeHash}`;
 };
 const decodeObject = ({ val, constr = null, schema = {}, defaultKeyType = DefaultTextFormat.UTF8, forJson = true }) => {
+    if (val === null || val === undefined) {
+        if (schema === 'bool' && (0, boolean_1.isBooleanable)(val)) {
+            return (0, boolean_1.boolean)(val);
+        }
+        return val;
+    }
     const isMap = val instanceof Map;
     if (isMap) {
         const obj = new Map();

package/utils/index.d.ts

@@ -21,5 +21,13 @@ export declare const ExcludesFalse: <T>(n?: T | null | undefined) => n is T;
 export declare const diff: (lhs: any, rhs: any) => any;
 export declare const mapStringifyReplacer: (_key: any, value: any) => any;
 export declare const mapNoKeysStringifyReplacer: (_key: any, value: any) => any;
+export declare const USER_ISSUE_TRACKING_ID_REGEX: RegExp;
+export declare const createUserIssueTrackingId: ({ timestamp, random }?: {
+    timestamp?: number | undefined;
+    random?: (() => number) | undefined;
+}) => string;
+export declare const isUserIssueTrackingId: (value: unknown) => value is string;
+export declare const normalizeUserIssueEventSegment: (value: string) => string;
+export declare const buildUserIssueEventKey: (repo: string, flow: string, pathOrFunction: string, step: string) => string;
 export { decodeCborToJson, encodeJsonToDatum, DefaultTextFormat as KeyType } from './cbor';
 export * from './crypto';

package/utils/index.js

@@ -14,7 +14,7 @@ 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 });
-exports.KeyType = exports.encodeJsonToDatum = exports.decodeCborToJson = exports.mapNoKeysStringifyReplacer = exports.mapStringifyReplacer = exports.diff = exports.ExcludesFalse = exports.makeObjectWithoutPrototype = exports.isEmptyObject = exports.isDate = exports.hasOwnProperty = exports.isObject = exports.isEmpty = exports.objectHasKeys = exports.getElapsedTime = exports.getSlotNumberFromDate = exports.getDateFromSlot = exports.isAlphaNumeric = exports.isNullEmptyOrUndefined = exports.isNumeric = exports.asyncForEach = exports.awaitForEach = exports.chunk = exports.toADA = exports.toLovelace = exports.delay = void 0;
+exports.KeyType = exports.encodeJsonToDatum = exports.decodeCborToJson = exports.buildUserIssueEventKey = exports.normalizeUserIssueEventSegment = exports.isUserIssueTrackingId = exports.createUserIssueTrackingId = exports.USER_ISSUE_TRACKING_ID_REGEX = exports.mapNoKeysStringifyReplacer = exports.mapStringifyReplacer = exports.diff = exports.ExcludesFalse = exports.makeObjectWithoutPrototype = exports.isEmptyObject = exports.isDate = exports.hasOwnProperty = exports.isObject = exports.isEmpty = exports.objectHasKeys = exports.getElapsedTime = exports.getSlotNumberFromDate = exports.getDateFromSlot = exports.isAlphaNumeric = exports.isNullEmptyOrUndefined = exports.isNumeric = exports.asyncForEach = exports.awaitForEach = exports.chunk = exports.toADA = exports.toLovelace = exports.delay = void 0;
 const delay = (ms) => {
     return new Promise((resolve) => setTimeout(resolve, ms));
 };
@@ -163,6 +163,38 @@ const mapNoKeysStringifyReplacer = (_key, value) => {
     }
 };
 exports.mapNoKeysStringifyReplacer = mapNoKeysStringifyReplacer;
+const BASE36_CHARS = '0123456789abcdefghijklmnopqrstuvwxyz';
+const USER_ISSUE_RANDOM_SEGMENT_LENGTH = 6;
+exports.USER_ISSUE_TRACKING_ID_REGEX = /^UI-[0-9a-z]+-[0-9a-z]{6}$/;
+const createUserIssueTrackingId = ({ timestamp = Date.now(), random = Math.random } = {}) => {
+    const timestampBase36 = Math.max(0, Math.floor(timestamp)).toString(36);
+    let randomSegment = '';
+    for (let i = 0; i < USER_ISSUE_RANDOM_SEGMENT_LENGTH; i++) {
+        const sample = random();
+        const clamped = Number.isFinite(sample) ? Math.min(0.999999999, Math.max(0, sample)) : 0;
+        const idx = Math.floor(clamped * BASE36_CHARS.length);
+        randomSegment += BASE36_CHARS[idx];
+    }
+    return `UI-${timestampBase36}-${randomSegment}`;
+};
+exports.createUserIssueTrackingId = createUserIssueTrackingId;
+const isUserIssueTrackingId = (value) => {
+    return typeof value === 'string' && exports.USER_ISSUE_TRACKING_ID_REGEX.test(value);
+};
+exports.isUserIssueTrackingId = isUserIssueTrackingId;
+const normalizeUserIssueEventSegment = (value) => {
+    return value
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '_')
+        .replace(/^_+|_+$/g, '')
+        .replace(/_+/g, '_');
+};
+exports.normalizeUserIssueEventSegment = normalizeUserIssueEventSegment;
+const buildUserIssueEventKey = (repo, flow, pathOrFunction, step) => {
+    const segment = (value) => (0, exports.normalizeUserIssueEventSegment)(value) || 'unknown';
+    return `user_issue.${segment(repo)}.${segment(flow)}.${segment(pathOrFunction)}.${segment(step)}`;
+};
+exports.buildUserIssueEventKey = buildUserIssueEventKey;
 var cbor_1 = require("./cbor");
 Object.defineProperty(exports, "decodeCborToJson", { enumerable: true, get: function () { return cbor_1.decodeCborToJson; } });
 Object.defineProperty(exports, "encodeJsonToDatum", { enumerable: true, get: function () { return cbor_1.encodeJsonToDatum; } });