@jsnw/srv-utils 1.0.0

package/dist/config/config-loader.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLoader = void 0;
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+const zod_1 = require("zod");
+const yaml_1 = require("yaml");
+const getRootPackageDirname_1 = require("../getRootPackageDirname");
+const PKG_ROOT_REGEX = /^%pkgroot[\/\\]/i;
+class ConfigLoader {
+    /**
+     * @template {z.ZodObject} S
+     * @template {object} P
+     * @param {string} path You can use %pkgroot prefix for automatic project root resolution by AppConfigLoader.
+     * Example: %pkgroot/config.yml
+     * @param {S} schema
+     * @param {P} addProps
+     * @returns {ResolvedConfig<S>}
+     */
+    static loadAndValidate(path, schema, addProps) {
+        if (PKG_ROOT_REGEX.test(path))
+            path = path.replace(PKG_ROOT_REGEX, (0, getRootPackageDirname_1.getRootPackageDirnameSync)() + node_path_1.sep);
+        let data = undefined;
+        let parsedYaml = undefined;
+        try {
+            data = (0, node_fs_1.readFileSync)(path, 'utf-8');
+        }
+        catch (e) {
+            console.error(`Failed to read config file at path: ${path}\nError: ${e?.message ?? '-'}; syscall: ${e?.syscall ?? '-'}`);
+            process.exit(1);
+        }
+        try {
+            parsedYaml = (0, yaml_1.parse)(data, { prettyErrors: true });
+        }
+        catch (e) {
+            console.error(`Failed to parse YAML file at path: ${path}\nError: ${e?.message ?? '-'}`);
+            process.exit(1);
+        }
+        const extendedSchema = schema.transform(v => ({
+            isDev: (process?.env?.APP_CONTEXT
+                ?? process?.env?.APPLICATION_CONTEXT
+                ?? process?.env?.NODE_ENV
+                ?? '').toLowerCase() !== 'production',
+            ...v
+        }));
+        const { data: config, error, success } = extendedSchema.safeParse(parsedYaml);
+        if (!success) {
+            if (error && error instanceof zod_1.ZodError) {
+                console.error(`Failed to validate config file at path ${path}. Error: ${zod_1.z.prettifyError(error)}`);
+                process.exit(1);
+            }
+            console.error(`Failed to parse config file at path ${path}`);
+            process.exit(1);
+        }
+        return {
+            ...config,
+            ...(addProps ? {} : addProps)
+        };
+    }
+}
+exports.ConfigLoader = ConfigLoader;

package/dist/config/config-loader.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configSchemas = exports.ConfigLoader = void 0;
+var config_loader_1 = require("./config-loader");
+Object.defineProperty(exports, "ConfigLoader", { enumerable: true, get: function () { return config_loader_1.ConfigLoader; } });
+var predefined_schemas_1 = require("./predefined-schemas");
+Object.defineProperty(exports, "configSchemas", { enumerable: true, get: function () { return predefined_schemas_1.configSchemas; } });

package/dist/config/predefined-schemas/connection.schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectionSchema = void 0;
+const zod_1 = require("zod");
+exports.connectionSchema = zod_1.z.object({
+    host: zod_1.z.string().nonempty(),
+    port: zod_1.z.number().min(1).max(65535),
+    user: zod_1.z.string(),
+    pass: zod_1.z.string()
+});

package/dist/config/predefined-schemas/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configSchemas = void 0;
+const timestring_schema_1 = require("./timestring.schema");
+const connection_schema_1 = require("./connection.schema");
+const mongodb_connection_schema_1 = require("./mongodb-connection.schema");
+const mysql_connection_schema_1 = require("./mysql-connection.schema");
+const redis_connection_schema_1 = require("./redis-connection.schema");
+exports.configSchemas = {
+    timeString: timestring_schema_1.timeStringSchema,
+    connection: connection_schema_1.connectionSchema,
+    mongodbConnection: mongodb_connection_schema_1.mongodbConnectionSchema,
+    mysqlConnection: mysql_connection_schema_1.mysqlConnectionSchema,
+    redisConnection: redis_connection_schema_1.redisConnectionSchema
+};

package/dist/config/predefined-schemas/mongodb-connection.schema.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mongodbConnectionSchema = void 0;
+const zod_1 = require("zod");
+const connection_schema_1 = require("./connection.schema");
+const timestring_schema_1 = require("./timestring.schema");
+exports.mongodbConnectionSchema = connection_schema_1.connectionSchema.extend({
+    db: zod_1.z.string().nonempty(),
+    authDb: zod_1.z.string().optional(),
+    connectTimeout: timestring_schema_1.timeStringSchema.default(5_000)
+}).transform(v => ({
+    ...v,
+    authDb: v.authDb || v.db,
+    dsn: `mongodb://${v.host}:${v.port}/${v.db}`
+}));

package/dist/config/predefined-schemas/mysql-connection.schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mysqlConnectionSchema = void 0;
+const zod_1 = require("zod");
+const connection_schema_1 = require("./connection.schema");
+exports.mysqlConnectionSchema = connection_schema_1.connectionSchema.extend({
+    dbname: zod_1.z.string().nonempty()
+});

package/dist/config/predefined-schemas/redis-connection.schema.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisConnectionSchema = void 0;
+const zod_1 = require("zod");
+const connection_schema_1 = require("./connection.schema");
+exports.redisConnectionSchema = connection_schema_1.connectionSchema.extend({
+    db: zod_1.z.number().min(0).default(0),
+    keyPrefix: zod_1.z.string().default('')
+});

package/dist/config/predefined-schemas/timestring.schema.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timeStringSchema = void 0;
+const zod_1 = require("zod");
+const ms_1 = __importDefault(require("ms"));
+const TIMESTRING_UNIT = ['Years', 'Year', 'Yrs', 'Yr', 'Y', 'Weeks', 'Week', 'W', 'Days', 'Day', 'D', 'Hours', 'Hour', 'Hrs', 'Hr', 'H', 'Minutes', 'Minute', 'Mins', 'Min', 'M', 'Seconds', 'Second', 'Secs', 'Sec', 's', 'Milliseconds', 'Millisecond', 'Msecs', 'Msec', 'Ms'];
+const TIMESTRING_REGEX = new RegExp(`\\d+\\s*(?:${TIMESTRING_UNIT.map(unit => unit.toLowerCase()).join('|')})`, 'i');
+exports.timeStringSchema = zod_1.z.string()
+    .nonempty()
+    .regex(TIMESTRING_REGEX)
+    .transform(v => (0, ms_1.default)(v));

package/dist/getRootPackageDirname.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRootPackageDirnameSync = getRootPackageDirnameSync;
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+let cachedRootPackageDirname = null;
+/**
+ * @returns {string}
+ */
+function getRootPackageDirnameSync() {
+    if (cachedRootPackageDirname !== null)
+        return cachedRootPackageDirname;
+    let path = (0, node_path_1.resolve)(__dirname, '..'), lastValidPath = path;
+    while (true) {
+        const packageJsonPath = (0, node_path_1.resolve)(path, 'package.json');
+        try {
+            (0, node_fs_1.accessSync)(packageJsonPath, node_fs_1.constants.F_OK | node_fs_1.constants.R_OK);
+        }
+        catch (e) {
+            break;
+        }
+        lastValidPath = path;
+        path = (0, node_path_1.resolve)(path, '..');
+    }
+    cachedRootPackageDirname = lastValidPath;
+    return lastValidPath;
+}

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withNest = exports.configSchemas = exports.ConfigLoader = exports.getRootPackageDirnameSync = exports.useTsconfigPaths = void 0;
+var useTsconfigPaths_1 = require("./useTsconfigPaths");
+Object.defineProperty(exports, "useTsconfigPaths", { enumerable: true, get: function () { return useTsconfigPaths_1.useTsconfigPaths; } });
+var getRootPackageDirname_1 = require("./getRootPackageDirname");
+Object.defineProperty(exports, "getRootPackageDirnameSync", { enumerable: true, get: function () { return getRootPackageDirname_1.getRootPackageDirnameSync; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "ConfigLoader", { enumerable: true, get: function () { return config_1.ConfigLoader; } });
+Object.defineProperty(exports, "configSchemas", { enumerable: true, get: function () { return config_1.configSchemas; } });
+var withNest_1 = require("./withNest");
+Object.defineProperty(exports, "withNest", { enumerable: true, get: function () { return withNest_1.withNest; } });

package/dist/types/config/config-loader.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { ResolvedConfig } from './config-loader.types';
+export declare abstract class ConfigLoader {
+    /**
+     * @template {z.ZodObject} S
+     * @template {object} P
+     * @param {string} path You can use %pkgroot prefix for automatic project root resolution by AppConfigLoader.
+     * Example: %pkgroot/config.yml
+     * @param {S} schema
+     * @param {P} addProps
+     * @returns {ResolvedConfig<S>}
+     */
+    static loadAndValidate<S extends z.ZodObject, P extends object | undefined = undefined>(path: string, schema: S, addProps?: P): ResolvedConfig<S, P>;
+}

package/dist/types/config/config-loader.types.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export type ResolvedConfig<T extends z.ZodObject, P extends object | undefined = undefined> = z.output<T> & {
+    isDev: boolean;
+} & (P extends undefined ? {} : P);

package/dist/types/config/index.d.ts

@@ -0,0 +1,3 @@
+export { ConfigLoader } from './config-loader';
+export type { ResolvedConfig } from './config-loader.types';
+export { configSchemas } from './predefined-schemas';

package/dist/types/config/predefined-schemas/connection.schema.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const connectionSchema: z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodNumber;
+    user: z.ZodString;
+    pass: z.ZodString;
+}, z.core.$strip>;

package/dist/types/config/predefined-schemas/index.d.ts

@@ -0,0 +1,50 @@
+export declare const configSchemas: {
+    timeString: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<number, string>>;
+    connection: import("zod").ZodObject<{
+        host: import("zod").ZodString;
+        port: import("zod").ZodNumber;
+        user: import("zod").ZodString;
+        pass: import("zod").ZodString;
+    }, import("zod/v4/core").$strip>;
+    mongodbConnection: import("zod").ZodPipe<import("zod").ZodObject<{
+        host: import("zod").ZodString;
+        port: import("zod").ZodNumber;
+        user: import("zod").ZodString;
+        pass: import("zod").ZodString;
+        db: import("zod").ZodString;
+        authDb: import("zod").ZodOptional<import("zod").ZodString>;
+        connectTimeout: import("zod").ZodDefault<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<number, string>>>;
+    }, import("zod/v4/core").$strip>, import("zod").ZodTransform<{
+        authDb: string;
+        dsn: string;
+        host: string;
+        port: number;
+        user: string;
+        pass: string;
+        db: string;
+        connectTimeout: number;
+    }, {
+        host: string;
+        port: number;
+        user: string;
+        pass: string;
+        db: string;
+        connectTimeout: number;
+        authDb?: string;
+    }>>;
+    mysqlConnection: import("zod").ZodObject<{
+        host: import("zod").ZodString;
+        port: import("zod").ZodNumber;
+        user: import("zod").ZodString;
+        pass: import("zod").ZodString;
+        dbname: import("zod").ZodString;
+    }, import("zod/v4/core").$strip>;
+    redisConnection: import("zod").ZodObject<{
+        host: import("zod").ZodString;
+        port: import("zod").ZodNumber;
+        user: import("zod").ZodString;
+        pass: import("zod").ZodString;
+        db: import("zod").ZodDefault<import("zod").ZodNumber>;
+        keyPrefix: import("zod").ZodDefault<import("zod").ZodString>;
+    }, import("zod/v4/core").$strip>;
+};

package/dist/types/config/predefined-schemas/mongodb-connection.schema.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+export declare const mongodbConnectionSchema: z.ZodPipe<z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodNumber;
+    user: z.ZodString;
+    pass: z.ZodString;
+    db: z.ZodString;
+    authDb: z.ZodOptional<z.ZodString>;
+    connectTimeout: z.ZodDefault<z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>>;
+}, z.core.$strip>, z.ZodTransform<{
+    authDb: string;
+    dsn: string;
+    host: string;
+    port: number;
+    user: string;
+    pass: string;
+    db: string;
+    connectTimeout: number;
+}, {
+    host: string;
+    port: number;
+    user: string;
+    pass: string;
+    db: string;
+    connectTimeout: number;
+    authDb?: string;
+}>>;

package/dist/types/config/predefined-schemas/mysql-connection.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const mysqlConnectionSchema: z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodNumber;
+    user: z.ZodString;
+    pass: z.ZodString;
+    dbname: z.ZodString;
+}, z.core.$strip>;

package/dist/types/config/predefined-schemas/redis-connection.schema.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const redisConnectionSchema: z.ZodObject<{
+    host: z.ZodString;
+    port: z.ZodNumber;
+    user: z.ZodString;
+    pass: z.ZodString;
+    db: z.ZodDefault<z.ZodNumber>;
+    keyPrefix: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;

package/dist/types/config/predefined-schemas/timestring.schema.d.ts

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export declare const timeStringSchema: z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>;

package/dist/types/getRootPackageDirname.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @returns {string}
+ */
+export declare function getRootPackageDirnameSync(): string;

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export { useTsconfigPaths } from './useTsconfigPaths';
+export { getRootPackageDirnameSync } from './getRootPackageDirname';
+export { ConfigLoader, configSchemas, type ResolvedConfig } from './config';
+export { withNest } from './withNest';

package/dist/types/useTsconfigPaths.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {string} fromPath
+ * @param {string} tsconfigPath
+ */
+export declare function useTsconfigPaths(fromPath: string, tsconfigPath: string): void;

package/dist/types/withNest.d.ts

@@ -0,0 +1,20 @@
+import type { INestApplicationContext } from '@nestjs/common';
+type WithNestFn = (app: INestApplicationContext, preventClosing: () => void) => Promise<void>;
+/**
+ * Executes a given function within the context of a NestJS application.
+ *
+ * This asynchronous function initializes a NestJS application context using the specified
+ * module class and then executes the provided function `fn` with the application instance.
+ * The application context is automatically closed upon completion of the function execution,
+ * unless the function execution requests otherwise by invoking a callback.
+ *
+ * @param {any} moduleCls - The module class to be used for creating the NestJS application context.
+ * @param {WithNestFn} fn - The function to be executed with the NestJS application context.
+ *                             It receives the application instance and a callback to prevent
+ *                             automatic application context closure.
+ * @returns {Promise<void>} A promise that resolves when the function execution is complete.
+ * @throws - Will throw an error if the `@nestjs/core` and/or `@nestjs/common` library is not found.
+ * @throws - Will propagate any error thrown by the executed function `fn`.
+ */
+export declare function withNest(moduleCls: any, fn: WithNestFn): Promise<void>;
+export {};

package/dist/useTsconfigPaths.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTsconfigPaths = useTsconfigPaths;
+const node_path_1 = require("node:path");
+/**
+ * @param {string} fromPath
+ * @param {string} tsconfigPath
+ */
+function useTsconfigPaths(fromPath, tsconfigPath) {
+    let moduleAlias = null;
+    try {
+        require('module-alias/register');
+        moduleAlias = require('module-alias');
+    }
+    catch (e) {
+        throw new Error('module-alias package should be installed to use the function');
+    }
+    const tsconfig = require(tsconfigPath), tsconfigDirPathname = (0, node_path_1.dirname)(tsconfigPath), paths = {};
+    Object.entries((tsconfig?.compilerOptions?.paths ?? {}))
+        .forEach(([moduleName, pathArray]) => {
+        if (pathArray.length === 0)
+            return;
+        paths[moduleName] = (0, node_path_1.resolve)(tsconfigDirPathname, (0, node_path_1.relative)(tsconfigDirPathname, fromPath), pathArray[0]);
+    });
+    moduleAlias.addAliases(paths);
+}

package/dist/withNest.js

@@ -0,0 +1,84 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withNest = withNest;
+/**
+ * Executes a given function within the context of a NestJS application.
+ *
+ * This asynchronous function initializes a NestJS application context using the specified
+ * module class and then executes the provided function `fn` with the application instance.
+ * The application context is automatically closed upon completion of the function execution,
+ * unless the function execution requests otherwise by invoking a callback.
+ *
+ * @param {any} moduleCls - The module class to be used for creating the NestJS application context.
+ * @param {WithNestFn} fn - The function to be executed with the NestJS application context.
+ *                             It receives the application instance and a callback to prevent
+ *                             automatic application context closure.
+ * @returns {Promise<void>} A promise that resolves when the function execution is complete.
+ * @throws - Will throw an error if the `@nestjs/core` and/or `@nestjs/common` library is not found.
+ * @throws - Will propagate any error thrown by the executed function `fn`.
+ */
+async function withNest(moduleCls, fn) {
+    let nestFactory = null;
+    try {
+        nestFactory = (await Promise.resolve().then(() => __importStar(require('@nestjs/core'))))?.NestFactory;
+        if (!nestFactory)
+            throw new Error('NestFactory not found');
+    }
+    catch (e) {
+        throw new Error('@nestjs/core and @nestjs/common are required for this function to work');
+    }
+    const app = await nestFactory.createApplicationContext(moduleCls);
+    let closeApplication = true;
+    let _e = undefined;
+    try {
+        await fn(app, () => {
+            closeApplication = false;
+        });
+    }
+    catch (e) {
+        console.error('Error caught while executing the WithNestFn. Error:', e);
+        _e = e;
+    }
+    try {
+        if (closeApplication)
+            await app.close();
+    }
+    catch (e) {
+        console.error('Failed to close application. Error:', e);
+    }
+    if (_e)
+        throw _e;
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@jsnw/srv-utils",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "./dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/pvbaliuk/jsn-srv-utils.git"
+  },
+  "keywords": [
+    "util",
+    "utils"
+  ],
+  "author": {
+    "name": "Pavlo Baliuk",
+    "email": "jsnow0177@gmail.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pvbaliuk/jsn-srv-utils/issues"
+  },
+  "homepage": "https://github.com/pvbaliuk/jsn-srv-utils#readme",
+  "dependencies": {
+    "ms": "^2.1.3",
+    "yaml": "^2.8.2",
+    "zod": "^4.3.6"
+  },
+  "optionalDependencies": {
+    "@nestjs/common": "^11.1.12",
+    "@nestjs/core": "^11.1.12",
+    "module-alias": "^2.3.3"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.1.12",
+    "@nestjs/core": "^11.1.12",
+    "@types/jest": "^30.0.0",
+    "@types/module-alias": "^2.0.4",
+    "@types/ms": "^2.1.0",
+    "jest": "^30.2.0",
+    "module-alias": "^2.3.3",
+    "rimraf": "^6.1.2",
+    "ts-jest": "^29.4.6",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3"
+  }
+}