@nestia/sdk 1.4.15 → 1.4.17

package/src/generates/internal/SdkSimulationProgrammer.ts

@@ -12,27 +12,33 @@ export namespace SdkSimulationProgrammer {
             `);`,
         ];
         const body: string[] = [
-            ...(route.parameters.length !== 0 ? assert(route.parameters) : []),
+            ...(route.parameters.filter((p) => p.category !== "headers")
+                .length !== 0
+                ? assert(route.parameters)
+                : []),
             ...(output ? returns() : []),
         ];
 
         return [
             `export const simulate = async (`,
             `    ${
-                route.parameters.length === 0 && route.output.name === "void"
+                route.parameters.filter((p) => p.category !== "headers")
+                    .length === 0 && route.output.name === "void"
                     ? "_connection"
                     : "connection"
             }: IConnection,`,
-            ...route.parameters.map(
-                (p) =>
-                    `    ${p.name}: ${
-                        p.category === "query" || p.category === "body"
-                            ? `${route.name}.${
-                                  p.category === "query" ? "Query" : "Input"
-                              }`
-                            : p.type.name
-                    },`,
-            ),
+            ...route.parameters
+                .filter((p) => p.category !== "headers")
+                .map(
+                    (p) =>
+                        `    ${p.name}: ${
+                            p.category === "query" || p.category === "body"
+                                ? `${route.name}.${
+                                      p.category === "query" ? "Query" : "Input"
+                                  }`
+                                : p.type.name
+                        },`,
+                ),
             `): Promise<${output ? "Output" : "void"}> => {`,
             ...body.map((l) => `    ${l}`),
             `}`,
@@ -46,18 +52,22 @@ export namespace SdkSimulationProgrammer {
         `    method: METHOD,`,
         `    host: connection.host,`,
         `    path: path(${parameters
-            .filter((p) => p.category !== "body")
+            .filter((p) => p.category !== "body" && p.category !== "headers")
             .map((p) => p.name)
             .join(", ")})`,
         `});`,
-        ...parameters.map((p) =>
-            p.category === "body"
-                ? `assert.body(() => typia.assert(${p.name}));`
-                : p.category === "query"
-                ? `assert.query(() => typia.assert(${p.name}));`
-                : `assert.param("${p.field}")("${
-                      p.custom && p.meta ? p.meta.type : p.type.name
-                  }")(() => typia.assert(${p.name}));`,
-        ),
+        ...parameters
+            .filter((p) => p.category !== "headers")
+            .map((p) =>
+                p.category === "body"
+                    ? `assert.body(() => typia.assert(${p.name}));`
+                    : p.category === "query"
+                    ? `assert.query(() => typia.assert(${p.name}));`
+                    : p.category === "headers"
+                    ? `assert.headers(() => typia.assert(${p.name}));` // not yet
+                    : `assert.param("${p.field}")("${
+                          p.custom && p.meta ? p.meta.type : p.type.name
+                      }")(() => typia.assert(${p.name}));`,
+            ),
     ];
 }

package/src/structures/IController.ts

@@ -24,6 +24,7 @@ export namespace IController {
     export type IParameter =
         | ICommonParameter
         | IQueryParameter
+        | IHeadersParameter
         | IBodyParameter
         | IPathParameter;
     export interface ICommonParameter {
@@ -33,6 +34,13 @@ export namespace IController {
         name: string;
         field: string | undefined;
     }
+    export interface IHeadersParameter {
+        custom: true;
+        category: "headers";
+        index: number;
+        name: string;
+        field: string | undefined;
+    }
     export interface IQueryParameter {
         custom: true;
         category: "query";

package/src/structures/{ISwaggerDocument.ts → ISwagger.ts}

@@ -1,16 +1,17 @@
 import { ISwaggerComponents } from "./ISwaggerComponents";
+import { ISwaggerInfo } from "./ISwaggerInfo";
 import { ISwaggerRoute } from "./ISwaggerRoute";
 
 /**
  * Swagger Document.
  *
- * `ISwaggerDocument` is a data structure representing content of `swagger.json` file
+ * `ISwagger` is a data structure representing content of `swagger.json` file
  * generated by Nestia. Note that, this is not an universal structure, but a dedicated
  * structure only for Nestia.
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export interface ISwaggerDocument {
+export interface ISwagger {
     /**
      * The version of the OpenAPI document.
      *
@@ -21,12 +22,12 @@ export interface ISwaggerDocument {
     /**
      * List of servers that provide the API.
      */
-    servers: ISwaggerDocument.IServer[];
+    servers: ISwagger.IServer[];
 
     /**
      * Information about the API.
      */
-    info: ISwaggerDocument.IInfo;
+    info: ISwaggerInfo;
 
     /**
      * The available paths and operations for the API.
@@ -56,7 +57,7 @@ export interface ISwaggerDocument {
      */
     security?: Record<string, string[]>[];
 }
-export namespace ISwaggerDocument {
+export namespace ISwagger {
     /**
      * Remote server definition.
      */
@@ -74,22 +75,16 @@ export namespace ISwaggerDocument {
         description?: string;
     }
 
-    /**
-     * General information about the API.
-     */
-    export interface IInfo {
-        /**
-         * Version of the API.
-         */
-        version: string;
-
+    export interface IExternalDocs {
         /**
-         * The title of the API.
+         * The URL for target documentation.
+         *
+         * @format url
          */
-        title: string;
+        url: string;
 
         /**
-         * A short description of the API.
+         * A short description of the target documentation.
          */
         description?: string;
     }

package/src/structures/ISwaggerInfo.ts

@@ -0,0 +1,80 @@
+/**
+ * Information about the API.
+ *
+ * @author Samchon
+ */
+export interface ISwaggerInfo {
+    /**
+     * The title of the API.
+     */
+    title: string;
+
+    /**
+     * A short description of the API.
+     */
+    description?: string;
+
+    /**
+     * A URL to the Terms of Service for the API.
+     *
+     * @format url
+     */
+    termsOfService?: string;
+
+    /**
+     * The contact information for the exposed API.
+     */
+    contact?: ISwaggerInfo.IContact;
+
+    /**
+     * The license information for the exposed API.
+     */
+    license?: ISwaggerInfo.ILicense;
+
+    /**
+     * Version of the API.
+     */
+    version: string;
+}
+export namespace ISwaggerInfo {
+    /**
+     * Contact information for the exposed API.
+     */
+    export interface IContact {
+        /**
+         * The identifying name of the contact person/organization.
+         */
+        name?: string;
+
+        /**
+         * The URL pointing to the contact information.
+         *
+         * @format url
+         */
+        url?: string;
+
+        /**
+         * The email address of the contact person/organization.
+         *
+         * @format email
+         */
+        email?: string;
+    }
+
+    /**
+     * License information for the exposed API.
+     */
+    export interface ILicense {
+        /**
+         * The license name used for the API.
+         */
+        name: string;
+
+        /**
+         * A URL to the license used for the API.
+         *
+         * @format url
+         */
+        url?: string;
+    }
+}

package/src/structures/ISwaggerRoute.ts

@@ -16,7 +16,7 @@ export interface ISwaggerRoute {
 }
 export namespace ISwaggerRoute {
     export interface IParameter {
-        name: string;
+        name?: string;
         in: string;
         schema: IJsonSchema;
         required: boolean;

package/src/structures/ParamCategory.ts

@@ -1 +1 @@
-export type ParamCategory = "param" | "query" | "body";
+export type ParamCategory = "param" | "query" | "body" | "headers";

package/lib/structures/ISwaggerDocument.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ISwaggerDocument.js","sourceRoot":"","sources":["../../src/structures/ISwaggerDocument.ts"],"names":[],"mappings":""}