nestia 3.0.17 → 3.1.1-dev.20221015

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

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

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

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

package/template/src/api/index.ts

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

package/template/src/api/module.ts

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

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

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

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

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

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

@@ -0,0 +1,46 @@
+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);
+    }
+}

package/template/src/providers/bbs/BbsArticleProvider.ts

@@ -0,0 +1,217 @@
+import { ForbiddenException, NotFoundException } from "@nestjs/common";
+import { v4 } from "uuid";
+
+import { IBbsArticle } from "@ORGANIZATION/PROJECT-api/lib/structures/bbs/IBbsArticle";
+import { IPage } from "@ORGANIZATION/PROJECT-api/lib/structures/common/IPage";
+
+import { MapUtil } from "../../utils/MapUtil";
+
+/**
+ * This is a fake provider.
+ *
+ * Remove it or change it to be stored on the real DB.
+ */
+export namespace BbsArticleProvider {
+    export async function index(
+        section: string,
+        input: IBbsArticle.IRequest,
+    ): Promise<IPage<IBbsArticle.ISummary>> {
+        // GET ENTIRE ARTICLES
+        const dict = storage.get(section);
+        if (dict === undefined)
+            throw new NotFoundException(
+                `Error on BbsArticleProvider.index(): unable to find the matched section "${section}".`,
+            );
+
+        /* disable-eslint */
+        let articles: IBbsArticle[] = Array.from(dict.values()).map(
+            (rec) => rec.article,
+        );
+
+        // SEARCH
+        if (input.search !== undefined) {
+            if (input.search.writer)
+                articles = articles.filter(
+                    (x) => x.writer.indexOf(input.search!.writer!) !== -1,
+                );
+            if (input.search.title)
+                articles = articles.filter(
+                    (x) =>
+                        x.contents
+                            .at(-1)!
+                            .title.indexOf(input.search!.title!) !== -1,
+                );
+            if (input.search.body)
+                articles = articles.filter(
+                    (x) =>
+                        x.contents.at(-1)!.body.indexOf(input.search!.body!) !==
+                        -1,
+                );
+        }
+
+        // SORT
+        if (input.sort?.length) {
+            for (const comp of input.sort.reverse())
+                articles = articles.sort((x, y) => {
+                    const sign = comp[0];
+                    const column = comp.substring(1);
+                    const closure = () => {
+                        if (column === "created_at")
+                            return (
+                                new Date(x.created_at).getTime() -
+                                new Date(y.created_at).getTime()
+                            );
+                        else if (column === "updated_at")
+                            return (
+                                new Date(
+                                    x.contents.at(-1)!.created_at,
+                                ).getTime() -
+                                new Date(
+                                    y.contents.at(-1)!.created_at,
+                                ).getTime()
+                            );
+                        else if (column === "writer")
+                            return x.writer.localeCompare(y.writer);
+                        else
+                            return x.contents
+                                .at(-1)!
+                                .title.localeCompare(y.contents.at(-1)!.title);
+                    };
+                    return sign === "+" ? closure() : -closure();
+                });
+        } else {
+            articles.sort(
+                (a, b) =>
+                    new Date(b.created_at).getTime() -
+                    new Date(a.created_at).getTime(),
+            );
+        }
+
+        // PAGINATION
+        const limit: number = input.limit || 100;
+        const start: number = ((input.page || 1) - 1) * limit;
+        return {
+            pagination: {
+                page: input.page || 1,
+                limit: limit,
+                total_count: articles.length,
+                total_pages: Math.ceil(articles.length / limit),
+            },
+            data: articles.slice(start, start + limit).map((article) => ({
+                id: article.id,
+                section: article.section,
+                writer: article.writer,
+                title: article.contents.at(-1)!.title,
+                created_at: article.created_at,
+                updated_at: article.contents.at(-1)!.created_at,
+            })),
+        };
+    }
+
+    export async function find(
+        section: string,
+        id: string,
+        password?: string,
+    ): Promise<IBbsArticle> {
+        const dict = storage.get(section);
+        if (dict === undefined)
+            throw new NotFoundException(
+                `Error on BbsArticleProvider.find(): unable to find the matched section "${section}".`,
+            );
+
+        const record = dict.get(id);
+        if (record === undefined)
+            throw new NotFoundException(
+                `Error on BbsArticleProvider.find(): unable to find the matched article "${id}".`,
+            );
+        else if (password !== undefined && password !== record.password)
+            throw new ForbiddenException(
+                `Error on BbsArticleProvider.find(): different password.`,
+            );
+        return record.article;
+    }
+
+    export async function store(
+        section: string,
+        input: IBbsArticle.IStore,
+    ): Promise<IBbsArticle> {
+        const now: string = datetime_to_string(new Date());
+        const article: IBbsArticle = {
+            id: v4(),
+            section,
+            writer: input.writer,
+            contents: [
+                {
+                    ...{
+                        ...input,
+                        password: undefined,
+                    },
+                    id: v4(),
+                    created_at: now,
+                },
+            ],
+            created_at: now,
+        };
+
+        const dict: Map<string, IRecord> = MapUtil.take(
+            storage,
+            section,
+            () => new Map(),
+        );
+        dict.set(article.id, {
+            article,
+            password: input.password,
+        });
+
+        return article;
+    }
+
+    export async function update(
+        section: string,
+        id: string,
+        input: IBbsArticle.IUpdate,
+    ): Promise<IBbsArticle.IContent> {
+        const article: IBbsArticle = await find(section, id, input.password);
+        const content: IBbsArticle.IContent = {
+            ...{
+                ...input,
+                password: undefined,
+            },
+            id: v4(),
+            created_at: datetime_to_string(new Date()),
+        };
+        article.contents.push(content);
+        return content;
+    }
+}
+
+interface IRecord {
+    article: IBbsArticle;
+    password: string;
+}
+const storage: Map<string, Map<string, IRecord>> = new Map();
+
+function datetime_to_string(date: Date): string {
+    return (
+        cipher(4)(date.getFullYear()) +
+        "-" +
+        ([
+            [date.getMonth() + 1, date.getDate()].map(cipher(2)).join("-"),
+            [date.getHours(), date.getMinutes(), date.getSeconds()]
+                .map(cipher(2))
+                .join(":"),
+        ].join(" ") +
+            "." +
+            precision(date.getMilliseconds()))
+    );
+}
+
+const cipher = (digit: number) => (value: number) => {
+    const str: string = String(value);
+    return "0".repeat(digit - str.length) + str;
+};
+
+const precision = (value: number) => {
+    const str: string = String(value);
+    return str + "0".repeat(3 - str.length);
+};