@nestia/sdk 7.0.0-dev.20250607 → 7.0.0

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/SwaggerOperationComposer.ts

@@ -1,119 +1,119 @@
-import { OpenApi } from "@samchon/openapi";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-
-import { INestiaConfig } from "../../INestiaConfig";
-import { SecurityAnalyzer } from "../../analyses/SecurityAnalyzer";
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
-import { SwaggerOperationParameterComposer } from "./SwaggerOperationParameterComposer";
-import { SwaggerOperationResponseComposer } from "./SwaggerOperationResponseComposer";
-
-export namespace SwaggerOperationComposer {
-  export const compose = (props: {
-    config: Omit<INestiaConfig.ISwaggerConfig, "output">;
-    document: OpenApi.IDocument;
-    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
-    route: ITypedHttpRoute;
-  }): OpenApi.IOperation => {
-    // COMPOSE TAGS
-    const tags: Set<string> = new Set([
-      ...props.route.controller.tags,
-      ...props.route.tags,
-      ...SwaggerDescriptionComposer.getJsDocTexts({
-        jsDocTags: props.route.jsDocTags,
-        name: "tag",
-      }).map((t) => t.split(" ")[0]),
-    ]);
-    if (tags.size) {
-      props.document.tags ??= [];
-      for (const t of tags)
-        if (props.document.tags.find((elem) => elem.name === t) === undefined)
-          props.document.tags.push({ name: t });
-      for (const texts of SwaggerDescriptionComposer.getJsDocTexts({
-        jsDocTags: props.route.jsDocTags,
-        name: "tag",
-      })) {
-        const [name, ...description] = texts.split(" ");
-        if (description.length)
-          props.document.tags.find(
-            (elem) => elem.name === name,
-          )!.description ??= description.join(" ");
-      }
-    }
-
-    // SECURITY
-    const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
-      ...props.route.controller.security,
-      ...props.route.security,
-      ...props.route.jsDocTags
-        .filter((tag) => tag.name === "security")
-        .map((tag) =>
-          tag.text === undefined
-            ? [{}]
-            : tag.text.map((text) => {
-                const line: string[] = text.text
-                  .split(" ")
-                  .filter((s) => s.trim())
-                  .filter((s) => !!s.length);
-                if (line.length === 0) return {};
-                return {
-                  [line[0]]: line.slice(1),
-                };
-              }),
-        )
-        .flat(),
-    );
-
-    // FINALIZE
-    return {
-      ...SwaggerDescriptionComposer.compose({
-        description: props.route.description,
-        jsDocTags: props.route.jsDocTags,
-        kind: "summary",
-      }),
-      deprecated: props.route.jsDocTags.some((tag) => tag.name === "deprecated")
-        ? true
-        : undefined,
-      tags: Array.from(tags),
-      operationId:
-        props.route.operationId ??
-        props.config.operationId?.({
-          class: props.route.controller.class.name,
-          function: props.route.name,
-          method: props.route.method as "GET",
-          path: props.route.path,
-        }),
-      parameters: [
-        ...props.route.pathParameters,
-        ...props.route.queryParameters,
-        ...(props.route.queryObject ? [props.route.queryObject] : []),
-        ...(props.route.headerObject ? [props.route.headerObject] : []),
-      ]
-        .map((p) =>
-          SwaggerOperationParameterComposer.compose({
-            config: props.config,
-            document: props.document,
-            schema: props.schema(p.metadata)!,
-            parameter: p,
-            jsDocTags: props.route.jsDocTags,
-          }),
-        )
-        .flat(),
-      requestBody: props.route.body
-        ? SwaggerOperationParameterComposer.body({
-            schema: props.schema(props.route.body.metadata)!,
-            jsDocTags: props.route.jsDocTags,
-            parameter: props.route.body,
-          })
-        : undefined,
-      responses: SwaggerOperationResponseComposer.compose({
-        schema: props.schema,
-        route: props.route,
-      }),
-      security: security.length ? security : undefined,
-      ...(props.route.extensions ?? {}),
-      "x-samchon-accessor": props.route.accessor,
-      "x-samchon-controller": props.route.controller.class.name,
-    };
-  };
-}
+import { OpenApi } from "@samchon/openapi";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { SecurityAnalyzer } from "../../analyses/SecurityAnalyzer";
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+import { SwaggerOperationParameterComposer } from "./SwaggerOperationParameterComposer";
+import { SwaggerOperationResponseComposer } from "./SwaggerOperationResponseComposer";
+
+export namespace SwaggerOperationComposer {
+  export const compose = (props: {
+    config: Omit<INestiaConfig.ISwaggerConfig, "output">;
+    document: OpenApi.IDocument;
+    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
+    route: ITypedHttpRoute;
+  }): OpenApi.IOperation => {
+    // COMPOSE TAGS
+    const tags: Set<string> = new Set([
+      ...props.route.controller.tags,
+      ...props.route.tags,
+      ...SwaggerDescriptionComposer.getJsDocTexts({
+        jsDocTags: props.route.jsDocTags,
+        name: "tag",
+      }).map((t) => t.split(" ")[0]),
+    ]);
+    if (tags.size) {
+      props.document.tags ??= [];
+      for (const t of tags)
+        if (props.document.tags.find((elem) => elem.name === t) === undefined)
+          props.document.tags.push({ name: t });
+      for (const texts of SwaggerDescriptionComposer.getJsDocTexts({
+        jsDocTags: props.route.jsDocTags,
+        name: "tag",
+      })) {
+        const [name, ...description] = texts.split(" ");
+        if (description.length)
+          props.document.tags.find(
+            (elem) => elem.name === name,
+          )!.description ??= description.join(" ");
+      }
+    }
+
+    // SECURITY
+    const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
+      ...props.route.controller.security,
+      ...props.route.security,
+      ...props.route.jsDocTags
+        .filter((tag) => tag.name === "security")
+        .map((tag) =>
+          tag.text === undefined
+            ? [{}]
+            : tag.text.map((text) => {
+                const line: string[] = text.text
+                  .split(" ")
+                  .filter((s) => s.trim())
+                  .filter((s) => !!s.length);
+                if (line.length === 0) return {};
+                return {
+                  [line[0]]: line.slice(1),
+                };
+              }),
+        )
+        .flat(),
+    );
+
+    // FINALIZE
+    return {
+      ...SwaggerDescriptionComposer.compose({
+        description: props.route.description,
+        jsDocTags: props.route.jsDocTags,
+        kind: "summary",
+      }),
+      deprecated: props.route.jsDocTags.some((tag) => tag.name === "deprecated")
+        ? true
+        : undefined,
+      tags: Array.from(tags),
+      operationId:
+        props.route.operationId ??
+        props.config.operationId?.({
+          class: props.route.controller.class.name,
+          function: props.route.name,
+          method: props.route.method as "GET",
+          path: props.route.path,
+        }),
+      parameters: [
+        ...props.route.pathParameters,
+        ...props.route.queryParameters,
+        ...(props.route.queryObject ? [props.route.queryObject] : []),
+        ...(props.route.headerObject ? [props.route.headerObject] : []),
+      ]
+        .map((p) =>
+          SwaggerOperationParameterComposer.compose({
+            config: props.config,
+            document: props.document,
+            schema: props.schema(p.metadata)!,
+            parameter: p,
+            jsDocTags: props.route.jsDocTags,
+          }),
+        )
+        .flat(),
+      requestBody: props.route.body
+        ? SwaggerOperationParameterComposer.body({
+            schema: props.schema(props.route.body.metadata)!,
+            jsDocTags: props.route.jsDocTags,
+            parameter: props.route.body,
+          })
+        : undefined,
+      responses: SwaggerOperationResponseComposer.compose({
+        schema: props.schema,
+        route: props.route,
+      }),
+      security: security.length ? security : undefined,
+      ...(props.route.extensions ?? {}),
+      "x-samchon-accessor": props.route.accessor,
+      "x-samchon-controller": props.route.controller.class.name,
+    };
+  };
+}