@dereekb/nestjs 13.11.14 → 13.11.15

package/index.cjs.js

@@ -148,6 +148,9 @@ function _ts_generator$2(thisArg, body) {
  * The ref's {@link AssetLocalPathRef.path} is resolved relative
  * to the configured {@link NodeJsLocalAssetLoaderConfig.basePath}.
  *
+ * @param config - Filesystem configuration with base path.
+ * @returns An {@link AssetLoader} backed by the local filesystem.
+ *
  * @example
  * ```ts
  * const loader = nodeJsLocalAssetLoader({ basePath: './assets' });
@@ -155,9 +158,6 @@ function _ts_generator$2(thisArg, body) {
  *   // reads from ./assets/data/districts.json
  * });
  * ```
- *
- * @param config - Filesystem configuration with base path.
- * @returns An {@link AssetLoader} backed by the local filesystem.
  */ function nodeJsLocalAssetLoader(config) {
     var basePath = config.basePath;
     var getFn = function getFn(ref) {
@@ -192,16 +192,17 @@ function _ts_generator$2(thisArg, body) {
  * Local assets are loaded from the filesystem. Remote assets (which always
  * have absolute URLs) are loaded via `fetch`.
  *
- * @example
- * ```ts
- * @Module(appAssetLoaderModuleMetadata({
+ * @param config - Local filesystem config and optional remote fetch config.
+ * @returns NestJS {@link ModuleMetadata} that provides an {@link AssetLoader}.
+ *
+ * @Module (appAssetLoaderModuleMetadata({
  *   local: { basePath: './assets' }
  * }))
  * export class AppAssetLoaderModule {}
  * ```
  *
- * @param config - Local filesystem config and optional remote fetch config.
- * @returns NestJS {@link ModuleMetadata} that provides an {@link AssetLoader}.
+ * @example
+ * ```ts
  */ function appAssetLoaderModuleMetadata(config) {
     var local = nodeJsLocalAssetLoader(config.local);
     var remote = rxjs.fetchAssetLoader(config.remote);
@@ -233,8 +234,8 @@ function _ts_generator$2(thisArg, body) {
  *
  * Checks for both http://localhost and https://localhost origins.
  *
- * @param context - the NestJS execution context containing the HTTP request
- * @returns true if the request origin is localhost
+ * @param context - The NestJS execution context containing the HTTP request.
+ * @returns True if the request origin is localhost.
  */ function isLocalhost(context) {
     var _req_headers_origin;
     var req = context.switchToHttp().getRequest();
@@ -385,26 +386,17 @@ function _ts_generator$1(thisArg, body) {
  */ var rawBodyLogger = new common.Logger('RawBody');
 var ParseRawBody = common.createParamDecorator(function(_, context) {
     return _async_to_generator$1(function() {
-        var req, body;
+        var req;
         return _ts_generator$1(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    req = context.switchToHttp().getRequest();
-                    if (!req.readable) {
-                        rawBodyLogger.error('RawBody request was not readable. This is generally due to bad configuration.');
-                        throw new common.BadRequestException('Invalid body');
-                    }
-                    return [
-                        4,
-                        rawbody(req)
-                    ];
-                case 1:
-                    body = _state.sent();
-                    return [
-                        2,
-                        body
-                    ];
+            req = context.switchToHttp().getRequest();
+            if (!req.readable) {
+                rawBodyLogger.error('RawBody request was not readable. This is generally due to bad configuration.');
+                throw new common.BadRequestException('Invalid body');
             }
+            return [
+                2,
+                rawbody(req)
+            ];
         });
     })();
 });
@@ -462,9 +454,9 @@ var ParseRawBody = common.createParamDecorator(function(_, context) {
 /**
  * Parses a raw body buffer as JSON.
  *
- * @param rawBody - The raw body buffer to parse
- * @returns The parsed JSON object
- * @throws {SyntaxError} When the body is not valid JSON
+ * @param rawBody - The raw body buffer to parse.
+ * @returns The parsed JSON object.
+ * @throws {SyntaxError} When the body is not valid JSON.
  *
  * @example
  * ```typescript
@@ -477,8 +469,8 @@ var ParseRawBody = common.createParamDecorator(function(_, context) {
 /**
  * Parses a raw body buffer as a URL-encoded query string.
  *
- * @param rawBody - The raw body buffer to parse
- * @returns The parsed query parameters
+ * @param rawBody - The raw body buffer to parse.
+ * @returns The parsed query parameters.
  *
  * @example
  * ```typescript
@@ -491,8 +483,8 @@ var ParseRawBody = common.createParamDecorator(function(_, context) {
 /**
  * Converts a raw body buffer to a trimmed UTF-8 string.
  *
- * @param rawBody - The raw body buffer to convert
- * @returns The decoded and trimmed string content
+ * @param rawBody - The raw body buffer to convert.
+ * @returns The decoded and trimmed string content.
  *
  * @example
  * ```typescript
@@ -779,9 +771,9 @@ function _type_of(obj) {
 /**
  * Merges two module metadata entries together.
  *
- * @param base - the base module metadata
- * @param additional - additional metadata to merge in
- * @returns the merged module metadata
+ * @param base - The base module metadata.
+ * @param additional - Additional metadata to merge in.
+ * @returns The merged module metadata.
  */ function mergeModuleMetadata(base) {
     var additional = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
     return {
@@ -808,8 +800,8 @@ function _type_of(obj) {
  *
  * For class providers, returns the class itself; for object providers, returns the provide token.
  *
- * @param providers - the providers to extract tokens from
- * @returns an array of injection tokens
+ * @param providers - Providers to extract tokens from.
+ * @returns Injection tokens collected from each provider.
  */ function injectionTokensFromProviders(providers) {
     return util.asArray(providers).map(function(x) {
         return (typeof x === "undefined" ? "undefined" : _type_of(x)) === 'object' ? x.provide : x;
@@ -866,8 +858,8 @@ function _define_property$3(obj, key, value) {
             value: /**
      * Validates that the configuration contains a non-empty client web app URL.
      *
-     * @param config - The configuration to validate
-     * @throws {Error} When `clientWebAppUrl` is not specified
+     * @param config - The configuration to validate.
+     * @throws {Error} When `clientWebAppUrl` is not specified.
      */ function assertValidConfig(config) {
                 if (!config.client.clientWebAppUrl) {
                     throw new Error('No client app url specified.');
@@ -955,8 +947,9 @@ function _class_call_check$2(instance, Constructor) {
  *
  * Reads the client web app URL from the CLIENT_WEB_APP_URL environment variable.
  *
- * @param configService - NestJS config service for reading environment variables
- * @returns a validated ClientAppServiceConfig
+ * @param configService - NestJS config service for reading environment variables.
+ * @returns A validated ClientAppServiceConfig.
+ *
  * @__NO_SIDE_EFFECTS__
  */ function clientAppConfigFactory(configService) {
     var config = {
@@ -1020,8 +1013,8 @@ function _class_call_check$1(instance, Constructor) {
  *
  * Use this to register a server environment configuration instance with the NestJS dependency injection container.
  *
- * @param env - the server environment config to provide
- * @returns a NestJS Provider that supplies the config under SERVER_ENV_TOKEN
+ * @param env - The server environment config to provide.
+ * @returns A NestJS Provider that supplies the config under SERVER_ENV_TOKEN.
  */ function serverEnvTokenProvider(env) {
     return {
         provide: SERVER_ENV_TOKEN,
@@ -1032,7 +1025,7 @@ function _class_call_check$1(instance, Constructor) {
 /**
  * Checks process.env.NODE_ENV for "test".
  *
- * @returns true if the current Node environment is "test", false otherwise
+ * @returns True if the current Node environment is "test", false otherwise.
  */ function isTestNodeEnv() {
     return process.env['NODE_ENV'] === 'test';
 }
@@ -1159,7 +1152,7 @@ exports.ServerEnvironmentService = __decorate([
  * @param input.dirPath - Absolute path to the parent directory; created (recursively) when missing.
  * @param input.data - Value to serialize as JSON (pretty-printed with two-space indentation).
  * @param input.mode - Optional numeric file mode (e.g. `0o600`) applied via `chmod` after the write.
- * @returns A promise that resolves once the JSON has been written and the optional `chmod` has completed.
+ * @returns Resolves once the JSON has been written and the optional `chmod` has completed.
  */ function writeJsonFile(input) {
     node_fs.mkdirSync(input.dirPath, {
         recursive: true
@@ -1170,16 +1163,14 @@ exports.ServerEnvironmentService = __decorate([
         }, function(err) {
             if (err) {
                 reject(err);
-                return;
-            }
-            if (input.mode == null) {
+            } else if (input.mode == null) {
                 resolve();
-                return;
+            } else {
+                node_fs.chmod(input.filePath, input.mode, function(chmodErr) {
+                    if (chmodErr) reject(chmodErr);
+                    else resolve();
+                });
             }
-            node_fs.chmod(input.filePath, input.mode, function(chmodErr) {
-                if (chmodErr) reject(chmodErr);
-                else resolve();
-            });
         });
     });
 }
@@ -1191,7 +1182,7 @@ exports.ServerEnvironmentService = __decorate([
  * swallowing them masks real failures and makes operations appear to have succeeded.
  *
  * @param filePath - Absolute path to the file to remove.
- * @returns A promise that resolves once the file is removed (or was already absent).
+ * @returns Resolves once the file is removed (or was already absent).
  */ function removeFile(filePath) {
     return promises$1.rm(filePath, {
         force: true
@@ -1448,7 +1439,7 @@ function _ts_generator(thisArg, body) {
     return {
         load: function load() {
             return _async_to_generator(function() {
-                var raw;
+                var raw, result;
                 return _ts_generator(this, function(_state) {
                     switch(_state.label){
                         case 0:
@@ -1459,14 +1450,13 @@ function _ts_generator(thisArg, body) {
                         case 1:
                             raw = _state.sent();
                             if (raw == null) {
-                                return [
-                                    2,
-                                    undefined
-                                ];
+                                result = undefined;
+                            } else {
+                                result = reviver == null ? raw : reviver(raw);
                             }
                             return [
                                 2,
-                                reviver == null ? raw : reviver(raw)
+                                result
                             ];
                     }
                 });
@@ -1562,38 +1552,32 @@ function _ts_generator(thisArg, body) {
                     case 1:
                         raw = _state.sent();
                         if (raw == null) {
-                            return [
-                                2,
-                                {}
-                            ];
-                        }
-                        if (reviver == null) {
-                            return [
-                                2,
-                                raw
-                            ];
-                        }
-                        result = {};
-                        _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
-                        try {
-                            for(_iterator = Object.keys(raw)[Symbol.iterator](); !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
-                                key = _step.value;
-                                revived = reviver(raw[key]);
-                                if (revived != null) {
-                                    result[key] = revived;
-                                }
-                            }
-                        } catch (err) {
-                            _didIteratorError = true;
-                            _iteratorError = err;
-                        } finally{
+                            result = {};
+                        } else if (reviver == null) {
+                            result = raw;
+                        } else {
+                            result = {};
+                            _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
                             try {
-                                if (!_iteratorNormalCompletion && _iterator.return != null) {
-                                    _iterator.return();
+                                for(_iterator = Object.keys(raw)[Symbol.iterator](); !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                                    key = _step.value;
+                                    revived = reviver(raw[key]);
+                                    if (revived != null) {
+                                        result[key] = revived;
+                                    }
                                 }
+                            } catch (err) {
+                                _didIteratorError = true;
+                                _iteratorError = err;
                             } finally{
-                                if (_didIteratorError) {
-                                    throw _iteratorError;
+                                try {
+                                    if (!_iteratorNormalCompletion && _iterator.return != null) {
+                                        _iterator.return();
+                                    }
+                                } finally{
+                                    if (_didIteratorError) {
+                                        throw _iteratorError;
+                                    }
                                 }
                             }
                         }
@@ -1766,8 +1750,8 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
 /**
  * Validates that the given secret is a 64-character hexadecimal string (32 bytes for AES-256).
  *
- * @param secret - the hex-encoded secret key string to validate
- * @returns true if the secret is exactly 64 valid hex characters, false otherwise
+ * @param secret - The hex-encoded secret key string to validate.
+ * @returns True if the secret is exactly 64 valid hex characters, false otherwise.
  *
  * @example
  * ```typescript
@@ -1784,15 +1768,15 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
  * The getter is called immediately and the key is validated on creation. The returned
  * function provides the resolved Buffer without re-resolving or re-validating.
  *
+ * @param source - The secret source configuration.
+ * @returns A getter that returns the resolved 32-byte Buffer for AES-256 encryption.
+ * @throws {Error} When the resolved key is not 64 hex characters.
+ *
  * @example
  * ```typescript
  * const getKey = resolveEncryptionKey('a'.repeat(64));
  * const key: Buffer = getKey();
  * ```
- *
- * @param source - The secret source configuration.
- * @returns A getter that returns the resolved 32-byte Buffer for AES-256 encryption.
- * @throws Error if the resolved key is not 64 hex characters.
  */ function resolveEncryptionKey(source) {
     var hex = util.getValueFromGetter(source);
     if (!isValidAES256GCMEncryptionSecret(hex)) {
@@ -1806,6 +1790,10 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
 /**
  * Creates an `AES256GCMEncryption` instance that captures the resolved key in a closure.
  *
+ * @param source - The hex-encoded secret or getter for the AES-256 key.
+ * @returns An `AES256GCMEncryption` instance.
+ * @throws {Error} When the resolved key is not 64 hex characters.
+ *
  * @example
  * ```typescript
  * const encryption = createAES256GCMEncryption('a'.repeat(64));
@@ -1818,9 +1806,6 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
  * // decryptedStr === 'hello'
  * ```
  *
- * @param source - The hex-encoded secret or getter for the AES-256 key.
- * @returns An `AES256GCMEncryption` instance.
- * @throws Error if the resolved key is not 64 hex characters.
  * @__NO_SIDE_EFFECTS__
  */ function createAES256GCMEncryption(source) {
     var getKey = resolveEncryptionKey(source);
@@ -1872,16 +1857,16 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
  *
  * Format: base64(IV (12 bytes) + ciphertext + authTag (16 bytes))
  *
+ * @param value - The value to encrypt (must be JSON-serializable).
+ * @param key - The 32-byte encryption key from `resolveEncryptionKey()`.
+ * @returns The encrypted value as a base64 string.
+ *
  * @example
  * ```typescript
  * const getKey = resolveEncryptionKey(mySecret);
  * const encrypted = encryptValue({ sensitive: 'data' }, getKey());
  * const decrypted = decryptValue<{ sensitive: string }>(encrypted, getKey());
  * ```
- *
- * @param value - The value to encrypt (must be JSON-serializable).
- * @param key - The 32-byte encryption key from `resolveEncryptionKey()`.
- * @returns The encrypted value as a base64 string.
  */ function encryptValue(value, key) {
     var iv = node_crypto.randomBytes(ENCRYPTED_FIELD_IV_LENGTH);
     var cipher = node_crypto.createCipheriv(ENCRYPTED_FIELD_ALGORITHM, key, iv);
@@ -1924,6 +1909,10 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
  * The key is resolved and validated eagerly at creation time. The provider encrypts/decrypts
  * raw strings (no JSON serialization) — suitable for use with `selectiveFieldEncryptor`.
  *
+ * @param source - The hex-encoded secret or getter for the AES-256 key.
+ * @returns A `StringEncryptionProvider` that encrypts/decrypts strings via AES-256-GCM.
+ * @throws {Error} When the resolved key is not 64 hex characters.
+ *
  * @example
  * ```typescript
  * const provider = createAesStringEncryptionProvider('a'.repeat(64));
@@ -1932,9 +1921,6 @@ var ENCRYPTED_FIELD_KEY_LENGTH = 32;
  * // decrypted === 'sensitive data'
  * ```
  *
- * @param source - The hex-encoded secret or getter for the AES-256 key.
- * @returns A `StringEncryptionProvider` that encrypts/decrypts strings via AES-256-GCM.
- * @throws Error if the resolved key is not 64 hex characters.
  * @__NO_SIDE_EFFECTS__
  */ function createAesStringEncryptionProvider(source) {
     var encryption = createAES256GCMEncryption(source);
@@ -2077,6 +2063,9 @@ function _templateObject() {
  * Lives in `@dereekb/nestjs` (rather than `@dereekb/util`) because it uses Node's
  * built-in `node:crypto` module, which isn't available in the browser.
  *
+ * @param buffer - PDF file contents.
+ * @returns The encryption status of the PDF.
+ *
  * @example
  * ```ts
  * const status = detectPdfEncryption(buffer);
@@ -2088,9 +2077,6 @@ function _templateObject() {
  *   // Safe to read, but not to mutate without the owner password.
  * }
  * ```
- *
- * @param buffer - PDF file contents.
- * @returns The encryption status of the PDF.
  */ function detectPdfEncryption(buffer) {
     var result = 'unknown_encrypted';
     var encryptIndex = findEncryptKeywordIndex(buffer);
@@ -2430,7 +2416,7 @@ function readPdfTokenOrRefValue(buffer, start) {
     var token = buffer.toString('latin1', start, tokenEnd);
     var referenceEnd = readIndirectReferenceEnd(buffer, tokenEnd);
     var result;
-    if (referenceEnd !== null) {
+    if (referenceEnd != null) {
         result = {
             entry: {
                 type: 'ref',