nestia 3.1.1 → 3.1.2-dev.20221016

package/template/packages/api/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 ORGANIZATION
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/template/packages/api/README.md

@@ -1,66 +0,0 @@
-# SDK for Client Developers
-## Outline
-[`@ORGANIZATION/PROJECT`](https://github.com/samchon/nestia-template) provides SDK (Software Development Kit) for convenience.
-
-For the client developers who are connecting to this backend server, [`@ORGANIZATION/PROJECT`](https://github.com/samchon/nestia-template) provides not API documents like the Swagger, but provides the API interaction library, one of the typical SDK (Software Development Kit) for the convenience.
-
-With the SDK, client developers never need to re-define the duplicated API interfaces. Just utilize the provided interfaces and asynchronous functions defined in the SDK. It would be much convenient than any other Rest API solutions.
-
-```bash
-npm install --save @ORGANIZATION/PROJECT-api
-```
-
-
-
-
-## Usage
-Import the `@ORGANIZATION/PROJECT-api` and enjoy the auto-completion.
-
-```typescript
-import api from "@ORGINIZATION/PROJECT-api";
-
-import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
-
-async function main(): Promise<void>
-{
-    //----
-    // PREPARATIONS
-    //----
-    // CONNECTION INFO
-    const connection: api.IConnection = {
-        host: "http://127.0.0.1:37001",
-    };
-
-    const article: IBbsArticle = await api.functional.bbs.articles.store(
-        connection,
-        "general",
-        {
-            writer: "Robot",
-            title: "Hello, world!",
-            body: "Hello, I'm test automation robot",
-            format: "txt",
-            files: [
-                {
-                    name: "logo",
-                    extension: "png",
-                    url: "https://somewhere.com/logo.png",
-                },
-            ],
-            password: "1234",
-        },
-    );
-    TSON.assertEquals(stored);
-
-    const page: IPage<IBbsArticle> = await api.functional.bbs.articles.index(
-        connection,
-        "general",
-        {
-            limit: 100,
-            search: {
-                writer: "Robot"
-            }
-        }
-    );
-    await TSON.assertEquals(page);
-}
-```

package/template/packages/api/package.json

@@ -1,21 +0,0 @@
-{
-  "name": "@ORGANIZATION/PROJECT-api",
-  "version": "0.0.0",
-  "description": "API for PROJECT",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/samchon/nestia-template"
-  },
-  "author": "AUTHOR",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/samchon/nestia-template/issues"
-  },
-  "homepage": "https://github.com/samchon/nestia-template#readme",
-  "dependencies": {
-    "nestia-fetcher": "^2.0.3",
-    "typescript-json": "^3.3.10"
-  }
-}

package/template/prettier.config.js

@@ -1,18 +0,0 @@
-module.exports = {
-    parser: "typescript",
-    printWidth: 80,
-    semi: true,
-    tabWidth: 4,
-    trailingComma: "all",
-    importOrder: [
-        "<THIRD_PARTY_MODULES>",
-        "^@ORGANIZATION/PROJECT-api(.*)$",
-        "^[./]"
-    ],
-    importOrderSeparation: true,
-    importOrderSortSpecifiers: true,
-    importOrderParserPlugins: [
-        "decorators-legacy",
-        "typescript",
-    ]
-};

package/template/src/Backend.ts

@@ -1,65 +0,0 @@
-import { INestApplication } from "@nestjs/common";
-import { NestFactory } from "@nestjs/core";
-import express from "express";
-import helper from "nestia-helper";
-
-import { Configuration } from "./Configuration";
-
-export class Backend {
-    private application_?: INestApplication;
-    private is_closing_: boolean = false;
-
-    public async open(): Promise<void> {
-        //----
-        // OPEN THE BACKEND SERVER
-        //----
-        // MOUNT CONTROLLERS
-        this.application_ = await NestFactory.create(
-            await helper.EncryptedModule.dynamic(
-                __dirname + "/controllers",
-                await Configuration.ENCRYPTION_PASSWORD(),
-            ),
-            { logger: false },
-        );
-
-        // CONFIGURATIONS
-        this.is_closing_ = false;
-        this.application_.enableCors();
-        this.application_.use(this.middleware.bind(this));
-
-        // DO OPEN
-        await this.application_.listen(await Configuration.API_PORT());
-
-        //----
-        // POST-PROCESSES
-        //----
-        // INFORM TO THE PM2
-        if (process.send) process.send("ready");
-
-        // WHEN KILL COMMAND COMES
-        process.on("SIGINT", async () => {
-            this.is_closing_ = true;
-            await this.close();
-            process.exit(0);
-        });
-    }
-
-    public async close(): Promise<void> {
-        if (this.application_ === undefined) return;
-
-        // DO CLOSE
-        await this.application_.close();
-        delete this.application_;
-    }
-
-    private middleware(
-        _request: express.Request,
-        response: express.Response,
-        next: FunctionLike,
-    ): void {
-        if (this.is_closing_ === true) response.set("Connection", "close");
-        next();
-    }
-}
-
-type FunctionLike = (...args: any[]) => any;

package/template/src/Configuration.ts

@@ -1,11 +0,0 @@
-import { IEncryptionPassword } from "nestia-fetcher";
-
-export namespace Configuration {
-    export const API_PORT = async () => 37001;
-    export const ENCRYPTION_PASSWORD = async (): Promise<
-        Readonly<IEncryptionPassword>
-    > => ({
-        key: "pJXhbHlYfzkC1CBK8R67faaBgJWB9Myu",
-        iv: "IXJBt4MflFxvxKkn",
-    });
-}

package/template/src/api/HttpError.ts

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

package/template/src/api/IConnection.ts

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

package/template/src/api/Primitive.ts

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

package/template/src/api/__internal/AesPkcs5.ts

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

package/template/src/api/__internal/Fetcher.ts

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

package/template/src/api/functional/bbs/articles/index.ts

@@ -1,166 +0,0 @@
-/**
- * @packageDocumentation
- * @module api.functional.bbs.articles
- * @nestia Generated by Nestia - https://github.com/samchon/nestia 
- */
-//================================================================
-import { Fetcher } from "nestia-fetcher";
-import type { IConnection } from "nestia-fetcher";
-
-import type { IBbsArticle } from "./../../../structures/bbs/IBbsArticle";
-import type { IPage } from "./../../../structures/common/IPage";
-
-/**
- * @controller BbsArticlesController.index()
- * @path PATCH /bbs/articles/:section
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function index
-    (
-        connection: IConnection,
-        section: string,
-        input: IBbsArticle.IRequest
-    ): Promise<index.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        index.ENCRYPTED,
-        index.METHOD,
-        index.path(section),
-        input
-    );
-}
-export namespace index
-{
-    export type Input = IBbsArticle.IRequest;
-    export type Output = IPage<IBbsArticle.ISummary>;
-
-    export const METHOD = "PATCH" as const;
-    export const PATH: string = "/bbs/articles/:section";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: true,
-    };
-
-    export function path(section: string): string
-    {
-        return `/bbs/articles/${encodeURIComponent(section)}`;
-    }
-}
-
-/**
- * @controller BbsArticlesController.at()
- * @path GET /bbs/articles/:section/:id
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function at
-    (
-        connection: IConnection,
-        section: string,
-        id: string
-    ): Promise<at.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        at.ENCRYPTED,
-        at.METHOD,
-        at.path(section, id)
-    );
-}
-export namespace at
-{
-    export type Output = IBbsArticle;
-
-    export const METHOD = "GET" as const;
-    export const PATH: string = "/bbs/articles/:section/:id";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: false,
-    };
-
-    export function path(section: string, id: string): string
-    {
-        return `/bbs/articles/${encodeURIComponent(section)}/${encodeURIComponent(id)}`;
-    }
-}
-
-/**
- * @controller BbsArticlesController.store()
- * @path POST /bbs/articles/:section
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function store
-    (
-        connection: IConnection,
-        section: string,
-        input: IBbsArticle.IStore
-    ): Promise<store.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        store.ENCRYPTED,
-        store.METHOD,
-        store.path(section),
-        input
-    );
-}
-export namespace store
-{
-    export type Input = IBbsArticle.IStore;
-    export type Output = IBbsArticle;
-
-    export const METHOD = "POST" as const;
-    export const PATH: string = "/bbs/articles/:section";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: false,
-    };
-
-    export function path(section: string): string
-    {
-        return `/bbs/articles/${encodeURIComponent(section)}`;
-    }
-}
-
-/**
- * @controller BbsArticlesController.update()
- * @path PUT /bbs/articles/:section/:id
- * @nestia Generated by Nestia - https://github.com/samchon/nestia
- */
-export function update
-    (
-        connection: IConnection,
-        section: string,
-        id: string,
-        input: IBbsArticle.IUpdate
-    ): Promise<update.Output>
-{
-    return Fetcher.fetch
-    (
-        connection,
-        update.ENCRYPTED,
-        update.METHOD,
-        update.path(section, id),
-        input
-    );
-}
-export namespace update
-{
-    export type Input = IBbsArticle.IUpdate;
-    export type Output = IBbsArticle.IContent;
-
-    export const METHOD = "PUT" as const;
-    export const PATH: string = "/bbs/articles/:section/:id";
-    export const ENCRYPTED: Fetcher.IEncrypted = {
-        request: false,
-        response: false,
-    };
-
-    export function path(section: string, id: string): string
-    {
-        return `/bbs/articles/${encodeURIComponent(section)}/${encodeURIComponent(id)}`;
-    }
-}

package/template/src/api/functional/bbs/index.ts

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

package/template/src/api/functional/index.ts

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

package/template/src/api/index.ts

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

package/template/src/api/module.ts

@@ -1,5 +0,0 @@
-export * from "./IConnection";
-export * from "./Primitive";
-export * from "./HttpError";
-
-export * as functional from "./functional";

package/template/src/api/structures/bbs/IBbsArticle.ts

@@ -1,142 +0,0 @@
-import { IAttachmentFile } from "../common/IAttachmentFile";
-import { IPage } from "../common/IPage";
-
-/**
- * BBS article.
- */
-export interface IBbsArticle {
-    /**
-     * Primary Key.
-     *
-     * @format uuid
-     */
-    id: string;
-
-    /**
-     * Section code.
-     */
-    section: string;
-
-    /**
-     * Name of nickname of writer.
-     */
-    writer: string;
-
-    /**
-     * List of contents.
-     *
-     * Whenever updating an article, its contents would be accumulated.
-     */
-    contents: IBbsArticle.IContent[];
-
-    /**
-     * Creation time of the article.
-     */
-    created_at: string;
-}
-
-export namespace IBbsArticle {
-    /**
-     * Page request info with some options.
-     */
-    export interface IRequest extends IPage.IRequest {
-        /**
-         * Searching options.
-         */
-        search?: IRequest.ISearch;
-
-        /**
-         * Sorting options.
-         *
-         * The plus sign means ASC and minus sign means DESC.
-         */
-        sort?: IPage.IRequest.Sort<IRequest.SortableColumns>;
-    }
-    export namespace IRequest {
-        /**
-         * Searching options.
-         */
-        export interface ISearch {
-            writer?: string;
-            title?: string;
-            body?: string;
-        }
-
-        /**
-         * List of sortable columns.
-         */
-        export type SortableColumns =
-            | "writer"
-            | "title"
-            | "created_at"
-            | "updated_at";
-    }
-
-    /**
-     * Summarized info.
-     */
-    export interface ISummary {
-        id: string;
-        writer: string;
-        title: string;
-        created_at: string;
-        updated_at: string;
-    }
-
-    /**
-     * Content info.
-     */
-    export interface IContent extends Omit<IUpdate, "password"> {
-        /**
-         * Primary key of individual content.
-         *
-         * @format uuid
-         */
-        id: string;
-
-        /**
-         * Creation time of this content.
-         */
-        created_at: string;
-    }
-
-    /**
-     * Store info.
-     */
-    export interface IStore extends IUpdate {
-        /**
-         * Name or nickname of the writer.
-         */
-        writer: string;
-    }
-
-    /**
-     * Update info.
-     */
-    export interface IUpdate {
-        /**
-         * Title of the article.
-         */
-        title: string;
-
-        /**
-         * Content body.
-         */
-        body: string;
-
-        /**
-         * Format of the content body.
-         */
-        format: "md" | "html" | "txt";
-
-        /**
-         * List of files (to be) attached.
-         */
-        files: IAttachmentFile[];
-
-        /**
-         * Password of the article.
-         */
-        password: string;
-    }
-}

package/template/src/api/structures/common/IAttachmentFile.ts

@@ -1,5 +0,0 @@
-export interface IAttachmentFile {
-    name: string;
-    extension: string | null;
-    url: string;
-}

package/template/src/api/structures/common/IPage.ts

@@ -1,75 +0,0 @@
-/**
- * @packageDocumentation
- * @module api.structures.common
- */
-//================================================================
-/**
- * Paged record set.
- *
- * @author Samchon
- */
- export interface IPage<T extends object> {
-    /**
-     * Pagination info.
-     */
-    pagination: IPage.IPagination;
-
-    /**
-     * List of records
-     */
-    data: T[];
-}
-export namespace IPage {
-    /**
-     * Pagination info.
-     */
-    export interface IPagination {
-        /**
-         * Current page number.
-         * 
-         * Starts from 1.
-         */
-        page: number;
-
-        /**
-         * Limit records per a page.
-         *
-         * @default 100
-         */
-        limit: number;
-
-        /**
-         * Number of total records.
-         */
-        total_count: number;
-
-        /**
-         * Number of total pages.
-         */
-        total_pages: number;
-    }
-
-    /**
-     * Request info of page.
-     */
-    export interface IRequest {
-        /**
-         * Target page number.
-         * 
-         * @default 1
-         */
-        page?: number;
-
-        /**
-         * Limit per a page.
-         * 
-         * @defualt 100
-         */
-        limit?: number;
-    }
-    export namespace IRequest {
-        export type Sort<Literal extends string> = Array<
-            `-${Literal}` | `+${Literal}`
-        >;
-    }
-}

package/template/src/controllers/BbsArticlesController.ts

@@ -1,46 +0,0 @@
-import helper from "nestia-helper";
-import { Controller } from "@nestjs/common";
-import { IBbsArticle } from "../api/structures/bbs/IBbsArticle";
-import { IPage } from "../api/structures/common/IPage";
-import { BbsArticleProvider } from "../providers/bbs/BbsArticleProvider";
-
-/**
- * This is a fake controller.
- *
- * Remove it or make it to be real one.
- */
-@Controller("bbs/articles/:section")
-export class BbsArticlesController {
-    @helper.EncryptedRoute.Patch()
-    public index(
-        @helper.TypedParam("section", "string") section: string,
-        @helper.TypedBody() input: IBbsArticle.IRequest,
-    ): Promise<IPage<IBbsArticle.ISummary>> {
-        return BbsArticleProvider.index(section, input);
-    }
-
-    @helper.TypedRoute.Get(":id")
-    public at(
-        @helper.TypedParam("section", "string") section: string,
-        @helper.TypedParam("id", "uuid") id: string,
-    ): Promise<IBbsArticle> {
-        return BbsArticleProvider.find(section, id);
-    }
-
-    @helper.TypedRoute.Post()
-    public store(
-        @helper.TypedParam("section", "string") section: string,
-        @helper.TypedBody() input: IBbsArticle.IStore,
-    ): Promise<IBbsArticle> {
-        return BbsArticleProvider.store(section, input);
-    }
-
-    @helper.TypedRoute.Put(":id")
-    public update(
-        @helper.TypedParam("section", "string") section: string,
-        @helper.TypedParam("id", "uuid") id: string,
-        @helper.TypedBody() input: IBbsArticle.IUpdate,
-    ): Promise<IBbsArticle.IContent> {
-        return BbsArticleProvider.update(section, id, input);
-    }
-}