@rainbow-o23/n3 1.0.40 → 1.0.42

package/README.md

@@ -386,7 +386,7 @@ Autonomous transactions take precedence over the transaction name, meaning that
 specified by the transaction name will be ignored. If you need to use the transaction name, you must nest the pipeline steps within
 transactional step sets, and ensure that the datasource name and transaction name remain the same.
 
-### By Entity
+### By Entity (Deprecated, not recommended)
 
 #### Load Entity by ID
 
@@ -602,18 +602,18 @@ CFG_ENDPOINTS_ORDER_PAYMENT_URL=https://order.com/payment
 
 #### Constructor Parameters
 
-| Name                 | Type                                                       | Default Value | Comments                                                                                                             |
-|----------------------|------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------|
-| endpointSystemCode   | string                                                     |               | Endpoint system code.                                                                                                |
-| endpointName         | string                                                     |               | Endpoint name.                                                                                                       |
-| urlGenerate          | ScriptFuncOrBody\<HttpGenerateUrl>                         |               | Endpoint url generator, `$endpointUrl`.                                                                              |
-| method               | string                                                     |               | Http method, default `post`.                                                                                         |
-| timeout              | number                                                     |               | Endpoint timeout, in seconds.                                                                                        |
-| headersGenerate      | ScriptFuncOrBody\<HttpGenerateHeaders>                     |               | Endpoint request headers generator.                                                                                  |
-| bodyUsed             | boolean                                                    |               | Send request with body or not, or automatically disregards the body when sending a `get` request when not specified. |
-| bodyGenerate         | ScriptFuncOrBody\<HttpGenerateBody>                        |               | Endpoint request body generator.                                                                                     |
-| responseGenerate     | ScriptFuncOrBody\<HttpGenerateResponse>                    |               | Endpoint response body generator, `$response`.                                                                       |
-| responseErrorHandles | {[key: HttpErrorCode]: ScriptFuncOrBody\<HttpHandleError>} |               | Endpoint response error handlers.                                                                                    |
+| Name                 | Type                                                                                                   | Default Value | Comments                                                                                                             |
+|----------------------|--------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------|
+| endpointSystemCode   | string                                                                                                 |               | Endpoint system code.                                                                                                |
+| endpointName         | string                                                                                                 |               | Endpoint name.                                                                                                       |
+| urlGenerate          | ScriptFuncOrBody\<HttpGenerateUrl>                                                                     |               | Endpoint url generator, `$endpointUrl`.                                                                              |
+| method               | string                                                                                                 |               | Http method, default `post`.                                                                                         |
+| timeout              | number                                                                                                 |               | Endpoint timeout, in seconds.                                                                                        |
+| headersGenerate      | ScriptFuncOrBody\<HttpGenerateHeaders>                                                                 |               | Endpoint request headers generator.                                                                                  |
+| bodyUsed             | boolean                                                                                                |               | Send request with body or not, or automatically disregards the body when sending a `get` request when not specified. |
+| bodyGenerate         | ScriptFuncOrBody\<HttpGenerateBody>                                                                    |               | Endpoint request body generator.                                                                                     |
+| responseGenerate     | ScriptFuncOrBody\<HttpGenerateResponse>                                                                |               | Endpoint response body generator, `$response`.                                                                       |
+| responseErrorHandles | ScriptFuncOrBody\<HttpHandleError><br>or<br>{[key: HttpErrorCode]: ScriptFuncOrBody\<HttpHandleError>} |               | Endpoint response error handlers.                                                                                    |
 
 ## Installation
 

package/index.cjs

@@ -1297,12 +1297,21 @@ class FetchPipelineStep extends AbstractFragmentaryPipelineStep {
                 throw e;
             }
         });
-        if (options.responseErrorHandles) {
-            const defaultHandler = async (options, _$helpers, _$) => {
-                throw new n1.UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
-            };
-            const createDefaultHandler = () => defaultHandler;
-            const getVariableNames = () => this.getErrorHandlerVariableName();
+        const defaultHandler = async (options, _$helpers, _$) => {
+            throw new n1.UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
+        };
+        const createDefaultHandler = () => defaultHandler;
+        const getVariableNames = () => this.getErrorHandlerVariableName();
+        if (typeof options.responseErrorHandles === 'string' || typeof options.responseErrorHandles === 'function') {
+            this._responseErrorHandleFunc = Utils.createAsyncFunction(options.responseErrorHandles, {
+                createDefault: createDefaultHandler, getVariableNames,
+                error: (e) => {
+                    this.getLogger().error(`Failed on create function for response error handler, snippet is [${options.responseErrorHandles}].`);
+                    throw e;
+                }
+            });
+        }
+        else if (options.responseErrorHandles != null) {
             const handlers = Object.keys(options.responseErrorHandles).reduce((handlers, status) => {
                 handlers[status] = Utils.createAsyncFunction(options.responseErrorHandles[status], {
                     createDefault: createDefaultHandler, getVariableNames,
@@ -1609,99 +1618,6 @@ class AbstractTypeOrmPipelineStep extends AbstractFragmentaryPipelineStep {
             }
         }
     }
-    async findMetadata(name, request) {
-        const runner = await this.createRunner(request);
-        const dataSource = runner.connection;
-        const metadata = (dataSource.entityMetadatas || []).find(metadata => metadata.name == name);
-        if (metadata == null) {
-            throw new n1.UncatchableError(ERR_TYPEORM_ENTITY_NOT_FOUND, `Entity[${name}] in data source[${this.getDataSourceName()}] not found.`);
-        }
-        const column = metadata.columns.find(column => column.isPrimary);
-        const repository = runner.manager.getRepository(metadata.target);
-        return [metadata, column, repository, dataSource];
-    }
-}
-
-class TypeOrmLoadEntityByIdPipelineStep extends AbstractTypeOrmPipelineStep {
-    _entityName;
-    constructor(options) {
-        super(options);
-        this._entityName = options.entityName;
-    }
-    getEntityName() {
-        return this._entityName;
-    }
-    async doPerform(id, request) {
-        const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-        const loaded = await repository.findOneBy({ [column.propertyName]: id });
-        if (loaded == null) {
-            return (void 0);
-        }
-        else {
-            return loaded;
-        }
-    }
-}
-
-class TypeOrmSaveEntityPipelineStep extends AbstractTypeOrmPipelineStep {
-    _entityName;
-    _fillIdBySnowflake;
-    _snowflakeShardId;
-    _uniquenessCheckSnippet;
-    _uniquenessCheckFunc;
-    constructor(options) {
-        super(options);
-        const config = this.getConfig();
-        this._entityName = options.entityName;
-        this._fillIdBySnowflake = options.fillIdBySnowflake ?? false;
-        this._snowflakeShardId = config.getNumber(`snowflake.shard.id`);
-        this._uniquenessCheckSnippet = options.uniquenessCheckSnippet;
-        this._uniquenessCheckFunc = Utils.createSyncFunction(this.getUniquenessCheckSnippet(), {
-            createDefault: () => (void 0),
-            getVariableNames: () => this.generateUniquenessCheckVariableNames(),
-            error: (e) => {
-                this.getLogger().error(`Failed on create function for uniqueness check, snippet is [${this.getUniquenessCheckSnippet()}].`);
-                throw e;
-            }
-        });
-    }
-    getEntityName() {
-        return this._entityName;
-    }
-    isFillIdBySnowflake() {
-        return this._fillIdBySnowflake;
-    }
-    getUniquenessCheckSnippet() {
-        return this._uniquenessCheckSnippet;
-    }
-    needUniquenessCheck() {
-        return this._uniquenessCheckFunc != null;
-    }
-    generateUniquenessCheckVariableNames() {
-        return ['given', 'existing'];
-    }
-    async doPerform(entity, request) {
-        const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-        if (this.needUniquenessCheck()) {
-            const id = entity[column.propertyName];
-            if (`${id ?? ''}`.trim().length !== 0) {
-                const existing = await repository.findOneBy({ [column.propertyName]: id });
-                if (existing != null) {
-                    const checked = this._uniquenessCheckFunc(entity, existing);
-                    if (checked.pass !== true) {
-                        throw new n1.CatchableError(checked.code, checked.message);
-                    }
-                }
-            }
-        }
-        if (this.isFillIdBySnowflake()) {
-            const id = entity[column.propertyName];
-            if (id == null || `${id ?? ''}`.trim().length === 0) {
-                entity[column.propertyName] = Snowflake.generate({ shardId: this._snowflakeShardId });
-            }
-        }
-        return await repository.save(entity);
-    }
 }
 
 class TypeOrmBySnippetPipelineStep extends AbstractTypeOrmPipelineStep {
@@ -2416,11 +2332,9 @@ exports.TypeOrmBulkSaveBySQLPipelineStep = TypeOrmBulkSaveBySQLPipelineStep;
 exports.TypeOrmBySnippetPipelineStep = TypeOrmBySnippetPipelineStep;
 exports.TypeOrmDataSourceHelper = TypeOrmDataSourceHelper;
 exports.TypeOrmDataSourceManager = TypeOrmDataSourceManager;
-exports.TypeOrmLoadEntityByIdPipelineStep = TypeOrmLoadEntityByIdPipelineStep;
 exports.TypeOrmLoadManyBySQLPipelineStep = TypeOrmLoadManyBySQLPipelineStep;
 exports.TypeOrmLoadOneBySQLPipelineStep = TypeOrmLoadOneBySQLPipelineStep;
 exports.TypeOrmParsedSQLCache = TypeOrmParsedSQLCache;
 exports.TypeOrmSaveBySQLPipelineStep = TypeOrmSaveBySQLPipelineStep;
-exports.TypeOrmSaveEntityPipelineStep = TypeOrmSaveEntityPipelineStep;
 exports.TypeOrmTransactionalPipelineStepSets = TypeOrmTransactionalPipelineStepSets;
 exports.Utils = Utils;

package/index.js

@@ -1295,12 +1295,21 @@ class FetchPipelineStep extends AbstractFragmentaryPipelineStep {
                 throw e;
             }
         });
-        if (options.responseErrorHandles) {
-            const defaultHandler = async (options, _$helpers, _$) => {
-                throw new UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
-            };
-            const createDefaultHandler = () => defaultHandler;
-            const getVariableNames = () => this.getErrorHandlerVariableName();
+        const defaultHandler = async (options, _$helpers, _$) => {
+            throw new UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
+        };
+        const createDefaultHandler = () => defaultHandler;
+        const getVariableNames = () => this.getErrorHandlerVariableName();
+        if (typeof options.responseErrorHandles === 'string' || typeof options.responseErrorHandles === 'function') {
+            this._responseErrorHandleFunc = Utils.createAsyncFunction(options.responseErrorHandles, {
+                createDefault: createDefaultHandler, getVariableNames,
+                error: (e) => {
+                    this.getLogger().error(`Failed on create function for response error handler, snippet is [${options.responseErrorHandles}].`);
+                    throw e;
+                }
+            });
+        }
+        else if (options.responseErrorHandles != null) {
             const handlers = Object.keys(options.responseErrorHandles).reduce((handlers, status) => {
                 handlers[status] = Utils.createAsyncFunction(options.responseErrorHandles[status], {
                     createDefault: createDefaultHandler, getVariableNames,
@@ -1607,99 +1616,6 @@ class AbstractTypeOrmPipelineStep extends AbstractFragmentaryPipelineStep {
             }
         }
     }
-    async findMetadata(name, request) {
-        const runner = await this.createRunner(request);
-        const dataSource = runner.connection;
-        const metadata = (dataSource.entityMetadatas || []).find(metadata => metadata.name == name);
-        if (metadata == null) {
-            throw new UncatchableError(ERR_TYPEORM_ENTITY_NOT_FOUND, `Entity[${name}] in data source[${this.getDataSourceName()}] not found.`);
-        }
-        const column = metadata.columns.find(column => column.isPrimary);
-        const repository = runner.manager.getRepository(metadata.target);
-        return [metadata, column, repository, dataSource];
-    }
-}
-
-class TypeOrmLoadEntityByIdPipelineStep extends AbstractTypeOrmPipelineStep {
-    _entityName;
-    constructor(options) {
-        super(options);
-        this._entityName = options.entityName;
-    }
-    getEntityName() {
-        return this._entityName;
-    }
-    async doPerform(id, request) {
-        const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-        const loaded = await repository.findOneBy({ [column.propertyName]: id });
-        if (loaded == null) {
-            return (void 0);
-        }
-        else {
-            return loaded;
-        }
-    }
-}
-
-class TypeOrmSaveEntityPipelineStep extends AbstractTypeOrmPipelineStep {
-    _entityName;
-    _fillIdBySnowflake;
-    _snowflakeShardId;
-    _uniquenessCheckSnippet;
-    _uniquenessCheckFunc;
-    constructor(options) {
-        super(options);
-        const config = this.getConfig();
-        this._entityName = options.entityName;
-        this._fillIdBySnowflake = options.fillIdBySnowflake ?? false;
-        this._snowflakeShardId = config.getNumber(`snowflake.shard.id`);
-        this._uniquenessCheckSnippet = options.uniquenessCheckSnippet;
-        this._uniquenessCheckFunc = Utils.createSyncFunction(this.getUniquenessCheckSnippet(), {
-            createDefault: () => (void 0),
-            getVariableNames: () => this.generateUniquenessCheckVariableNames(),
-            error: (e) => {
-                this.getLogger().error(`Failed on create function for uniqueness check, snippet is [${this.getUniquenessCheckSnippet()}].`);
-                throw e;
-            }
-        });
-    }
-    getEntityName() {
-        return this._entityName;
-    }
-    isFillIdBySnowflake() {
-        return this._fillIdBySnowflake;
-    }
-    getUniquenessCheckSnippet() {
-        return this._uniquenessCheckSnippet;
-    }
-    needUniquenessCheck() {
-        return this._uniquenessCheckFunc != null;
-    }
-    generateUniquenessCheckVariableNames() {
-        return ['given', 'existing'];
-    }
-    async doPerform(entity, request) {
-        const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-        if (this.needUniquenessCheck()) {
-            const id = entity[column.propertyName];
-            if (`${id ?? ''}`.trim().length !== 0) {
-                const existing = await repository.findOneBy({ [column.propertyName]: id });
-                if (existing != null) {
-                    const checked = this._uniquenessCheckFunc(entity, existing);
-                    if (checked.pass !== true) {
-                        throw new CatchableError(checked.code, checked.message);
-                    }
-                }
-            }
-        }
-        if (this.isFillIdBySnowflake()) {
-            const id = entity[column.propertyName];
-            if (id == null || `${id ?? ''}`.trim().length === 0) {
-                entity[column.propertyName] = Snowflake.generate({ shardId: this._snowflakeShardId });
-            }
-        }
-        return await repository.save(entity);
-    }
 }
 
 class TypeOrmBySnippetPipelineStep extends AbstractTypeOrmPipelineStep {
@@ -2364,4 +2280,4 @@ class TypeOrmTransactionalPipelineStepSets extends PipelineStepSets {
     }
 }
 
-export { AbstractFragmentaryPipelineStep, AbstractTypeOrmBySQLPipelineStep, AbstractTypeOrmDataSource, AbstractTypeOrmLoadBySQLPipelineStep, AbstractTypeOrmPipelineStep, AsyncPipelineStepSets, BetterSqlite3TypeOrmDatasource, ConditionalPipelineStepSets, DEFAULT_TRANSACTION_NAME, DeletePropertyPipelineStep, ERR_EACH_FRAGMENT_NOT_ANY_ARRAY, ERR_FETCH_ERROR, ERR_PIPELINE_REF_NOT_EMPTY, ERR_PIPELINE_REF_NOT_FOUND, ERR_PIPELINE_SNIPPET_CANNOT_USE_EVAL, ERR_PIPELINE_SNIPPET_CANNOT_USE_FUNCTION, ERR_PIPELINE_SNIPPET_CANNOT_USE_GLOBAL, ERR_PIPELINE_SNIPPET_CANNOT_USE_PROCESS, ERR_PIPELINE_STEP_CONDITIONAL_SNIPPET_NOT_EMPTY, ERR_PIPELINE_STEP_METHOD_NOT_SUPPORTED, ERR_PIPELINE_STEP_REF_NOT_EMPTY, ERR_PIPELINE_STEP_REF_NOT_FOUND, ERR_PIPELINE_STEP_SNIPPET_NOT_EMPTY, ERR_TYPEORM_DATASOURCE_CREATOR_NOT_FOUND, ERR_TYPEORM_DATASOURCE_NOT_FOUND, ERR_TYPEORM_DATASOURCE_TYPE_NOT_FOUND, ERR_TYPEORM_ENTITY_NOT_FOUND, ERR_TYPEORM_SQL_NOT_EMPTY, ERR_TYPEORM_STEP_SNIPPET_NOT_EMPTY, ERR_TYPEORM_TRANSACTION_NOT_FOUND, EachPipelineStepSets, FetchPipelineStep, GetPropertyPipelineStep, HttpAbortErrorCode, HttpUnknownErrorCode, MssqlTypeOrmDatasource, MysqlTypeOrmDatasource, OracleTypeOrmDatasource, ParallelPipelineStepSets, ParsedSqlSegmentType, PgsqlTypeOrmDatasource, PipelineStepSets, RefPipelinePipelineStep, RefStepPipelineStep, RoutesPipelineStepSets, SnippetPipelineStep, SnowflakePipelineStep, SupportedDataSourceTypes, TypeOrmBulkSaveBySQLPipelineStep, TypeOrmBySnippetPipelineStep, TypeOrmDataSourceHelper, TypeOrmDataSourceManager, TypeOrmLoadEntityByIdPipelineStep, TypeOrmLoadManyBySQLPipelineStep, TypeOrmLoadOneBySQLPipelineStep, TypeOrmParsedSQLCache, TypeOrmSaveBySQLPipelineStep, TypeOrmSaveEntityPipelineStep, TypeOrmTransactionalPipelineStepSets, Utils };
+export { AbstractFragmentaryPipelineStep, AbstractTypeOrmBySQLPipelineStep, AbstractTypeOrmDataSource, AbstractTypeOrmLoadBySQLPipelineStep, AbstractTypeOrmPipelineStep, AsyncPipelineStepSets, BetterSqlite3TypeOrmDatasource, ConditionalPipelineStepSets, DEFAULT_TRANSACTION_NAME, DeletePropertyPipelineStep, ERR_EACH_FRAGMENT_NOT_ANY_ARRAY, ERR_FETCH_ERROR, ERR_PIPELINE_REF_NOT_EMPTY, ERR_PIPELINE_REF_NOT_FOUND, ERR_PIPELINE_SNIPPET_CANNOT_USE_EVAL, ERR_PIPELINE_SNIPPET_CANNOT_USE_FUNCTION, ERR_PIPELINE_SNIPPET_CANNOT_USE_GLOBAL, ERR_PIPELINE_SNIPPET_CANNOT_USE_PROCESS, ERR_PIPELINE_STEP_CONDITIONAL_SNIPPET_NOT_EMPTY, ERR_PIPELINE_STEP_METHOD_NOT_SUPPORTED, ERR_PIPELINE_STEP_REF_NOT_EMPTY, ERR_PIPELINE_STEP_REF_NOT_FOUND, ERR_PIPELINE_STEP_SNIPPET_NOT_EMPTY, ERR_TYPEORM_DATASOURCE_CREATOR_NOT_FOUND, ERR_TYPEORM_DATASOURCE_NOT_FOUND, ERR_TYPEORM_DATASOURCE_TYPE_NOT_FOUND, ERR_TYPEORM_ENTITY_NOT_FOUND, ERR_TYPEORM_SQL_NOT_EMPTY, ERR_TYPEORM_STEP_SNIPPET_NOT_EMPTY, ERR_TYPEORM_TRANSACTION_NOT_FOUND, EachPipelineStepSets, FetchPipelineStep, GetPropertyPipelineStep, HttpAbortErrorCode, HttpUnknownErrorCode, MssqlTypeOrmDatasource, MysqlTypeOrmDatasource, OracleTypeOrmDatasource, ParallelPipelineStepSets, ParsedSqlSegmentType, PgsqlTypeOrmDatasource, PipelineStepSets, RefPipelinePipelineStep, RefStepPipelineStep, RoutesPipelineStepSets, SnippetPipelineStep, SnowflakePipelineStep, SupportedDataSourceTypes, TypeOrmBulkSaveBySQLPipelineStep, TypeOrmBySnippetPipelineStep, TypeOrmDataSourceHelper, TypeOrmDataSourceManager, TypeOrmLoadManyBySQLPipelineStep, TypeOrmLoadOneBySQLPipelineStep, TypeOrmParsedSQLCache, TypeOrmSaveBySQLPipelineStep, TypeOrmTransactionalPipelineStepSets, Utils };

package/lib/http/fetch-step.d.ts

@@ -11,7 +11,7 @@ export interface FetchPipelineStepOptions<In = PipelineStepPayload, Out = Pipeli
     bodyUsed?: boolean;
     bodyGenerate?: ScriptFuncOrBody<HttpGenerateBody<In, InFragment>>;
     responseGenerate?: ScriptFuncOrBody<HttpGenerateResponse<In, InFragment>>;
-    responseErrorHandles?: {
+    responseErrorHandles?: ScriptFuncOrBody<HttpHandleError<In, InFragment, OutFragment>> | {
         [key: HttpErrorCode]: ScriptFuncOrBody<HttpHandleError<In, InFragment, OutFragment>>;
     };
 }

package/lib/typeorm-step/abstract-typeorm-step.d.ts

@@ -1,9 +1,8 @@
 import { PipelineStepData, PipelineStepPayload, Undefinable } from '@rainbow-o23/n1';
-import { DataSource, EntityMetadata, ObjectLiteral, QueryRunner, Repository } from 'typeorm';
-import { ColumnMetadata } from 'typeorm/metadata/ColumnMetadata.js';
+import { QueryRunner } from 'typeorm';
 import { AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions } from '../step';
 import { DataSourceType, TypeOrmDataSource } from '../typeorm';
-import { TypeOrmDataSourceName, TypeOrmEntityName, TypeOrmTransactionKey, TypeOrmTransactionName } from './types';
+import { TypeOrmDataSourceName, TypeOrmTransactionKey, TypeOrmTransactionName } from './types';
 export interface TypeOrmPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out> extends FragmentaryPipelineStepOptions<In, Out, InFragment, OutFragment> {
     dataSourceName: TypeOrmDataSourceName;
     transactionName?: TypeOrmTransactionName;
@@ -26,5 +25,4 @@ export declare abstract class AbstractTypeOrmPipelineStep<In = PipelineStepPaylo
     protected createRunner(request: PipelineStepData<In>): Promise<QueryRunner>;
     protected trans<R>(run: (runner: QueryRunner) => Promise<R>, handleRollbackError: (err: Error) => Undefinable<Error>, request: PipelineStepData<In>): Promise<R>;
     protected autoTrans<R>(run: (runner: QueryRunner) => Promise<R>, request: PipelineStepData<In>): Promise<R>;
-    protected findMetadata<E extends ObjectLiteral>(name: TypeOrmEntityName, request: PipelineStepData<In>): Promise<[EntityMetadata, ColumnMetadata, Repository<E>, DataSource]>;
 }

package/lib/typeorm-step/index.d.ts

@@ -1,7 +1,5 @@
 export * from './types';
 export * from './abstract-typeorm-step';
-export * from './typeorm-load-entity-by-id-step';
-export * from './typeorm-save-entity-step';
 export * from './typeorm-by-snippet-step';
 export * from './abstract-typeorm-by-sql-step';
 export * from './abstract-typeorm-load-by-sql-step';
@@ -9,4 +7,4 @@ export * from './typeorm-load-one-by-sql-step';
 export * from './typeorm-load-many-by-sql-step';
 export * from './typeorm-save-by-sql-step';
 export * from './typeorm-bulk-save-by-sql-step';
-export * from './type-orm-transactional-step-sets';
+export * from './typeorm-transactional-step-sets';

package/lib/typeorm-step/types.d.ts

@@ -5,7 +5,6 @@ export type TypeOrmIdType = string | number | bigint;
 export type TypeOrmDataSourceName = string;
 export type TypeOrmTransactionName = string;
 export type TypeOrmTransactionKey = `${TypeOrmDataSourceName}.${TypeOrmTransactionName}`;
-export type TypeOrmEntityName = string;
 export type TypeOrmEntityValue = string | number | bigint | boolean | Date | null | undefined;
 export type TypeOrmEntityToLoad = DeepPartial<ObjectLiteral>;
 export type TypeOrmEntityToSave = DeepPartial<ObjectLiteral>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rainbow-o23/n3",
-	"version": "1.0.40",
+	"version": "1.0.42",
 	"description": "o23 pipelines",
 	"main": "index.cjs",
 	"module": "index.js",
@@ -21,7 +21,7 @@
 		"url": "https://github.com/InsureMO/rainbow-o23/issues"
 	},
 	"dependencies": {
-		"@rainbow-o23/n1": "1.0.40",
+		"@rainbow-o23/n1": "1.0.42",
 		"node-fetch": "2.6.7",
 		"typeorm": "^0.3.17"
 	},

package/src/lib/http/fetch-step.ts

@@ -26,9 +26,8 @@ export interface FetchPipelineStepOptions<In = PipelineStepPayload, Out = Pipeli
 	bodyUsed?: boolean;
 	bodyGenerate?: ScriptFuncOrBody<HttpGenerateBody<In, InFragment>>;
 	responseGenerate?: ScriptFuncOrBody<HttpGenerateResponse<In, InFragment>>;
-	responseErrorHandles?: {
-		[key: HttpErrorCode]: ScriptFuncOrBody<HttpHandleError<In, InFragment, OutFragment>>;
-	};
+	responseErrorHandles?: ScriptFuncOrBody<HttpHandleError<In, InFragment, OutFragment>>
+		| { [key: HttpErrorCode]: ScriptFuncOrBody<HttpHandleError<In, InFragment, OutFragment>>; };
 }
 
 export class FetchPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = In, OutFragment = Out>
@@ -112,13 +111,21 @@ export class FetchPipelineStep<In = PipelineStepPayload, Out = PipelineStepPaylo
 				throw e;
 			}
 		});
-		if (options.responseErrorHandles) {
-			// eslint-disable-next-line @typescript-eslint/no-unused-vars
-			const defaultHandler = async (options: HttpErrorHandleOptions<In, InFragment>, _$helpers: PipelineStepHelpers, _$: PipelineStepHelpers): Promise<OutFragment> | never => {
-				throw new UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
-			};
-			const createDefaultHandler = () => defaultHandler;
-			const getVariableNames = () => this.getErrorHandlerVariableName();
+		// eslint-disable-next-line @typescript-eslint/no-unused-vars
+		const defaultHandler = async (options: HttpErrorHandleOptions<In, InFragment>, _$helpers: PipelineStepHelpers, _$: PipelineStepHelpers): Promise<OutFragment> | never => {
+			throw new UncatchableError(ERR_FETCH_ERROR, `Error[${options.$errorCode}] caught when fetch data from remote[${options.$url}].`);
+		};
+		const createDefaultHandler = () => defaultHandler;
+		const getVariableNames = () => this.getErrorHandlerVariableName();
+		if (typeof options.responseErrorHandles === 'string' || typeof options.responseErrorHandles === 'function') {
+			this._responseErrorHandleFunc = Utils.createAsyncFunction(options.responseErrorHandles, {
+				createDefault: createDefaultHandler, getVariableNames,
+				error: (e: Error) => {
+					this.getLogger().error(`Failed on create function for response error handler, snippet is [${options.responseErrorHandles}].`);
+					throw e;
+				}
+			});
+		} else if (options.responseErrorHandles != null) {
 			const handlers: Record<HttpErrorCode, HttpHandleError<In, InFragment, OutFragment>> = Object.keys(options.responseErrorHandles).reduce((handlers, status) => {
 				handlers[status] = Utils.createAsyncFunction(options.responseErrorHandles[status], {
 					createDefault: createDefaultHandler, getVariableNames,

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

@@ -1,17 +1,11 @@
 import {PipelineStepData, PipelineStepPayload, UncatchableError, Undefinable} from '@rainbow-o23/n1';
-import {DataSource, EntityMetadata, ObjectLiteral, QueryRunner, Repository} from 'typeorm';
-import {ColumnMetadata} from 'typeorm/metadata/ColumnMetadata.js';
-import {
-	ERR_TYPEORM_DATASOURCE_NOT_FOUND,
-	ERR_TYPEORM_ENTITY_NOT_FOUND,
-	ERR_TYPEORM_TRANSACTION_NOT_FOUND
-} from '../error-codes';
+import {QueryRunner} from 'typeorm';
+import {ERR_TYPEORM_DATASOURCE_NOT_FOUND, ERR_TYPEORM_TRANSACTION_NOT_FOUND} from '../error-codes';
 import {AbstractFragmentaryPipelineStep, FragmentaryPipelineStepOptions} from '../step';
 import {DataSourceType, TypeOrmDataSource, TypeOrmDataSourceManager} from '../typeorm';
 import {
 	DEFAULT_TRANSACTION_NAME,
 	TypeOrmDataSourceName,
-	TypeOrmEntityName,
 	TypeOrmTransactionalContext,
 	TypeOrmTransactionKey,
 	TypeOrmTransactionName
@@ -222,20 +216,4 @@ export abstract class AbstractTypeOrmPipelineStep<In = PipelineStepPayload, Out
 			}
 		}
 	}
-
-	/**
-	 * find metadata by given name. throw error when data source or metadata not found.
-	 */
-	protected async findMetadata<E extends ObjectLiteral>(name: TypeOrmEntityName, request: PipelineStepData<In>): Promise<[EntityMetadata, ColumnMetadata, Repository<E>, DataSource]> {
-		const runner = await this.createRunner(request);
-		const dataSource = runner.connection;
-		const metadata = (dataSource.entityMetadatas || []).find(metadata => metadata.name == name);
-		if (metadata == null) {
-			throw new UncatchableError(ERR_TYPEORM_ENTITY_NOT_FOUND,
-				`Entity[${name}] in data source[${this.getDataSourceName()}] not found.`);
-		}
-		const column = metadata.columns.find(column => column.isPrimary);
-		const repository = runner.manager.getRepository(metadata.target);
-		return [metadata, column, repository as Repository<E>, dataSource];
-	}
 }

package/src/lib/typeorm-step/index.ts

@@ -1,8 +1,6 @@
 export * from './types';
 
 export * from './abstract-typeorm-step';
-export * from './typeorm-load-entity-by-id-step';
-export * from './typeorm-save-entity-step';
 
 export * from './typeorm-by-snippet-step';
 export * from './abstract-typeorm-by-sql-step';
@@ -14,4 +12,4 @@ export * from './typeorm-load-many-by-sql-step';
 export * from './typeorm-save-by-sql-step';
 export * from './typeorm-bulk-save-by-sql-step';
 
-export * from './type-orm-transactional-step-sets';
+export * from './typeorm-transactional-step-sets';

package/src/lib/typeorm-step/types.ts

@@ -6,7 +6,6 @@ export type TypeOrmIdType = string | number | bigint;
 export type TypeOrmDataSourceName = string;
 export type TypeOrmTransactionName = string;
 export type TypeOrmTransactionKey = `${TypeOrmDataSourceName}.${TypeOrmTransactionName}`;
-export type TypeOrmEntityName = string;
 export type TypeOrmEntityValue = string | number | bigint | boolean | Date | null | undefined;
 export type TypeOrmEntityToLoad = DeepPartial<ObjectLiteral>;
 export type TypeOrmEntityToSave = DeepPartial<ObjectLiteral>;

package/lib/typeorm-step/typeorm-load-entity-by-id-step.d.ts

@@ -1,12 +0,0 @@
-import { PipelineStepData, PipelineStepPayload, Undefinable } from '@rainbow-o23/n1';
-import { AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions } from './abstract-typeorm-step';
-import { TypeOrmEntityName, TypeOrmEntityToLoad, TypeOrmIdType } from './types';
-export interface TypeOrmLoadEntityByIdPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = TypeOrmIdType, OutFragment = Out> extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-    entityName: TypeOrmEntityName;
-}
-export declare class TypeOrmLoadEntityByIdPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, OutFragment = TypeOrmEntityToLoad> extends AbstractTypeOrmPipelineStep<In, Out, TypeOrmIdType, OutFragment> {
-    private readonly _entityName;
-    constructor(options: TypeOrmLoadEntityByIdPipelineStepOptions<In, Out, TypeOrmIdType, OutFragment>);
-    getEntityName(): TypeOrmEntityName;
-    protected doPerform(id: TypeOrmIdType, request: PipelineStepData<In>): Promise<Undefinable<OutFragment>>;
-}

package/lib/typeorm-step/typeorm-save-entity-step.d.ts

@@ -1,33 +0,0 @@
-import { O23ExternalErrorCode, PipelineStepData, PipelineStepPayload, Undefinable } from '@rainbow-o23/n1';
-import { DeepPartial, ObjectLiteral } from 'typeorm';
-import { ScriptFuncOrBody } from '../step';
-import { AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions } from './abstract-typeorm-step';
-import { TypeOrmEntityName } from './types';
-export type EntityToSave = DeepPartial<ObjectLiteral>;
-export type UniquenessCheckResult = {
-    pass: true;
-} | {
-    pass: false;
-    code: O23ExternalErrorCode;
-    message: string;
-};
-export type UniquenessCheckFunc<EntityToSave> = (given: EntityToSave, existing: EntityToSave) => UniquenessCheckResult;
-export interface TypeOrmSaveEntityPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = EntityToSave, OutFragment = EntityToSave> extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-    entityName: TypeOrmEntityName;
-    fillIdBySnowflake?: boolean;
-    uniquenessCheckSnippet?: ScriptFuncOrBody<UniquenessCheckFunc<InFragment>>;
-}
-export declare class TypeOrmSaveEntityPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = EntityToSave, OutFragment = EntityToSave> extends AbstractTypeOrmPipelineStep<In, Out, InFragment, OutFragment> {
-    private readonly _entityName;
-    private readonly _fillIdBySnowflake;
-    private readonly _snowflakeShardId;
-    private readonly _uniquenessCheckSnippet?;
-    private readonly _uniquenessCheckFunc?;
-    constructor(options: TypeOrmSaveEntityPipelineStepOptions<In, Out, InFragment, OutFragment>);
-    getEntityName(): TypeOrmEntityName;
-    isFillIdBySnowflake(): boolean;
-    getUniquenessCheckSnippet(): Undefinable<ScriptFuncOrBody<UniquenessCheckFunc<InFragment>>>;
-    needUniquenessCheck(): boolean;
-    protected generateUniquenessCheckVariableNames(): Array<string>;
-    protected doPerform(entity: InFragment, request: PipelineStepData<In>): Promise<OutFragment>;
-}

package/src/lib/typeorm-step/typeorm-load-entity-by-id-step.ts

@@ -1,35 +0,0 @@
-import {PipelineStepData, PipelineStepPayload, Undefinable} from '@rainbow-o23/n1';
-import {AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions} from './abstract-typeorm-step';
-import {TypeOrmEntityName, TypeOrmEntityToLoad, TypeOrmIdType} from './types';
-
-export interface TypeOrmLoadEntityByIdPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = TypeOrmIdType, OutFragment = Out>
-	extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-	entityName: TypeOrmEntityName;
-}
-
-/**
- * no transaction here
- */
-export class TypeOrmLoadEntityByIdPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, OutFragment = TypeOrmEntityToLoad>
-	extends AbstractTypeOrmPipelineStep<In, Out, TypeOrmIdType, OutFragment> {
-	private readonly _entityName: TypeOrmEntityName;
-
-	public constructor(options: TypeOrmLoadEntityByIdPipelineStepOptions<In, Out, TypeOrmIdType, OutFragment>) {
-		super(options);
-		this._entityName = options.entityName;
-	}
-
-	public getEntityName(): TypeOrmEntityName {
-		return this._entityName;
-	}
-
-	protected async doPerform(id: TypeOrmIdType, request: PipelineStepData<In>): Promise<Undefinable<OutFragment>> {
-		const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-		const loaded = await repository.findOneBy({[column.propertyName]: id}) as OutFragment;
-		if (loaded == null) {
-			return (void 0);
-		} else {
-			return loaded;
-		}
-	}
-}

package/src/lib/typeorm-step/typeorm-save-entity-step.ts

@@ -1,112 +0,0 @@
-import {
-	CatchableError,
-	O23ExternalErrorCode,
-	PipelineStepData,
-	PipelineStepPayload,
-	Undefinable
-} from '@rainbow-o23/n1';
-import {DeepPartial, ObjectLiteral} from 'typeorm';
-import {ScriptFuncOrBody, Utils} from '../step';
-import {Snowflake} from '../utils';
-import {AbstractTypeOrmPipelineStep, TypeOrmPipelineStepOptions} from './abstract-typeorm-step';
-import {TypeOrmEntityName} from './types';
-
-export type EntityToSave = DeepPartial<ObjectLiteral>;
-
-export type UniquenessCheckResult = { pass: true } | { pass: false, code: O23ExternalErrorCode, message: string };
-/**
- * parameter names could be change {@link TypeOrmSaveEntityPipelineStep#generateUniquenessCheckVariableNames}
- */
-export type UniquenessCheckFunc<EntityToSave> = (given: EntityToSave, existing: EntityToSave) => UniquenessCheckResult;
-
-export interface TypeOrmSaveEntityPipelineStepOptions<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = EntityToSave, OutFragment = EntityToSave>
-	extends TypeOrmPipelineStepOptions<In, Out, InFragment, OutFragment> {
-	entityName: TypeOrmEntityName;
-	fillIdBySnowflake?: boolean;
-	uniquenessCheckSnippet?: ScriptFuncOrBody<UniquenessCheckFunc<InFragment>>;
-}
-
-/**
- * no transaction here
- */
-export class TypeOrmSaveEntityPipelineStep<In = PipelineStepPayload, Out = PipelineStepPayload, InFragment = EntityToSave, OutFragment = EntityToSave>
-	extends AbstractTypeOrmPipelineStep<In, Out, InFragment, OutFragment> {
-	private readonly _entityName: TypeOrmEntityName;
-	private readonly _fillIdBySnowflake: boolean;
-	private readonly _snowflakeShardId: number;
-	private readonly _uniquenessCheckSnippet?: ScriptFuncOrBody<UniquenessCheckFunc<InFragment>>;
-	private readonly _uniquenessCheckFunc?: UniquenessCheckFunc<InFragment>;
-
-	public constructor(options: TypeOrmSaveEntityPipelineStepOptions<In, Out, InFragment, OutFragment>) {
-		super(options);
-		const config = this.getConfig();
-		this._entityName = options.entityName;
-		this._fillIdBySnowflake = options.fillIdBySnowflake ?? false;
-		this._snowflakeShardId = config.getNumber(`snowflake.shard.id`);
-		this._uniquenessCheckSnippet = options.uniquenessCheckSnippet;
-		this._uniquenessCheckFunc = Utils.createSyncFunction(this.getUniquenessCheckSnippet(), {
-			createDefault: () => (void 0),
-			getVariableNames: () => this.generateUniquenessCheckVariableNames(),
-			error: (e: Error) => {
-				this.getLogger().error(`Failed on create function for uniqueness check, snippet is [${this.getUniquenessCheckSnippet()}].`);
-				throw e;
-			}
-		});
-	}
-
-	public getEntityName(): TypeOrmEntityName {
-		return this._entityName;
-	}
-
-	public isFillIdBySnowflake(): boolean {
-		return this._fillIdBySnowflake;
-	}
-
-	public getUniquenessCheckSnippet(): Undefinable<ScriptFuncOrBody<UniquenessCheckFunc<InFragment>>> {
-		return this._uniquenessCheckSnippet;
-	}
-
-	public needUniquenessCheck(): boolean {
-		return this._uniquenessCheckFunc != null;
-	}
-
-	protected generateUniquenessCheckVariableNames(): Array<string> {
-		return ['given', 'existing'];
-	}
-
-	/**
-	 * 1. check uniqueness of given entity,
-	 *   - only when need it, see {@link needUniquenessCheck}
-	 *   - load entity by id, which get from given entity,
-	 *   - compare given and existing by uniqueness check snippet (see {@link _uniquenessCheckFunc}), only when existing loaded from database,
-	 *   - throw catchable error if failed on uniqueness check,
-	 * 2. generate snowflake id and set into given entity,
-	 *   - only when need it, see {@link isFillIdBySnowflake}
-	 * 3. save it.
-	 */
-	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	protected async doPerform(entity: InFragment, request: PipelineStepData<In>): Promise<OutFragment> {
-		const [, column, repository] = await this.findMetadata(this.getEntityName(), request);
-		if (this.needUniquenessCheck()) {
-			const id = entity[column.propertyName];
-			if (`${id ?? ''}`.trim().length !== 0) {
-				const existing = await repository.findOneBy({[column.propertyName]: id}) as InFragment;
-				if (existing != null) {
-					const checked = this._uniquenessCheckFunc(entity, existing);
-					if (checked.pass !== true) {
-						throw new CatchableError(checked.code, checked.message);
-					}
-				}
-			}
-		}
-		if (this.isFillIdBySnowflake()) {
-			// fill id if not exists
-			const id = entity[column.propertyName];
-			if (id == null || `${id ?? ''}`.trim().length === 0) {
-				entity[column.propertyName] = Snowflake.generate({shardId: this._snowflakeShardId}) as unknown as number;
-			}
-		}
-
-		return await repository.save(entity) as OutFragment;
-	}
-}