@nestia/sdk 11.0.0-dev.20260305 → 11.0.0-dev.20260312

package/src/generates/internal/SwaggerDescriptionComposer.ts

@@ -1,64 +1,64 @@
-import { IJsDocTagInfo } from "typia";
-
-export namespace SwaggerDescriptionComposer {
-  export const compose = <Kind extends "summary" | "title">(props: {
-    description: string | null;
-    jsDocTags: IJsDocTagInfo[];
-    kind: Kind;
-  }): Kind extends "summary"
-    ? { summary?: string; description?: string }
-    : { title?: string; description?: string } => {
-    const title: string | undefined = (() => {
-      const [explicit] = getJsDocTexts({
-        jsDocTags: props.jsDocTags,
-        name: props.kind,
-      });
-      if (explicit?.length) return explicit;
-      else if (!props.description?.length) return undefined;
-
-      const index: number = props.description.indexOf("\n");
-      const top: string = (
-        index === -1 ? props.description : props.description.substring(0, index)
-      ).trim();
-      return top.endsWith(".") ? top.substring(0, top.length - 1) : undefined;
-    })();
-    return {
-      [props.kind]: title,
-      description: props.description?.length ? props.description : undefined,
-    } as any;
-  };
-
-  export const descriptionFromJsDocTag = (props: {
-    jsDocTags: IJsDocTagInfo[];
-    tag: string;
-    parameter?: string;
-  }): string | undefined => {
-    const parametric: (elem: IJsDocTagInfo) => boolean = props.parameter
-      ? (tag) =>
-          tag.text!.find(
-            (elem) =>
-              elem.kind === "parameterName" && elem.text === props.parameter,
-          ) !== undefined
-      : () => true;
-    const tag: IJsDocTagInfo | undefined = props.jsDocTags.find(
-      (tag) => tag.name === props.tag && tag.text && parametric(tag),
-    );
-    return tag && tag.text
-      ? tag.text.find((elem) => elem.kind === "text")?.text
-      : undefined;
-  };
-
-  export const getJsDocTexts = (props: {
-    jsDocTags: IJsDocTagInfo[];
-    name: string;
-  }): string[] =>
-    props.jsDocTags
-      .filter(
-        (tag) =>
-          tag.name === props.name &&
-          tag.text &&
-          tag.text.find((elem) => elem.kind === "text" && elem.text.length) !==
-            undefined,
-      )
-      .map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
-}
+import { IJsDocTagInfo } from "typia";
+
+export namespace SwaggerDescriptionComposer {
+  export const compose = <Kind extends "summary" | "title">(props: {
+    description: string | null;
+    jsDocTags: IJsDocTagInfo[];
+    kind: Kind;
+  }): Kind extends "summary"
+    ? { summary?: string; description?: string }
+    : { title?: string; description?: string } => {
+    const title: string | undefined = (() => {
+      const [explicit] = getJsDocTexts({
+        jsDocTags: props.jsDocTags,
+        name: props.kind,
+      });
+      if (explicit?.length) return explicit;
+      else if (!props.description?.length) return undefined;
+
+      const index: number = props.description.indexOf("\n");
+      const top: string = (
+        index === -1 ? props.description : props.description.substring(0, index)
+      ).trim();
+      return top.endsWith(".") ? top.substring(0, top.length - 1) : undefined;
+    })();
+    return {
+      [props.kind]: title,
+      description: props.description?.length ? props.description : undefined,
+    } as any;
+  };
+
+  export const descriptionFromJsDocTag = (props: {
+    jsDocTags: IJsDocTagInfo[];
+    tag: string;
+    parameter?: string;
+  }): string | undefined => {
+    const parametric: (elem: IJsDocTagInfo) => boolean = props.parameter
+      ? (tag) =>
+          tag.text!.find(
+            (elem) =>
+              elem.kind === "parameterName" && elem.text === props.parameter,
+          ) !== undefined
+      : () => true;
+    const tag: IJsDocTagInfo | undefined = props.jsDocTags.find(
+      (tag) => tag.name === props.tag && tag.text && parametric(tag),
+    );
+    return tag && tag.text
+      ? tag.text.find((elem) => elem.kind === "text")?.text
+      : undefined;
+  };
+
+  export const getJsDocTexts = (props: {
+    jsDocTags: IJsDocTagInfo[];
+    name: string;
+  }): string[] =>
+    props.jsDocTags
+      .filter(
+        (tag) =>
+          tag.name === props.name &&
+          tag.text &&
+          tag.text.find((elem) => elem.kind === "text" && elem.text.length) !==
+            undefined,
+      )
+      .map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
+}

package/src/generates/internal/SwaggerOperationParameterComposer.ts

@@ -116,7 +116,7 @@ export namespace SwaggerOperationParameterComposer {
         (tag) => tag.name !== "hidden" && tag.name !== "ignore",
       ),
     ).map((p) => {
-      const json: IJsonSchemaCollection = JsonSchemasProgrammer.write({
+      const json: IJsonSchemaCollection = JsonSchemasProgrammer.writeSchemas({
         version: "3.1",
         metadatas: [p.value],
       }) as IJsonSchemaCollection;

package/src/index.ts

@@ -1,4 +1,4 @@
-import * as nestia from "./module";
-
-export * from "./module";
-export default nestia;
+import * as nestia from "./module";
+
+export * from "./module";
+export default nestia;

package/src/structures/INestiaProject.ts

@@ -1,13 +1,13 @@
-import ts from "typescript";
-
-import { INestiaConfig } from "../INestiaConfig";
-import { INestiaSdkInput } from "./INestiaSdkInput";
-import { IReflectOperationError } from "./IReflectOperationError";
-
-export interface INestiaProject {
-  config: INestiaConfig;
-  input: INestiaSdkInput;
-  checker: ts.TypeChecker;
-  errors: IReflectOperationError[];
-  warnings: IReflectOperationError[];
-}
+import ts from "typescript";
+
+import { INestiaConfig } from "../INestiaConfig";
+import { INestiaSdkInput } from "./INestiaSdkInput";
+import { IReflectOperationError } from "./IReflectOperationError";
+
+export interface INestiaProject {
+  config: INestiaConfig;
+  input: INestiaSdkInput;
+  checker: ts.TypeChecker;
+  errors: IReflectOperationError[];
+  warnings: IReflectOperationError[];
+}

package/src/structures/INestiaSdkInput.ts

@@ -1,20 +1,20 @@
-import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
-
-export interface INestiaSdkInput {
-  controllers: INestiaSdkInput.IController[];
-  globalPrefix?: {
-    prefix: string;
-    exclude?: Array<string | RouteInfo>;
-  };
-  versioning?: {
-    prefix: string;
-    defaultVersion?: VersionValue;
-  };
-}
-export namespace INestiaSdkInput {
-  export interface IController {
-    class: Function;
-    location: string;
-    prefixes: string[];
-  }
-}
+import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
+
+export interface INestiaSdkInput {
+  controllers: INestiaSdkInput.IController[];
+  globalPrefix?: {
+    prefix: string;
+    exclude?: Array<string | RouteInfo>;
+  };
+  versioning?: {
+    prefix: string;
+    defaultVersion?: VersionValue;
+  };
+}
+export namespace INestiaSdkInput {
+  export interface IController {
+    class: Function;
+    location: string;
+    prefixes: string[];
+  }
+}

package/src/structures/IReflectApplication.ts

@@ -1,8 +1,8 @@
-import { INestApplication } from "@nestjs/common";
-
-import { IReflectController } from "./IReflectController";
-
-export interface IReflectApplication {
-  application: INestApplication;
-  controllers: IReflectController[];
-}
+import { INestApplication } from "@nestjs/common";
+
+import { IReflectController } from "./IReflectController";
+
+export interface IReflectApplication {
+  application: INestApplication;
+  controllers: IReflectController[];
+}

package/src/structures/IReflectController.ts

@@ -1,15 +1,15 @@
-import type { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
-
-import { IReflectHttpOperation } from "./IReflectHttpOperation";
-import { IReflectWebSocketOperation } from "./IReflectWebSocketOperation";
-
-export interface IReflectController {
-  class: Function;
-  prefixes: string[];
-  paths: string[];
-  file: string;
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  operations: Array<IReflectHttpOperation | IReflectWebSocketOperation>;
-  security: Record<string, string[]>[];
-  tags: string[];
-}
+import type { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
+
+import { IReflectHttpOperation } from "./IReflectHttpOperation";
+import { IReflectWebSocketOperation } from "./IReflectWebSocketOperation";
+
+export interface IReflectController {
+  class: Function;
+  prefixes: string[];
+  paths: string[];
+  file: string;
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  operations: Array<IReflectHttpOperation | IReflectWebSocketOperation>;
+  security: Record<string, string[]>[];
+  tags: string[];
+}

package/src/structures/IReflectHttpOperation.ts

@@ -1,26 +1,26 @@
-import { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
-import { IJsDocTagInfo } from "typia";
-
-import { IReflectHttpOperationException } from "./IReflectHttpOperationException";
-import { IReflectHttpOperationParameter } from "./IReflectHttpOperationParameter";
-import { IReflectHttpOperationSuccess } from "./IReflectHttpOperationSuccess";
-import { IReflectImport } from "./IReflectImport";
-
-export interface IReflectHttpOperation {
-  protocol: "http";
-  function: Function;
-  name: string;
-  method: string;
-  paths: string[];
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  parameters: IReflectHttpOperationParameter[];
-  success: IReflectHttpOperationSuccess;
-  exceptions: Record<string, IReflectHttpOperationException>;
-  security: Record<string, string[]>[];
-  tags: string[];
-  imports: IReflectImport[];
-  operationId: string | undefined;
-  description: string | null;
-  jsDocTags: IJsDocTagInfo[];
-  extensions?: Record<string, any>;
-}
+import { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
+import { IJsDocTagInfo } from "typia";
+
+import { IReflectHttpOperationException } from "./IReflectHttpOperationException";
+import { IReflectHttpOperationParameter } from "./IReflectHttpOperationParameter";
+import { IReflectHttpOperationSuccess } from "./IReflectHttpOperationSuccess";
+import { IReflectImport } from "./IReflectImport";
+
+export interface IReflectHttpOperation {
+  protocol: "http";
+  function: Function;
+  name: string;
+  method: string;
+  paths: string[];
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  parameters: IReflectHttpOperationParameter[];
+  success: IReflectHttpOperationSuccess;
+  exceptions: Record<string, IReflectHttpOperationException>;
+  security: Record<string, string[]>[];
+  tags: string[];
+  imports: IReflectImport[];
+  operationId: string | undefined;
+  description: string | null;
+  jsDocTags: IJsDocTagInfo[];
+  extensions?: Record<string, any>;
+}

package/src/structures/IReflectImport.ts

@@ -1,6 +1,6 @@
-export interface IReflectImport {
-  file: string;
-  asterisk: string | null;
-  default: string | null;
-  elements: string[];
-}
+export interface IReflectImport {
+  file: string;
+  asterisk: string | null;
+  default: string | null;
+  elements: string[];
+}

package/src/structures/IReflectOperationError.ts

@@ -1,26 +1,26 @@
-import { IComparable } from "tstl";
-
-import { IOperationMetadata } from "../transformers/IOperationMetadata";
-
-export interface IReflectOperationError {
-  file: string;
-  class: string;
-  function: string | null;
-  from: string | null;
-  contents: Array<string | IOperationMetadata.IError>;
-}
-export namespace IReflectOperationError {
-  export class Key implements Pick<IComparable<Key>, "less"> {
-    public constructor(public readonly error: IReflectOperationError) {}
-
-    public less(obj: Key): boolean {
-      if (this.error.file !== obj.error.file)
-        return this.error.file < obj.error.file;
-      else if (this.error.class !== obj.error.class)
-        return this.error.class < obj.error.class;
-      else if (this.error.function !== obj.error.function)
-        return (this.error.function ?? "") < (obj.error.function ?? "");
-      return (this.error.from ?? "") < (obj.error.from ?? "");
-    }
-  }
-}
+import { IComparable } from "tstl";
+
+import { IOperationMetadata } from "../transformers/IOperationMetadata";
+
+export interface IReflectOperationError {
+  file: string;
+  class: string;
+  function: string | null;
+  from: string | null;
+  contents: Array<string | IOperationMetadata.IError>;
+}
+export namespace IReflectOperationError {
+  export class Key implements Pick<IComparable<Key>, "less"> {
+    public constructor(public readonly error: IReflectOperationError) {}
+
+    public less(obj: Key): boolean {
+      if (this.error.file !== obj.error.file)
+        return this.error.file < obj.error.file;
+      else if (this.error.class !== obj.error.class)
+        return this.error.class < obj.error.class;
+      else if (this.error.function !== obj.error.function)
+        return (this.error.function ?? "") < (obj.error.function ?? "");
+      return (this.error.from ?? "") < (obj.error.from ?? "");
+    }
+  }
+}

package/src/structures/IReflectType.ts

@@ -1,4 +1,4 @@
-export interface IReflectType {
-  name: string;
-  typeArguments?: IReflectType[];
-}
+export interface IReflectType {
+  name: string;
+  typeArguments?: IReflectType[];
+}

package/src/structures/IReflectWebSocketOperation.ts

@@ -1,17 +1,17 @@
-import { VERSION_NEUTRAL } from "@nestjs/common";
-import ts from "typescript";
-
-import { IReflectImport } from "./IReflectImport";
-import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
-
-export interface IReflectWebSocketOperation {
-  protocol: "websocket";
-  name: string;
-  paths: string[];
-  function: Function;
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  parameters: IReflectWebSocketOperationParameter[];
-  imports: IReflectImport[];
-  description: string | null;
-  jsDocTags: ts.JSDocTagInfo[];
-}
+import { VERSION_NEUTRAL } from "@nestjs/common";
+import ts from "typescript";
+
+import { IReflectImport } from "./IReflectImport";
+import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
+
+export interface IReflectWebSocketOperation {
+  protocol: "websocket";
+  name: string;
+  paths: string[];
+  function: Function;
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  parameters: IReflectWebSocketOperationParameter[];
+  imports: IReflectImport[];
+  description: string | null;
+  jsDocTags: ts.JSDocTagInfo[];
+}

package/src/structures/IReflectWebSocketOperationParameter.ts

@@ -1,36 +1,36 @@
-import { IJsDocTagInfo } from "typia";
-
-import { IReflectImport } from "./IReflectImport";
-import { IReflectType } from "./IReflectType";
-
-export type IReflectWebSocketOperationParameter =
-  | IReflectWebSocketOperationParameter.IAcceptor
-  | IReflectWebSocketOperationParameter.IDriver
-  | IReflectWebSocketOperationParameter.IHeader
-  | IReflectWebSocketOperationParameter.IParam
-  | IReflectWebSocketOperationParameter.IQuery;
-export namespace IReflectWebSocketOperationParameter {
-  export type IAcceptor = IBase<"acceptor">;
-  export type IDriver = IBase<"driver">;
-  export type IHeader = IBase<"header">;
-  export type IQuery = IBase<"query">;
-  export interface IParam extends IBase<"param"> {
-    field: string;
-  }
-  interface IBase<Category extends string> {
-    category: Category;
-    name: string;
-    index: number;
-    type: IReflectType;
-    imports: IReflectImport[];
-    description: string | null;
-    jsDocTags: IJsDocTagInfo[];
-  }
-
-  /** @internal */
-  export interface IPreconfigured {
-    category: "acceptor" | "driver" | "header" | "param" | "query";
-    index: number;
-    field?: string;
-  }
-}
+import { IJsDocTagInfo } from "typia";
+
+import { IReflectImport } from "./IReflectImport";
+import { IReflectType } from "./IReflectType";
+
+export type IReflectWebSocketOperationParameter =
+  | IReflectWebSocketOperationParameter.IAcceptor
+  | IReflectWebSocketOperationParameter.IDriver
+  | IReflectWebSocketOperationParameter.IHeader
+  | IReflectWebSocketOperationParameter.IParam
+  | IReflectWebSocketOperationParameter.IQuery;
+export namespace IReflectWebSocketOperationParameter {
+  export type IAcceptor = IBase<"acceptor">;
+  export type IDriver = IBase<"driver">;
+  export type IHeader = IBase<"header">;
+  export type IQuery = IBase<"query">;
+  export interface IParam extends IBase<"param"> {
+    field: string;
+  }
+  interface IBase<Category extends string> {
+    category: Category;
+    name: string;
+    index: number;
+    type: IReflectType;
+    imports: IReflectImport[];
+    description: string | null;
+    jsDocTags: IJsDocTagInfo[];
+  }
+
+  /** @internal */
+  export interface IPreconfigured {
+    category: "acceptor" | "driver" | "header" | "param" | "query";
+    index: number;
+    field?: string;
+  }
+}

package/src/structures/ITypedHttpRoute.ts

@@ -1,41 +1,41 @@
-import { IJsDocTagInfo } from "typia";
-
-import { IReflectController } from "./IReflectController";
-import { IReflectImport } from "./IReflectImport";
-import { ITypedHttpRouteException } from "./ITypedHttpRouteException";
-import { ITypedHttpRouteParameter } from "./ITypedHttpRouteParameter";
-import { ITypedHttpRouteSuccess } from "./ITypedHttpRouteSuccess";
-
-export interface ITypedHttpRoute {
-  protocol: "http";
-  function: Function;
-  controller: IReflectController;
-  name: string;
-  method: string;
-  path: string;
-  accessor: string[];
-
-  // PARAMETERS
-  pathParameters: ITypedHttpRouteParameter.IPath[];
-  queryParameters: ITypedHttpRouteParameter.IQuery[];
-  headerParameters: ITypedHttpRouteParameter.IHeaders[];
-  queryObject: ITypedHttpRouteParameter.IQuery | null;
-  headerObject: ITypedHttpRouteParameter.IHeaders | null;
-  body: ITypedHttpRouteParameter.IBody | null;
-
-  // RESPONSES
-  success: ITypedHttpRouteSuccess;
-  exceptions: Record<
-    number | "2XX" | "3XX" | "4XX" | "5XX",
-    ITypedHttpRouteException
-  >;
-
-  // ADDITIONAL INFORMATION
-  security: Record<string, string[]>[];
-  tags: string[];
-  imports: IReflectImport[];
-  description: string | null;
-  jsDocTags: IJsDocTagInfo[];
-  operationId: string | undefined;
-  extensions?: Record<string, any>;
-}
+import { IJsDocTagInfo } from "typia";
+
+import { IReflectController } from "./IReflectController";
+import { IReflectImport } from "./IReflectImport";
+import { ITypedHttpRouteException } from "./ITypedHttpRouteException";
+import { ITypedHttpRouteParameter } from "./ITypedHttpRouteParameter";
+import { ITypedHttpRouteSuccess } from "./ITypedHttpRouteSuccess";
+
+export interface ITypedHttpRoute {
+  protocol: "http";
+  function: Function;
+  controller: IReflectController;
+  name: string;
+  method: string;
+  path: string;
+  accessor: string[];
+
+  // PARAMETERS
+  pathParameters: ITypedHttpRouteParameter.IPath[];
+  queryParameters: ITypedHttpRouteParameter.IQuery[];
+  headerParameters: ITypedHttpRouteParameter.IHeaders[];
+  queryObject: ITypedHttpRouteParameter.IQuery | null;
+  headerObject: ITypedHttpRouteParameter.IHeaders | null;
+  body: ITypedHttpRouteParameter.IBody | null;
+
+  // RESPONSES
+  success: ITypedHttpRouteSuccess;
+  exceptions: Record<
+    number | "2XX" | "3XX" | "4XX" | "5XX",
+    ITypedHttpRouteException
+  >;
+
+  // ADDITIONAL INFORMATION
+  security: Record<string, string[]>[];
+  tags: string[];
+  imports: IReflectImport[];
+  description: string | null;
+  jsDocTags: IJsDocTagInfo[];
+  operationId: string | undefined;
+  extensions?: Record<string, any>;
+}

package/src/structures/ITypedWebSocketRoute.ts

@@ -1,24 +1,24 @@
-import { VERSION_NEUTRAL } from "@nestjs/common";
-import ts from "typescript";
-
-import { IReflectController } from "./IReflectController";
-import { IReflectImport } from "./IReflectImport";
-import { ITypedWebSocketRouteParameter } from "./ITypedWebSocketRouteParameter";
-
-export interface ITypedWebSocketRoute {
-  protocol: "websocket";
-  controller: IReflectController;
-  name: string;
-  path: string;
-  accessor: string[];
-  function: Function;
-  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  acceptor: ITypedWebSocketRouteParameter.IAcceptor;
-  header: ITypedWebSocketRouteParameter.IHeader | null;
-  pathParameters: ITypedWebSocketRouteParameter.IParam[];
-  query: ITypedWebSocketRouteParameter.IQuery | null;
-  driver: ITypedWebSocketRouteParameter.IDriver | null;
-  imports: IReflectImport[];
-  description: string | null;
-  jsDocTags: ts.JSDocTagInfo[];
-}
+import { VERSION_NEUTRAL } from "@nestjs/common";
+import ts from "typescript";
+
+import { IReflectController } from "./IReflectController";
+import { IReflectImport } from "./IReflectImport";
+import { ITypedWebSocketRouteParameter } from "./ITypedWebSocketRouteParameter";
+
+export interface ITypedWebSocketRoute {
+  protocol: "websocket";
+  controller: IReflectController;
+  name: string;
+  path: string;
+  accessor: string[];
+  function: Function;
+  versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
+  acceptor: ITypedWebSocketRouteParameter.IAcceptor;
+  header: ITypedWebSocketRouteParameter.IHeader | null;
+  pathParameters: ITypedWebSocketRouteParameter.IParam[];
+  query: ITypedWebSocketRouteParameter.IQuery | null;
+  driver: ITypedWebSocketRouteParameter.IDriver | null;
+  imports: IReflectImport[];
+  description: string | null;
+  jsDocTags: ts.JSDocTagInfo[];
+}

package/src/structures/ITypedWebSocketRouteParameter.ts

@@ -1,3 +1,3 @@
-import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
-
-export import ITypedWebSocketRouteParameter = IReflectWebSocketOperationParameter;
+import { IReflectWebSocketOperationParameter } from "./IReflectWebSocketOperationParameter";
+
+export import ITypedWebSocketRouteParameter = IReflectWebSocketOperationParameter;