nestia 3.1.0 → 3.1.1-dev.20221016

package/.eslintrc.cjs

@@ -0,0 +1,33 @@
+module.exports = {
+    root: true,
+    plugins: [
+        "@typescript-eslint"
+    ],
+    extends: [
+        "plugin:@typescript-eslint/recommended",
+    ],
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        project: "tsconfig.json"
+    },
+    overrides: [
+        {
+            files: ["src/**/*.ts"],
+            rules: {
+                "@typescript-eslint/consistent-type-definitions": "off",
+                "@typescript-eslint/no-duplicate-imports": "error",
+                "@typescript-eslint/no-empty-function": "off",
+                "@typescript-eslint/no-empty-interface": "off",
+                "@typescript-eslint/no-explicit-any": "off",
+                "@typescript-eslint/no-inferrable-types": "off",
+                "@typescript-eslint/no-namespace": "off",
+                "@typescript-eslint/no-inferrable-types": "off",
+                "@typescript-eslint/no-non-null-assertion": "off",
+                "@typescript-eslint/no-unused-vars": "off",
+                "@typescript-eslint/no-var-requires": "off",
+                "@typescript-eslint/no-floating-promises": "error",
+                "@typescript-eslint/prefer-as-const": "error",
+            }
+        }
+    ]
+};

package/.prettierignore

@@ -0,0 +1,5 @@
+bundle
+lib
+node_modules
+
+README.md

package/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "editor.tabSize": 4,
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    },
+  }
+}

package/demo/encrypted/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/encrypted/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/encrypted/src/api/HttpError.ts

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

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

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

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

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

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

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

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

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

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

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

package/demo/encrypted/src/api/functional/sellers/authenticate/index.ts

@@ -0,0 +1,136 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.sellers.authenticate
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import { Fetcher, Primitive } from "nestia-fetcher";
+import type { IConnection } from "nestia-fetcher";
+
+import type { ISeller } from "./../../../structures/ISeller";
+
+export * as password from "./password";
+
+/**
+ * Join as a seller.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param input Information of yours
+ * @return Information of newly joined seller
+ * 
+ * @controller SellerAuthenticateController.join()
+ * @path POST /sellers/authenticate/join
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function join
+    (
+        connection: IConnection,
+        input: Primitive<join.Input>
+    ): Promise<join.Output>
+{
+    return Fetcher.fetch
+    (
+        connection,
+        join.ENCRYPTED,
+        join.METHOD,
+        join.path(),
+        input
+    );
+}
+export namespace join
+{
+    export type Input = Primitive<ISeller.IJoin>;
+    export type Output = Primitive<ISeller>;
+
+    export const METHOD = "POST" as const;
+    export const PATH: string = "/sellers/authenticate/join";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: true,
+        response: true,
+    };
+
+    export function path(): string
+    {
+        return `/sellers/authenticate/join`;
+    }
+}
+
+/**
+ * Log-in as a seller.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param input Email and password
+ * @return Information of the seller
+ * 
+ * @controller SellerAuthenticateController.login()
+ * @path POST /sellers/authenticate/login
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function login
+    (
+        connection: IConnection,
+        input: Primitive<login.Input>
+    ): Promise<login.Output>
+{
+    return Fetcher.fetch
+    (
+        connection,
+        login.ENCRYPTED,
+        login.METHOD,
+        login.path(),
+        input
+    );
+}
+export namespace login
+{
+    export type Input = Primitive<ISeller.ILogin>;
+    export type Output = Primitive<ISeller>;
+
+    export const METHOD = "POST" as const;
+    export const PATH: string = "/sellers/authenticate/login";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: true,
+        response: true,
+    };
+
+    export function path(): string
+    {
+        return `/sellers/authenticate/login`;
+    }
+}
+
+/**
+ * Erase the seller by itself.
+ * 
+ * @controller SellerAuthenticateController.exit()
+ * @path DELETE /sellers/authenticate/exit
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function exit
+    (
+        connection: IConnection
+    ): Promise<void>
+{
+    return Fetcher.fetch
+    (
+        connection,
+        exit.ENCRYPTED,
+        exit.METHOD,
+        exit.path()
+    );
+}
+export namespace exit
+{
+
+    export const METHOD = "DELETE" as const;
+    export const PATH: string = "/sellers/authenticate/exit";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: false,
+        response: false,
+    };
+
+    export function path(): string
+    {
+        return `/sellers/authenticate/exit`;
+    }
+}

package/demo/encrypted/src/api/functional/sellers/authenticate/password/index.ts

@@ -0,0 +1,53 @@
+/**
+ * @packageDocumentation
+ * @module api.functional.sellers.authenticate.password
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia 
+ */
+//================================================================
+import { Fetcher, Primitive } from "nestia-fetcher";
+import type { IConnection } from "nestia-fetcher";
+
+import type { ISeller } from "./../../../../structures/ISeller";
+
+/**
+ * Change password.
+ * 
+ * @param connection connection Information of the remote HTTP(s) server with headers (+encryption password)
+ * @param input Old and new passwords
+ * @return Empty object
+ * 
+ * @controller SellerAuthenticateController.change()
+ * @path PATCH /sellers/authenticate/password/change
+ * @nestia Generated by Nestia - https://github.com/samchon/nestia
+ */
+export function change
+    (
+        connection: IConnection,
+        input: Primitive<change.Input>
+    ): Promise<void>
+{
+    return Fetcher.fetch
+    (
+        connection,
+        change.ENCRYPTED,
+        change.METHOD,
+        change.path(),
+        input
+    );
+}
+export namespace change
+{
+    export type Input = Primitive<ISeller.IChangePassword>;
+
+    export const METHOD = "PATCH" as const;
+    export const PATH: string = "/sellers/authenticate/password/change";
+    export const ENCRYPTED: Fetcher.IEncrypted = {
+        request: true,
+        response: false,
+    };
+
+    export function path(): string
+    {
+        return `/sellers/authenticate/password/change`;
+    }
+}

package/demo/encrypted/src/api/functional/sellers/index.ts

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

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

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

package/demo/encrypted/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";

package/demo/encrypted/src/api/structures/ISeller.ts

@@ -0,0 +1,56 @@
+/**
+ * Seller information.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISeller {
+    /**
+     * Primary key.
+     */
+    id: number;
+
+    /**
+     * Email address.
+     */
+    email: string;
+
+    /**
+     * Name of the seller.
+     */
+    name: string;
+
+    /**
+     * Mobile number of the seller.
+     */
+    mobile: string;
+
+    /**
+     * Belonged company name.
+     */
+    company: string;
+
+    /**
+     * Joined time.
+     */
+    created_at: string;
+}
+
+export namespace ISeller {
+    export interface ILogin {
+        email: string;
+        password: string;
+    }
+
+    export interface IJoin {
+        email: string;
+        password: string;
+        name: string;
+        mobile: string;
+        company: string;
+    }
+
+    export interface IChangePassword {
+        old_password: string;
+        new_password: string;
+    }
+}

package/demo/encrypted/src/controllers/SellerAuthenticateController.ts

@@ -0,0 +1,70 @@
+import type express from "express";
+import * as nest from "@nestjs/common";
+import helper from "nestia-helper";
+
+import { ISeller } from "../api/structures/ISeller";
+
+@nest.Controller("sellers/authenticate")
+export class SellerAuthenticateController {
+    /**
+     * Join as a seller.
+     *
+     * @param input Information of yours
+     * @return Information of newly joined seller
+     */
+    @helper.EncryptedRoute.Post("join")
+    public async join(
+        @helper.EncryptedBody() input: ISeller.IJoin,
+    ): Promise<ISeller> {
+        return {
+            id: 0,
+            email: input.email,
+            name: input.name,
+            mobile: input.mobile,
+            company: input.company,
+            created_at: new Date().toString(),
+        };
+    }
+
+    /**
+     * Log-in as a seller.
+     *
+     * @param input Email and password
+     * @return Information of the seller
+     */
+    @helper.EncryptedRoute.Post("login")
+    public async login(
+        @helper.EncryptedBody() input: ISeller.ILogin,
+    ): Promise<ISeller> {
+        return {
+            id: 0,
+            email: input.email,
+            mobile: "01012345678",
+            name: "John Doe",
+            company: "ABC Company",
+            created_at: new Date().toString(),
+        };
+    }
+
+    /**
+     * Change password.
+     *
+     * @param input Old and new passwords
+     * @return Empty object
+     */
+    @nest.Patch("password/change")
+    public async change(
+        @nest.Request() _httpReq: express.Request,
+        @helper.EncryptedBody() input: ISeller.IChangePassword,
+    ): Promise<void> {
+        input;
+    }
+
+    /**
+     * Erase the seller by itself.
+     */
+    @nest.Delete("exit")
+    public async exit(
+        @nest.Request() _httpReq: express.Request,
+    ): Promise<void> {}
+}

package/demo/encrypted/src/test/features/test_seller_exit.ts

@@ -0,0 +1,18 @@
+import TSON from "typescript-json";
+import api from "../../api";
+import { ISeller } from "../../api/structures/ISeller";
+
+export async function test_seller_exit(
+    connection: api.IConnection,
+): Promise<void> {
+    const seller: ISeller = await api.functional.sellers.authenticate.login(
+        connection,
+        {
+            email: "someone@someone.com",
+            password: "qweqwe123!",
+        },
+    );
+    TSON.assertType(seller);
+
+    await api.functional.sellers.authenticate.exit(connection);
+}

package/demo/encrypted/src/test/features/test_seller_join.ts

@@ -0,0 +1,19 @@
+import TSON from "typescript-json";
+import api from "../../api";
+import { ISeller } from "../../api/structures/ISeller";
+
+export async function test_seller_join(
+    connection: api.IConnection,
+): Promise<void> {
+    const seller: ISeller = await api.functional.sellers.authenticate.join(
+        connection,
+        {
+            email: "someone@someone.com",
+            name: "Someone",
+            mobile: "01012345678",
+            company: "Some Company",
+            password: "qweqwe123!",
+        },
+    );
+    TSON.assertType(seller);
+}

package/demo/encrypted/src/test/features/test_seller_login.ts

@@ -0,0 +1,16 @@
+import TSON from "typescript-json";
+import api from "../../api";
+import { ISeller } from "../../api/structures/ISeller";
+
+export async function test_seller_login(
+    connection: api.IConnection,
+): Promise<void> {
+    const seller: ISeller = await api.functional.sellers.authenticate.login(
+        connection,
+        {
+            email: "someone@someone.com",
+            password: "qweqwe123!",
+        },
+    );
+    TSON.assertType(seller);
+}

package/demo/encrypted/src/test/features/test_seller_password_change.ts

@@ -0,0 +1,18 @@
+import TSON from "typescript-json";
+import api from "../../api";
+import { ISeller } from "../../api/structures/ISeller";
+
+export async function test_seller_password_change(
+    connection: api.IConnection,
+): Promise<void> {
+    const seller: ISeller = await api.functional.sellers.authenticate.login(
+        connection,
+        {
+            email: "someone@someone.com",
+            password: "qweqwe123!",
+        },
+    );
+    TSON.assertType(seller);
+
+    await api.functional.sellers.authenticate.exit(connection);
+}

package/demo/encrypted/src/test/index.ts

@@ -0,0 +1,24 @@
+import api from "../api";
+import { Backend } from "../Backend";
+import { Configuration } from "../Configuration";
+import { DynamicImportIterator } from "./internal/DynamicImportIterator";
+
+async function main(): Promise<void> {
+    const server: Backend = new Backend();
+    await server.open();
+
+    const connection: api.IConnection = {
+        host: `http://127.0.0.1:${Configuration.PORT}`,
+        encryption: Configuration.ENCRYPTION_PASSWORD,
+    };
+    await DynamicImportIterator.main(__dirname, {
+        prefix: "test",
+        parameters: () => [connection],
+    });
+
+    await server.close();
+}
+main().catch((exp) => {
+    console.log(exp);
+    process.exit(-1);
+});

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

@@ -0,0 +1,109 @@
+const EXTENSION = __filename.substr(-2);
+
+import cli from "cli";
+import fs from "fs";
+import { IPointer } from "tstl/functional/IPointer";
+
+import { StopWatch } from "./StopWatch";
+
+interface ICommand {
+    include?: string;
+    exclude?: string;
+}
+
+export namespace DynamicImportIterator {
+    export type Closure<Arguments extends any[]> = (
+        ...args: Arguments
+    ) => Promise<any>;
+    type Module<Arguments extends any[]> = {
+        [key: string]: Closure<Arguments>;
+    };
+
+    export interface IOptions<Parameters extends any[]> {
+        prefix: string;
+        parameters: () => Parameters;
+        wrapper?: (name: string, output: any) => Promise<any>;
+        counter?: IPointer<number>;
+        showElapsedTime?: boolean;
+    }
+
+    export async function main<Arguments extends any[]>(
+        path: string,
+        options: IOptions<Arguments>,
+    ): Promise<void> {
+        const command: ICommand = cli.parse();
+        await iterate(options, command, path);
+    }
+
+    export async function force<Arguments extends any[]>(
+        path: string,
+        options: IOptions<Arguments>,
+    ): Promise<Error[]> {
+        const command: ICommand = cli.parse();
+        const exceptions: Error[] = [];
+
+        await iterate(options, command, path, exceptions);
+        return exceptions;
+    }
+
+    async function iterate<Arguments extends any[]>(
+        options: IOptions<Arguments>,
+        command: ICommand,
+        path: string,
+        exceptions?: Error[],
+    ): Promise<void> {
+        const directory: string[] = await fs.promises.readdir(path);
+        for (const file of directory) {
+            const current: string = `${path}/${file}`;
+            const stats: fs.Stats = await fs.promises.lstat(current);
+
+            if (stats.isDirectory() === true) {
+                await iterate(options, command, current, exceptions);
+                continue;
+            } else if (file.substr(-3) !== `.${EXTENSION}`) continue;
+
+            const external: Module<Arguments> = await import(current);
+            await execute(options, command, external, exceptions);
+        }
+    }
+
+    async function execute<Arguments extends any[]>(
+        options: IOptions<Arguments>,
+        command: ICommand,
+        external: Module<Arguments>,
+        exceptions?: Error[],
+    ): Promise<void> {
+        for (const key in external) {
+            if (command.exclude && key.indexOf(command.exclude) !== -1)
+                continue;
+            else if (command.include && key.indexOf(command.include) === -1)
+                continue;
+            else if (key.substr(0, options.prefix.length) !== options.prefix)
+                continue;
+            else if (external[key] instanceof Function) {
+                const closure: Closure<Arguments> = external[key];
+                const func = async () => {
+                    const output = await closure(...options.parameters());
+                    if (options.wrapper) await options.wrapper(key, output);
+                };
+
+                try {
+                    if (options.counter) ++options.counter.value;
+                    if (options.showElapsedTime === false) {
+                        await func();
+                        console.log(`  - ${key}`);
+                    } else {
+                        const time: number = await StopWatch.measure(func);
+                        console.log(`  - ${key}: ${time.toLocaleString()} ms`);
+                    }
+                } catch (exp) {
+                    if (!(exp instanceof Error)) return;
+
+                    console.log(`  - ${key} -> ${exp.name}`);
+                    if (exceptions !== undefined) exceptions.push(exp);
+                    else throw exp;
+                }
+            }
+        }
+    }
+}