@nestia/sdk 1.0.7 → 1.0.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jeongho Nam
+
+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/assets/config/nestia.config.ts

@@ -1,70 +1,70 @@
-import { INestiaSdkConfiguration } from "@nestia/sdk";
-
-export const NESTIA_CONFIG: INestiaSdkConfiguration = {
-    /**
-     * List of files or directories containing the NestJS controller classes.
-     */
-    input: "src/controllers",
-
-    /**
-     * Output directory that SDK would be placed in.
-     *
-     * If not configured, you can't build the SDK library.
-     */
-    output: "src/api",
-
-    /**
-     * Whether to assert parameter types or not.
-     *
-     * If you configure this property to be `true`, all of the function parameters would be
-     * checked through the [typia](https://github.com/samchon/typia#runtime-type-checkers).
-     * This option would make your SDK library slower, but would enahcne the type safety even
-     * in the runtime level.
-     *
-     * @default false
-     */
-    // assert: true,
-
-    /**
-     * Whether to optimize JSON string conversion 2x faster or not.
-     *
-     * If you configure this property to be `true`, the SDK library would utilize the
-     * [typia](https://github.com/samchon/typia#fastest-json-string-converter)
-     * and the JSON string conversion speed really be 2x faster.
-     *
-     * @default false
-     */
-    // json: true,
-
-    /**
-     * Whether to wrap DTO by primitive type.
-     *
-     * If you don't configure this property as `false`, all of DTOs in the
-     * SDK library would be automatically wrapped by {@link Primitive} type.
-     *
-     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
-     * all of methods in the DTO type would be automatically erased. Also, if
-     * the DTO has a `toJSON()` method, the DTO type would be automatically
-     * converted to return type of the `toJSON()` method.
-     *
-     * @default true
-     */
-    // primitive: false,
-
-    /**
-     * Building `swagger.json` is also possible.
-     *
-     * If not specified, you can't build the `swagger.json`.
-     */
-    swagger: {
-        /**
-         * Output path of the `swagger.json`.
-         *
-         * If you've configured only directory, the file name would be the `swagger.json`.
-         * Otherwise you've configured the full path with file name and extension, the
-         * `swagger.json` file would be renamed to it.
-         */
-        output: "dist/swagger.json",
-    },
-};
-export default NESTIA_CONFIG;
+import { INestiaSdkConfiguration } from "@nestia/sdk";
+
+export const NESTIA_CONFIG: INestiaSdkConfiguration = {
+    /**
+     * List of files or directories containing the NestJS controller classes.
+     */
+    input: "src/controllers",
+
+    /**
+     * Output directory that SDK would be placed in.
+     *
+     * If not configured, you can't build the SDK library.
+     */
+    output: "src/api",
+
+    /**
+     * Whether to assert parameter types or not.
+     *
+     * If you configure this property to be `true`, all of the function parameters would be
+     * checked through the [typia](https://github.com/samchon/typia#runtime-type-checkers).
+     * This option would make your SDK library slower, but would enahcne the type safety even
+     * in the runtime level.
+     *
+     * @default false
+     */
+    // assert: true,
+
+    /**
+     * Whether to optimize JSON string conversion 2x faster or not.
+     *
+     * If you configure this property to be `true`, the SDK library would utilize the
+     * [typia](https://github.com/samchon/typia#fastest-json-string-converter)
+     * and the JSON string conversion speed really be 2x faster.
+     *
+     * @default false
+     */
+    // json: true,
+
+    /**
+     * Whether to wrap DTO by primitive type.
+     *
+     * If you don't configure this property as `false`, all of DTOs in the
+     * SDK library would be automatically wrapped by {@link Primitive} type.
+     *
+     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
+     * all of methods in the DTO type would be automatically erased. Also, if
+     * the DTO has a `toJSON()` method, the DTO type would be automatically
+     * converted to return type of the `toJSON()` method.
+     *
+     * @default true
+     */
+    // primitive: false,
+
+    /**
+     * Building `swagger.json` is also possible.
+     *
+     * If not specified, you can't build the `swagger.json`.
+     */
+    swagger: {
+        /**
+         * Output path of the `swagger.json`.
+         *
+         * If you've configured only directory, the file name would be the `swagger.json`.
+         * Otherwise you've configured the full path with file name and extension, the
+         * `swagger.json` file would be renamed to it.
+         */
+        output: "dist/swagger.json",
+    },
+};
+export default NESTIA_CONFIG;

package/lib/executable/sdk.js

@@ -40,22 +40,22 @@ const child_process_1 = __importDefault(require("child_process"));
 const fs_1 = __importDefault(require("fs"));
 const process_1 = __importDefault(require("process"));
 const CommandParser_1 = require("./internal/CommandParser");
-const USAGE = `Wrong command has been detected. Use like below:
-
-npx @nestia/sdk [command] [options?]
-
-  1. npx @nestia/sdk dependencies --manager (npm|pnpm|yarn)
-    - npx @nestia/sdk dependencies
-    - npx @nestia/sdk dependencies --manager pnpm
-  2. npx @nestia/sdk init
-  3. npx @nestia/sdk sdk <input> --out <output>
-    - npx @nestia/sdk sdk # when "nestia.config.ts" be configured
-    - npx @nestia/sdk sdk src/controllers --out src/api
-    - npx @nestia/sdk sdk src/**/*.controller.ts --out src/api
-  4. npx @nestia/sdk swagger <input> --out <output>
-    - npx @nestia/sdk swagger # when "nestia.config.ts" be configured
-    - npx @nestia/sdk swagger src/controllers --out src/api
-    - npx @nestia/sdk swagger src/**/*.controller.ts --out src/api       
+const USAGE = `Wrong command has been detected. Use like below:
+
+npx @nestia/sdk [command] [options?]
+
+  1. npx @nestia/sdk dependencies --manager (npm|pnpm|yarn)
+    - npx @nestia/sdk dependencies
+    - npx @nestia/sdk dependencies --manager pnpm
+  2. npx @nestia/sdk init
+  3. npx @nestia/sdk sdk <input> --out <output>
+    - npx @nestia/sdk sdk # when "nestia.config.ts" be configured
+    - npx @nestia/sdk sdk src/controllers --out src/api
+    - npx @nestia/sdk sdk src/**/*.controller.ts --out src/api
+  4. npx @nestia/sdk swagger <input> --out <output>
+    - npx @nestia/sdk swagger # when "nestia.config.ts" be configured
+    - npx @nestia/sdk swagger src/controllers --out src/api
+    - npx @nestia/sdk swagger src/**/*.controller.ts --out src/api       
 `;
 function halt(desc) {
     console.error(desc);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/sdk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Nestia SDK and Swagger generator",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -61,7 +61,7 @@
     "tsconfck": "^2.0.1",
     "tsconfig-paths": "^4.1.1",
     "tstl": "^2.5.13",
-    "typia": "^3.4.22"
+    "typia": "^3.5.5"
   },
   "files": [
     "assets",

package/src/INestiaConfig.ts

@@ -1,147 +1,147 @@
-import ts from "typescript";
-
-import { ISwaggerDocument } from "./structures/ISwaggerDocument";
-import type { StripEnums } from "./utils/StripEnums";
-
-/**
- * Definition for the `nestia.config.ts` file.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface INestiaConfig {
-    /**
-     * List of files or directories containing the NestJS controller classes.
-     */
-    input: string | string[] | INestiaConfig.IInput;
-
-    /**
-     * Output directory that SDK would be placed in.
-     *
-     * If not configured, you can't build the SDK library.
-     */
-    output?: string;
-
-    /**
-     * Compiler options for the TypeScript.
-     *
-     * If you've omitted this property or the assigned property cannot fully cover the
-     * `tsconfig.json`, the properties from the `tsconfig.json` would be assigned to here.
-     * Otherwise, this property has been configured and it's detailed values are different
-     * with the `tsconfig.json`, this property values would be used instead.
-     *
-     * ```typescript
-     * import ts from "typescript";
-     *
-     * const tsconfig: ts.TsConfig;
-     * const nestiaConfig: IConfiguration;
-     *
-     * const compilerOptions: ts.CompilerOptions = {
-     *     ...tsconfig.compilerOptions,
-     *     ...(nestiaConfig.compilerOptions || {})
-     * }
-     * ```
-     */
-    compilerOptions?: StripEnums<ts.CompilerOptions>;
-
-    /**
-     * Whether to assert parameter types or not.
-     *
-     * If you configure this property to be `true`, all of the function parameters
-     * would be checked through [typia](https://github.com/samchon/typia#runtime-validators).
-     * This option would make your SDK library slower, but would enahcne the type safety
-     * even in the runtime level.
-     *
-     * @default false
-     */
-    assert?: boolean;
-
-    /**
-     * Whether to optimize JSON string conversion 10x faster or not.
-     *
-     * If you configure this property to be `true`, the SDK library would utilize the
-     * [typia](https://github.com/samchon/typia#enhanced-json)
-     * and the JSON string conversion speed really be 10x faster.
-     *
-     * @default false
-     */
-    json?: boolean;
-
-    /**
-     * Whether to wrap DTO by primitive type.
-     *
-     * If you don't configure this property as `false`, all of DTOs in the
-     * SDK library would be automatically wrapped by {@link Primitive} type.
-     *
-     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
-     * all of methods in the DTO type would be automatically erased. Also, if
-     * the DTO has a `toJSON()` method, the DTO type would be automatically
-     * converted to return type of the `toJSON()` method.
-     *
-     * @default true
-     */
-    primitive?: boolean;
-
-    /**
-     * Building `swagger.json` is also possible.
-     *
-     * If not specified, you can't build the `swagger.json`.
-     */
-    swagger?: INestiaConfig.ISwaggerConfig;
-}
-export namespace INestiaConfig {
-    /**
-     * List of files or directories to include or exclude to specifying the NestJS
-     * controllers.
-     */
-    export interface IInput {
-        /**
-         * List of files or directories containing the NestJS controller classes.
-         */
-        include: string[];
-
-        /**
-         * List of files or directories to be excluded.
-         */
-        exclude?: string[];
-    }
-
-    /**
-     * Building `swagger.json` is also possible.
-     */
-    export interface ISwaggerConfig {
-        /**
-         * Output path of the `swagger.json`.
-         *
-         * If you've configured only directory, the file name would be the `swagger.json`.
-         * Otherwise you've configured the full path with file name and extension, the
-         * `swagger.json` file would be renamed to it.
-         */
-        output: string;
-
-        /**
-         * Security schemes.
-         */
-        security?: Record<string, ISwaggerConfig.ISecurityScheme>;
-    }
-    export namespace ISwaggerConfig {
-        export type ISecurityScheme =
-            | IApiKey
-            | Exclude<
-                  ISwaggerDocument.ISecurityScheme,
-                  ISwaggerDocument.ISecurityScheme.IApiKey
-              >;
-        export interface IApiKey {
-            type: "apiKey";
-
-            /**
-             * @default header
-             */
-            in?: "header" | "query" | "cookie";
-
-            /**
-             * @default Authorization
-             */
-            name?: string;
-        }
-    }
-}
+import ts from "typescript";
+
+import { ISwaggerDocument } from "./structures/ISwaggerDocument";
+import type { StripEnums } from "./utils/StripEnums";
+
+/**
+ * Definition for the `nestia.config.ts` file.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface INestiaConfig {
+    /**
+     * List of files or directories containing the NestJS controller classes.
+     */
+    input: string | string[] | INestiaConfig.IInput;
+
+    /**
+     * Output directory that SDK would be placed in.
+     *
+     * If not configured, you can't build the SDK library.
+     */
+    output?: string;
+
+    /**
+     * Compiler options for the TypeScript.
+     *
+     * If you've omitted this property or the assigned property cannot fully cover the
+     * `tsconfig.json`, the properties from the `tsconfig.json` would be assigned to here.
+     * Otherwise, this property has been configured and it's detailed values are different
+     * with the `tsconfig.json`, this property values would be used instead.
+     *
+     * ```typescript
+     * import ts from "typescript";
+     *
+     * const tsconfig: ts.TsConfig;
+     * const nestiaConfig: IConfiguration;
+     *
+     * const compilerOptions: ts.CompilerOptions = {
+     *     ...tsconfig.compilerOptions,
+     *     ...(nestiaConfig.compilerOptions || {})
+     * }
+     * ```
+     */
+    compilerOptions?: StripEnums<ts.CompilerOptions>;
+
+    /**
+     * Whether to assert parameter types or not.
+     *
+     * If you configure this property to be `true`, all of the function parameters
+     * would be checked through [typia](https://github.com/samchon/typia#runtime-validators).
+     * This option would make your SDK library slower, but would enahcne the type safety
+     * even in the runtime level.
+     *
+     * @default false
+     */
+    assert?: boolean;
+
+    /**
+     * Whether to optimize JSON string conversion 10x faster or not.
+     *
+     * If you configure this property to be `true`, the SDK library would utilize the
+     * [typia](https://github.com/samchon/typia#enhanced-json)
+     * and the JSON string conversion speed really be 10x faster.
+     *
+     * @default false
+     */
+    json?: boolean;
+
+    /**
+     * Whether to wrap DTO by primitive type.
+     *
+     * If you don't configure this property as `false`, all of DTOs in the
+     * SDK library would be automatically wrapped by {@link Primitive} type.
+     *
+     * For refenrece, if a DTO type be capsuled by the {@link Primitive} type,
+     * all of methods in the DTO type would be automatically erased. Also, if
+     * the DTO has a `toJSON()` method, the DTO type would be automatically
+     * converted to return type of the `toJSON()` method.
+     *
+     * @default true
+     */
+    primitive?: boolean;
+
+    /**
+     * Building `swagger.json` is also possible.
+     *
+     * If not specified, you can't build the `swagger.json`.
+     */
+    swagger?: INestiaConfig.ISwaggerConfig;
+}
+export namespace INestiaConfig {
+    /**
+     * List of files or directories to include or exclude to specifying the NestJS
+     * controllers.
+     */
+    export interface IInput {
+        /**
+         * List of files or directories containing the NestJS controller classes.
+         */
+        include: string[];
+
+        /**
+         * List of files or directories to be excluded.
+         */
+        exclude?: string[];
+    }
+
+    /**
+     * Building `swagger.json` is also possible.
+     */
+    export interface ISwaggerConfig {
+        /**
+         * Output path of the `swagger.json`.
+         *
+         * If you've configured only directory, the file name would be the `swagger.json`.
+         * Otherwise you've configured the full path with file name and extension, the
+         * `swagger.json` file would be renamed to it.
+         */
+        output: string;
+
+        /**
+         * Security schemes.
+         */
+        security?: Record<string, ISwaggerConfig.ISecurityScheme>;
+    }
+    export namespace ISwaggerConfig {
+        export type ISecurityScheme =
+            | IApiKey
+            | Exclude<
+                  ISwaggerDocument.ISecurityScheme,
+                  ISwaggerDocument.ISecurityScheme.IApiKey
+              >;
+        export interface IApiKey {
+            type: "apiKey";
+
+            /**
+             * @default header
+             */
+            in?: "header" | "query" | "cookie";
+
+            /**
+             * @default Authorization
+             */
+            name?: string;
+        }
+    }
+}