@rainbow-o23/n3 0.1.13 → 0.1.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 InsureMO
+
+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/README.md

@@ -1,3 +1,13 @@
+![Static Badge](https://img.shields.io/badge/InsureMO-777AF2.svg)
+
+![TypeORM](https://img.shields.io/badge/TypeORM-E83524.svg)
+![MySQL](https://img.shields.io/badge/MySQL-white.svg?logo=mysql&logoColor=4479A1&style=social)
+![PostgreSQL](https://img.shields.io/badge/PostgreSQL-white.svg?logo=postgresql&logoColor=4169E1&style=social)
+![MSSQL](https://img.shields.io/badge/MSSQL-white.svg?logo=microsoftsqlserver&logoColor=CC2927&style=social)
+![Oracle](https://img.shields.io/badge/Oracle-white.svg?logo=oracle&logoColor=F80000&style=social)
+
+![Module Formats](https://img.shields.io/badge/module%20formats-cjs-green.svg)
+
 # o23/n3
 
 `o23/n3` provides the most basic pipeline steps.
@@ -339,7 +349,7 @@ When `typeorm.DB.type=better-sqlite3`:
 
 > SQLite save `DateTime` column as javascript `string`.
 
-> NEVER use it in production. 
+> NEVER use it in production.
 
 ### Constructor Parameters
 
@@ -426,8 +436,8 @@ Since different databases have varying degrees of support for dialects, `o23/n3`
 - For pagination, `$.limit($offset, $limit)` will be translated and executed in the appropriate dialect. For example,
 	- `MySQL` uses `LIMIT $offset, $limit`,
 	- `PostgreSQL` uses `OFFSET $offset LIMIT $limit`.
-	- `MSSQL` uses `OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY`,
-		- SQL Server requires an `ORDER BY` clause for pagination SQL. If there is no `ORDER BY` clause, will
+	- `MSSQL` and `Oracle` use `OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY`,
+		- `MSSQL` requires an `ORDER BY` clause for pagination SQL. If there is no `ORDER BY` clause, will
 		  use `ORDER BY 1 OFFSET $offset ROWS FETCH NEXT $limit ROWS ONLY`.
 - For JSON column, because some databases (such as MSSQL) do not have a JSON column type, they cannot automatically replace strings in the
   result set with JSON objects,
@@ -440,9 +450,9 @@ Since different databases have varying degrees of support for dialects, `o23/n3`
 	- Use `$enabled.@bool` to explicitly indicate that the `enabled` property of given parameters is of boolean in-memory and numeric in
 	  database data type.
 - For datetime (MySQL, MSSQL) / timestamp (Oracle, PostgreSQL) column,
-	- Use `created_at as "createAt.@ts"` to explicitly indicate that the `createAt` column is of string in-memory and timestamp in database
-	  data type.
-	- Use `$createAt.@ts` to explicitly indicate that the `createAt` property of given parameters is of string in-memory and timestamp in
+	- Use `created_at as "createdAt.@ts"` to explicitly indicate that the `createdAt` column is of string in-memory and timestamp in
+	  database data type.
+	- Use `$createdAt.@ts` to explicitly indicate that the `createdAt` property of given parameters is of string in-memory and timestamp in
 	  database data type.
 
 > We recommend that if you need to consider support for multiple database dialects, using enhanced syntax will make it easier to write SQL.

package/index.cjs

@@ -797,19 +797,11 @@ class ConditionalPipelineStepSets extends PipelineStepSets {
         return this._otherwiseStepBuilders;
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async check(data, _request) {
+    async check(data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await this._func($helpers, $helpers);
-        }
-        else {
-            return await this._func(data, $helpers, $helpers);
-        }
+        return await this._func(data, request, $helpers, $helpers);
     }
     async perform(request) {
         return await this.performAndCatch(request, async (fragment) => {
@@ -831,12 +823,12 @@ class ConditionalPipelineStepSets extends PipelineStepSets {
             }
         });
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
@@ -871,19 +863,11 @@ class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
         return { config: this.getConfig(), logger: this.getLogger() };
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async check(func, data, _request) {
+    async check(func, data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await func($helpers, $helpers);
-        }
-        else {
-            return await func(data, $helpers, $helpers);
-        }
+        return await func(data, request, $helpers, $helpers);
     }
     async doPerform(data, request) {
         throw new n1.UncatchableError(ERR_PIPELINE_STEP_METHOD_NOT_SUPPORTED, `Method[${RoutesPipelineStepSets.name}.doPerform] not supported.`);
@@ -917,12 +901,12 @@ class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
             }
         });
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class SnippetPipelineStep extends AbstractFragmentaryPipelineStep {
@@ -946,26 +930,18 @@ class SnippetPipelineStep extends AbstractFragmentaryPipelineStep {
         return this._snippet;
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async doPerform(data, _request) {
+    async doPerform(data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await this._func($helpers, $helpers);
-        }
-        else {
-            return await this._func(data, $helpers, $helpers);
-        }
-    }
-    isInFragmentIgnored() {
-        return false;
+        return await this._func(data, request, $helpers, $helpers);
     }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class SnowflakePipelineStep extends AbstractFragmentaryPipelineStep {
@@ -1585,30 +1561,26 @@ class TypeOrmBySnippetPipelineStep extends AbstractTypeOrmPipelineStep {
     generateVariableNames() {
         return [
             this.getRunnerVariableName(),
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
+            this.getInFragmentVariableName(),
+            this.getRequestVariableName(),
             ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        ];
     }
     async doPerform(basis, request) {
         return await this.autoTrans(async (runner) => {
             const $helpers = this.getHelpers();
-            if (this.isInFragmentIgnored()) {
-                return await this._func(runner, $helpers, $helpers);
-            }
-            else {
-                return await this._func(runner, basis, $helpers, $helpers);
-            }
+            return await this._func(runner, basis, request, $helpers, $helpers);
         }, request);
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getRunnerVariableName() {
         return '$runner';
     }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 exports.ParsedSqlSegmentType = void 0;
@@ -2065,7 +2037,7 @@ class AbstractTypeOrmBySQLPipelineStep extends AbstractTypeOrmPipelineStep {
                         return result.rowCount;
                     default:
                         if (result.hasOwnProperty('rows')) {
-                            return result.rows;
+                            return (result.rows ?? []).map(item => this.beautify({ data: item, datasourceType }));
                         }
                         else {
                             return result;
@@ -2079,7 +2051,7 @@ class AbstractTypeOrmBySQLPipelineStep extends AbstractTypeOrmPipelineStep {
                     return this.beautify({ data: result, datasourceType });
                 }
             default:
-                return result;
+                return this.beautify({ data: result, datasourceType });
         }
     }
 }

package/index.js

@@ -795,19 +795,11 @@ class ConditionalPipelineStepSets extends PipelineStepSets {
         return this._otherwiseStepBuilders;
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async check(data, _request) {
+    async check(data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await this._func($helpers, $helpers);
-        }
-        else {
-            return await this._func(data, $helpers, $helpers);
-        }
+        return await this._func(data, request, $helpers, $helpers);
     }
     async perform(request) {
         return await this.performAndCatch(request, async (fragment) => {
@@ -829,12 +821,12 @@ class ConditionalPipelineStepSets extends PipelineStepSets {
             }
         });
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
@@ -869,19 +861,11 @@ class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
         return { config: this.getConfig(), logger: this.getLogger() };
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async check(func, data, _request) {
+    async check(func, data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await func($helpers, $helpers);
-        }
-        else {
-            return await func(data, $helpers, $helpers);
-        }
+        return await func(data, request, $helpers, $helpers);
     }
     async doPerform(data, request) {
         throw new UncatchableError(ERR_PIPELINE_STEP_METHOD_NOT_SUPPORTED, `Method[${RoutesPipelineStepSets.name}.doPerform] not supported.`);
@@ -915,12 +899,12 @@ class RoutesPipelineStepSets extends AbstractFragmentaryPipelineStep {
             }
         });
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class SnippetPipelineStep extends AbstractFragmentaryPipelineStep {
@@ -944,26 +928,18 @@ class SnippetPipelineStep extends AbstractFragmentaryPipelineStep {
         return this._snippet;
     }
     generateVariableNames() {
-        return [
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-            ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
     }
-    async doPerform(data, _request) {
+    async doPerform(data, request) {
         const $helpers = this.getHelpers();
-        if (this.isInFragmentIgnored()) {
-            return await this._func($helpers, $helpers);
-        }
-        else {
-            return await this._func(data, $helpers, $helpers);
-        }
-    }
-    isInFragmentIgnored() {
-        return false;
+        return await this._func(data, request, $helpers, $helpers);
     }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 class SnowflakePipelineStep extends AbstractFragmentaryPipelineStep {
@@ -1583,30 +1559,26 @@ class TypeOrmBySnippetPipelineStep extends AbstractTypeOrmPipelineStep {
     generateVariableNames() {
         return [
             this.getRunnerVariableName(),
-            this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
+            this.getInFragmentVariableName(),
+            this.getRequestVariableName(),
             ...this.getHelpersVariableNames()
-        ].filter(x => x != null);
+        ];
     }
     async doPerform(basis, request) {
         return await this.autoTrans(async (runner) => {
             const $helpers = this.getHelpers();
-            if (this.isInFragmentIgnored()) {
-                return await this._func(runner, $helpers, $helpers);
-            }
-            else {
-                return await this._func(runner, basis, $helpers, $helpers);
-            }
+            return await this._func(runner, basis, request, $helpers, $helpers);
         }, request);
     }
-    isInFragmentIgnored() {
-        return false;
-    }
     getRunnerVariableName() {
         return '$runner';
     }
     getInFragmentVariableName() {
         return '$factor';
     }
+    getRequestVariableName() {
+        return '$request';
+    }
 }
 
 var ParsedSqlSegmentType;
@@ -2063,7 +2035,7 @@ class AbstractTypeOrmBySQLPipelineStep extends AbstractTypeOrmPipelineStep {
                         return result.rowCount;
                     default:
                         if (result.hasOwnProperty('rows')) {
-                            return result.rows;
+                            return (result.rows ?? []).map(item => this.beautify({ data: item, datasourceType }));
                         }
                         else {
                             return result;
@@ -2077,7 +2049,7 @@ class AbstractTypeOrmBySQLPipelineStep extends AbstractTypeOrmPipelineStep {
                     return this.beautify({ data: result, datasourceType });
                 }
             default:
-                return result;
+                return this.beautify({ data: result, datasourceType });
         }
     }
 }

package/lib/step/conditional-step-sets.d.ts

@@ -1,11 +1,9 @@
 import { PipelineStepBuilder, PipelineStepData, PipelineStepHelpers, PipelineStepPayload, Undefinable } from '@rainbow-o23/n1';
 import { PipelineStepSets, PipelineStepSetsOptions } from './step-sets';
 import { ScriptFuncOrBody } from './types';
-export type ConditionCheckWithInFragment<InFragment> = ($factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
-export type ConditionCheckWithoutInFragment = ($helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
-export type ConditionCheckFunc<InFragment> = ConditionCheckWithInFragment<InFragment> | ConditionCheckWithoutInFragment;
+export type ConditionCheckFunc<In, InFragment> = ($factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
 export interface ConditionalPipelineStepSetsOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends PipelineStepSetsOptions<In, Out, InFragment, OutFragment> {
-    check: ScriptFuncOrBody<ConditionCheckFunc<InFragment>>;
+    check: ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>;
     otherwiseSteps: Array<PipelineStepBuilder>;
 }
 export declare class ConditionalPipelineStepSets<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends PipelineStepSets<In, Out, InFragment, OutFragment> {
@@ -13,11 +11,11 @@ export declare class ConditionalPipelineStepSets<In = PipelineStepPayload, Out =
     private readonly _func;
     private readonly _otherwiseStepBuilders;
     constructor(options: ConditionalPipelineStepSetsOptions<In, Out, InFragment, OutFragment>);
-    getCheckSnippet(): ScriptFuncOrBody<ConditionCheckFunc<InFragment>>;
+    getCheckSnippet(): ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>;
     protected getOtherwiseStepBuilders(): Undefinable<Array<PipelineStepBuilder>>;
     protected generateVariableNames(): Array<string>;
-    protected check(data: InFragment, _request: PipelineStepData<In>): Promise<boolean>;
+    protected check(data: InFragment, request: PipelineStepData<In>): Promise<boolean>;
     perform(request: PipelineStepData<In>): Promise<PipelineStepData<Out>>;
-    protected isInFragmentIgnored(): boolean;
     protected getInFragmentVariableName(): string;
+    protected getRequestVariableName(): string;
 }

package/lib/step/routes-step-sets.d.ts

@@ -2,29 +2,29 @@ import { PipelineStepBuilder, PipelineStepData, PipelineStepOptions, PipelineSte
 import { AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions } from './abstract-fragmentary-pipeline-step';
 import { ConditionCheckFunc } from './conditional-step-sets';
 import { ScriptFuncOrBody } from './types';
-export interface RoutesConditionalStepOptions<InFragment> {
-    check: ScriptFuncOrBody<ConditionCheckFunc<InFragment>>;
+export interface RoutesConditionalStepOptions<In, InFragment> {
+    check: ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>;
     steps?: Array<PipelineStepBuilder>;
 }
 export interface RoutesPipelineStepSetsOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
-    conditionalSteps: Array<RoutesConditionalStepOptions<InFragment>>;
+    conditionalSteps: Array<RoutesConditionalStepOptions<In, InFragment>>;
     otherwiseSteps?: Array<PipelineStepBuilder>;
 }
-export interface RoutesConditionalStep<InFragment> {
-    check: ConditionCheckFunc<InFragment>;
+export interface RoutesConditionalStep<In, InFragment> {
+    check: ConditionCheckFunc<In, InFragment>;
     steps: Array<PipelineStepBuilder>;
 }
 export declare class RoutesPipelineStepSets<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends AbstractFragmentaryPipelineStep<In, Out, InFragment, OutFragment> {
     private readonly _conditionalStepBuilders;
     private readonly _otherwiseStepBuilders;
     constructor(options: RoutesPipelineStepSetsOptions<In, Out, InFragment, OutFragment>);
-    protected getConditionalStepBuilders(): Array<RoutesConditionalStep<InFragment>>;
+    protected getConditionalStepBuilders(): Array<RoutesConditionalStep<In, InFragment>>;
     protected getOtherwiseStepBuilders(): Undefinable<Array<PipelineStepBuilder>>;
     protected buildStepOptions(): Pick<PipelineStepOptions, 'config' | 'logger'>;
     protected generateVariableNames(): Array<string>;
-    protected check(func: ConditionCheckFunc<InFragment>, data: InFragment, _request: PipelineStepData<In>): Promise<boolean>;
+    protected check(func: ConditionCheckFunc<In, InFragment>, data: InFragment, request: PipelineStepData<In>): Promise<boolean>;
     protected doPerform(data: InFragment, request: PipelineStepData<In>): Promise<OutFragment>;
     perform(request: PipelineStepData<In>): Promise<PipelineStepData<Out>>;
-    protected isInFragmentIgnored(): boolean;
     protected getInFragmentVariableName(): string;
+    protected getRequestVariableName(): string;
 }

package/lib/step/snippet-step.d.ts

@@ -1,19 +1,17 @@
 import { PipelineStepData, PipelineStepHelpers, PipelineStepPayload } from '@rainbow-o23/n1';
 import { AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions } from './abstract-fragmentary-pipeline-step';
 import { ScriptFuncOrBody } from './types';
-export type PerformWithInFragment<InFragment, OutFragment> = ($factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type PerformWithoutInFragment<OutFragment> = ($helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type PerformFunc<InFragment, OutFragment> = PerformWithInFragment<InFragment, OutFragment> | PerformWithoutInFragment<OutFragment>;
+export type PerformFunc<In, InFragment, OutFragment> = ($factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
 export interface SnippetPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
-    snippet: ScriptFuncOrBody<PerformFunc<InFragment, OutFragment>>;
+    snippet: ScriptFuncOrBody<PerformFunc<In, InFragment, OutFragment>>;
 }
 export declare class SnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends AbstractFragmentaryPipelineStep<In, Out, InFragment, OutFragment> {
     private readonly _snippet;
     private readonly _func;
     constructor(options: SnippetPipelineStepOptions<In, Out, InFragment, OutFragment>);
-    getSnippet(): ScriptFuncOrBody<PerformFunc<InFragment, OutFragment>>;
+    getSnippet(): ScriptFuncOrBody<PerformFunc<In, InFragment, OutFragment>>;
     protected generateVariableNames(): Array<string>;
-    protected doPerform(data: InFragment, _request: PipelineStepData<In>): Promise<OutFragment>;
-    protected isInFragmentIgnored(): boolean;
+    protected doPerform(data: InFragment, request: PipelineStepData<In>): Promise<OutFragment>;
     protected getInFragmentVariableName(): string;
+    protected getRequestVariableName(): string;
 }

package/lib/typeorm-step/typeorm-by-snippet-step.d.ts

@@ -2,20 +2,18 @@ import { PipelineStepData, PipelineStepHelpers, PipelineStepPayload } from '@rai
 import { QueryRunner } from 'typeorm';
 import { ScriptFuncOrBody } from '../step';
 import { AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions } from './abstract-typeorm-step';
-export type TypeOrmPerformWithInFragment<InFragment, OutFragment> = ($runner: QueryRunner, $factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type TypeOrmPerformWithoutInFragment<OutFragment> = ($runner: QueryRunner, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type TypeOrmPerformFunc<InFragment, OutFragment> = TypeOrmPerformWithInFragment<InFragment, OutFragment> | TypeOrmPerformWithoutInFragment<OutFragment>;
+export type TypeOrmPerformFunc<In, InFragment, OutFragment> = ($runner: QueryRunner, $factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
 export interface TypeOrmBySnippetPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-    snippet: ScriptFuncOrBody<TypeOrmPerformFunc<InFragment, OutFragment>>;
+    snippet: ScriptFuncOrBody<TypeOrmPerformFunc<In, InFragment, OutFragment>>;
 }
 export declare class TypeOrmBySnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends AbstractTypeOrmPipelineStep<In, Out, InFragment, OutFragment> {
     private readonly _snippet;
     private readonly _func;
     constructor(options: TypeOrmBySnippetPipelineStepOptions<In, Out, InFragment, OutFragment>);
-    getSnippet(): ScriptFuncOrBody<TypeOrmPerformFunc<InFragment, OutFragment>>;
+    getSnippet(): ScriptFuncOrBody<TypeOrmPerformFunc<In, InFragment, OutFragment>>;
     protected generateVariableNames(): Array<string>;
     protected doPerform(basis: InFragment, request: PipelineStepData<In>): Promise<OutFragment>;
-    protected isInFragmentIgnored(): boolean;
     protected getRunnerVariableName(): string;
     protected getInFragmentVariableName(): string;
+    protected getRequestVariableName(): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rainbow-o23/n3",
-	"version": "0.1.13",
+	"version": "0.1.15",
 	"description": "o23 pipelines",
 	"main": "index.cjs",
 	"module": "index.js",
@@ -15,12 +15,13 @@
 		"type": "git",
 		"url": "git+https://github.com/InsureMO/rainbow-o23.git"
 	},
+	"author": "Rainbow Team",
 	"license": "MIT",
 	"bugs": {
 		"url": "https://github.com/InsureMO/rainbow-o23/issues"
 	},
 	"dependencies": {
-		"@rainbow-o23/n1": "0.1.13",
+		"@rainbow-o23/n1": "0.1.15",
 		"@theinternetfolks/snowflake": "^1.3.0",
 		"node-fetch": "2.6.1",
 		"typeorm": "^0.3.17"

package/src/lib/step/conditional-step-sets.ts

@@ -11,16 +11,11 @@ import {PipelineStepSets, PipelineStepSetsOptions} from './step-sets';
 import {ScriptFuncOrBody} from './types';
 import {Utils} from './utils';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type ConditionCheckWithInFragment<InFragment> = ($factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type ConditionCheckWithoutInFragment = ($helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
-export type ConditionCheckFunc<InFragment> =
-	ConditionCheckWithInFragment<InFragment> | ConditionCheckWithoutInFragment;
+export type ConditionCheckFunc<In, InFragment> = ($factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<boolean>;
 
 export interface ConditionalPipelineStepSetsOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends PipelineStepSetsOptions<In, Out, InFragment, OutFragment> {
-	check: ScriptFuncOrBody<ConditionCheckFunc<InFragment>>;
+	check: ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>;
 	otherwiseSteps: Array<PipelineStepBuilder>;
 }
 
@@ -29,8 +24,8 @@ export interface ConditionalPipelineStepSetsOptions<In = PipelineStepPayload, Ou
  */
 export class ConditionalPipelineStepSets<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends PipelineStepSets<In, Out, InFragment, OutFragment> {
-	private readonly _checkSnippet: ScriptFuncOrBody<ConditionCheckFunc<InFragment>>;
-	private readonly _func: ConditionCheckFunc<InFragment>;
+	private readonly _checkSnippet: ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>;
+	private readonly _func: ConditionCheckFunc<In, InFragment>;
 	private readonly _otherwiseStepBuilders: Undefinable<Array<PipelineStepBuilder>>;
 
 	// noinspection TypeScriptAbstractClassConstructorCanBeMadeProtected
@@ -50,7 +45,7 @@ export class ConditionalPipelineStepSets<In = PipelineStepPayload, Out = Pipelin
 		this._otherwiseStepBuilders = options.otherwiseSteps;
 	}
 
-	public getCheckSnippet(): ScriptFuncOrBody<ConditionCheckFunc<InFragment>> {
+	public getCheckSnippet(): ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>> {
 		return this._checkSnippet;
 	}
 
@@ -59,20 +54,12 @@ export class ConditionalPipelineStepSets<In = PipelineStepPayload, Out = Pipelin
 	}
 
 	protected generateVariableNames(): Array<string> {
-		return [
-			this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-			...this.getHelpersVariableNames()
-		].filter(x => x != null);
+		return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
 	}
 
-	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	protected async check(data: InFragment, _request: PipelineStepData<In>): Promise<boolean> {
+	protected async check(data: InFragment, request: PipelineStepData<In>): Promise<boolean> {
 		const $helpers = this.getHelpers();
-		if (this.isInFragmentIgnored()) {
-			return await (this._func as ConditionCheckWithoutInFragment)($helpers, $helpers);
-		} else {
-			return await (this._func as ConditionCheckWithInFragment<InFragment>)(data, $helpers, $helpers);
-		}
+		return await this._func(data, request, $helpers, $helpers);
 	}
 
 	public async perform(request: PipelineStepData<In>): Promise<PipelineStepData<Out>> {
@@ -98,18 +85,14 @@ export class ConditionalPipelineStepSets<In = PipelineStepPayload, Out = Pipelin
 		});
 	}
 
-	/**
-	 * is request step data ignored to snippet function.
-	 * default returns false
-	 */
-	protected isInFragmentIgnored(): boolean {
-		return false;
-	}
-
 	/**
 	 * override this method when want to use another variable name rather than "$factor"
 	 */
 	protected getInFragmentVariableName(): string {
 		return '$factor';
 	}
+
+	protected getRequestVariableName(): string {
+		return '$request';
+	}
 }

package/src/lib/step/routes-step-sets.ts

@@ -8,28 +8,24 @@ import {
 } from '@rainbow-o23/n1';
 import {ERR_PIPELINE_STEP_CONDITIONAL_SNIPPET_NOT_EMPTY, ERR_PIPELINE_STEP_METHOD_NOT_SUPPORTED} from '../error-codes';
 import {AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions} from './abstract-fragmentary-pipeline-step';
-import {
-	ConditionCheckFunc,
-	ConditionCheckWithInFragment,
-	ConditionCheckWithoutInFragment
-} from './conditional-step-sets';
+import {ConditionCheckFunc} from './conditional-step-sets';
 import {PipelineStepSets} from './step-sets';
 import {ScriptFuncOrBody} from './types';
 import {Utils} from './utils';
 
-export interface RoutesConditionalStepOptions<InFragment> {
-	check: ScriptFuncOrBody<ConditionCheckFunc<InFragment>>,
+export interface RoutesConditionalStepOptions<In, InFragment> {
+	check: ScriptFuncOrBody<ConditionCheckFunc<In, InFragment>>,
 	steps?: Array<PipelineStepBuilder>;
 }
 
 export interface RoutesPipelineStepSetsOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
-	conditionalSteps: Array<RoutesConditionalStepOptions<InFragment>>;
+	conditionalSteps: Array<RoutesConditionalStepOptions<In, InFragment>>;
 	otherwiseSteps?: Array<PipelineStepBuilder>;
 }
 
-export interface RoutesConditionalStep<InFragment> {
-	check: ConditionCheckFunc<InFragment>;
+export interface RoutesConditionalStep<In, InFragment> {
+	check: ConditionCheckFunc<In, InFragment>;
 	steps: Array<PipelineStepBuilder>;
 }
 
@@ -38,7 +34,7 @@ export interface RoutesConditionalStep<InFragment> {
  */
 export class RoutesPipelineStepSets<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends AbstractFragmentaryPipelineStep<In, Out, InFragment, OutFragment> {
-	private readonly _conditionalStepBuilders: Array<RoutesConditionalStep<InFragment>>;
+	private readonly _conditionalStepBuilders: Array<RoutesConditionalStep<In, InFragment>>;
 	private readonly _otherwiseStepBuilders: Undefinable<Array<PipelineStepBuilder>>;
 
 	constructor(options: RoutesPipelineStepSetsOptions<In, Out, InFragment, OutFragment>) {
@@ -61,7 +57,7 @@ export class RoutesPipelineStepSets<In = PipelineStepPayload, Out = PipelineStep
 		this._otherwiseStepBuilders = options.otherwiseSteps;
 	}
 
-	protected getConditionalStepBuilders(): Array<RoutesConditionalStep<InFragment>> {
+	protected getConditionalStepBuilders(): Array<RoutesConditionalStep<In, InFragment>> {
 		return this._conditionalStepBuilders;
 	}
 
@@ -74,20 +70,12 @@ export class RoutesPipelineStepSets<In = PipelineStepPayload, Out = PipelineStep
 	}
 
 	protected generateVariableNames(): Array<string> {
-		return [
-			this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-			...this.getHelpersVariableNames()
-		].filter(x => x != null);
+		return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
 	}
 
-	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	protected async check(func: ConditionCheckFunc<InFragment>, data: InFragment, _request: PipelineStepData<In>): Promise<boolean> {
+	protected async check(func: ConditionCheckFunc<In, InFragment>, data: InFragment, request: PipelineStepData<In>): Promise<boolean> {
 		const $helpers = this.getHelpers();
-		if (this.isInFragmentIgnored()) {
-			return await (func as ConditionCheckWithoutInFragment)($helpers, $helpers);
-		} else {
-			return await (func as ConditionCheckWithInFragment<InFragment>)(data, $helpers, $helpers);
-		}
+		return await func(data, request, $helpers, $helpers);
 	}
 
 	/**
@@ -130,18 +118,14 @@ export class RoutesPipelineStepSets<In = PipelineStepPayload, Out = PipelineStep
 		});
 	}
 
-	/**
-	 * is request step data ignored to snippet function.
-	 * default returns false
-	 */
-	protected isInFragmentIgnored(): boolean {
-		return false;
-	}
-
 	/**
 	 * override this method when want to use another variable name rather than "$factor"
 	 */
 	protected getInFragmentVariableName(): string {
 		return '$factor';
 	}
+
+	protected getRequestVariableName(): string {
+		return '$request';
+	}
 }

package/src/lib/step/snippet-step.ts

@@ -4,16 +4,12 @@ import {AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions} from '.
 import {ScriptFuncOrBody} from './types';
 import {Utils} from './utils';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type PerformWithInFragment<InFragment, OutFragment> = ($factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type PerformWithoutInFragment<OutFragment> = ($helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type PerformFunc<InFragment, OutFragment> =
-	PerformWithInFragment<InFragment, OutFragment> | PerformWithoutInFragment<OutFragment>;
+export type PerformFunc<In, InFragment, OutFragment> =
+	($factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
 
 export interface SnippetPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
-	snippet: ScriptFuncOrBody<PerformFunc<InFragment, OutFragment>>;
+	snippet: ScriptFuncOrBody<PerformFunc<In, InFragment, OutFragment>>;
 }
 
 /**
@@ -24,8 +20,8 @@ export interface SnippetPipelineStepOptions<In = PipelineStepPayload, Out = Pipe
  */
 export class SnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends AbstractFragmentaryPipelineStep<In, Out, InFragment, OutFragment> {
-	private readonly _snippet: ScriptFuncOrBody<PerformFunc<InFragment, OutFragment>>;
-	private readonly _func: PerformFunc<InFragment, OutFragment>;
+	private readonly _snippet: ScriptFuncOrBody<PerformFunc<In, InFragment, OutFragment>>;
+	private readonly _func: PerformFunc<In, InFragment, OutFragment>;
 
 	public constructor(options: SnippetPipelineStepOptions<In, Out, InFragment, OutFragment>) {
 		super(options);
@@ -42,33 +38,17 @@ export class SnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPay
 		});
 	}
 
-	public getSnippet(): ScriptFuncOrBody<PerformFunc<InFragment, OutFragment>> {
+	public getSnippet(): ScriptFuncOrBody<PerformFunc<In, InFragment, OutFragment>> {
 		return this._snippet;
 	}
 
 	protected generateVariableNames(): Array<string> {
-		return [
-			this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
-			...this.getHelpersVariableNames()
-		].filter(x => x != null);
+		return [this.getInFragmentVariableName(), this.getRequestVariableName(), ...this.getHelpersVariableNames()];
 	}
 
-	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	protected async doPerform(data: InFragment, _request: PipelineStepData<In>): Promise<OutFragment> {
+	protected async doPerform(data: InFragment, request: PipelineStepData<In>): Promise<OutFragment> {
 		const $helpers = this.getHelpers();
-		if (this.isInFragmentIgnored()) {
-			return await (this._func as PerformWithoutInFragment<OutFragment>)($helpers, $helpers);
-		} else {
-			return await (this._func as PerformWithInFragment<InFragment, OutFragment>)(data, $helpers, $helpers);
-		}
-	}
-
-	/**
-	 * is request step data ignored to snippet function.
-	 * default returns false
-	 */
-	protected isInFragmentIgnored(): boolean {
-		return false;
+		return await this._func(data, request, $helpers, $helpers);
 	}
 
 	/**
@@ -77,4 +57,8 @@ export class SnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPay
 	protected getInFragmentVariableName(): string {
 		return '$factor';
 	}
+
+	protected getRequestVariableName(): string {
+		return '$request';
+	}
 }

package/src/lib/typeorm-step/abstract-typeorm-by-sql-step.ts

@@ -536,7 +536,7 @@ export abstract class AbstractTypeOrmBySQLPipelineStep<In = PipelineStepPayload,
 						// eslint-disable-next-line no-prototype-builtins
 						if (result.hasOwnProperty('rows')) {
 							// for SELECT
-							return result.rows;
+							return (result.rows ?? []).map(item => this.beautify({data: item, datasourceType}));
 						} else {
 							// INSERT, an empty array
 							return result;
@@ -550,7 +550,7 @@ export abstract class AbstractTypeOrmBySQLPipelineStep<In = PipelineStepPayload,
 					return this.beautify({data: result, datasourceType});
 				}
 			default:
-				return result;
+				return this.beautify({data: result, datasourceType});
 		}
 	}
 }

package/src/lib/typeorm-step/typeorm-by-snippet-step.ts

@@ -4,16 +4,11 @@ import {ERR_TYPEORM_STEP_SNIPPET_NOT_EMPTY} from '../error-codes';
 import {ScriptFuncOrBody, Utils} from '../step';
 import {AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions} from './abstract-typeorm-step';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type TypeOrmPerformWithInFragment<InFragment, OutFragment> = ($runner: QueryRunner, $factor: InFragment, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type TypeOrmPerformWithoutInFragment<OutFragment> = ($runner: QueryRunner, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
-export type TypeOrmPerformFunc<InFragment, OutFragment> =
-	TypeOrmPerformWithInFragment<InFragment, OutFragment> | TypeOrmPerformWithoutInFragment<OutFragment>;
+export type TypeOrmPerformFunc<In, InFragment, OutFragment> = ($runner: QueryRunner, $factor: InFragment, $request: PipelineStepData<In>, $helpers: PipelineStepHelpers, $: PipelineStepHelpers) => Promise<OutFragment>;
 
 export interface TypeOrmBySnippetPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-	snippet: ScriptFuncOrBody<TypeOrmPerformFunc<InFragment, OutFragment>>;
+	snippet: ScriptFuncOrBody<TypeOrmPerformFunc<In, InFragment, OutFragment>>;
 }
 
 /**
@@ -21,8 +16,8 @@ export interface TypeOrmBySnippetPipelineStepOptions<In = PipelineStepPayload, O
  */
 export class TypeOrmBySnippetPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
 	extends AbstractTypeOrmPipelineStep<In, Out, InFragment, OutFragment> {
-	private readonly _snippet: ScriptFuncOrBody<TypeOrmPerformFunc<InFragment, OutFragment>>;
-	private readonly _func: TypeOrmPerformFunc<InFragment, OutFragment>;
+	private readonly _snippet: ScriptFuncOrBody<TypeOrmPerformFunc<In, InFragment, OutFragment>>;
+	private readonly _func: TypeOrmPerformFunc<In, InFragment, OutFragment>;
 
 	public constructor(options: TypeOrmBySnippetPipelineStepOptions<In, Out, InFragment, OutFragment>) {
 		super(options);
@@ -39,37 +34,26 @@ export class TypeOrmBySnippetPipelineStep<In = PipelineStepPayload, Out = Pipeli
 		});
 	}
 
-	public getSnippet(): ScriptFuncOrBody<TypeOrmPerformFunc<InFragment, OutFragment>> {
+	public getSnippet(): ScriptFuncOrBody<TypeOrmPerformFunc<In, InFragment, OutFragment>> {
 		return this._snippet;
 	}
 
 	protected generateVariableNames(): Array<string> {
 		return [
 			this.getRunnerVariableName(),
-			this.isInFragmentIgnored() ? null : this.getInFragmentVariableName(),
+			this.getInFragmentVariableName(),
+			this.getRequestVariableName(),
 			...this.getHelpersVariableNames()
-		].filter(x => x != null);
+		];
 	}
 
 	protected async doPerform(basis: InFragment, request: PipelineStepData<In>): Promise<OutFragment> {
 		return await this.autoTrans<OutFragment>(async (runner) => {
 			const $helpers = this.getHelpers();
-			if (this.isInFragmentIgnored()) {
-				return await (this._func as TypeOrmPerformWithoutInFragment<OutFragment>)(runner, $helpers, $helpers);
-			} else {
-				return await (this._func as TypeOrmPerformWithInFragment<InFragment, OutFragment>)(runner, basis, $helpers, $helpers);
-			}
+			return await this._func(runner, basis, request, $helpers, $helpers);
 		}, request);
 	}
 
-	/**
-	 * is request step data ignored to snippet function.
-	 * default returns false
-	 */
-	protected isInFragmentIgnored(): boolean {
-		return false;
-	}
-
 	protected getRunnerVariableName(): string {
 		return '$runner';
 	}
@@ -80,4 +64,8 @@ export class TypeOrmBySnippetPipelineStep<In = PipelineStepPayload, Out = Pipeli
 	protected getInFragmentVariableName(): string {
 		return '$factor';
 	}
+
+	protected getRequestVariableName(): string {
+		return '$request';
+	}
 }