@jsnw/srv-utils 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,70 @@
+# @jsnw/srv-utils
+
+Small server-side utility bundle for Node.js/TypeScript projects. It includes helpers for tsconfig path aliases, NestJS app bootstrapping, and YAML config loading with Zod validation plus a few predefined schemas.
+
+## Install
+
+```bash
+npm install @jsnw/srv-utils
+```
+
+Optional dependencies:
+- `module-alias` for `useTsconfigPaths`
+- `@nestjs/core` and `@nestjs/common` for `withNest`
+
+## Exports
+
+### useTsconfigPaths(fromPath, tsconfigPath)
+Loads `compilerOptions.paths` from a tsconfig file and registers them via `module-alias`.
+
+```ts
+import {useTsconfigPaths} from '@jsnw/srv-utils';
+
+useTsconfigPaths(__dirname, './tsconfig.json');
+```
+
+### getRootPackageDirnameSync()
+Finds the highest directory (from the current module) that still has a readable `package.json`.
+
+```ts
+import {getRootPackageDirnameSync} from '@jsnw/srv-utils';
+
+const root = getRootPackageDirnameSync();
+```
+
+### ConfigLoader.loadAndValidate(path, schema, addProps?)
+Loads a YAML file and validates it with a Zod schema. It also injects `isDev` based on `APP_CONTEXT`, `APPLICATION_CONTEXT`, or `NODE_ENV`. You can use `%pkgroot/` prefix in the path for automatic project-root resolution.
+
+```ts
+import {ConfigLoader, configSchemas} from '@jsnw/srv-utils';
+
+const config = ConfigLoader.loadAndValidate(
+  '%pkgroot/config.yml',
+  configSchemas.mongodbConnection
+);
+```
+
+### configSchemas
+Predefined Zod schemas:
+- `timeString` (parses strings like `5s`, `2 min` into milliseconds)
+- `connection` (host/port/user/pass)
+- `mongodbConnection` (extends connection, adds db/authDb/connectTimeout + dsn)
+- `mysqlConnection` (extends connection, adds dbname)
+- `redisConnection` (extends connection, adds db/keyPrefix)
+
+### withNest(moduleCls, fn)
+Creates a NestJS application context, runs your function, then closes the app unless you call `preventClosing`.
+
+```ts
+import {withNest} from '@jsnw/srv-utils';
+import {AppModule} from './app.module';
+
+await withNest(AppModule, async (app, preventClosing) => {
+  // use app.get(...) etc.
+  // preventClosing(); // if you want to keep it open
+});
+```
+
+## Types
+
+`ResolvedConfig` is exported from `@jsnw/srv-utils` for typed config results.

package/dist/types/useTsconfigPaths.d.ts

@@ -1,5 +1,9 @@
+type UseTsconfigPathsOptions = {
+    basePath?: string;
+    tsconfigPath: string;
+};
 /**
- * @param {string} fromPath
- * @param {string} tsconfigPath
+ * @param {UseTsconfigPathsOptions} options
  */
-export declare function useTsconfigPaths(fromPath: string, tsconfigPath: string): void;
+export declare function useTsconfigPaths({ basePath, tsconfigPath }: UseTsconfigPathsOptions): void;
+export {};

package/dist/useTsconfigPaths.js

@@ -3,10 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTsconfigPaths = useTsconfigPaths;
 const node_path_1 = require("node:path");
 /**
- * @param {string} fromPath
- * @param {string} tsconfigPath
+ * @param {UseTsconfigPathsOptions} options
  */
-function useTsconfigPaths(fromPath, tsconfigPath) {
+function useTsconfigPaths({ basePath, tsconfigPath }) {
     let moduleAlias = null;
     try {
         require('module-alias/register');
@@ -15,12 +14,17 @@ function useTsconfigPaths(fromPath, tsconfigPath) {
     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 = {};
+    const tsconfig = require((0, node_path_1.resolve)(tsconfigPath)), tsconfigDirPathname = (0, node_path_1.dirname)(tsconfigPath), paths = {};
+    if (!basePath && !tsconfig?.compilerOptions?.baseUrl)
+        throw new TypeError('Either basePath option should be provided or tsconfig.json should contain compilerOptions.baseUrl property');
+    const baseUrl = tsconfig?.compilerOptions?.baseUrl
+        ? (0, node_path_1.resolve)(tsconfig.compilerOptions.baseUrl)
+        : (0, node_path_1.resolve)(basePath);
     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]);
+        paths[moduleName] = (0, node_path_1.resolve)(tsconfigDirPathname, baseUrl, pathArray[0]);
     });
     moduleAlias.addAliases(paths);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jsnw/srv-utils",
-  "version": "1.0.0",
-  "description": "",
+  "version": "1.0.3",
+  "description": "Server-side utilities for Node.js/TypeScript: tsconfig paths, Nest helpers, and config loading.",
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",
   "exports": {