nestia 3.1.0 → 3.1.1-dev.20221016

package/demo/encrypted/src/test/internal/StopWatch.ts

@@ -0,0 +1,15 @@
+export namespace StopWatch {
+    export type Task = () => Promise<void>;
+
+    export async function measure(task: Task): Promise<number> {
+        const time: number = Date.now();
+        await task();
+        return Date.now() - time;
+    }
+
+    export async function trace(title: string, task: Task): Promise<void> {
+        process.stdout.write(title);
+        const time: number = await measure(task);
+        console.log(`: ${time.toLocaleString()} ms`);
+    }
+}

package/demo/encrypted/swagger.json

@@ -0,0 +1,257 @@
+{
+  "openapi": "3.0.1",
+  "servers": [
+    {
+      "url": "https://github.com/samchon/nestia",
+      "description": "insert your server url"
+    }
+  ],
+  "info": {
+    "version": "0.1.0",
+    "title": "Generated by nestia - https://github.com/samchon/nestia"
+  },
+  "paths": {
+    "/sellers/authenticate/join": {
+      "post": {
+        "tags": [],
+        "summary": "encrypted",
+        "parameters": [],
+        "requestBody": {
+          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/nestia-helper#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of yours",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISeller.IJoin"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "## Warning\nResponse data have been encrypted.\n\nThe response body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedRoute.P.ost](https://github.com/samchon/nestia-helper#encryptedroute) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of newly joined seller",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISeller"
+                }
+              }
+            }
+          }
+        },
+        "description": "Join as a seller."
+      }
+    },
+    "/sellers/authenticate/login": {
+      "post": {
+        "tags": [],
+        "summary": "encrypted",
+        "parameters": [],
+        "requestBody": {
+          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/nestia-helper#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nEmail and password",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISeller.ILogin"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "## Warning\nResponse data have been encrypted.\n\nThe response body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedRoute.P.ost](https://github.com/samchon/nestia-helper#encryptedroute) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nInformation of the seller",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISeller"
+                }
+              }
+            }
+          }
+        },
+        "description": "Log-in as a seller."
+      }
+    },
+    "/sellers/authenticate/password/change": {
+      "patch": {
+        "tags": [],
+        "summary": "encrypted",
+        "parameters": [],
+        "requestBody": {
+          "description": "## Warning\nRequest body must be encrypted.\n\nThe request body data would be encrypted as \"AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding\", through the [EncryptedBody](https://github.com/samchon/nestia-helper#encryptedbody) component.\n\nTherefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.\n\n-----------------\n\nOld and new passwords",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISeller.IChangePassword"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Empty object"
+          }
+        },
+        "description": "Change password."
+      }
+    },
+    "/sellers/authenticate/exit": {
+      "delete": {
+        "tags": [],
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        },
+        "description": "Erase the seller by itself."
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "apiKey",
+        "name": "Authorization",
+        "in": "header"
+      }
+    },
+    "schemas": {
+      "ISeller.IJoin": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string",
+            "nullable": false
+          },
+          "password": {
+            "type": "string",
+            "nullable": false
+          },
+          "name": {
+            "type": "string",
+            "nullable": false
+          },
+          "mobile": {
+            "type": "string",
+            "nullable": false
+          },
+          "company": {
+            "type": "string",
+            "nullable": false
+          }
+        },
+        "nullable": false,
+        "required": [
+          "email",
+          "password",
+          "name",
+          "mobile",
+          "company"
+        ],
+        "jsDocTags": []
+      },
+      "ISeller": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "number",
+            "nullable": false,
+            "description": "Primary key."
+          },
+          "email": {
+            "type": "string",
+            "nullable": false,
+            "description": "Email address."
+          },
+          "name": {
+            "type": "string",
+            "nullable": false,
+            "description": "Name of the seller."
+          },
+          "mobile": {
+            "type": "string",
+            "nullable": false,
+            "description": "Mobile number of the seller."
+          },
+          "company": {
+            "type": "string",
+            "nullable": false,
+            "description": "Belonged company name."
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Joined time."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "id",
+          "email",
+          "name",
+          "mobile",
+          "company",
+          "created_at"
+        ],
+        "description": "Seller information.",
+        "jsDocTags": [
+          {
+            "name": "author",
+            "text": [
+              {
+                "text": "Jeongho Nam - https://github.com/samchon",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      "ISeller.ILogin": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string",
+            "nullable": false
+          },
+          "password": {
+            "type": "string",
+            "nullable": false
+          }
+        },
+        "nullable": false,
+        "required": [
+          "email",
+          "password"
+        ],
+        "jsDocTags": []
+      },
+      "ISeller.IChangePassword": {
+        "type": "object",
+        "properties": {
+          "old_password": {
+            "type": "string",
+            "nullable": false
+          },
+          "new_password": {
+            "type": "string",
+            "nullable": false
+          }
+        },
+        "nullable": false,
+        "required": [
+          "old_password",
+          "new_password"
+        ],
+        "jsDocTags": []
+      }
+    }
+  },
+  "security": [
+    {
+      "bearerAuth": []
+    }
+  ]
+}

package/demo/encrypted/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    // "target": "ESNext",
+    // "module": "ESNext",
+    // "moduleResolution": "node"
+  }
+}

package/demo/generic/nestia.config.ts

@@ -0,0 +1,10 @@
+const config = {
+    input: ["src/controllers"],
+    output: "src/api",
+    swagger: {
+        output: "swagger.json",
+    },
+    assert: true,
+    json: true,
+};
+export default config;

package/demo/generic/src/Backend.ts

@@ -0,0 +1,27 @@
+import helper from "nestia-helper";
+import * as nest from "@nestjs/common";
+import { NestFactory } from "@nestjs/core";
+import { Configuration } from "./Configuration";
+
+export class Backend {
+    private application_?: nest.INestApplication;
+
+    public async open(): Promise<void> {
+        this.application_ = await NestFactory.create(
+            await helper.EncryptedModule.dynamic(
+                __dirname + "/controllers",
+                Configuration.ENCRYPTION_PASSWORD,
+            ),
+            { logger: false },
+        );
+        await this.application_.listen(Configuration.PORT);
+    }
+
+    public async close(): Promise<void> {
+        if (this.application_ === undefined) return;
+
+        const app = this.application_;
+        delete this.application_;
+        await app.close();
+    }
+}

package/demo/generic/src/Configuration.ts

@@ -0,0 +1,7 @@
+export namespace Configuration {
+    export const PORT = 12345;
+    export const ENCRYPTION_PASSWORD = {
+        key: "a".repeat(32),
+        iv: "b".repeat(16),
+    };
+}

package/demo/generic/src/api/HttpError.ts

@@ -0,0 +1 @@
+export { HttpError } from "nestia-fetcher";

package/demo/generic/src/api/IConnection.ts

@@ -0,0 +1 @@
+export { IConnection } from "nestia-fetcher";

package/demo/generic/src/api/Primitive.ts

@@ -0,0 +1 @@
+export { Primitive } from "nestia-fetcher";

package/demo/generic/src/api/__internal/AesPkcs5.ts

@@ -0,0 +1 @@
+export { AesPkcs5 } from "nestia-fetcher";

package/demo/generic/src/api/__internal/Fetcher.ts

@@ -0,0 +1 @@
+export { Fetcher } from "nestia-fetcher";

package/demo/generic/src/api/functional/consumers/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.consumers
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+export * as sales from "./sales";

package/demo/generic/src/api/functional/consumers/sales/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.consumers.sales
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+export * as questions from "./questions";
+export * as reviews from "./reviews";

package/demo/generic/src/api/functional/consumers/sales/questions/index.ts

@@ -0,0 +1,136 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.consumers.sales.questions
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import { Fetcher, Primitive } from "nestia-fetcher";
+import type { IConnection } from "nestia-fetcher";
+import TSON from "typescript-json";
+
+import type { ISaleArticle } from "./../../../../structures/ISaleArticle";
+import type { ISaleInquiry } from "./../../../../structures/ISaleInquiry";
+
+/**
+ * Store a new inquiry.
+ * 
+ * Write a new article inquirying about a sale.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param request Instance of the Express.Request
+ * @param section Code of the target section
+ * @param saleId ID of the target sale
+ * @param input Content to archive
+ * @return Newly archived inquiry
+ * @throw 400 bad request error when type of the input data is not valid
+ * @throw 401 unauthorized error when you've not logged in yet
+ * 
+ * @controller ConsumerSaleQuestionsController.store()
+ * @path POST /consumers/:section/sales/:saleId/questions
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function store
+    (
+        connection: IConnection,
+        section: string,
+        saleId: string,
+        input: Primitive<store.Input>
+    ): Promise<store.Output>
+{
+    TSON.assertType<typeof section>(section);
+    TSON.assertType<typeof saleId>(saleId);
+    TSON.assertType<typeof input>(input);
+
+    return Fetcher.fetch
+    (
+        connection,
+        store.ENCRYPTED,
+        store.METHOD,
+        store.path(section, saleId),
+        input,
+        store.stringify
+    );
+}
+export namespace store
+{
+    export type Input = Primitive<ISaleArticle.IStore>;
+    export type Output = Primitive<ISaleInquiry<ISaleArticle.IContent>>;
+
+    export const METHOD = "POST" as const;
+    export const PATH: string = "/consumers/:section/sales/:saleId/questions";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: false,
+        response: false,
+    };
+
+    export function path(section: string, saleId: string): string
+    {
+        return `/consumers/${encodeURIComponent(section)}/sales/${encodeURIComponent(saleId)}/questions`;
+    }
+    export const stringify = (input: Input) => TSON.stringify(input);
+}
+
+/**
+ * Update an inquiry.
+ * 
+ * Update ordinary inquiry article. However, it would not modify the content reocrd
+ * {@link ISaleInquiry.IContent}, but be accumulated into the {@link ISaleInquiry.contents}.
+ * Therefore, all of the poeple can read how the content has been changed.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param request Instance of the Express.Request
+ * @param section Code of the target section
+ * @param saleId ID of the target sale
+ * @param id ID of the target article to be updated
+ * @param input New content to be overwritten
+ * @return The newly created content record
+ * @throw 400 bad request error when type of the input data is not valid
+ * @throw 401 unauthorized error when you've not logged in yet
+ * @throw 403 forbidden error when the article is not yours
+ * 
+ * @controller ConsumerSaleQuestionsController.update()
+ * @path PUT /consumers/:section/sales/:saleId/questions/:id
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function update
+    (
+        connection: IConnection,
+        section: string,
+        saleId: string,
+        id: number,
+        input: Primitive<update.Input>
+    ): Promise<update.Output>
+{
+    TSON.assertType<typeof section>(section);
+    TSON.assertType<typeof saleId>(saleId);
+    TSON.assertType<typeof id>(id);
+    TSON.assertType<typeof input>(input);
+
+    return Fetcher.fetch
+    (
+        connection,
+        update.ENCRYPTED,
+        update.METHOD,
+        update.path(section, saleId, id),
+        input,
+        update.stringify
+    );
+}
+export namespace update
+{
+    export type Input = Primitive<ISaleArticle.IStore>;
+    export type Output = Primitive<ISaleInquiry<ISaleArticle.IContent>>;
+
+    export const METHOD = "PUT" as const;
+    export const PATH: string = "/consumers/:section/sales/:saleId/questions/:id";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: false,
+        response: false,
+    };
+
+    export function path(section: string, saleId: string, id: number): string
+    {
+        return `/consumers/${encodeURIComponent(section)}/sales/${encodeURIComponent(saleId)}/questions/${encodeURIComponent(id)}`;
+    }
+    export const stringify = (input: Input) => TSON.stringify(input);
+}

package/demo/generic/src/api/functional/consumers/sales/reviews/index.ts

@@ -0,0 +1,136 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.consumers.sales.reviews
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import { Fetcher, Primitive } from "nestia-fetcher";
+import type { IConnection } from "nestia-fetcher";
+import TSON from "typescript-json";
+
+import type { ISaleReview } from "./../../../../structures/ISaleReview";
+import type { ISaleInquiry } from "./../../../../structures/ISaleInquiry";
+
+/**
+ * Store a new inquiry.
+ * 
+ * Write a new article inquirying about a sale.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param request Instance of the Express.Request
+ * @param section Code of the target section
+ * @param saleId ID of the target sale
+ * @param input Content to archive
+ * @return Newly archived inquiry
+ * @throw 400 bad request error when type of the input data is not valid
+ * @throw 401 unauthorized error when you've not logged in yet
+ * 
+ * @controller ConsumerSaleReviewsController.store()
+ * @path POST /consumers/:section/sales/:saleId/reviews
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function store
+    (
+        connection: IConnection,
+        section: string,
+        saleId: string,
+        input: Primitive<store.Input>
+    ): Promise<store.Output>
+{
+    TSON.assertType<typeof section>(section);
+    TSON.assertType<typeof saleId>(saleId);
+    TSON.assertType<typeof input>(input);
+
+    return Fetcher.fetch
+    (
+        connection,
+        store.ENCRYPTED,
+        store.METHOD,
+        store.path(section, saleId),
+        input,
+        store.stringify
+    );
+}
+export namespace store
+{
+    export type Input = Primitive<ISaleReview.IStore>;
+    export type Output = Primitive<ISaleInquiry<ISaleReview.IContent>>;
+
+    export const METHOD = "POST" as const;
+    export const PATH: string = "/consumers/:section/sales/:saleId/reviews";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: false,
+        response: false,
+    };
+
+    export function path(section: string, saleId: string): string
+    {
+        return `/consumers/${encodeURIComponent(section)}/sales/${encodeURIComponent(saleId)}/reviews`;
+    }
+    export const stringify = (input: Input) => TSON.stringify(input);
+}
+
+/**
+ * Update an inquiry.
+ * 
+ * Update ordinary inquiry article. However, it would not modify the content reocrd
+ * {@link ISaleInquiry.IContent}, but be accumulated into the {@link ISaleInquiry.contents}.
+ * Therefore, all of the poeple can read how the content has been changed.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param request Instance of the Express.Request
+ * @param section Code of the target section
+ * @param saleId ID of the target sale
+ * @param id ID of the target article to be updated
+ * @param input New content to be overwritten
+ * @return The newly created content record
+ * @throw 400 bad request error when type of the input data is not valid
+ * @throw 401 unauthorized error when you've not logged in yet
+ * @throw 403 forbidden error when the article is not yours
+ * 
+ * @controller ConsumerSaleReviewsController.update()
+ * @path PUT /consumers/:section/sales/:saleId/reviews/:id
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function update
+    (
+        connection: IConnection,
+        section: string,
+        saleId: string,
+        id: number,
+        input: Primitive<update.Input>
+    ): Promise<update.Output>
+{
+    TSON.assertType<typeof section>(section);
+    TSON.assertType<typeof saleId>(saleId);
+    TSON.assertType<typeof id>(id);
+    TSON.assertType<typeof input>(input);
+
+    return Fetcher.fetch
+    (
+        connection,
+        update.ENCRYPTED,
+        update.METHOD,
+        update.path(section, saleId, id),
+        input,
+        update.stringify
+    );
+}
+export namespace update
+{
+    export type Input = Primitive<ISaleReview.IStore>;
+    export type Output = Primitive<ISaleInquiry<ISaleReview.IContent>>;
+
+    export const METHOD = "PUT" as const;
+    export const PATH: string = "/consumers/:section/sales/:saleId/reviews/:id";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: false,
+        response: false,
+    };
+
+    export function path(section: string, saleId: string, id: number): string
+    {
+        return `/consumers/${encodeURIComponent(section)}/sales/${encodeURIComponent(saleId)}/reviews/${encodeURIComponent(id)}`;
+    }
+    export const stringify = (input: Input) => TSON.stringify(input);
+}

package/demo/generic/src/api/functional/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @module api.functional
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+export * as consumers from "./consumers";

package/demo/generic/src/api/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @packageDocumentation
+ * @module api
+ */
+//================================================================
+export * from "./module";
+
+import * as api from "./module";
+export default api;

package/demo/generic/src/api/module.ts

@@ -0,0 +1,10 @@
+/**
+ * @packageDocumentation
+ * @module api
+ */
+//================================================================
+export * from "./IConnection";
+export * from "./Primitive";
+export * from "./HttpError";
+
+export * as functional from "./functional";