@dudousxd/nestjs-codegen 0.14.2 → 0.16.0

package/dist/nest/index.d.cts

@@ -1,5 +1,6 @@
-import { DynamicModule, OnApplicationBootstrap, OnModuleDestroy } from '@nestjs/common';
-import { U as UserConfig } from '../index-DT8SgPxp.cjs';
+import * as _nestjs_common from '@nestjs/common';
+import { DynamicModule, OnApplicationBootstrap, OnModuleDestroy, ExecutionContext } from '@nestjs/common';
+import { U as UserConfig } from '../index-LQNP7Ms3.cjs';
 import 'ts-morph';
 
 /**
@@ -82,4 +83,56 @@ declare class NestjsCodegenModule {
     static forRoot(options?: CodegenModuleOptions): DynamicModule;
 }
 
-export { CODEGEN_MODULE_OPTIONS, type CodegenModuleOptions, NestjsCodegenModule, NestjsCodegenService, shouldRun };
+/**
+ * Normalize a raw query value — `string | string[] | undefined | null` (and, for
+ * back-compat with the comma-joined wire format, a comma-separated string) — into
+ * a clean `string[]`.
+ *
+ * Why this exists: Express (and therefore Nest's default query parser) hands back a
+ * **bare `string`** when a querystring key carries exactly one value (`?ids=a`), and a
+ * `string[]` only when it carries two or more (`?ids=a&ids=b`). `ParseArrayPipe` rejects
+ * the single-value form, so the *common* case (one item selected) 400s while the
+ * multi-value case passes — an inverted footgun. This helper accepts every shape:
+ *
+ * - `undefined` / `null`                 → `[]`
+ * - `'a'`            (single value)      → `['a']`
+ * - `['a', 'b']`     (repeated param)    → `['a', 'b']`
+ * - `'a,b'`          (comma-joined wire) → `['a', 'b']`  (see `@dudousxd/nestjs-client`
+ *                                          `arrayFormat: 'comma'`, the client default)
+ *
+ * Empty/whitespace-only entries are dropped. The comma-split is a compatibility fallback:
+ * once the client sends `arrayFormat: 'repeat'` (`?ids=a&ids=b`), it degrades to a no-op
+ * and only the single-value bare-string case still needs normalizing.
+ *
+ * Exported standalone so it can back a `class-transformer` `@Transform` on a DTO field
+ * (`@Transform(({ value }) => toStringList(value))`) as well as the {@link QueryList}
+ * param decorator.
+ */
+declare function toStringList(raw: unknown): string[];
+/**
+ * Resolve a `string[]` from a request's query param `key` via {@link toStringList}.
+ * The seam the {@link QueryList} decorator is built on — exported so callers can reuse
+ * the exact resolution in a bespoke `createParamDecorator`. Returns `[]` when no `key`
+ * is given (a param decorator cannot infer the target property name).
+ */
+declare function resolveQueryList(key: string | undefined, ctx: ExecutionContext): string[];
+/**
+ * Param decorator that reads an array query param safely, always yielding a clean
+ * `string[]` regardless of whether the client sent one value, many, or a comma-joined
+ * string. Use it instead of `@Query(key, ParseArrayPipe)` for *optional* array query
+ * params:
+ *
+ * ```ts
+ * @Get()
+ * list(@QueryList('baseIds') baseIds: string[]) {
+ *   // baseIds is always a clean string[] — [] when the param is absent,
+ *   // ['a'] for ?baseIds=a, ['a','b'] for ?baseIds=a&baseIds=b or ?baseIds=a,b
+ * }
+ * ```
+ *
+ * See {@link toStringList} for the exact normalization and the single-value footgun it
+ * closes.
+ */
+declare const QueryList: (...dataOrPipes: (string | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>> | undefined)[]) => ParameterDecorator;
+
+export { CODEGEN_MODULE_OPTIONS, type CodegenModuleOptions, NestjsCodegenModule, NestjsCodegenService, QueryList, resolveQueryList, shouldRun, toStringList };

package/dist/nest/index.d.ts

@@ -1,5 +1,6 @@
-import { DynamicModule, OnApplicationBootstrap, OnModuleDestroy } from '@nestjs/common';
-import { U as UserConfig } from '../index-DT8SgPxp.js';
+import * as _nestjs_common from '@nestjs/common';
+import { DynamicModule, OnApplicationBootstrap, OnModuleDestroy, ExecutionContext } from '@nestjs/common';
+import { U as UserConfig } from '../index-LQNP7Ms3.js';
 import 'ts-morph';
 
 /**
@@ -82,4 +83,56 @@ declare class NestjsCodegenModule {
     static forRoot(options?: CodegenModuleOptions): DynamicModule;
 }
 
-export { CODEGEN_MODULE_OPTIONS, type CodegenModuleOptions, NestjsCodegenModule, NestjsCodegenService, shouldRun };
+/**
+ * Normalize a raw query value — `string | string[] | undefined | null` (and, for
+ * back-compat with the comma-joined wire format, a comma-separated string) — into
+ * a clean `string[]`.
+ *
+ * Why this exists: Express (and therefore Nest's default query parser) hands back a
+ * **bare `string`** when a querystring key carries exactly one value (`?ids=a`), and a
+ * `string[]` only when it carries two or more (`?ids=a&ids=b`). `ParseArrayPipe` rejects
+ * the single-value form, so the *common* case (one item selected) 400s while the
+ * multi-value case passes — an inverted footgun. This helper accepts every shape:
+ *
+ * - `undefined` / `null`                 → `[]`
+ * - `'a'`            (single value)      → `['a']`
+ * - `['a', 'b']`     (repeated param)    → `['a', 'b']`
+ * - `'a,b'`          (comma-joined wire) → `['a', 'b']`  (see `@dudousxd/nestjs-client`
+ *                                          `arrayFormat: 'comma'`, the client default)
+ *
+ * Empty/whitespace-only entries are dropped. The comma-split is a compatibility fallback:
+ * once the client sends `arrayFormat: 'repeat'` (`?ids=a&ids=b`), it degrades to a no-op
+ * and only the single-value bare-string case still needs normalizing.
+ *
+ * Exported standalone so it can back a `class-transformer` `@Transform` on a DTO field
+ * (`@Transform(({ value }) => toStringList(value))`) as well as the {@link QueryList}
+ * param decorator.
+ */
+declare function toStringList(raw: unknown): string[];
+/**
+ * Resolve a `string[]` from a request's query param `key` via {@link toStringList}.
+ * The seam the {@link QueryList} decorator is built on — exported so callers can reuse
+ * the exact resolution in a bespoke `createParamDecorator`. Returns `[]` when no `key`
+ * is given (a param decorator cannot infer the target property name).
+ */
+declare function resolveQueryList(key: string | undefined, ctx: ExecutionContext): string[];
+/**
+ * Param decorator that reads an array query param safely, always yielding a clean
+ * `string[]` regardless of whether the client sent one value, many, or a comma-joined
+ * string. Use it instead of `@Query(key, ParseArrayPipe)` for *optional* array query
+ * params:
+ *
+ * ```ts
+ * @Get()
+ * list(@QueryList('baseIds') baseIds: string[]) {
+ *   // baseIds is always a clean string[] — [] when the param is absent,
+ *   // ['a'] for ?baseIds=a, ['a','b'] for ?baseIds=a&baseIds=b or ?baseIds=a,b
+ * }
+ * ```
+ *
+ * See {@link toStringList} for the exact normalization and the single-value footgun it
+ * closes.
+ */
+declare const QueryList: (...dataOrPipes: (string | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>> | undefined)[]) => ParameterDecorator;
+
+export { CODEGEN_MODULE_OPTIONS, type CodegenModuleOptions, NestjsCodegenModule, NestjsCodegenService, QueryList, resolveQueryList, shouldRun, toStringList };