@settlemint/sdk-utils 2.3.2 → 2.3.3-main6f8f814c

package/dist/logging.js

@@ -0,0 +1,221 @@
+//#region src/logging/mask-tokens.ts
+/**
+* Masks sensitive SettleMint tokens in output text by replacing them with asterisks.
+* Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).
+*
+* @param output - The text string that may contain sensitive tokens
+* @returns The text with any sensitive tokens masked with asterisks
+* @example
+* import { maskTokens } from "@settlemint/sdk-utils/terminal";
+*
+* // Masks a token in text
+* const masked = maskTokens("Token: sm_pat_****"); // "Token: ***"
+*/
+const maskTokens = (output) => {
+	return output.replace(/sm_(pat|aat|sat)_[0-9a-zA-Z]+/g, "***");
+};
+
+//#endregion
+//#region src/logging/logger.ts
+/**
+* Creates a simple logger with configurable log level
+*
+* @param options - Configuration options for the logger
+* @param options.level - The minimum log level to output (default: warn)
+* @param options.prefix - The prefix to add to the log message (default: "")
+* @returns A logger instance with debug, info, warn, and error methods
+*
+* @example
+* import { createLogger } from "@/utils/logging/logger";
+*
+* const logger = createLogger({ level: 'info' });
+*
+* logger.info('User logged in', { userId: '123' });
+* logger.error('Operation failed', new Error('Connection timeout'));
+*/
+function createLogger(options = {}) {
+	const { level = "warn", prefix = "" } = options;
+	const logLevels = {
+		debug: 0,
+		info: 1,
+		warn: 2,
+		error: 3,
+		none: 4
+	};
+	const currentLevelValue = logLevels[level];
+	const formatArgs = (args) => {
+		if (args.length === 0 || args.every((arg) => arg === undefined || arg === null)) {
+			return "";
+		}
+		const formatted = args.map((arg) => {
+			if (arg instanceof Error) {
+				return `\n${arg.stack || arg.message}`;
+			}
+			if (typeof arg === "object" && arg !== null) {
+				return `\n${JSON.stringify(arg, null, 2)}`;
+			}
+			return ` ${String(arg)}`;
+		}).join("");
+		return `, args:${formatted}`;
+	};
+	const shouldLog = (level$1) => {
+		return logLevels[level$1] >= currentLevelValue;
+	};
+	return {
+		debug: (message, ...args) => {
+			if (shouldLog("debug")) {
+				console.debug(`\x1b[32m${prefix}[DEBUG] ${maskTokens(message)}${maskTokens(formatArgs(args))}\x1b[0m`);
+			}
+		},
+		info: (message, ...args) => {
+			if (shouldLog("info")) {
+				console.info(`\x1b[34m${prefix}[INFO] ${maskTokens(message)}${maskTokens(formatArgs(args))}\x1b[0m`);
+			}
+		},
+		warn: (message, ...args) => {
+			if (shouldLog("warn")) {
+				console.warn(`\x1b[33m${prefix}[WARN] ${maskTokens(message)}${maskTokens(formatArgs(args))}\x1b[0m`);
+			}
+		},
+		error: (message, ...args) => {
+			if (shouldLog("error")) {
+				console.error(`\x1b[31m${prefix}[ERROR] ${maskTokens(message)}${maskTokens(formatArgs(args))}\x1b[0m`);
+			}
+		}
+	};
+}
+/**
+* Default logger instance with standard configuration
+*/
+const logger = createLogger();
+
+//#endregion
+//#region src/string.ts
+/**
+* Capitalizes the first letter of a string.
+*
+* @param val - The string to capitalize
+* @returns The input string with its first letter capitalized
+*
+* @example
+* import { capitalizeFirstLetter } from "@settlemint/sdk-utils";
+*
+* const capitalized = capitalizeFirstLetter("hello");
+* // Returns: "Hello"
+*/
+function capitalizeFirstLetter(val) {
+	return String(val).charAt(0).toUpperCase() + String(val).slice(1);
+}
+/**
+* Converts a camelCase string to a human-readable string.
+*
+* @param s - The camelCase string to convert
+* @returns The human-readable string
+*
+* @example
+* import { camelCaseToWords } from "@settlemint/sdk-utils";
+*
+* const words = camelCaseToWords("camelCaseString");
+* // Returns: "Camel Case String"
+*/
+function camelCaseToWords(s) {
+	const result = s.replace(/([a-z])([A-Z])/g, "$1 $2");
+	const withSpaces = result.replace(/([A-Z])([a-z])/g, " $1$2");
+	const capitalized = capitalizeFirstLetter(withSpaces);
+	return capitalized.replace(/\s+/g, " ").trim();
+}
+/**
+* Replaces underscores and hyphens with spaces.
+*
+* @param s - The string to replace underscores and hyphens with spaces
+* @returns The input string with underscores and hyphens replaced with spaces
+*
+* @example
+* import { replaceUnderscoresAndHyphensWithSpaces } from "@settlemint/sdk-utils";
+*
+* const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
+* // Returns: "Already Spaced Second"
+*/
+function replaceUnderscoresAndHyphensWithSpaces(s) {
+	return s.replace(/[-_]/g, " ");
+}
+/**
+* Truncates a string to a maximum length and appends "..." if it is longer.
+*
+* @param value - The string to truncate
+* @param maxLength - The maximum length of the string
+* @returns The truncated string or the original string if it is shorter than the maximum length
+*
+* @example
+* import { truncate } from "@settlemint/sdk-utils";
+*
+* const truncated = truncate("Hello, world!", 10);
+* // Returns: "Hello, wor..."
+*/
+function truncate(value, maxLength) {
+	if (value.length <= maxLength) {
+		return value;
+	}
+	return `${value.slice(0, maxLength)}...`;
+}
+
+//#endregion
+//#region src/logging/request-logger.ts
+const WARNING_THRESHOLD = 500;
+const TRUNCATE_LENGTH = 50;
+/**
+* Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)
+* @param logger - The logger to use
+* @param name - The name of the request
+* @param fn - The fetch function to use
+* @returns The fetch function
+*/
+function requestLogger(logger$1, name, fn) {
+	return async (...args) => {
+		const start = Date.now();
+		try {
+			return await fn(...args);
+		} finally {
+			const end = Date.now();
+			const duration = end - start;
+			const body = extractInfoFromBody(args[1]?.body ?? "{}");
+			const message = `${name} path: ${args[0]}, took ${formatDuration(duration)}`;
+			if (duration > WARNING_THRESHOLD) {
+				logger$1.warn(message, body);
+			} else {
+				logger$1.info(message, body);
+			}
+		}
+	};
+}
+function formatDuration(duration) {
+	return duration < 1e3 ? `${duration}ms` : `${(duration / 1e3).toFixed(3)}s`;
+}
+function extractInfoFromBody(body) {
+	try {
+		const parsedBody = typeof body === "string" ? JSON.parse(body) : body;
+		if (parsedBody === null || parsedBody === undefined || Object.keys(parsedBody).length === 0) {
+			return null;
+		}
+		const dataToKeep = {};
+		if ("query" in parsedBody) {
+			dataToKeep.query = truncate(parsedBody.query, TRUNCATE_LENGTH);
+		}
+		if ("variables" in parsedBody) {
+			dataToKeep.variables = truncate(JSON.stringify(parsedBody.variables), TRUNCATE_LENGTH);
+		}
+		if ("operationName" in parsedBody) {
+			dataToKeep.operationName = truncate(parsedBody.operationName, TRUNCATE_LENGTH);
+		}
+		if (Object.keys(dataToKeep).length > 0) {
+			return JSON.stringify(dataToKeep);
+		}
+		return truncate(JSON.stringify(parsedBody || "{}"), TRUNCATE_LENGTH);
+	} catch {
+		return "{}";
+	}
+}
+
+//#endregion
+export { createLogger, maskTokens, requestLogger };
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","names":["output: string","options: LoggerOptions","logLevels: Record<LogLevel, number>","args: unknown[]","level: LogLevel","level","message: string","val: string","s: string","value: string","maxLength: number","logger: Logger","name: string","fn: typeof fetch","duration: number","body: BodyInit","dataToKeep: Record<string, unknown>"],"sources":["../src/logging/mask-tokens.ts","../src/logging/logger.ts","../src/string.ts","../src/logging/request-logger.ts"],"sourcesContent":["/**\n * Masks sensitive SettleMint tokens in output text by replacing them with asterisks.\n * Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).\n *\n * @param output - The text string that may contain sensitive tokens\n * @returns The text with any sensitive tokens masked with asterisks\n * @example\n * import { maskTokens } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Masks a token in text\n * const masked = maskTokens(\"Token: sm_pat_****\"); // \"Token: ***\"\n */\nexport const maskTokens = (output: string): string => {\n  return output.replace(/sm_(pat|aat|sat)_[0-9a-zA-Z]+/g, \"***\");\n};\n","import { maskTokens } from \"./mask-tokens.js\";\n\n/**\n * Log levels supported by the logger\n */\nexport type LogLevel = \"debug\" | \"info\" | \"warn\" | \"error\" | \"none\";\n\n/**\n * Configuration options for the logger\n * @interface LoggerOptions\n */\nexport interface LoggerOptions {\n  /** The minimum log level to output */\n  level?: LogLevel;\n  /** The prefix to add to the log message */\n  prefix?: string;\n}\n\n/**\n * Simple logger interface with basic logging methods\n * @interface Logger\n */\nexport interface Logger {\n  /** Log debug information */\n  debug: (message: string, ...args: unknown[]) => void;\n  /** Log general information */\n  info: (message: string, ...args: unknown[]) => void;\n  /** Log warnings */\n  warn: (message: string, ...args: unknown[]) => void;\n  /** Log errors */\n  error: (message: string, ...args: unknown[]) => void;\n}\n\n/**\n * Creates a simple logger with configurable log level\n *\n * @param options - Configuration options for the logger\n * @param options.level - The minimum log level to output (default: warn)\n * @param options.prefix - The prefix to add to the log message (default: \"\")\n * @returns A logger instance with debug, info, warn, and error methods\n *\n * @example\n * import { createLogger } from \"@/utils/logging/logger\";\n *\n * const logger = createLogger({ level: 'info' });\n *\n * logger.info('User logged in', { userId: '123' });\n * logger.error('Operation failed', new Error('Connection timeout'));\n */\nexport function createLogger(options: LoggerOptions = {}): Logger {\n  const { level = \"warn\", prefix = \"\" } = options;\n\n  const logLevels: Record<LogLevel, number> = {\n    debug: 0,\n    info: 1,\n    warn: 2,\n    error: 3,\n    none: 4,\n  };\n\n  const currentLevelValue = logLevels[level];\n\n  const formatArgs = (args: unknown[]): string => {\n    if (args.length === 0 || args.every((arg) => arg === undefined || arg === null)) {\n      return \"\";\n    }\n\n    const formatted = args\n      .map((arg) => {\n        if (arg instanceof Error) {\n          return `\\n${arg.stack || arg.message}`;\n        }\n        if (typeof arg === \"object\" && arg !== null) {\n          return `\\n${JSON.stringify(arg, null, 2)}`;\n        }\n        return ` ${String(arg)}`;\n      })\n      .join(\"\");\n\n    return `, args:${formatted}`;\n  };\n\n  const shouldLog = (level: LogLevel): boolean => {\n    return logLevels[level] >= currentLevelValue;\n  };\n\n  return {\n    debug: (message: string, ...args: unknown[]) => {\n      if (shouldLog(\"debug\")) {\n        console.debug(`\\x1b[32m${prefix}[DEBUG] ${maskTokens(message)}${maskTokens(formatArgs(args))}\\x1b[0m`);\n      }\n    },\n    info: (message: string, ...args: unknown[]) => {\n      if (shouldLog(\"info\")) {\n        console.info(`\\x1b[34m${prefix}[INFO] ${maskTokens(message)}${maskTokens(formatArgs(args))}\\x1b[0m`);\n      }\n    },\n    warn: (message: string, ...args: unknown[]) => {\n      if (shouldLog(\"warn\")) {\n        console.warn(`\\x1b[33m${prefix}[WARN] ${maskTokens(message)}${maskTokens(formatArgs(args))}\\x1b[0m`);\n      }\n    },\n    error: (message: string, ...args: unknown[]) => {\n      if (shouldLog(\"error\")) {\n        console.error(`\\x1b[31m${prefix}[ERROR] ${maskTokens(message)}${maskTokens(formatArgs(args))}\\x1b[0m`);\n      }\n    },\n  };\n}\n\n/**\n * Default logger instance with standard configuration\n */\nexport const logger = createLogger();\n","/**\n * Capitalizes the first letter of a string.\n *\n * @param val - The string to capitalize\n * @returns The input string with its first letter capitalized\n *\n * @example\n * import { capitalizeFirstLetter } from \"@settlemint/sdk-utils\";\n *\n * const capitalized = capitalizeFirstLetter(\"hello\");\n * // Returns: \"Hello\"\n */\nexport function capitalizeFirstLetter(val: string) {\n  return String(val).charAt(0).toUpperCase() + String(val).slice(1);\n}\n\n/**\n * Converts a camelCase string to a human-readable string.\n *\n * @param s - The camelCase string to convert\n * @returns The human-readable string\n *\n * @example\n * import { camelCaseToWords } from \"@settlemint/sdk-utils\";\n *\n * const words = camelCaseToWords(\"camelCaseString\");\n * // Returns: \"Camel Case String\"\n */\nexport function camelCaseToWords(s: string) {\n  const result = s.replace(/([a-z])([A-Z])/g, \"$1 $2\");\n  const withSpaces = result.replace(/([A-Z])([a-z])/g, \" $1$2\");\n  const capitalized = capitalizeFirstLetter(withSpaces);\n  return capitalized.replace(/\\s+/g, \" \").trim();\n}\n\n/**\n * Replaces underscores and hyphens with spaces.\n *\n * @param s - The string to replace underscores and hyphens with spaces\n * @returns The input string with underscores and hyphens replaced with spaces\n *\n * @example\n * import { replaceUnderscoresAndHyphensWithSpaces } from \"@settlemint/sdk-utils\";\n *\n * const result = replaceUnderscoresAndHyphensWithSpaces(\"Already_Spaced-Second\");\n * // Returns: \"Already Spaced Second\"\n */\nexport function replaceUnderscoresAndHyphensWithSpaces(s: string) {\n  return s.replace(/[-_]/g, \" \");\n}\n\n/**\n * Truncates a string to a maximum length and appends \"...\" if it is longer.\n *\n * @param value - The string to truncate\n * @param maxLength - The maximum length of the string\n * @returns The truncated string or the original string if it is shorter than the maximum length\n *\n * @example\n * import { truncate } from \"@settlemint/sdk-utils\";\n *\n * const truncated = truncate(\"Hello, world!\", 10);\n * // Returns: \"Hello, wor...\"\n */\nexport function truncate(value: string, maxLength: number) {\n  if (value.length <= maxLength) {\n    return value;\n  }\n  return `${value.slice(0, maxLength)}...`;\n}\n","import { truncate } from \"../string.js\";\nimport type { Logger } from \"./logger.js\";\n\nconst WARNING_THRESHOLD = 500;\nconst TRUNCATE_LENGTH = 50;\n\n/**\n * Logs the request and duration of a fetch call (> 500ms is logged as warn, otherwise info)\n * @param logger - The logger to use\n * @param name - The name of the request\n * @param fn - The fetch function to use\n * @returns The fetch function\n */\nexport function requestLogger(logger: Logger, name: string, fn: typeof fetch) {\n  return async (...args: Parameters<typeof fetch>) => {\n    const start = Date.now();\n    try {\n      return await fn(...args);\n    } finally {\n      const end = Date.now();\n      const duration = end - start;\n      const body = extractInfoFromBody(args[1]?.body ?? \"{}\");\n      const message = `${name} path: ${args[0]}, took ${formatDuration(duration)}`;\n      if (duration > WARNING_THRESHOLD) {\n        logger.warn(message, body);\n      } else {\n        logger.info(message, body);\n      }\n    }\n  };\n}\n\nfunction formatDuration(duration: number) {\n  return duration < 1000 ? `${duration}ms` : `${(duration / 1000).toFixed(3)}s`;\n}\n\nfunction extractInfoFromBody(body: BodyInit) {\n  try {\n    const parsedBody = typeof body === \"string\" ? JSON.parse(body) : body;\n\n    if (parsedBody === null || parsedBody === undefined || Object.keys(parsedBody).length === 0) {\n      return null;\n    }\n\n    const dataToKeep: Record<string, unknown> = {};\n    // Check for graphql fields\n    if (\"query\" in parsedBody) {\n      dataToKeep.query = truncate(parsedBody.query, TRUNCATE_LENGTH);\n    }\n    if (\"variables\" in parsedBody) {\n      dataToKeep.variables = truncate(JSON.stringify(parsedBody.variables), TRUNCATE_LENGTH);\n    }\n    if (\"operationName\" in parsedBody) {\n      dataToKeep.operationName = truncate(parsedBody.operationName, TRUNCATE_LENGTH);\n    }\n\n    if (Object.keys(dataToKeep).length > 0) {\n      return JSON.stringify(dataToKeep);\n    }\n\n    // Not graphql, return the body as is\n    return truncate(JSON.stringify(parsedBody || \"{}\"), TRUNCATE_LENGTH);\n  } catch {\n    return \"{}\";\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,MAAa,aAAa,CAACA,WAA2B;AACpD,QAAO,OAAO,QAAQ,kCAAkC,MAAM;AAC/D;;;;;;;;;;;;;;;;;;;;ACmCD,SAAgB,aAAaC,UAAyB,CAAE,GAAU;CAChE,MAAM,EAAE,QAAQ,QAAQ,SAAS,IAAI,GAAG;CAExC,MAAMC,YAAsC;EAC1C,OAAO;EACP,MAAM;EACN,MAAM;EACN,OAAO;EACP,MAAM;CACP;CAED,MAAM,oBAAoB,UAAU;CAEpC,MAAM,aAAa,CAACC,SAA4B;AAC9C,MAAI,KAAK,WAAW,KAAK,KAAK,MAAM,CAAC,QAAQ,QAAQ,aAAa,QAAQ,KAAK,EAAE;AAC/E,UAAO;EACR;EAED,MAAM,YAAY,KACf,IAAI,CAAC,QAAQ;AACZ,OAAI,eAAe,OAAO;AACxB,YAAQ,IAAI,IAAI,SAAS,IAAI,QAAQ;GACtC;AACD,cAAW,QAAQ,YAAY,QAAQ,MAAM;AAC3C,YAAQ,IAAI,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;GAC1C;AACD,WAAQ,GAAG,OAAO,IAAI,CAAC;EACxB,EAAC,CACD,KAAK,GAAG;AAEX,UAAQ,SAAS,UAAU;CAC5B;CAED,MAAM,YAAY,CAACC,YAA6B;AAC9C,SAAO,UAAUC,YAAU;CAC5B;AAED,QAAO;EACL,OAAO,CAACC,SAAiB,GAAG,SAAoB;AAC9C,OAAI,UAAU,QAAQ,EAAE;AACtB,YAAQ,OAAO,UAAU,OAAO,UAAU,WAAW,QAAQ,CAAC,EAAE,WAAW,WAAW,KAAK,CAAC,CAAC,SAAS;GACvG;EACF;EACD,MAAM,CAACA,SAAiB,GAAG,SAAoB;AAC7C,OAAI,UAAU,OAAO,EAAE;AACrB,YAAQ,MAAM,UAAU,OAAO,SAAS,WAAW,QAAQ,CAAC,EAAE,WAAW,WAAW,KAAK,CAAC,CAAC,SAAS;GACrG;EACF;EACD,MAAM,CAACA,SAAiB,GAAG,SAAoB;AAC7C,OAAI,UAAU,OAAO,EAAE;AACrB,YAAQ,MAAM,UAAU,OAAO,SAAS,WAAW,QAAQ,CAAC,EAAE,WAAW,WAAW,KAAK,CAAC,CAAC,SAAS;GACrG;EACF;EACD,OAAO,CAACA,SAAiB,GAAG,SAAoB;AAC9C,OAAI,UAAU,QAAQ,EAAE;AACtB,YAAQ,OAAO,UAAU,OAAO,UAAU,WAAW,QAAQ,CAAC,EAAE,WAAW,WAAW,KAAK,CAAC,CAAC,SAAS;GACvG;EACF;CACF;AACF;;;;AAKD,MAAa,SAAS,cAAc;;;;;;;;;;;;;;;;ACrGpC,SAAgB,sBAAsBC,KAAa;AACjD,QAAO,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE;AAClE;;;;;;;;;;;;;AAcD,SAAgB,iBAAiBC,GAAW;CAC1C,MAAM,SAAS,EAAE,QAAQ,mBAAmB,QAAQ;CACpD,MAAM,aAAa,OAAO,QAAQ,mBAAmB,QAAQ;CAC7D,MAAM,cAAc,sBAAsB,WAAW;AACrD,QAAO,YAAY,QAAQ,QAAQ,IAAI,CAAC,MAAM;AAC/C;;;;;;;;;;;;;AAcD,SAAgB,uCAAuCA,GAAW;AAChE,QAAO,EAAE,QAAQ,SAAS,IAAI;AAC/B;;;;;;;;;;;;;;AAeD,SAAgB,SAASC,OAAeC,WAAmB;AACzD,KAAI,MAAM,UAAU,WAAW;AAC7B,SAAO;CACR;AACD,SAAQ,EAAE,MAAM,MAAM,GAAG,UAAU,CAAC;AACrC;;;;AClED,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB;;;;;;;;AASxB,SAAgB,cAAcC,UAAgBC,MAAcC,IAAkB;AAC5E,QAAO,OAAO,GAAG,SAAmC;EAClD,MAAM,QAAQ,KAAK,KAAK;AACxB,MAAI;AACF,UAAO,MAAM,GAAG,GAAG,KAAK;EACzB,UAAS;GACR,MAAM,MAAM,KAAK,KAAK;GACtB,MAAM,WAAW,MAAM;GACvB,MAAM,OAAO,oBAAoB,KAAK,IAAI,QAAQ,KAAK;GACvD,MAAM,WAAW,EAAE,KAAK,SAAS,KAAK,GAAG,SAAS,eAAe,SAAS,CAAC;AAC3E,OAAI,WAAW,mBAAmB;AAChC,aAAO,KAAK,SAAS,KAAK;GAC3B,OAAM;AACL,aAAO,KAAK,SAAS,KAAK;GAC3B;EACF;CACF;AACF;AAED,SAAS,eAAeC,UAAkB;AACxC,QAAO,WAAW,OAAQ,EAAE,SAAS,OAAO,EAAE,CAAC,WAAW,KAAM,QAAQ,EAAE,CAAC;AAC5E;AAED,SAAS,oBAAoBC,MAAgB;AAC3C,KAAI;EACF,MAAM,oBAAoB,SAAS,WAAW,KAAK,MAAM,KAAK,GAAG;AAEjE,MAAI,eAAe,QAAQ,eAAe,aAAa,OAAO,KAAK,WAAW,CAAC,WAAW,GAAG;AAC3F,UAAO;EACR;EAED,MAAMC,aAAsC,CAAE;AAE9C,MAAI,WAAW,YAAY;AACzB,cAAW,QAAQ,SAAS,WAAW,OAAO,gBAAgB;EAC/D;AACD,MAAI,eAAe,YAAY;AAC7B,cAAW,YAAY,SAAS,KAAK,UAAU,WAAW,UAAU,EAAE,gBAAgB;EACvF;AACD,MAAI,mBAAmB,YAAY;AACjC,cAAW,gBAAgB,SAAS,WAAW,eAAe,gBAAgB;EAC/E;AAED,MAAI,OAAO,KAAK,WAAW,CAAC,SAAS,GAAG;AACtC,UAAO,KAAK,UAAU,WAAW;EAClC;AAGD,SAAO,SAAS,KAAK,UAAU,cAAc,KAAK,EAAE,gBAAgB;CACrE,QAAO;AACN,SAAO;CACR;AACF"}