nestia 0.3.5 → 1.0.0

package/README.md

@@ -70,18 +70,19 @@ Just type the `nestia sdk <input> --out <output>` command in the console. If the
 
 Also, when generating a SDK using the cli options, `compilerOptions` would follow the `tsconfig.json`, that is configured for the backend server. If no `tsconfig.json` file exists in your project, the configuration would be default option (`ES5` with `strict` mode). If you want to use different `compilerOptions` with the `tsconfig.json`, you should configure the [nestia.config.ts](#nestiaconfigts).
 
-```bash
-npx nestia install
-```
-
 ### Dependencies
-SDK library generated by the **Nestia** has some dependencies like below. 
-
-When you type the `nestia install` command in the console, those dependencies would be automatically installed and enrolled to the `dependencies` and `devDependencies` fields in the `package.json`
+SDK library generated by the **Nestia** requires the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module. 
 
-  - [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node)
-  - [node-fetch](https://github.com/node-fetch/node-fetch)
+Therefore, when you publish an SDK library generated by this **Nestia**, you have to write the [nestia-fetcher](https://github.com/samchon/nestia-fetcher) module into the `dependencies` property of the `package.json` file like below. You also can configure the `dependencies` property of the `package.json` file by typing the `npm install --save nestia-fetcher` command in the console, too.
 
+```json
+{
+  "name": "payments-server-api",
+  "dependencies": {
+    "nestia-fetcher": "^1.0.2"
+  }
+}
+```
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestia",
-  "version": "0.3.5",
+  "version": "1.0.0",
   "description": "Automatic SDK and Document generator for the NestJS",
   "main": "src/index.ts",
   "bin": {
@@ -36,11 +36,10 @@
     "del": "^6.0.0",
     "ts-node": "^9.1.1",
     "tstl": "^2.5.0",
-    "ttypescript": "^1.5.12",
     "typescript": "^4.3.2"
   },
   "devDependencies": {
-    "encrypted-nestjs": "^0.1.5",
+    "nestia-helper": "^1.0.0",
     "rimraf": "^3.0.2"
   }
 }

package/src/analyses/ControllerAnalyzer.ts

@@ -104,6 +104,8 @@ export namespace ControllerAnalyzer
         let path: string = NodePath.join(controller.path, func.path).split("\\").join("/");
         if (path[0] !== "/")
             path = "/" + path;
+        if (path[path.length - 1] === "/" && path !== "/")
+            path = path.substr(0, path.length - 1);
 
         // RETURNS
         return {

package/src/analyses/ReflectAnalyzer.ts

@@ -1,4 +1,4 @@
-import * as path from "path";
+import Pather from "path";
 
 import { ArrayUtil } from "../utils/ArrayUtil";
 import { StringUtil } from "../utils/StringUtil";
@@ -128,7 +128,7 @@ export namespace ReflectAnalyzer
         }
 
         // VALIDATE PATH ARGUMENTS
-        const funcPathArguments: string[] = StringUtil.betweens(path.join(controller.path, meta.path).split("\\").join("/"), ":", "/").sort();
+        const funcPathArguments: string[] = StringUtil.betweens(Pather.join(controller.path, meta.path).split("\\").join("/"), ":", "/").sort();
         const paramPathArguments: string[] = meta.parameters.filter(param => param.category === "param").map(param => param.field!).sort();
 
         if (equal(funcPathArguments, paramPathArguments) === false)
@@ -158,6 +158,7 @@ export namespace ReflectAnalyzer
             return null;
 
         return {
+            name: key,
             category: type,
             index: param.index,
             field: param.data,
@@ -169,15 +170,19 @@ export namespace ReflectAnalyzer
     {
         if (param.factory === undefined)
             return null;
-        else if (param.factory.name === "EncryptedBody")
+        else if (param.factory.name === "EncryptedBody" || param.factory.name === "PlainBody")
+        {
             return {
                 category: "body",
                 index: param.index,
+                name: param.name,
                 field: param.data,
-                encrypted: true
+                encrypted: param.factory.name === "EncryptedBody"
             };
+        }
         else if (param.factory.name === "TypedParam")
             return {
+                name: param.name,
                 category: "param",
                 index: param.index,
                 field: param.data,
@@ -193,6 +198,7 @@ export namespace ReflectAnalyzer
 
     interface INestParam
     {
+        name: string;
         index: number;
         factory?: Function;
         data: string | undefined;

package/src/bin/nestia.ts

@@ -78,11 +78,7 @@ async function sdk(input: string[], command: ICommand): Promise<void>
 
 async function install(): Promise<void>
 {
-    for (const module of ["@types/node", "node-fetch"])
-    {
-        console.log(`installing ${module}...`);
-        await Terminal.execute(`npm install --save-dev ${module}`);
-    }
+    await Terminal.execute("npm install --save nestia-fetcher");
 }
 
 async function main(): Promise<void>

package/src/bundle/HttpError.ts

@@ -1,33 +1 @@
-/**
- * @packageDocumentation
- * @module api
- */
-//================================================================
-/**
- * HTTP Error from the backend server.
- * 
- * @author Jeongho Nam - https://github.com/samchon
- */
-export class HttpError extends Error
-{
-    public readonly method: string;
-    public readonly path: string;
-    public readonly status: number;
-
-    public constructor(method: string, path: string, status: number, message: string)
-    {
-        super(message);
-
-        // INHERITANCE POLYFILL
-        const proto: HttpError = new.target.prototype;
-        if (Object.setPrototypeOf)
-            Object.setPrototypeOf(this, proto);
-        else
-            (this as any).__proto__ = proto;
-
-        // ASSIGN MEMBERS
-        this.method = method;
-        this.path = path;
-        this.status = status;
-    }
-}
+export { HttpError } from "nestia-fetcher";

package/src/bundle/IConnection.ts

@@ -1,26 +1 @@
-/**
- * @packageDocumentation
- * @module api
- */
-//================================================================
-export interface IConnection
-{
-    host: string;
-    headers?: Record<string, string>;
-    encryption?: IConnection.IEncyptionPassword | IConnection.EncryptionClosure;
-    path?: (path: string) => string;
-}
-
-export namespace IConnection
-{
-    export interface IEncyptionPassword
-    {
-        key: string;
-        iv: string;
-    }
-
-    export interface EncryptionClosure
-    {
-        (content: string, isEncode: boolean): IEncyptionPassword;
-    } 
-}
+export { IConnection } from "nestia-fetcher";

package/src/bundle/Primitive.ts

@@ -1,113 +1 @@
-/**
- * @packageDocumentation
- * @module api
- */
-//================================================================
-/**
- * 객체의 원시 타입.
- * 
- * `Primitive` 는 대상 인스턴스의 모든 메서드를 제거하여, 그 타입을 pritimive object 의 형태로 
- * 바꾸어주는 TMP (Type Meta Programming) 타입이다.
- * 
- * @template Instance 대상 인스턴스
- * @author Samchon
- */
-export type Primitive<Instance> = value_of<Instance> extends object
-    ? Instance extends object
-        ? Instance extends IJsonable<infer Raw>
-            ? value_of<Raw> extends object
-                ? Raw extends object
-                    ? PrimitiveObject<Raw> // object would be primitified
-                    : never // cannot be
-                : value_of<Raw> // atomic value
-            : PrimitiveObject<Instance> // object would be primitified
-        : never // cannot be
-    : value_of<Instance>;
-
-export namespace Primitive
-{
-    /**
-     * Primitive object 하드 카피.
-     * 
-     * `Primitive.clone()` 은 파라미터 인스턴스를 원시 오브젝트 형태로 hard copy 하는 함수이다.
-     * 
-     * @param instance 복사 대상 인스턴스
-     * @return 복사된 객체
-     */
-    export function clone<Instance>(instance: Instance): Primitive<Instance>
-    {
-        return JSON.parse(JSON.stringify(instance));
-    }
-
-    /**
-     * @todo
-     */
-    export function equal_to<Instance>(x: Instance, y: Instance): boolean
-    {
-        return JSON.stringify(x) === JSON.stringify(y) || recursive_equal_to(x, y);
-    }
-}
-
-type PrimitiveObject<Instance extends object> = Instance extends Array<infer T>
-    ? Primitive<T>[]
-    : 
-    {
-        [P in keyof Instance]: Instance[P] extends Function
-            ? never
-            : Primitive<Instance[P]>
-    };
-
-type value_of<Instance> = 
-    is_value_of<Instance, Boolean> extends true ? boolean
-    : is_value_of<Instance, Number> extends true ? number
-    : is_value_of<Instance, String> extends true ? string
-    : Instance;
-
-type is_value_of<Instance, Object extends IValueOf<any>> = 
-    Instance extends Object
-        ? Object extends IValueOf<infer Primitive>
-            ? Instance extends Primitive
-                ? false
-                : true // not Primitive, but Object
-            : false // cannot be
-        : false;
-
-interface IValueOf<T>
-{
-    valueOf(): T;
-}
-
-interface IJsonable<T>
-{
-    toJSON(): T;
-}
-
-function object_equal_to<T extends object>(x: T, y: T): boolean
-{
-    for (const key in x)
-        if (recursive_equal_to(x[key], y[key]) === false)
-            return false;
-    return true;
-}
-
-function array_equal_to<T>(x: T[], y: T[]): boolean
-{
-    if (x.length !== y.length)
-        return false;
-
-    return x.every((value, index) => recursive_equal_to(value, y[index]));
-}
-
-function recursive_equal_to<T>(x: T, y: T): boolean
-{
-    const type = typeof x;
-    if (type !== typeof y)
-        return false;
-    else if (type === "object")
-        if (x instanceof Array)
-            return array_equal_to(x, y as typeof x);
-        else
-            return object_equal_to(<any>x as object, <any>y as object);
-    else
-        return x === y;
-}
+export { Primitive } from "nestia-fetcher";

package/src/bundle/__internal/AesPkcs5.ts

@@ -1,51 +1 @@
-/**
- * @packageDocumentation
- * @module api.__internal
- */
-//================================================================
-import * as crypto from "crypto";
-
-/**
- * Utility class for AES Encryption.
- * 
- *   - AES-128/256
- *   - CBC mode
- *   - PKCS#5 Padding
- *   - Base64 Encoding
- * 
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace AesPkcs5
-{
-    /**
-     * Encode data
-     * 
-     * @param data Target data
-     * @param key Key value of the encryption.
-     * @param iv Initializer Vector for the encryption
-     * @return Encoded data
-     */
-    export function encode(data: string, key: string, iv: string): string
-    {
-        const bytes: number = key.length * 8;
-        const cipher: crypto.Cipher = crypto.createCipheriv(`AES-${bytes}-CBC`, key, iv);
-
-        return cipher.update(data, "utf8", "base64") + cipher.final("base64");
-    }
- 
-    /**
-     * Decode data.
-     * 
-     * @param data Target data
-     * @param key Key value of the decryption.
-     * @param iv Initializer Vector for the decryption
-     * @return Decoded data.
-     */
-    export function decode(data: string, key: string, iv: string): string
-    {
-        const bytes: number = key.length * 8;
-        const decipher: crypto.Decipher = crypto.createDecipheriv(`AES-${bytes}-CBC`, key, iv);
-
-        return decipher.update(data, "base64", "utf8") + decipher.final("utf8");
-    }
-}
+export { AesPkcs5 } from "nestia-fetcher";

package/src/bundle/__internal/Fetcher.ts

@@ -1,126 +1 @@
-/**
- * @packageDocumentation
- * @module api.__internal
- */
-//================================================================
-import { AesPkcs5 } from "./AesPkcs5";
-import { HttpError } from "../HttpError";
-import { IConnection } from "../IConnection";
-import { Primitive } from "../Primitive";
-
-// POLYFILL FOR NODE
-if (typeof global === "object"
-    && typeof global.process === "object" 
-    && typeof global.process.versions === "object"
-    && typeof global.process.versions.node !== undefined)
-(global as any).fetch = require("node-fetch");
-
-export class Fetcher
-{
-    public static fetch<Output>(connection: IConnection, config: Fetcher.IConfig, method: "GET" | "DELETE", path: string): Promise<Primitive<Output>>;
-    public static fetch<Input, Output>(connection: IConnection, config: Fetcher.IConfig, method: "POST" | "PUT" | "PATCH", path: string, input: Input): Promise<Primitive<Output>>;
-
-    public static async fetch<Output>
-        (
-            connection: IConnection, 
-            config: Fetcher.IConfig, 
-            method: string, 
-            path: string, 
-            input?: object
-        ): Promise<Primitive<Output>>
-    {
-        if (config.input_encrypted === true || config.output_encrypted === true)
-            if (connection.encryption === undefined)
-                throw new Error("Error on nestia.Fetcher.encrypt(): the encryption password has not been configured.");
-
-        //----
-        // REQUEST MESSSAGE
-        //----
-        // METHOD & HEADERS
-        const init: RequestInit = {
-            method,
-            headers: config.input_encrypted === false && input !== undefined && typeof input === "object"
-                ? { 
-                    ...connection.headers,
-                    "Content-Type": "application/json"
-                }
-                : connection.headers
-        };
-
-        // REQUEST BODY (WITH ENCRYPTION)
-        if (input !== undefined)
-        {
-            let content: string = JSON.stringify(input);
-            if (config.input_encrypted === true)
-            {
-                const password: IConnection.IEncyptionPassword = connection.encryption instanceof Function
-                    ? connection.encryption!(content, true)
-                    : connection.encryption!;
-                content = AesPkcs5.encode(content, password.key, password.iv);
-            }
-            init.body = content;
-        }
-
-        //----
-        // RESPONSE MESSAGE
-        //----
-        // URL SPECIFICATION
-        if (connection.host[connection.host.length - 1] !== "/" && path[0] !== "/")
-            path = "/" + path;
-        if (connection.path)
-            path = connection.path(path);
-        
-        const url: URL = new URL(`${connection.host}${path}`);
-
-        // DO FETCH
-        const response: Response = await fetch(url.href, init);
-        let content: string = await response.text();
-
-        if (!content)
-            return undefined!;
-
-        // CHECK THE STATUS CODE
-        if (response.status !== 200 && response.status !== 201)
-            throw new HttpError(method, path, response.status, content);
-
-        // FINALIZATION (WITH DECODING)
-        if (config.output_encrypted === true)
-        {
-            const password: IConnection.IEncyptionPassword = connection.encryption instanceof Function
-                ? connection.encryption!(content, false)
-                : connection.encryption!;
-            content = AesPkcs5.decode(content, password.key, password.iv);
-        }
-
-        //----
-        // OUTPUT
-        //----
-        let ret: { __set_headers__: Record<string, any> } & Primitive<Output> = content as any;
-        try
-        {
-            // PARSE RESPONSE BODY
-            ret = JSON.parse(ret as any);
-
-            // FIND __SET_HEADERS__ FIELD
-            if (ret.__set_headers__ !== undefined && typeof ret.__set_headers__ === "object")
-            {
-                if (connection.headers === undefined)
-                    connection.headers = {};
-                Object.assign(connection.headers, ret.__set_headers__);
-            }
-        }
-        catch {}
-
-        // RETURNS
-        return ret;
-    }
-}
-
-export namespace Fetcher
-{
-    export interface IConfig
-    {
-        input_encrypted?: boolean;
-        output_encrypted: boolean;
-    }
-}
+export { Fetcher } from "nestia-fetcher";

package/src/generates/FileGenerator.ts

@@ -2,7 +2,6 @@ import * as fs from "fs";
 import { HashMap } from "tstl/container/HashMap";
 
 import { IRoute } from "../structures/IRoute";
-import { DirectoryUtil } from "../utils/DirectoryUtil";
 import { ImportDictionary } from "../utils/ImportDictionary";
 import { FunctionGenerator } from "./FunctionGenerator";
 
@@ -21,14 +20,8 @@ export namespace FileGenerator
         // RELOCATE FOR ONLY ONE CONTROLLER METHOD IN AN URL CASE
         relocate(root);
 
-        const defaultImportDict: ImportDictionary = new ImportDictionary();
-        defaultImportDict.emplace(`${outDir}/__internal/AesPkcs5.ts`, true, "AesPkcs5");
-        defaultImportDict.emplace(`${outDir}/__internal/Fetcher.ts`, true, "Fetcher");
-        defaultImportDict.emplace(`${outDir}/Primitive.ts`, true, "Primitive");
-        defaultImportDict.emplace(`${outDir}/IConnection.ts`, false, "IConnection");
-
-        await DirectoryUtil.remove(outDir + "/functional");
-        await iterate(defaultImportDict, outDir + "/functional", root);
+        // ITERATE FILES
+        await iterate(outDir + "/functional", root);
     }
 
     function emplace(directory: Directory, route: IRoute): void
@@ -70,7 +63,7 @@ export namespace FileGenerator
     /* ---------------------------------------------------------
         FILE ITERATOR
     --------------------------------------------------------- */
-    async function iterate(defaultImportDict: ImportDictionary, outDir: string, directory: Directory): Promise<void>
+    async function iterate(outDir: string, directory: Directory): Promise<void>
     {
         // CREATE A NEW DIRECTORY
         try
@@ -83,7 +76,7 @@ export namespace FileGenerator
         let content: string = "";
         for (const it of directory.directories)
         {
-            await iterate(defaultImportDict, `${outDir}/${it.first}`, it.second);
+            await iterate(`${outDir}/${it.first}`, it.second);
             content += `export * as ${it.first} from "./${it.first}";\n`;
         }
         content += "\n";
@@ -100,10 +93,23 @@ export namespace FileGenerator
 
         // FINALIZE THE CONTENT
         if (directory.routes.length !== 0)
-            content = defaultImportDict.toScript(outDir) + "\n\n" 
-                + importDict.toScript(outDir) + "\n\n" 
+            content = ""
+                + `import { AesPkcs5, Fetcher, Primitive } from "nestia-fetcher";\n`
+                + `import type { IConnection } from "nestia-fetcher";\n`
+                + 
+                (
+                    importDict.empty()
+                        ? ""
+                        : "\n" + importDict.toScript(outDir) + "\n"
+                )
                 + content + "\n\n"
-                + defaultImportDict.listUp();
+                + "//---------------------------------------------------------\n"
+                + "// TO PREVENT THE UNUSED VARIABLE ERROR\n"
+                + "//---------------------------------------------------------\n"
+                + "AesPkcs5;\n"
+                + "Fetcher;\n"
+                + "Primitive;";
+
         content = "/**\n"
             + " * @packageDocumentation\n"
             + ` * @module ${directory.module}\n`

package/src/generates/FunctionGenerator.ts

@@ -2,7 +2,6 @@ import type * as tsc from "typescript";
 import { Pair } from "tstl/utility/Pair";
 import { Vector } from "tstl/container/Vector";
 
-import { Fetcher } from "../bundle/__internal/Fetcher";
 import { IRoute } from "../structures/IRoute";
 
 export namespace FunctionGenerator
@@ -23,25 +22,17 @@ export namespace FunctionGenerator
     --------------------------------------------------------- */
     function body(route: IRoute, query: IRoute.IParameter | undefined, input: IRoute.IParameter | undefined): string
     {
-        // PATH WITH ENCRYPTION
-        const path: string = get_path(route, query);
-        const config: Fetcher.IConfig = {
-            input_encrypted: input !== undefined && input.encrypted,
-            output_encrypted: route.encrypted
-        };
-
         // FETCH ARGUMENTS WITH REQUST BODY
+        const parameters = filter_parameters(route, query);
         const fetchArguments: string[] = 
         [
             "connection",
-            JSON.stringify(config, null, 4)
-                .split('"').join("")
-                .split("\n").join("\n" + " ".repeat(8)),
-            `"${route.method}"`,
-            path
+            `${route.name}.ENCRYPTED`,
+            `${route.name}.METHOD`,
+            `${route.name}.path(${parameters.map(p => p.name).join(", ")})`
         ];
         if (input !== undefined)
-            fetchArguments.push("input");
+            fetchArguments.push(input.name);
 
         // RETURNS WITH FINALIZATION
         return "{\n"
@@ -52,18 +43,12 @@ export namespace FunctionGenerator
             + "}";
     }
 
-    function get_path(route: IRoute, query: IRoute.IParameter | undefined): string
+    function filter_parameters(route: IRoute, query: IRoute.IParameter | undefined): IRoute.IParameter[]
     {
         const parameters = route.parameters.filter(param => param.category === "param");
-        let path: string = route.path;
-
-        for (const param of parameters)
-            path = path.replace(`:${param.field}`, `\${${param.name}}`);
-
-        new URLSearchParams()
-        return (query !== undefined)
-            ? `\`${path}?\${new URLSearchParams(${query.name} as any).toString()}\``
-            : `\`${path}\``
+        if (query)
+            parameters.push(query);
+        return parameters;
     }
 
     /* ---------------------------------------------------------
@@ -149,6 +134,7 @@ export namespace FunctionGenerator
 
     function tail(route: IRoute, query: IRoute.IParameter | undefined, input: IRoute.IParameter | undefined): string | null
     {
+        // LIST UP TYPES
         const types: Pair<string, string>[] = [];
         if (query !== undefined)
             types.push(new Pair("Query", query.type));
@@ -157,12 +143,36 @@ export namespace FunctionGenerator
         if (route.output !== "void")
             types.push(new Pair("Output", route.output));
         
-        if (types.length === 0)
-            return null;
-        
+        // PATH WITH PARAMETERS
+        const parameters = filter_parameters(route, query);
+        let path: string = route.path;
+        for (const param of parameters)
+            if (param.category === "param")
+                path = path.replace(`:${param.field}`, `\${${param.name}}`);
+        path = (query !== undefined)
+            ? `\`${path}?\${new URLSearchParams(${query.name} as any).toString()}\``
+            : `\`${path}\``;
+
         return `export namespace ${route.name}\n`
             + "{\n"
-            + (types.map(tuple => `    export type ${tuple.first} = Primitive<${tuple.second}>;`).join("\n")) + "\n"
+            + 
+            (
+                types.length !== 0
+                    ? types.map(tuple => `    export type ${tuple.first} = Primitive<${tuple.second}>;`).join("\n") + "\n"
+                    : ""
+            )
+            + "\n"
+            + `    export const METHOD = "${route.method}" as const;\n`
+            + `    export const PATH: string = "${route.path}";\n`
+            + `    export const ENCRYPTED: Fetcher.IEncrypted = {\n`
+            + `        request: ${input !== undefined && input.encrypted},\n`
+            + `        response: ${route.encrypted},\n`
+            + `    };\n`
+            + "\n"
+            + `    export function path(${parameters.map(param => `${param.name}: ${param.type}`).join(", ")}): string\n`
+            + `    {\n`
+            + `        return ${path};\n`
+            + `    }\n`
             + "}";
     }
 }

package/src/structures/IController.ts

@@ -22,6 +22,7 @@ export namespace IController
 
     export interface IParameter
     {
+        name: string;
         index: number;
         field: string | undefined;
         category: ParamCategory;

package/src/utils/ImportDictionary.ts

@@ -8,6 +8,11 @@ export class ImportDictionary
 {
     private readonly dict_: HashMap<string, Pair<boolean, HashSet<string>>> = new HashMap();
 
+    public empty(): boolean
+    {
+        return this.dict_.empty();
+    }
+
     public emplace(file: string, realistic: boolean, instance: string): void
     {
         if (file.substr(-5) === ".d.ts")
@@ -36,17 +41,4 @@ export class ImportDictionary
         }
         return statements.join("\n");
     }
-
-    public listUp(): string
-    {
-        let content: string = ""
-            + "//---------------------------------------------------------\n"
-            + "// TO PREVENT THE UNUSED VARIABLE ERROR\n"
-            + "//---------------------------------------------------------\n";
-        for (const it of this.dict_)
-            if (it.second.first === true)
-                for (const instance of it.second.second)
-                    content += instance + ";\n";
-        return content;
-    }
 }

package/tsconfig.json

@@ -68,6 +68,7 @@
     /* Experimental Options */
     "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
     "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    "stripInternal": true,
 
     /* Advanced Options */
     "skipLibCheck": true,                     /* Skip type checking of declaration files. */