badak 1.0.0 → 1.0.2

package/.mocharc.json

@@ -0,0 +1,9 @@
+{
+	"require": [
+		"tsx"
+	],
+	"spec": [
+		"spec/**/*.ts"
+	],
+	"timeout": 1000
+}

package/README-KR.md

@@ -1,12 +1,13 @@
 ![npm](https://img.shields.io/npm/v/badak?logo=npm)
 
-![logo](https://github.com/han41858/badak/raw/master/docs/logo/badak_200.png)
+![logo](https://github.com/han41858/badak/raw/main/docs/logo/badak_200.png)
 
 # badak
 
 badak은 Promise, TypeScript 기반으로 개발된 백엔드 프레임워크입니다.
 
-> badak은 TypeScript로 작성되었으며 JavaScript 코드로 컴파일되어 배포됩니다. 따라서 TypeScript 문법으로 사용할 수도 있고 JavaScript 문법으로 사용할 수도 있습니다.
+> badak은 TypeScript로 작성되었으며 JavaScript 코드로 컴파일되어 배포됩니다.
+> 따라서 TypeScript 문법으로 사용할 수도 있고 JavaScript 문법으로 사용할 수도 있습니다.
 
 ## 설치방법
 
@@ -14,10 +15,8 @@ badak은 npm으로 배포되며 npm/yarn 으로 설치할 수 있습니다.
 
 ```bash
 npm install badak
-
 # 또는
-
-yarn install badak
+yarn add badak
 ```
 
 ## 사용방법
@@ -25,26 +24,25 @@ yarn install badak
 ```typescript
 import { Badak } from 'badak';
 
-const rule : RouteRule = {
-	users : {
-		GET : () => {
-			// return user list
+const rule: RouteRule = {
+	users: {
+		GET: () => {
+			// 사용자 목록을 반환합니다.
 			return {
-				list : ['han', 'kim', 'lee']
+				list: ['han', 'kim', 'lee']
 			}
 		},
-		POST : (user : User) => {
-			// add user
-
+		POST: (user: User) => {
+			// 사용자를 추가합니다.
 			return {
-				result : 'ok'
+				result: 'ok'
 			}
 		}
 	}
 };
 
 
-const app : Badak = new Badak();
+const app: Badak = new Badak();
 await app.route(routeRule);
 await app.listen(3000);
 ```
@@ -56,80 +54,193 @@ await app.listen(3000);
 badak 인스턴스를 생성합니다. 생성자로 옵션을 전달할 수 있습니다.
 
 ```typescript
-const app : Badak = new Badak();
+const app: Badak = new Badak();
 
-const appWithLog : Badak = new Badak({
-	catchErrorLog : true
+const appWithLog: Badak = new Badak({
+	catchErrorLog: true
 });
 ```
 
-### `auth() : Promise<void>`
+### `auth(fnc: MiddlewareFunction): Promise<void>`
+
+인증용 미들웨어 함수를 지정합니다. 인증 함수는 하나만 지정할 수 있습니다.
+인증 미들웨어로 등록된 함수는 `before()` 이후에, 라우팅 함수가 실행되기 전에 실행됩니다.
+인증 미들웨어 함수에서 오류가 발생하면 `401 Unauthorized` 에러가 발생합니다.
+
+### `before(fnc: MiddlewareFunction): Promise<void>`
+
+라우팅 함수가 실행되기 전에 실행할 미들웨어 함수를 등록합니다.
+미들웨어 함수는 여러개를 지정할 수 있으며, 지정한 순서와 관계없이 병렬로 실행됩니다.
+
+### `after(fnc: MiddlewareFunction): Promise<void>`
+
+라우팅 함수가 실행된 후에 실행할 미들웨어 함수를 등록합니다.
+미들웨어 함수는 여러개를 지정할 수 있으며, 지정한 순서와 관계없이 병렬로 실행됩니다.
+
+### `config(key: string, value: unknown): Promise<void>`
+
+badak 앱이 실행되는 동작을 조정합니다.
+
+### `listen(port: number): Promise<void>`
+
+서버 응답을 시작합니다.
+
+### `isRunning(): boolean`
+
+서버가 실행중인지 확인하고 결과값을 반환합니다.
+초기 상태는 `false` 이며, `listen()` 함수가 실행된 이후에 `true`가 되고, `stop()`으로 종료한 후에는 `false`가 됩니다.
+
+### `getHttpServer(): Server | undefined`
 
-### `before() : Promise<void>`
+HTTP 서버 인스턴스를 반환합니다.
+Badak 내부 멤버에 접근할 때 사용합니다.
 
-### `after() : Promise<void>`
+### `stop(): Promise<void>`
 
-### `config() : Promise<void>`
+HTTP 서버를 정지합니다.
 
-### `listen(port : number) : Promise<void>`
+### `route(rule: RouteRule): Promise<void>`
 
-### `isRunning() : boolean`
+라우팅 함수를 등록합니다.
 
-### `getHttpServer() : Server | undefined`
+### `get(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
 
-### `stop() : Promise<void>`
+`GET` 메서드 요청에 반응하는 라우팅 함수를 등록합니다.
 
-### `route(rule : RouteRule) : Promise<void>`
+### `post(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
 
-### `get(address : string, fnc : RouteFunction, option ?: RouteOption) : Promise<void>`
+`POST` 메서드 요청에 반응하는 라우팅 함수를 등록합니다.
 
-### `post(address : string, fnc : RouteFunction, option ?: RouteOption) : Promise<void>`
+### `put(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
 
-### `put(address : string, fnc : RouteFunction, option ?: RouteOption) : Promise<void>`
+`PUT` 메서드 요청에 반응하는 라우팅 함수를 등록합니다.
 
-### `delete(address : string, fnc : RouteFunction, option ?: RouteOption) : Promise<void>`
+### `delete(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
 
-### `static(uri : string, path : string) : Promise<void>`
+`DELETE` 메서드 요청에 반응하는 라우팅 함수를 등록합니다.
 
-### `setSPARoot(uri : string, path : string) : Promise<void>`
+### `static(uri: string, path: string): Promise<void>`
+
+정적 파일로 제공할 주소와 파일 경로를 연결합니다.
+
+### `setSPARoot(uri: string, path: string): Promise<void>`
+
+SPA 앱으로 사용할 주소와 파일 경로를 연결합니다.
+지정된 폴더 안에 있는 파일은 정적으로 제공되며, 캐싱됩니다.
 
 ## 인터페이스
 
+### `MiddlewareFunction`
+
+```typescript
+export type MiddlewareFunction = (req: IncomingMessage, res: ServerResponse, responseBody?: unknown) => void | Promise<void>;
+```
+
+`before()`, `after()`에 등록하는 함수입니다.
+미들웨어 함수는 라우팅 함수에 전달되는 인자를 변경할 수 없습니다.
+
+### `RouteFunction`
+
+```typescript
+export type RouteFunction = (param: any, req: IncomingMessage, res: ServerResponse) => unknown | Promise<unknown>;
+```
+
+HTTP 요청에 반응할 라우팅 함수를 등록합니다.
+라우팅 함수가 반환한 값은 HTTP 응답으로 반환됩니다.
+
 ### `BadakOption`
 
-Badak 앱의 동작 방식을 지정합니다.
+badak 앱의 동작 방식을 지정합니다.
 
-#### `catchErrorLog : boolean`
+#### `catchErrorLog: boolean`
 
 에러가 발생하면 콘솔에 로그를 출력합니다.
 
 기본값은 `true` 입니다.
 
-#### `preventError : boolean`
+#### `preventError: boolean`
 
-에러가 발생하면 node로 전달합니다. `false` 값을 지정하면 에러를 전달하지 않고 무시합니다.
+에러가 발생하면 node로 전달합니다.
+`false` 값을 지정하면 에러를 전달하지 않고 무시합니다.
 
 기본값은 `true` 입니다.
 
-#### `defaultMethod : Method | undefined`
+#### `defaultMethod: METHOD | undefined`
 
-라우팅에 사용할 기본 HTTP 메서드 타입을 지정합니다. 이 값을 지정하면 `Badak.route()` 메서드를 사용할 때 HTTP 메서드 지정을 생략할 수 있습니다.
+라우팅에 사용할 기본 HTTP 메서드 타입을 지정합니다.
+이 값을 지정하면 `Badak.route()` 메서드를 사용할 때 HTTP 메서드 지정을 생략할 수 있습니다.
 
 - 지정 전 :
 
 ```typescript
-{
-	'users' : {
-		GET : getUserList
+app.route({
+	users: {
+		GET: getUserList
 	}
-}
+});
 ```
 
 - `app.config('defaultMethod', 'GET')` 지정 후 :
 
 ```typescript
-{
-	'users' : getUserList
-}
+app.route({
+	users: getUserList
+});
 ```
 
+#### `parseNumber: boolean`
+
+인자로 전달되는 문자열 형태의 숫자를 `number` 타입으로 변환합니다.
+
+기본값은 `false` 입니다.
+
+#### `parseDate: boolean`
+
+인자로 전달되는 문자열 형태의 날짜를 `Date` 타입으로 변환합니다.
+
+기본값은 `false` 입니다.
+
+### `RouteOption`
+
+라우팅 함수의 동작을 결정합니다.
+
+#### `auth: boolean`
+
+`false`로 지정하면 이 라우팅 함수가 실행될 때 `auth()` 함수를 실행하지 않습니다.
+
+기본값은 `true` 입니다.
+
+## 특수 라우팅
+
+`route()`나 `get()`, `post()`, `put()`, `delete()` 함수의 경로에 특수 라우팅을 사용할 수 있습니다.
+
+### `:` 라우팅
+
+`/:userId`로 라우팅 경로를 지정하고 `/user1`로 HTTP 요청을 보내면, 요청이 매칭되며 라우팅 함수의 인자로 `{ userId: 'user1' }`이 전달됩니다.
+
+### `?` 라우팅
+
+`/users?`로 라우팅 경로를 지정하면 `/user`와 `/users` 경로를 매칭할 수 있습니다.
+
+### `+` 라우팅
+
+`/user1+`로 라우팅 경로를 지정하면 `/user1`과 `/user11` 등의 경로를 매칭할 수 있습니다.
+
+### `*` 라우팅
+
+`/user1*`로 라우팅 경로를 지정하면 `/user`와 `/user1`, `/user11` 등의 경로를 매칭할 수 있습니다.
+
+## 라우팅 인자
+
+### 쿼리 스트링
+
+`GET` 메서드를 요청하는 경우 쿼리 스트링 인자를 파싱해서 라우팅 함수로 전달합니다.
+
+아래 예제는 모두 `/path` 경로와 매칭되며 전달되는 인자는 각각 이렇습니다.
+
+```bash
+/path?          # {}
+/path?key       # { key: null }
+/path?key=      # { key: '' }
+/path?key=value # { key: 'value' }
+```

package/README.md

@@ -1,9 +1,252 @@
 ![npm](https://img.shields.io/npm/v/badak?logo=npm)
 
-![logo](https://github.com/han41858/badak/raw/master/docs/logo/badak_200.png)
+![logo](https://github.com/han41858/badak/raw/main/docs/logo/badak_200.png)
 
-# badak
+[한국어](https://github.com/han41858/badak/blob/main/README-KR.md)
 
 # badak
 
-node.js Server framework based on Promise and TypeScript
+badak is a backend framework developed based on Promises and TypeScript.
+
+> badak is written in TypeScript and is compiled and distributed as JavaScript code.
+> So, it can be used in TypeScript syntax or JavaScript syntax.
+
+## Install
+
+badak is distributed with npm and can be installed with npm/yarn.
+
+```bash
+npm install badak
+# or
+yarn add badak
+```
+
+## Usage
+
+```typescript
+import { Badak } from 'badak';
+
+const rule: RouteRule = {
+	users: {
+		GET: () => {
+			// returns a list of users.
+			return {
+				list: ['han', 'kim', 'lee']
+			}
+		},
+		POST: (user: User) => {
+			// add a user.
+			return {
+				result: 'ok'
+			}
+		}
+	}
+};
+
+
+const app: Badak = new Badak();
+await app.route(routeRule);
+await app.listen(3000);
+```
+
+## Methods
+
+### `new Badak(option?: Partial<BadakOption>)`
+
+Create a badak instance. You can pass options to the constructor.
+
+```typescript
+const app: Badak = new Badak();
+
+const appWithLog: Badak = new Badak({
+	catchErrorLog: true
+});
+```
+
+### `auth(fnc: MiddlewareFunction): Promise<void>`
+
+Set a middleware function for authentication. Only one authentication function can be specified.
+The registered function is executed after `before()` and before the routing function is executed.
+If an error occurs in this middleware function, a `401 Unauthorized` error occurs.
+
+### `before(fnc: MiddlewareFunction): Promise<void>`
+
+Registers a middleware function to run **before** the routing function is executed.
+Multiple middleware functions can be specified,
+and they are executed in parallel regardless of the order in which they are specified.
+
+### `after(fnc: MiddlewareFunction): Promise<void>`
+
+Registers a middleware function to run **after** the routing function is executed.
+Multiple middleware functions can be specified,
+and they are executed in parallel regardless of the order in which they are specified.
+
+### `config(key: string, value: unknown): Promise<void>`
+
+Controls how badak apps run.
+
+### `listen(port: number): Promise<void>`
+
+The server starts responding.
+
+### `isRunning(): boolean`
+
+Checks if the server is running and returns the results.
+The initial state is `false`, becomes `true` after the `listen()` function is executed,
+and becomes `false` after terminating with `stop()`.
+
+### `getHttpServer(): Server | undefined`
+
+Returns the HTTP server instance.
+Used to access badak internal members.
+
+### `stop(): Promise<void>`
+
+Stop the HTTP server.
+
+### `route(rule: RouteRule): Promise<void>`
+
+Register a routing function.
+
+### `get(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
+
+Registers a routing function that responds to `GET` method requests.
+
+### `post(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
+
+Registers a routing function that responds to `POST` method requests.
+
+### `put(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
+
+Registers a routing function that responds to `PUT` method requests.
+
+### `delete(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>`
+
+Registers a routing function that responds to `DELETE` method requests.
+
+### `static(uri: string, path: string): Promise<void>`
+
+Concatenate the address and file path to be provided as a static file.
+
+### `setSPARoot(uri: string, path: string): Promise<void>`
+
+Connect the address and file path to be used with the SPA app.
+Files within the specified folder are served statically and cached.
+
+## 인터페이스
+
+### `MiddlewareFunction`
+
+```typescript
+export type MiddlewareFunction = (req: IncomingMessage, res: ServerResponse, responseBody?: unknown) => void | Promise<void>;
+```
+
+This is a function registered in `before()` and `after()`.
+Middleware functions cannot change the arguments passed to the routing function.
+
+### `RouteFunction`
+
+```typescript
+export type RouteFunction = (param: any, req: IncomingMessage, res: ServerResponse) => unknown | Promise<unknown>;
+```
+
+Register a routing function to respond to HTTP requests.
+The value returned by the routing function is returned as an HTTP response.
+
+### `BadakOption`
+
+Specifies how the badak app should behave.
+
+#### `catchErrorLog: boolean`
+
+If an error occurs, a log is output to the console.
+
+The default is `true`.
+
+#### `preventError: boolean`
+
+If an error occurs, it is transmitted to the node.
+If you specify a value of `false`, the error will not be passed and will be ignored.
+
+The default is `true`.
+
+#### `defaultMethod: METHOD | undefined`
+
+Specifies the default HTTP method type to use for routing.
+Specifying this value allows you to omit specifying the HTTP method when using the `Badak.route()` method.
+
+- before :
+
+```typescript
+app.route({
+	users: {
+		GET: getUserList
+	}
+});
+```
+
+- after `app.config('defaultMethod', 'GET')` :
+
+```typescript
+app.route({
+	users: getUserList
+});
+```
+
+#### `parseNumber: boolean`
+
+Converts the string-type number passed as an argument to the `number` type.
+
+The default is `false`.
+
+#### `parseDate: boolean`
+
+Converts the date in string format passed as an argument to the `Date` type.
+
+The default is `false`.
+
+### `RouteOption`
+
+Determines the behavior of routing functions.
+
+#### `auth: boolean`
+
+If specified as `false`, the `auth()` function will not be executed when this routing function is executed.
+
+The default is `true`.
+
+## Special Routing
+
+Special routing can be used on the routes of the `route()`, `get()`, `post()`, `put()`, and `delete()` functions.
+
+### `:` routing
+
+If you specify a routing path with `/:userId` and send an HTTP request to `/user1`,
+the request is matched and `{ userId: 'user1' }` is passed as an argument to the routing function.
+
+### `?` routing
+
+If you specify the routing path as `/users?`, you can match the `/user` and `/users` paths.
+
+### `+` routing
+
+If you specify the routing path as `/user1+`, you can match paths such as `/user1` and `/user11`.
+
+### `*` routing
+
+If you specify a routing path as `/user1*`, you can match paths such as `/user`, `/user1`, and `/user11`.
+
+## Routing Param
+
+### query string
+
+When requesting the `GET` method, the query string argument is parsed and passed to the routing function.
+
+The examples below all match the `/path` path, and the arguments passed are as follows.
+
+```bash
+/path?          # {}
+/path?key       # { key: null }
+/path?key=      # { key: '' }
+/path?key=value # { key: 'value' }
+```

package/build/badak.d.ts

@@ -1,38 +1,38 @@
-/// <reference types="node" />
-import { Server } from 'net';
-import { BadakOption, MiddlewareFunction, RouteFunction, RouteOption, RouteRule } from './interfaces';
-export declare class Badak {
-    private _http;
-    private _authFnc;
-    private _middlewaresBefore;
-    private _middlewaresAfter;
-    private _routeRules;
-    private _staticRules;
-    private _staticCache;
-    private _spaRoot;
-    private _config;
-    constructor(option?: Partial<BadakOption>);
-    private _refineRouteRule;
-    private getUriKeyArr;
-    private _checkUriDuplication;
-    private _assignRule;
-    auth(fnc: MiddlewareFunction): Promise<void>;
-    before(middleware: MiddlewareFunction): Promise<void>;
-    after(middleware: MiddlewareFunction): Promise<void>;
-    config(key: string, value: unknown): Promise<void>;
-    private _routeAbbrValidator;
-    get(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
-    post(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
-    put(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
-    delete(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
-    private _paramConverter;
-    private _paramParser;
-    private _static;
-    static(uri: string, path: string): Promise<void>;
-    route(rule: RouteRule): Promise<void>;
-    setSPARoot(uri: string, path: string): Promise<void>;
-    listen(port: number): Promise<void>;
-    isRunning(): boolean;
-    getHttpServer(): Server | undefined;
-    stop(): Promise<void>;
-}
+/// <reference types="node" />
+import { Server } from 'node:net';
+import { BadakOption, MiddlewareFunction, RouteFunction, RouteOption, RouteRule } from './interfaces';
+export declare class Badak {
+    private _http;
+    private _authFnc;
+    private _middlewaresBefore;
+    private _middlewaresAfter;
+    private _routeRules;
+    private _staticRules;
+    private _staticCache;
+    private _spaRoot;
+    private _config;
+    constructor(option?: Partial<BadakOption>);
+    private _refineRouteRule;
+    private getUriKeyArr;
+    private _checkUriDuplication;
+    private _assignRule;
+    auth(fnc: MiddlewareFunction): Promise<void>;
+    before(middleware: MiddlewareFunction): Promise<void>;
+    after(middleware: MiddlewareFunction): Promise<void>;
+    config(key: string, value: unknown): Promise<void>;
+    private _routeAbbrValidator;
+    get(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
+    post(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
+    put(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
+    delete(address: string, fnc: RouteFunction, option?: RouteOption): Promise<void>;
+    private _paramConverter;
+    private _paramParser;
+    private _static;
+    static(uri: string, path: string): Promise<void>;
+    route(rule: RouteRule): Promise<void>;
+    setSPARoot(uri: string, path: string): Promise<void>;
+    listen(port: number): Promise<void>;
+    isRunning(): boolean;
+    getHttpServer(): Server | undefined;
+    stop(): Promise<void>;
+}