@kikiutils/shared 18.2.0 → 19.0.0

package/dist/object.js

@@ -1,59 +0,0 @@
-//#region src/object.ts
-/**
-* Serializes a nested object into a deterministic, flat string format.
-*
-* @remarks
-* This function recursively traverses the input object (including nested objects and arrays),
-* flattens it into key paths using dot notation (e.g. "a.b.0.c"), sorts all keys,
-* and joins each key-value pair into a string with customizable separators.
-*
-* It is designed for use cases such as signature generation, cache key construction,
-* or any context requiring consistent and predictable object serialization.
-*
-* Note: Empty objects and arrays produce an empty string, which is useful for
-* generating deterministic signature payloads.
-*
-* @param input - The object to serialize. Can contain nested objects and arrays.
-* @param kvSeparator - The string used to separate each key from its value (default: '=').
-* @param pairSeparator - The string used to separate each key-value pair (default: '&').
-*
-* @returns A deterministic string representation of the input object.
-*
-* @example
-*
-* ```ts
-* import { stringifyObjectDeterministically } from '@kikiutils/shared/object';
-*
-* console.log(stringifyObjectDeterministically({
-*     b: 2,
-*     a: {
-*         x: 1,
-*         y: [
-*             3,
-*             4,
-*         ],
-*     },
-* })); // => a.x=1&a.y.0=3&a.y.1=4&b=2
-*
-* console.log(stringifyObjectDeterministically({ foo: 'bar' }, ':', '|')); // => foo:bar
-* console.log(stringifyObjectDeterministically({})); // => ''
-* ```
-*/
-function stringifyObjectDeterministically(input, kvSeparator = "=", pairSeparator = "&") {
-	const entries = [];
-	function walk(object, path = []) {
-		if (Array.isArray(object)) object.forEach((value, i) => {
-			walk(value, [...path, i.toString()]);
-		});
-		else if (object !== null && typeof object === "object" && Object.prototype.toString.call(object) === "[object Object]") Object.keys(object).sort().forEach((key) => {
-			walk(object[key], [...path, key]);
-		});
-		else entries.push(`${path.join(".")}${kvSeparator}${String(object)}`);
-	}
-	walk(input);
-	return entries.sort().join(pairSeparator);
-}
-//#endregion
-export { stringifyObjectDeterministically };
-
-//# sourceMappingURL=object.js.map

package/dist/object.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.js","names":[],"sources":["../src/object.ts"],"sourcesContent":["/**\n * Serializes a nested object into a deterministic, flat string format.\n *\n * @remarks\n * This function recursively traverses the input object (including nested objects and arrays),\n * flattens it into key paths using dot notation (e.g. \"a.b.0.c\"), sorts all keys,\n * and joins each key-value pair into a string with customizable separators.\n *\n * It is designed for use cases such as signature generation, cache key construction,\n * or any context requiring consistent and predictable object serialization.\n *\n * Note: Empty objects and arrays produce an empty string, which is useful for\n * generating deterministic signature payloads.\n *\n * @param input - The object to serialize. Can contain nested objects and arrays.\n * @param kvSeparator - The string used to separate each key from its value (default: '=').\n * @param pairSeparator - The string used to separate each key-value pair (default: '&').\n *\n * @returns A deterministic string representation of the input object.\n *\n * @example\n *\n * ```ts\n * import { stringifyObjectDeterministically } from '@kikiutils/shared/object';\n *\n * console.log(stringifyObjectDeterministically({\n *     b: 2,\n *     a: {\n *         x: 1,\n *         y: [\n *             3,\n *             4,\n *         ],\n *     },\n * })); // => a.x=1&a.y.0=3&a.y.1=4&b=2\n *\n * console.log(stringifyObjectDeterministically({ foo: 'bar' }, ':', '|')); // => foo:bar\n * console.log(stringifyObjectDeterministically({})); // => ''\n * ```\n */\nexport function stringifyObjectDeterministically(\n    input: Record<string, any>,\n    kvSeparator: string = '=',\n    pairSeparator: string = '&',\n) {\n    const entries: string[] = [];\n\n    function walk(object: any, path: string[] = []) {\n        if (Array.isArray(object)) {\n            object.forEach((value, i) => {\n                walk(\n                    value,\n                    [\n                        ...path,\n                        i.toString(),\n                    ],\n                );\n            });\n        } else if (\n            object !== null\n            && typeof object === 'object'\n            && Object.prototype.toString.call(object) === '[object Object]'\n        ) {\n            Object.keys(object).sort().forEach((key) => {\n                walk(\n                    object[key],\n                    [\n                        ...path,\n                        key,\n                    ],\n                );\n            });\n        } else entries.push(`${path.join('.')}${kvSeparator}${String(object)}`);\n    }\n\n    walk(input);\n    return entries.sort().join(pairSeparator);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,iCACZ,OACA,cAAsB,KACtB,gBAAwB,KAC1B;CACE,MAAM,UAAoB,CAAC;CAE3B,SAAS,KAAK,QAAa,OAAiB,CAAC,GAAG;EAC5C,IAAI,MAAM,QAAQ,MAAM,GACpB,OAAO,SAAS,OAAO,MAAM;GACzB,KACI,OACA,CACI,GAAG,MACH,EAAE,SAAS,CACf,CACJ;EACJ,CAAC;OACE,IACH,WAAW,QACR,OAAO,WAAW,YAClB,OAAO,UAAU,SAAS,KAAK,MAAM,MAAM,mBAE9C,OAAO,KAAK,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,QAAQ;GACxC,KACI,OAAO,MACP,CACI,GAAG,MACH,GACJ,CACJ;EACJ,CAAC;OACE,QAAQ,KAAK,GAAG,KAAK,KAAK,GAAG,IAAI,cAAc,OAAO,MAAM,GAAG;CAC1E;CAEA,KAAK,KAAK;CACV,OAAO,QAAQ,KAAK,CAAC,CAAC,KAAK,aAAa;AAC5C"}

package/dist/pino.d.ts

@@ -1,25 +0,0 @@
-import { pino } from "pino";
-//#region src/pino.d.ts
-/**
- * A pino logger with environment-controlled verbosity.
- *
- * @remarks
- * `PINO_LOGGER_LEVEL` sets the log level when nonempty at module initialization;
- * otherwise, `NODE_ENV=production` selects `error`, and other environments retain the logger's default level.
- * Assign `logger.level` to change verbosity after initialization.
- *
- * @example
- *
- * ```ts
- * import { logger } from '@kikiutils/shared/pino';
- *
- * logger.level = 'info';
- * logger.info('Application started');
- * ```
- *
- * @see {@link https://getpino.io/#/docs/api?id=level-string | Pino log levels}
- */
-export declare const pinoLogger: pino.Logger<never, boolean>;
-export declare const logger: pino.Logger<never, boolean>;
-//#endregion
-//# sourceMappingURL=pino.d.ts.map

package/dist/pino.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pino.d.ts","names":[],"sources":["../src/pino.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;qBA6Ba,YAAU,KAAA;qBACV,QAAM,KAAA"}

package/dist/pino.js

@@ -1,34 +0,0 @@
-import { pino } from "pino";
-import { PinoPretty } from "pino-pretty";
-//#region src/pino.ts
-const stream = PinoPretty({
-	colorize: true,
-	ignore: "hostname,pid",
-	translateTime: "SYS:yyyy-mm-dd HH:MM:ss.l"
-});
-/**
-* A pino logger with environment-controlled verbosity.
-*
-* @remarks
-* `PINO_LOGGER_LEVEL` sets the log level when nonempty at module initialization;
-* otherwise, `NODE_ENV=production` selects `error`, and other environments retain the logger's default level.
-* Assign `logger.level` to change verbosity after initialization.
-*
-* @example
-*
-* ```ts
-* import { logger } from '@kikiutils/shared/pino';
-*
-* logger.level = 'info';
-* logger.info('Application started');
-* ```
-*
-* @see {@link https://getpino.io/#/docs/api?id=level-string | Pino log levels}
-*/
-const pinoLogger = pino({}, stream);
-const logger = pinoLogger;
-pinoLogger.level = process.env.PINO_LOGGER_LEVEL || (process.env.NODE_ENV === "production" ? "error" : pinoLogger.level);
-//#endregion
-export { logger, pinoLogger };
-
-//# sourceMappingURL=pino.js.map

package/dist/pino.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pino.js","names":[],"sources":["../src/pino.ts"],"sourcesContent":["import { pino } from 'pino';\nimport { PinoPretty } from 'pino-pretty';\n\n// Configure pretty-printed log output.\nconst stream = PinoPretty({\n    colorize: true, // Enable colored output for better readability\n    ignore: 'hostname,pid', // Exclude 'hostname' and 'pid' fields from the logs\n    translateTime: 'SYS:yyyy-mm-dd HH:MM:ss.l', // Format the timestamp in 'yyyy-mm-dd HH:MM:ss.l' format\n});\n\n/**\n * A pino logger with environment-controlled verbosity.\n *\n * @remarks\n * `PINO_LOGGER_LEVEL` sets the log level when nonempty at module initialization;\n * otherwise, `NODE_ENV=production` selects `error`, and other environments retain the logger's default level.\n * Assign `logger.level` to change verbosity after initialization.\n *\n * @example\n *\n * ```ts\n * import { logger } from '@kikiutils/shared/pino';\n *\n * logger.level = 'info';\n * logger.info('Application started');\n * ```\n *\n * @see {@link https://getpino.io/#/docs/api?id=level-string | Pino log levels}\n */\nexport const pinoLogger = pino({}, stream);\nexport const logger = pinoLogger;\n// eslint-disable-next-line style/max-len\npinoLogger.level = process.env.PINO_LOGGER_LEVEL || (process.env.NODE_ENV === 'production' ? 'error' : pinoLogger.level);\n"],"mappings":";;;AAIA,MAAM,SAAS,WAAW;CACtB,UAAU;CACV,QAAQ;CACR,eAAe;AACnB,CAAC;;;;;;;;;;;;;;;;;;;;AAqBD,MAAa,aAAa,KAAK,CAAC,GAAG,MAAM;AACzC,MAAa,SAAS;AAEtB,WAAW,QAAQ,QAAQ,IAAI,sBAAsB,QAAQ,IAAI,aAAa,eAAe,UAAU,WAAW"}

package/src/classes/ssh-client.ts

@@ -1,175 +0,0 @@
-import { createConsola } from 'consola';
-import type { ConsolaInstance } from 'consola';
-import { NodeSSH } from 'node-ssh';
-import type {
-    Config,
-    SSHExecCommandOptions,
-    SSHGetPutDirectoryOptions,
-    SSHPutFilesOptions,
-} from 'node-ssh';
-import type {
-    SFTPWrapper,
-    TransferOptions,
-} from 'ssh2';
-
-import type { PathLike } from './path';
-
-const loggerLevelStringToConsolaLogLevelMap = {
-    debug: 4,
-    error: 0,
-    fatal: 0,
-    info: 3,
-    normal: 2,
-    silent: -999,
-    trace: 5,
-    verbose: 999,
-    warn: 1,
-} as const;
-
-export class SshClient {
-    // Private instance properties
-    readonly #connectConfig: Config;
-    readonly #logger: ConsolaInstance;
-    #nodeSsh: NodeSSH;
-
-    // Public instance properties
-    getDir = this.getDirectory;
-    putDir = this.putDirectory;
-
-    // Constructor
-    constructor(host: string, username: string, password: string, port: number = 22, connectConfig?: Config) {
-        this.#connectConfig = {
-            ...connectConfig,
-            host,
-            password,
-            port,
-            username,
-        };
-
-        this.#logger = createConsola();
-        this.#nodeSsh = new NodeSSH();
-        if (process.env.NODE_ENV === 'production') this.setLoggerLevel('error');
-    }
-
-    // Public instance accessors
-    get nodeSsh() {
-        return this.#nodeSsh;
-    }
-
-    // Public instance methods
-    async connect() {
-        try {
-            this.#nodeSsh = await this.#nodeSsh.connect(this.#connectConfig);
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    disconnect() {
-        try {
-            this.#nodeSsh.dispose();
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    execCommand(command: string, options?: SSHExecCommandOptions) {
-        return this.#nodeSsh.execCommand(command, options).catch(() => {});
-    }
-
-    execCommandWithIo(command: string, options?: SSHExecCommandOptions) {
-        return this.execCommand(
-            command,
-            {
-                ...options,
-                onStderr: (data) => process.stderr.write(data.toString()),
-                onStdout: (data) => process.stdout.write(data.toString()),
-            },
-        );
-    }
-
-    async getDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {
-        try {
-            return await this.#nodeSsh.getDirectory(localDirectory.toString(), remoteDirectory.toString(), options);
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    async getFile(
-        localFile: PathLike,
-        remoteFile: PathLike,
-        givenSftp?: null | SFTPWrapper,
-        transferOptions?: null | TransferOptions,
-    ) {
-        try {
-            await this.#nodeSsh.getFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    isConnected() {
-        return this.#nodeSsh.isConnected();
-    }
-
-    async mkdir(path: PathLike) {
-        try {
-            await this.#nodeSsh.mkdir(path.toString());
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    async putDirectory(localDirectory: PathLike, remoteDirectory: PathLike, options?: SSHGetPutDirectoryOptions) {
-        try {
-            return await this.#nodeSsh.putDirectory(localDirectory.toString(), remoteDirectory.toString(), options);
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    async putFile(
-        localFile: PathLike,
-        remoteFile: PathLike,
-        givenSftp?: null | SFTPWrapper,
-        transferOptions?: null | TransferOptions,
-    ) {
-        try {
-            await this.#nodeSsh.putFile(localFile.toString(), remoteFile.toString(), givenSftp, transferOptions);
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    async putFiles(files: { local: PathLike; remote: PathLike }[], options?: SSHPutFilesOptions) {
-        try {
-            const convertedFiles = files.map(({ local, remote }) => ({
-                local: local.toString(),
-                remote: remote.toString(),
-            }));
-
-            await this.#nodeSsh.putFiles(convertedFiles, options);
-            return true;
-        } catch (error) {
-            this.#logger.error(error);
-            return false;
-        }
-    }
-
-    setLoggerLevel(level: keyof typeof loggerLevelStringToConsolaLogLevelMap) {
-        this.#logger.level = loggerLevelStringToConsolaLogLevelMap[level];
-    }
-}

package/src/consola.ts

@@ -1,25 +0,0 @@
-import { createConsola } from 'consola';
-
-/**
- * A consola logger with environment-controlled verbosity.
- *
- * @remarks
- * `CONSOLA_LOGGER_LEVEL` sets the log level when defined at module initialization;
- * otherwise, `NODE_ENV=production` selects `0`, and other environments retain the logger's default level.
- * Assign `logger.level` to change verbosity after initialization.
- *
- * @example
- *
- * ```ts
- * import { logger } from '@kikiutils/shared/consola';
- *
- * logger.level = 3;
- * logger.info('Application started');
- * ```
- *
- * @see {@link https://github.com/unjs/consola#log-level | Consola log levels}
- */
-export const consolaLogger = createConsola();
-export const logger = consolaLogger;
-if (process.env.CONSOLA_LOGGER_LEVEL !== undefined) consolaLogger.level = +process.env.CONSOLA_LOGGER_LEVEL;
-else consolaLogger.level = process.env.NODE_ENV === 'production' ? 0 : consolaLogger.level;

package/src/object.ts

@@ -1,78 +0,0 @@
-/**
- * Serializes a nested object into a deterministic, flat string format.
- *
- * @remarks
- * This function recursively traverses the input object (including nested objects and arrays),
- * flattens it into key paths using dot notation (e.g. "a.b.0.c"), sorts all keys,
- * and joins each key-value pair into a string with customizable separators.
- *
- * It is designed for use cases such as signature generation, cache key construction,
- * or any context requiring consistent and predictable object serialization.
- *
- * Note: Empty objects and arrays produce an empty string, which is useful for
- * generating deterministic signature payloads.
- *
- * @param input - The object to serialize. Can contain nested objects and arrays.
- * @param kvSeparator - The string used to separate each key from its value (default: '=').
- * @param pairSeparator - The string used to separate each key-value pair (default: '&').
- *
- * @returns A deterministic string representation of the input object.
- *
- * @example
- *
- * ```ts
- * import { stringifyObjectDeterministically } from '@kikiutils/shared/object';
- *
- * console.log(stringifyObjectDeterministically({
- *     b: 2,
- *     a: {
- *         x: 1,
- *         y: [
- *             3,
- *             4,
- *         ],
- *     },
- * })); // => a.x=1&a.y.0=3&a.y.1=4&b=2
- *
- * console.log(stringifyObjectDeterministically({ foo: 'bar' }, ':', '|')); // => foo:bar
- * console.log(stringifyObjectDeterministically({})); // => ''
- * ```
- */
-export function stringifyObjectDeterministically(
-    input: Record<string, any>,
-    kvSeparator: string = '=',
-    pairSeparator: string = '&',
-) {
-    const entries: string[] = [];
-
-    function walk(object: any, path: string[] = []) {
-        if (Array.isArray(object)) {
-            object.forEach((value, i) => {
-                walk(
-                    value,
-                    [
-                        ...path,
-                        i.toString(),
-                    ],
-                );
-            });
-        } else if (
-            object !== null
-            && typeof object === 'object'
-            && Object.prototype.toString.call(object) === '[object Object]'
-        ) {
-            Object.keys(object).sort().forEach((key) => {
-                walk(
-                    object[key],
-                    [
-                        ...path,
-                        key,
-                    ],
-                );
-            });
-        } else entries.push(`${path.join('.')}${kvSeparator}${String(object)}`);
-    }
-
-    walk(input);
-    return entries.sort().join(pairSeparator);
-}

package/src/pino.ts

@@ -1,33 +0,0 @@
-import { pino } from 'pino';
-import { PinoPretty } from 'pino-pretty';
-
-// Configure pretty-printed log output.
-const stream = PinoPretty({
-    colorize: true, // Enable colored output for better readability
-    ignore: 'hostname,pid', // Exclude 'hostname' and 'pid' fields from the logs
-    translateTime: 'SYS:yyyy-mm-dd HH:MM:ss.l', // Format the timestamp in 'yyyy-mm-dd HH:MM:ss.l' format
-});
-
-/**
- * A pino logger with environment-controlled verbosity.
- *
- * @remarks
- * `PINO_LOGGER_LEVEL` sets the log level when nonempty at module initialization;
- * otherwise, `NODE_ENV=production` selects `error`, and other environments retain the logger's default level.
- * Assign `logger.level` to change verbosity after initialization.
- *
- * @example
- *
- * ```ts
- * import { logger } from '@kikiutils/shared/pino';
- *
- * logger.level = 'info';
- * logger.info('Application started');
- * ```
- *
- * @see {@link https://getpino.io/#/docs/api?id=level-string | Pino log levels}
- */
-export const pinoLogger = pino({}, stream);
-export const logger = pinoLogger;
-// eslint-disable-next-line style/max-len
-pinoLogger.level = process.env.PINO_LOGGER_LEVEL || (process.env.NODE_ENV === 'production' ? 'error' : pinoLogger.level);