@xbg.solutions/utils-logger 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Logger utility barrel export
+ */
+export * from './logger';
+export * from './logger-types';
+import { Logger } from './logger';
+/**
+ * Default logger instance for use outside request context
+ * For request-scoped logging, use the logger from req.logger
+ */
+export declare const logger: Logger;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAE/B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,MAAM,QAAoD,CAAC"}

package/lib/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 });
+exports.logger = void 0;
+/**
+ * Logger utility barrel export
+ */
+__exportStar(require("./logger"), exports);
+__exportStar(require("./logger-types"), exports);
+const logger_1 = require("./logger");
+/**
+ * Default logger instance for use outside request context
+ * For request-scoped logging, use the logger from req.logger
+ */
+exports.logger = new logger_1.Logger('system', { service: 'wishlist-api' });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,2CAAyB;AACzB,iDAA+B;AAE/B,qCAAkC;AAElC;;;GAGG;AACU,QAAA,MAAM,GAAG,IAAI,eAAM,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC"}

package/lib/logger-types.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Logger type definitions
+ */
+/**
+ * Base log context interface
+ * Represents metadata that can be attached to log messages
+ */
+export interface LogContext {
+    [key: string]: unknown;
+}
+/**
+ * Common context fields used across the application
+ */
+export interface BaseLogContext extends LogContext {
+    operation?: string;
+    userId?: string;
+    accountUID?: string;
+    listUID?: string;
+    itemUID?: string;
+    contactUID?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Log level enum (re-export for convenience)
+ */
+export declare enum LogLevel {
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+//# sourceMappingURL=logger-types.d.ts.map

package/lib/logger-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-types.d.ts","sourceRoot":"","sources":["../src/logger-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;CAChB"}

package/lib/logger-types.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Logger type definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+/**
+ * Log level enum (re-export for convenience)
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "debug";
+    LogLevel["INFO"] = "info";
+    LogLevel["WARN"] = "warn";
+    LogLevel["ERROR"] = "error";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+//# sourceMappingURL=logger-types.js.map

package/lib/logger-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-types.js","sourceRoot":"","sources":["../src/logger-types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAuBH;;GAEG;AACH,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB"}

package/lib/logger.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Structured Logger with Correlation IDs
+ *
+ * Integrates with Firebase Functions logging (GCP Cloud Logging)
+ * Never logs PII in plaintext - sanitizes metadata
+ */
+import { LogContext } from './logger-types';
+export { LogLevel } from './logger-types';
+export declare class Logger {
+    private readonly correlationId;
+    private readonly context;
+    constructor(correlationId: string, context?: LogContext);
+    /**
+     * Sanitize metadata to remove sensitive fields
+     */
+    private sanitizeMetadata;
+    /**
+     * Build log data structure
+     */
+    private buildLogData;
+    /**
+     * Log debug message (development only)
+     */
+    debug(message: string, meta?: LogContext): void;
+    /**
+     * Log info message
+     */
+    info(message: string, meta?: LogContext): void;
+    /**
+     * Log warning message
+     */
+    warn(message: string, meta?: LogContext): void;
+    /**
+     * Log error message with error object
+     */
+    error(message: string, error: Error, meta?: LogContext): void;
+    /**
+     * Create child logger with additional context
+     */
+    child(additionalContext: LogContext): Logger;
+}
+//# sourceMappingURL=logger.d.ts.map

package/lib/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAY,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAmC1C,qBAAa,MAAM;IAEf,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,UAAe;IAG3C;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAiBpB;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAOnD;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAKlD;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAKlD;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAYjE;;OAEG;IACH,KAAK,CAAC,iBAAiB,EAAE,UAAU,GAAG,MAAM;CAM7C"}

package/lib/logger.js

@@ -0,0 +1,123 @@
+"use strict";
+/**
+ * Structured Logger with Correlation IDs
+ *
+ * Integrates with Firebase Functions logging (GCP Cloud Logging)
+ * Never logs PII in plaintext - sanitizes metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.LogLevel = void 0;
+const firebase_functions_1 = require("firebase-functions");
+const logger_types_1 = require("./logger-types");
+var logger_types_2 = require("./logger-types");
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_types_2.LogLevel; } });
+/**
+ * Sensitive field names that should never be logged
+ */
+const SENSITIVE_FIELDS = [
+    'password',
+    'token',
+    'secret',
+    'key',
+    'apiKey',
+    'api_key',
+    'accessToken',
+    'access_token',
+    'refreshToken',
+    'refresh_token',
+    'email',
+    'phoneNumber',
+    'phone',
+    'address',
+    'addressLine1',
+    'addressLine2',
+    'city',
+    'state',
+    'postalCode',
+    'postal_code',
+    'ssn',
+    'creditCard',
+    'credit_card',
+    'cardNumber',
+    'card_number',
+    'cvv',
+    'authorization',
+];
+class Logger {
+    constructor(correlationId, context = {}) {
+        this.correlationId = correlationId;
+        this.context = context;
+    }
+    /**
+     * Sanitize metadata to remove sensitive fields
+     */
+    sanitizeMetadata(meta) {
+        const sanitized = {};
+        for (const [key, value] of Object.entries(meta)) {
+            // Check if field name is sensitive
+            const lowerKey = key.toLowerCase();
+            const isSensitive = SENSITIVE_FIELDS.some((field) => lowerKey.includes(field.toLowerCase()));
+            if (isSensitive) {
+                sanitized[key] = '[REDACTED]';
+            }
+            else if (value && typeof value === 'object' && !Array.isArray(value)) {
+                // Recursively sanitize nested objects
+                sanitized[key] = this.sanitizeMetadata(value);
+            }
+            else {
+                sanitized[key] = value;
+            }
+        }
+        return sanitized;
+    }
+    /**
+     * Build log data structure
+     */
+    buildLogData(level, message, meta = {}) {
+        const sanitizedMeta = this.sanitizeMetadata(meta);
+        return Object.assign({ correlationId: this.correlationId, timestamp: new Date().toISOString(), level,
+            message, context: this.context }, sanitizedMeta);
+    }
+    /**
+     * Log debug message (development only)
+     */
+    debug(message, meta = {}) {
+        if (process.env.LOG_LEVEL === 'debug' || process.env.NODE_ENV === 'development') {
+            const logData = this.buildLogData(logger_types_1.LogLevel.DEBUG, message, meta);
+            firebase_functions_1.logger.debug(logData);
+        }
+    }
+    /**
+     * Log info message
+     */
+    info(message, meta = {}) {
+        const logData = this.buildLogData(logger_types_1.LogLevel.INFO, message, meta);
+        firebase_functions_1.logger.info(logData);
+    }
+    /**
+     * Log warning message
+     */
+    warn(message, meta = {}) {
+        const logData = this.buildLogData(logger_types_1.LogLevel.WARN, message, meta);
+        firebase_functions_1.logger.warn(logData);
+    }
+    /**
+     * Log error message with error object
+     */
+    error(message, error, meta = {}) {
+        const logData = this.buildLogData(logger_types_1.LogLevel.ERROR, message, Object.assign({ error: {
+                name: error.name,
+                message: error.message,
+                stack: error.stack,
+            } }, meta));
+        firebase_functions_1.logger.error(logData);
+    }
+    /**
+     * Create child logger with additional context
+     */
+    child(additionalContext) {
+        return new Logger(this.correlationId, Object.assign(Object.assign({}, this.context), additionalContext));
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.js.map

package/lib/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2DAAyD;AACzD,iDAAsD;AAEtD,+CAA0C;AAAjC,wGAAA,QAAQ,OAAA;AAEjB;;GAEG;AACH,MAAM,gBAAgB,GAAG;IACvB,UAAU;IACV,OAAO;IACP,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,SAAS;IACT,aAAa;IACb,cAAc;IACd,cAAc;IACd,eAAe;IACf,OAAO;IACP,aAAa;IACb,OAAO;IACP,SAAS;IACT,cAAc;IACd,cAAc;IACd,MAAM;IACN,OAAO;IACP,YAAY;IACZ,aAAa;IACb,KAAK;IACL,YAAY;IACZ,aAAa;IACb,YAAY;IACZ,aAAa;IACb,KAAK;IACL,eAAe;CAChB,CAAC;AAEF,MAAa,MAAM;IACjB,YACmB,aAAqB,EACrB,UAAsB,EAAE;QADxB,kBAAa,GAAb,aAAa,CAAQ;QACrB,YAAO,GAAP,OAAO,CAAiB;IACxC,CAAC;IAEJ;;OAEG;IACK,gBAAgB,CAAC,IAAgB;QACvC,MAAM,SAAS,GAAe,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,mCAAmC;YACnC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAClD,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CACvC,CAAC;YAEF,IAAI,WAAW,EAAE,CAAC;gBAChB,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAChC,CAAC;iBAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvE,sCAAsC;gBACtC,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAmB,CAAC,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,YAAY,CAClB,KAAe,EACf,OAAe,EACf,OAAmB,EAAE;QAErB,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAElD,uBACE,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACnC,KAAK;YACL,OAAO,EACP,OAAO,EAAE,IAAI,CAAC,OAAO,IAClB,aAAa,EAChB;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,OAAmB,EAAE;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YAChF,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,uBAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YACjE,2BAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAe,EAAE,OAAmB,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,uBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAChE,2BAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAe,EAAE,OAAmB,EAAE;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,uBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAChE,2BAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAe,EAAE,KAAY,EAAE,OAAmB,EAAE;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,uBAAQ,CAAC,KAAK,EAAE,OAAO,kBACvD,KAAK,EAAE;gBACL,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,IACE,IAAI,EACP,CAAC;QACH,2BAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAA6B;QACjC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,kCAC/B,IAAI,CAAC,OAAO,GACZ,iBAAiB,EACpB,CAAC;IACL,CAAC;CACF;AAtGD,wBAsGC"}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@xbg.solutions/utils-logger",
+  "version": "1.0.0",
+  "description": "Structured logging with PII sanitization and GCP Cloud Logging",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": ["lib"],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf lib",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {"uuid": "^9.0.1"},
+  "devDependencies": {"@types/uuid": "^9.0.7", "@types/node": "^20.11.0", "typescript": "^5.3.3"},
+  "engines": {
+    "node": "22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}