@nestia/fetcher 1.3.0 → 1.3.2

package/lib/IConnection.d.ts

@@ -1,11 +1,12 @@
 import { IEncryptionPassword } from "./IEncryptionPassword";
+import { IRandomGenerator } from "./IRandomGenerator";
 /**
  * Connection information.
  *
- * `IConnection` is a type of interface who represents connection information of the remote
- * HTTP server. You can target the remote HTTP server by wring the {@link IConnection.host}
- * variable down. Also, you can configure special header values by specializing the
- * {@link IConnection.headers} variable.
+ * `IConnection` is an interface ttype who represents connection information of the
+ * remote HTTP server. You can target the remote HTTP server by wring the
+ * {@link IConnection.host} variable down. Also, you can configure special header values
+ * by specializing the {@link IConnection.headers} variable.
  *
  * If the remote HTTP server encrypts or decrypts its body data through the AES-128/256
  * algorithm, specify the {@link IConnection.encryption} with {@link IEncryptionPassword}
@@ -18,21 +19,6 @@ export interface IConnection {
      * Host address of the remote HTTP server.
      */
     host: string;
-    /**
-     * Use `typia.random<T>()` function instead.
-     *
-     * If you configure this property to be `true`, your SDK library does not send
-     * any request to remote backend server, but just returns a random data generated
-     * by `typia.random<T>()` function.
-     *
-     * By the way, to utilize this random property, SDK library must be generated with
-     * `random` option, too. Open `nestia.config.ts` file, and configure `random: true`
-     * property in the top level. Then newly generated SDK library would have a
-     * built-in random generator.
-     *
-     * @default false
-     */
-    random?: boolean;
     /**
      * Header values delivered to the remote HTTP server.
      */
@@ -41,4 +27,28 @@ export interface IConnection {
      * Encryption password of its closure function.
      */
     encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+    /**
+     * Use simulation mode.
+     *
+     * If you configure this property to be `true` or assign an {@link IRandomGenerator}
+     * instance, your SDK library does not send any request to remote backend server,
+     * but just returns random data generated by `typia.random<T>()` function with
+     * request data validation.
+     *
+     * By the way, to utilize this simulation mode, SDK library must be generated with
+     * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
+     * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
+     * generated SDK library would have a built-in mock-up data generator.
+     *
+     * @default false
+     */
+    simulate?: boolean | Partial<IRandomGenerator>;
+    /**
+     * Use simulation mode.
+     *
+     * @default false
+     * @deprecated Use {@link simulate} property instead.
+     *             This property would be erased after v2.0 update
+     */
+    random?: boolean | Partial<IRandomGenerator>;
 }

package/lib/IRandomGenerator.d.ts

@@ -0,0 +1,32 @@
+export interface IRandomGenerator {
+    boolean(): boolean;
+    integer(minimum?: number, maximum?: number): number;
+    number(minimum?: number, maximum?: number): number;
+    bigint(minimum?: bigint, maximum?: bigint): bigint;
+    string(length?: number): string;
+    array<T>(closure: (index: number) => T, count?: number): T[];
+    length(): number;
+    uuid(): string;
+    email(): string;
+    url(): string;
+    ipv4(): string;
+    ipv6(): string;
+    pattern(regex: RegExp): string;
+    date(minimum?: number, maximum?: number): string;
+    datetime(minimum?: number, maximum?: number): string;
+    customs?: IRandomGenerator.CustomMap;
+}
+export declare namespace IRandomGenerator {
+    type CustomMap = {
+        [Type in keyof Customizable]?: (tags: ICommentTag[]) => Customizable[Type] | undefined;
+    };
+    type Customizable = {
+        number: number;
+        string: string;
+        bigint: bigint;
+    };
+    interface ICommentTag {
+        name: string;
+        value?: string;
+    }
+}

package/lib/IRandomGenerator.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IRandomGenerator.js.map

package/lib/IRandomGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRandomGenerator.js","sourceRoot":"","sources":["../src/IRandomGenerator.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/src/IConnection.ts

@@ -1,12 +1,13 @@
 import { IEncryptionPassword } from "./IEncryptionPassword";
+import { IRandomGenerator } from "./IRandomGenerator";
 
 /**
  * Connection information.
  *
- * `IConnection` is a type of interface who represents connection information of the remote
- * HTTP server. You can target the remote HTTP server by wring the {@link IConnection.host}
- * variable down. Also, you can configure special header values by specializing the
- * {@link IConnection.headers} variable.
+ * `IConnection` is an interface ttype who represents connection information of the
+ * remote HTTP server. You can target the remote HTTP server by wring the
+ * {@link IConnection.host} variable down. Also, you can configure special header values
+ * by specializing the {@link IConnection.headers} variable.
  *
  * If the remote HTTP server encrypts or decrypts its body data through the AES-128/256
  * algorithm, specify the {@link IConnection.encryption} with {@link IEncryptionPassword}
@@ -20,22 +21,6 @@ export interface IConnection {
      */
     host: string;
 
-    /**
-     * Use `typia.random<T>()` function instead.
-     *
-     * If you configure this property to be `true`, your SDK library does not send
-     * any request to remote backend server, but just returns a random data generated
-     * by `typia.random<T>()` function.
-     *
-     * By the way, to utilize this random property, SDK library must be generated with
-     * `random` option, too. Open `nestia.config.ts` file, and configure `random: true`
-     * property in the top level. Then newly generated SDK library would have a
-     * built-in random generator.
-     *
-     * @default false
-     */
-    random?: boolean;
-
     /**
      * Header values delivered to the remote HTTP server.
      */
@@ -45,4 +30,30 @@ export interface IConnection {
      * Encryption password of its closure function.
      */
     encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+
+    /**
+     * Use simulation mode.
+     *
+     * If you configure this property to be `true` or assign an {@link IRandomGenerator}
+     * instance, your SDK library does not send any request to remote backend server,
+     * but just returns random data generated by `typia.random<T>()` function with
+     * request data validation.
+     *
+     * By the way, to utilize this simulation mode, SDK library must be generated with
+     * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
+     * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
+     * generated SDK library would have a built-in mock-up data generator.
+     *
+     * @default false
+     */
+    simulate?: boolean | Partial<IRandomGenerator>;
+
+    /**
+     * Use simulation mode.
+     *
+     * @default false
+     * @deprecated Use {@link simulate} property instead.
+     *             This property would be erased after v2.0 update
+     */
+    random?: boolean | Partial<IRandomGenerator>;
 }

package/src/IRandomGenerator.ts

@@ -0,0 +1,38 @@
+export interface IRandomGenerator {
+    boolean(): boolean;
+    integer(minimum?: number, maximum?: number): number;
+    number(minimum?: number, maximum?: number): number;
+    bigint(minimum?: bigint, maximum?: bigint): bigint;
+    string(length?: number): string;
+    array<T>(closure: (index: number) => T, count?: number): T[];
+    length(): number;
+
+    uuid(): string;
+    email(): string;
+    url(): string;
+    ipv4(): string;
+    ipv6(): string;
+    pattern(regex: RegExp): string;
+    date(minimum?: number, maximum?: number): string;
+    datetime(minimum?: number, maximum?: number): string;
+
+    customs?: IRandomGenerator.CustomMap;
+}
+export namespace IRandomGenerator {
+    export type CustomMap = {
+        [Type in keyof Customizable]?: (
+            tags: ICommentTag[],
+        ) => Customizable[Type] | undefined;
+    };
+
+    export type Customizable = {
+        number: number;
+        string: string;
+        bigint: bigint;
+    }
+
+    export interface ICommentTag {
+        name: string;
+        value?: string;
+    }
+}