nestia 3.1.1-dev.20221016 → 3.1.1-dev.20221016-3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestia",
-  "version": "3.1.1-dev.20221016",
+  "version": "3.1.1-dev.20221016-3",
   "description": "Automatic SDK and Document generator for the NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -63,5 +63,14 @@
     "typescript": "^4.8.4",
     "typescript-transform-paths": "^3.3.1",
     "uuid": "^8.3.2"
-  }
+  },
+  "files": [
+    "README.md",
+    "LICENSE",
+    "CONTRIBUTING.md",
+    "CODE_OF_CONDUCT",
+    "template",
+    "bundle",
+    "lib"
+  ]
 }

package/.eslintrc.cjs

@@ -1,33 +0,0 @@
-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/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-open_collective: nestia

package/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -1,42 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-## Bug Report
-Note that, the bug you're reporting may have registered in the [issues](https://github.com/samchon/nestia/search?type=issues) by another user. Even the bug you're reporting may have been fixed in the `@next` version. In such reasons, I recommend you to check the old [issues](https://github.com/samchon/nestia/search?type=issues) and reproduct your code with the `@next` version before publishing the bug reporting issue.
-
-```bash
-`npm install --save-dev nestia@next`
-```
-
-When the same error occurs even in the `@next` version, then please fill the below template:
-
-### Summary
-Write a short summary of the bug in here.
-
-  - **SDK Version**: 2.1.0-dev.20220505
-  - **Expected behavior**: 
-  - **Actual behavior**: 
-
-Write detailed description in here.
-
-
-
-### Code occuring the bug
-```typescript
-/* Demonstration code occuring the bug you're reporting */
-```
-
-Write the demonstration code occuring the bug you're reporting.
-
-However, as the `nestia` is not a typical library who being used by the `import` statement but a executable program generating the SDK (Software Development Kit), it would be difficult to describe the bug with only the demonstration code.
-
-In that case, you'd better to make a demonstration project occuring the bug to report. After the demonstration repository composition, fill the below `bash` script section. Of course, if you can describe the bug clearly, without the demonstration project construction, just skip it. Creating the demonstration repository is not essential.
-
-```bash
-git clone https://github.com/someone/nestia-bug-report-xxx
-cd nestia-bug-report-xxx
-npx nestia sdk
-```

package/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,13 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-## Feature Request
-Thanks for your suggestion. Feel free to just state your idea. Writing the issue, it would better to filling the below items:
-
-  - A description of the problem you're trying to solve.
-  - An overview of the suggested solution.
-  - Examples of how the suggestion whould work in various places.
-    - Code examples showing the expected behavior.

package/.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,11 +0,0 @@
----
-name: Question
-about: What do you want to know?
-
----
-
-## Question
-I always welcome any questions about this backend proejct. However, half of questions can be solved by traveling [README.md](https://github.com/samchon/nestia) or old [issues](https://github.com/samchon/nestia/search?type=issues). Therefore, I recommend you to visit them before. If you have a question that has not been treated and you're extremely urgently, just contact me.
-
-  - E-mail: samchon.github@gmail.com
-  - Mobile: 82-10-3627-0016

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +0,0 @@
-Before submitting a Pull Request, please test your code. 
-
-If you created a new created a new feature, then create the unit test function, too.
-
-```bash
-# COMPILE THE BACKEND SERVER
-npm run build
-
-# RUN THE TEST AUTOMATION PROGRAM
-npm run test
-```
-
-Learn more about the [CONTRIBUTING](CONTRIBUTING.md)

package/.github/workflows/build.yml

@@ -1,14 +0,0 @@
-name: build
-on: [push, pull_request]
-
-jobs:
-  Ubuntu:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-      - run: npm install
-      - run: npm run build
-      - run: npm run test

package/.prettierignore

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

package/.vscode/settings.json

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

package/CODE_OF_CONDUCT.md

@@ -1,133 +0,0 @@
-
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
-
-Community Impact Guidelines were inspired by 
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
-at [https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/demo/encrypted/src/Backend.ts

@@ -1,27 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

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

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

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

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

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

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

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

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

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

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

@@ -1,7 +0,0 @@
-/**
- * @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

@@ -1,136 +0,0 @@
-/**
- * @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

@@ -1,53 +0,0 @@
-/**
- * @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

@@ -1,7 +0,0 @@
-/**
- * @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

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

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

@@ -1,10 +0,0 @@
-/**
- * @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

@@ -1,56 +0,0 @@
-/**
- * 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;
-    }
-}