@chevre/domain 24.0.0-alpha.5 → 24.0.0-alpha.52

package/lib/chevre/repo/transaction/placeOrder.js

@@ -0,0 +1,528 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaceOrderRepo = void 0;
+const moment_1 = __importDefault(require("moment"));
+const transaction_1 = require("../../eventEmitter/transaction");
+const factory = __importStar(require("../../factory"));
+const settings_1 = require("../../settings");
+const transaction_2 = require("../mongoose/schemas/transaction");
+const AVAILABLE_PROJECT_FIELDS = [
+    'project',
+    'status',
+    'typeOf',
+    'agent',
+    'seller',
+    'object',
+    'expires',
+    'startDate',
+    'endDate',
+    'instrument',
+    'result',
+    'potentialActions',
+    // 'recipient',
+    'error',
+    'tasksExportAction',
+];
+/**
+ * 注文取引リポジトリ
+ */
+class PlaceOrderRepo {
+    transactionModel;
+    constructor(connection) {
+        this.transactionModel = connection.model(transaction_2.modelName, (0, transaction_2.createSchema)());
+    }
+    static CREATE_MONGO_CONDITIONS(params) {
+        if (params.typeOf !== factory.transactionType.PlaceOrder) {
+            throw new factory.errors.Argument('typeOf', `must be ${factory.transactionType.PlaceOrder}`);
+        }
+        const andConditions = [];
+        const projectIdEq = params.project?.id?.$eq;
+        if (typeof projectIdEq === 'string') {
+            andConditions.push({ 'project.id': { $eq: projectIdEq } });
+        }
+        if (typeof params.typeOf === 'string') {
+            andConditions.push({ typeOf: { $eq: params.typeOf } });
+        }
+        if (params.startFrom !== undefined) {
+            andConditions.push({
+                startDate: { $gte: params.startFrom }
+            });
+        }
+        if (params.startThrough !== undefined) {
+            andConditions.push({
+                startDate: { $lte: params.startThrough }
+            });
+        }
+        if (params.endFrom !== undefined) {
+            andConditions.push({
+                endDate: {
+                    $exists: true,
+                    $gte: params.endFrom
+                }
+            });
+        }
+        if (params.endThrough !== undefined) {
+            andConditions.push({
+                endDate: {
+                    $exists: true,
+                    $lt: params.endThrough
+                }
+            });
+        }
+        if (Array.isArray(params.ids)) {
+            andConditions.push({
+                _id: { $in: params.ids }
+            });
+        }
+        if (Array.isArray(params.statuses)) {
+            andConditions.push({ status: { $in: params.statuses } });
+        }
+        const statusIn = params.status?.$in;
+        if (Array.isArray(statusIn)) {
+            andConditions.push({ status: { $in: statusIn } });
+        }
+        if (params.agent !== undefined) {
+            if (params.agent.typeOf !== undefined) {
+                andConditions.push({
+                    'agent.typeOf': {
+                        $exists: true,
+                        $eq: params.agent.typeOf
+                    }
+                });
+            }
+            if (Array.isArray(params.agent.ids)) {
+                andConditions.push({
+                    'agent.id': {
+                        $exists: true,
+                        $in: params.agent.ids
+                    }
+                });
+            }
+            if (Array.isArray(params.agent.identifiers)) {
+                andConditions.push({
+                    'agent.identifier': {
+                        $exists: true,
+                        $in: params.agent.identifiers
+                    }
+                });
+            }
+        }
+        const tasksExportActionStatusIn = params.tasksExportAction?.actionStatus?.$in;
+        if (Array.isArray(tasksExportActionStatusIn)) {
+            andConditions.push({ 'tasksExportAction.actionStatus': { $exists: true, $in: tasksExportActionStatusIn } });
+        }
+        const tasksExportActionStatusEq = params.tasksExportAction?.actionStatus?.$eq;
+        if (typeof tasksExportActionStatusEq === 'string') {
+            andConditions.push({ 'tasksExportAction.actionStatus': { $exists: true, $eq: tasksExportActionStatusEq } });
+        }
+        const sellerIdIn = params.seller?.ids;
+        if (Array.isArray(sellerIdIn)) {
+            andConditions.push({ 'seller.id': { $exists: true, $in: sellerIdIn } });
+        }
+        const resultOrderNumberIn = params.result?.order?.orderNumbers;
+        if (Array.isArray(resultOrderNumberIn)) {
+            andConditions.push({ 'result.order.orderNumber': { $exists: true, $in: resultOrderNumberIn } });
+        }
+        const resultOrderConfirmationNumberEq = params.result?.order?.confirmationNumber?.$eq;
+        if (typeof resultOrderConfirmationNumberEq === 'string') {
+            andConditions.push({
+                'result.order.confirmationNumber': { $exists: true, $eq: resultOrderConfirmationNumberEq }
+            });
+        }
+        const objectOrderNumberEq = params.object?.orderNumber?.$eq;
+        if (typeof objectOrderNumberEq === 'string') {
+            andConditions.push({ 'object.orderNumber': { $exists: true, $eq: objectOrderNumberEq } });
+        }
+        return andConditions;
+    }
+    async countPlaceOrder(params) {
+        const { limit } = params;
+        const conditions = PlaceOrderRepo.CREATE_MONGO_CONDITIONS(params);
+        const query = this.transactionModel.countDocuments((conditions.length > 0) ? { $and: conditions } : {});
+        if (typeof limit === 'number' && limit >= 0) {
+            query.limit(limit);
+        }
+        const count = await query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
+            .exec();
+        return { count };
+    }
+    /**
+     * 取引を検索する
+     */
+    async findPlaceOrderTransactions(params) {
+        const { inclusion } = params;
+        const conditions = PlaceOrderRepo.CREATE_MONGO_CONDITIONS(params);
+        let positiveProjectionFields = AVAILABLE_PROJECT_FIELDS;
+        if (Array.isArray(inclusion) && inclusion.length > 0) {
+            positiveProjectionFields = positiveProjectionFields.filter((key) => inclusion.includes(key));
+        }
+        const projection = {
+            _id: 0,
+            id: { $toString: '$_id' },
+            ...Object.fromEntries(positiveProjectionFields.map((key) => ([key, 1])))
+        };
+        const query = this.transactionModel.find((conditions.length > 0) ? { $and: conditions } : {})
+            .select(projection);
+        if (typeof params.limit === 'number' && params.limit > 0) {
+            const page = (typeof params.page === 'number' && params.page > 0) ? params.page : 1;
+            query.limit(params.limit)
+                .skip(params.limit * (page - 1));
+        }
+        if (params.sort?.startDate !== undefined) {
+            query.sort({ startDate: params.sort.startDate });
+        }
+        // const explainResult = await (<any>query).explain();
+        // console.log(explainResult[0].executionStats.allPlansExecution.map((e: any) => e.executionStages.inputStage));
+        return query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
+            .lean()
+            .exec();
+    }
+    /**
+     * 進行中取引に保管された採用済決済方法を検索する
+     */
+    async findInProgressPaymentMethodId(params) {
+        const doc = await this.transactionModel.findOne({
+            _id: { $eq: params.id },
+            typeOf: { $eq: factory.transactionType.PlaceOrder },
+            status: { $eq: factory.transactionStatusType.InProgress }
+        }, { 'object.paymentMethods': 1 })
+            .lean() // 2024-08-26~
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${factory.transactionType.PlaceOrder} ${factory.transactionStatusType.InProgress} not found`);
+        }
+        return doc.object.paymentMethods;
+    }
+    /**
+     * 取引の注文番号を検索する
+     */
+    async findInProgressOrderNumberById(params) {
+        const doc = await this.transactionModel.findOne({
+            _id: { $eq: params.id },
+            typeOf: { $eq: factory.transactionType.PlaceOrder },
+            status: { $eq: factory.transactionStatusType.InProgress }
+        }, { 'object.orderNumber': 1 })
+            .lean() // 2024-08-26~
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${factory.transactionType.PlaceOrder} ${factory.transactionStatusType.InProgress} not found`);
+        }
+        return doc.object.orderNumber;
+    }
+    /**
+     * 取引の確認番号を検索する
+     */
+    async findInProgressConfirmationNumberById(params) {
+        const doc = await this.transactionModel.findOne({
+            _id: { $eq: params.id },
+            typeOf: { $eq: factory.transactionType.PlaceOrder },
+            status: { $in: params.status.$in }
+        }, { 'object.confirmationNumber': 1 })
+            .lean() // 2024-08-26~
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${factory.transactionType.PlaceOrder} ${params.status.$in.join(' or ')} not found`);
+        }
+        return doc.object.confirmationNumber;
+    }
+    /**
+     * 取引期限変更
+     */
+    async updateExpires(params) {
+        const doc = await this.transactionModel.findOneAndUpdate({
+            _id: { $eq: params.id },
+            typeOf: { $eq: params.typeOf },
+            status: { $eq: factory.transactionStatusType.InProgress }
+        }, {
+            $set: {
+                expires: params.expires
+            }
+        }, {
+            projection: { _id: 1 }
+        })
+            .lean()
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} ${factory.transactionStatusType.InProgress} not found`);
+        }
+    }
+    /**
+     * 取引オブジェクトを更新
+     * 注文名称など
+     */
+    async updateObject(params) {
+        const doc = await this.transactionModel.findOneAndUpdate({
+            _id: { $eq: params.id },
+            typeOf: { $eq: params.typeOf },
+            status: { $eq: factory.transactionStatusType.InProgress }
+        }, {
+            $set: {
+                ...(typeof params.object?.name === 'string') ? { 'object.name': params.object.name } : undefined
+            }
+        }, {
+            projection: { _id: 1 }
+        })
+            .lean()
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} ${factory.transactionStatusType.InProgress} not found`);
+        }
+    }
+    /**
+     * 特定の進行中取引を更新する(汎用)
+     */
+    async findByIdAndUpdateInProgress(params) {
+        await this.transactionModel.findOneAndUpdate({
+            _id: { $eq: params.id },
+            status: { $eq: factory.transactionStatusType.InProgress }
+        }, params.update, {
+            // new: true,
+            projection: { _id: 1 }
+        })
+            .lean()
+            .exec()
+            .then((doc) => {
+            if (doc === null) {
+                throw new factory.errors.ArgumentNull(this.transactionModel.modelName);
+            }
+        });
+    }
+    /**
+     * 進行中取引のobjectに注文番号を保管する
+     */
+    async saveOrderNumberIfNotExist(params) {
+        const result = await this.transactionModel.updateOne({
+            _id: { $eq: params.id },
+            status: { $eq: factory.transactionStatusType.InProgress },
+            'object.orderNumber': { $exists: false }
+        }, { $set: { 'object.orderNumber': params.orderNumber } })
+            .exec();
+        return { modifiedCount: result.modifiedCount };
+    }
+    async saveConfirmationNumberIfNotExist(params) {
+        await this.transactionModel.updateOne({
+            _id: { $eq: params.id },
+            // status: { $eq: factory.transactionStatusType.InProgress },
+            status: { $in: params.status.$in },
+            'object.confirmationNumber': { $exists: false }
+        }, { $set: { 'object.confirmationNumber': params.confirmationNumber } })
+            .exec();
+    }
+    /**
+     * 進行中の注文取引を取得する
+     */
+    async findPlaceOrderInProgressById(params, inclusion // make required(2024-05-29~)
+    ) {
+        let positiveProjectionFields = AVAILABLE_PROJECT_FIELDS;
+        if (Array.isArray(inclusion) && inclusion.length > 0) {
+            positiveProjectionFields = positiveProjectionFields.filter((key) => inclusion.includes(key));
+        }
+        else {
+            throw new factory.errors.NotImplemented('inclusion must be specified'); // 2024-08-26~
+        }
+        const projection = {
+            _id: 0,
+            id: { $toString: '$_id' },
+            ...Object.fromEntries(positiveProjectionFields.map((key) => ([key, 1])))
+        };
+        const filter = {
+            _id: { $eq: params.id },
+            typeOf: { $eq: params.typeOf },
+            status: { $eq: factory.transactionStatusType.InProgress },
+            // expiresを条件に追加(2023-05-12~),
+            expires: { $gt: new Date() }
+        };
+        const doc = await this.transactionModel.findOne(filter, projection)
+            .lean()
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} ${factory.transactionStatusType.InProgress} not found`);
+        }
+        return doc;
+    }
+    /**
+     * 特定注文取引参照
+     */
+    async findPlaceOrderById(params, inclusion // make required(2024-05-31~)
+    ) {
+        let positiveProjectionFields = AVAILABLE_PROJECT_FIELDS;
+        if (Array.isArray(inclusion) && inclusion.length > 0) {
+            positiveProjectionFields = positiveProjectionFields.filter((key) => inclusion.includes(key));
+        }
+        else {
+            throw new factory.errors.NotImplemented('inclusion must be specified'); // 2024-08-26~
+        }
+        const projection = {
+            _id: 0,
+            id: { $toString: '$_id' },
+            ...Object.fromEntries(positiveProjectionFields.map((key) => ([key, 1])))
+        };
+        const doc = await this.transactionModel.findOne({
+            _id: { $eq: params.id },
+            typeOf: { $eq: params.typeOf }
+        }, projection)
+            .lean() // 2024-08-26~
+            .exec();
+        if (doc === null) {
+            throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} not found`);
+        }
+        return doc;
+    }
+    /**
+     * 取引を開始する
+     */
+    async startPlaceOrder(params) {
+        const status = factory.transactionStatusType.InProgress;
+        const tasksExportAction = { actionStatus: factory.actionStatusType.PotentialActionStatus };
+        // const tasksExportationStatus = factory.transactionTasksExportationStatus.Unexported; // discontinue(2024-06-20~)
+        const startDate = new Date();
+        let expires;
+        const { typeOf } = params;
+        // expiresInSecondsの指定があれば優先して適用する(2022-11-25~)
+        if (typeof params.expiresInSeconds === 'number' && params.expiresInSeconds > 0) {
+            expires = (0, moment_1.default)(startDate)
+                .add(params.expiresInSeconds, 'seconds')
+                .toDate();
+        }
+        else {
+            throw new factory.errors.ArgumentNull('expiresInSeconds');
+        }
+        let creatingTransaction;
+        if (typeOf === factory.transactionType.PlaceOrder) {
+            const { agent, project, object, seller, instrument } = params;
+            creatingTransaction = {
+                status, startDate, expires, typeOf, tasksExportAction,
+                agent, project, seller, object,
+                ...(typeof instrument?.id === 'string') ? { instrument } : undefined
+            };
+        }
+        else {
+            throw new factory.errors.NotImplemented(`${typeOf} not implemented`);
+        }
+        // reimplemnt with insertMany(2024-05-30~)
+        const result = await this.transactionModel.insertMany(creatingTransaction, { rawResult: true });
+        const id = result.insertedIds?.[0]?.toHexString();
+        if (typeof id !== 'string') {
+            throw new factory.errors.Internal('transaction not saved');
+        }
+        // 取引開始時にも取引イベントエミッター連携(2024-03-21~)
+        transaction_1.transactionEventEmitter.emitTransactionStatusChanged({ id, typeOf, status });
+        return { expires, id, startDate, status }; // minimize response(2024-05-30~)
+    }
+    /**
+     * 取引を確定する
+     */
+    async confirmPlaceOrder(params) {
+        const endDate = new Date();
+        const doc = await this.transactionModel.findOneAndUpdate({
+            _id: { $eq: params.id },
+            typeOf: { $eq: params.typeOf },
+            status: { $eq: factory.transactionStatusType.InProgress },
+            expires: { $gt: endDate } // add expires(2025-02-27~)
+        }, {
+            status: factory.transactionStatusType.Confirmed, // ステータス変更
+            endDate,
+            // 'object.authorizeActions': params.authorizeActions,
+            result: params.result, // resultを更新
+            potentialActions: params.potentialActions // resultを更新
+        }, {
+            new: true,
+            projection: { _id: 1 }
+        })
+            .lean()
+            .exec();
+        // NotFoundであれば取引状態確認
+        if (doc === null) {
+            const { expires, status } = await this.findPlaceOrderById({ typeOf: params.typeOf, id: params.id }, ['expires', 'status']);
+            if (status === factory.transactionStatusType.Confirmed) {
+                // すでに確定済の場合スルー
+            }
+            else if (status === factory.transactionStatusType.Expired) {
+                throw new factory.errors.Argument('Transaction id', 'Already expired');
+            }
+            else if (status === factory.transactionStatusType.Canceled) {
+                throw new factory.errors.Argument('Transaction id', 'Already canceled');
+            }
+            else {
+                if ((0, moment_1.default)(expires)
+                    .isSameOrBefore((0, moment_1.default)(endDate))) {
+                    throw new factory.errors.Argument('Transaction id', 'potentially expired');
+                }
+                throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} ${factory.transactionStatusType.InProgress} not found`);
+            }
+        }
+        transaction_1.transactionEventEmitter.emitTransactionStatusChanged({
+            id: params.id,
+            typeOf: params.typeOf,
+            status: factory.transactionStatusType.Confirmed
+        });
+    }
+    /**
+     * 取引を中止する
+     */
+    async cancelPlaceOrder(params) {
+        const endDate = new Date();
+        // 進行中ステータスの取引を中止する
+        const doc = await this.transactionModel.findOneAndUpdate({
+            typeOf: params.typeOf,
+            _id: params.id,
+            status: factory.transactionStatusType.InProgress
+        }, {
+            status: factory.transactionStatusType.Canceled,
+            endDate: endDate
+        }, {
+            new: true,
+            projection: { _id: 1 }
+        })
+            .lean()
+            .exec();
+        // NotFoundであれば取引状態確認
+        if (doc === null) {
+            const { status } = await this.findPlaceOrderById(params, ['status']);
+            if (status === factory.transactionStatusType.Canceled) {
+                // すでに中止済の場合スルー
+            }
+            else if (status === factory.transactionStatusType.Expired) {
+                throw new factory.errors.Argument('Transaction id', 'Transaction already expired');
+            }
+            else if (status === factory.transactionStatusType.Confirmed) {
+                throw new factory.errors.Argument('Transaction id', 'Confirmed transaction unable to cancel');
+            }
+            else {
+                throw new factory.errors.NotFound(this.transactionModel.modelName, `${params.typeOf} ${factory.transactionStatusType.InProgress} not found`);
+            }
+        }
+        transaction_1.transactionEventEmitter.emitTransactionStatusChanged({
+            id: params.id,
+            typeOf: params.typeOf,
+            status: factory.transactionStatusType.Canceled
+        });
+    }
+}
+exports.PlaceOrderRepo = PlaceOrderRepo;

package/lib/chevre/repo/transaction/returnOrder.d.ts

@@ -0,0 +1,45 @@
+import type { Connection, FilterQuery } from 'mongoose';
+import * as factory from '../../factory';
+type IKeyOfProjection = keyof Pick<factory.transaction.ITransaction<factory.transactionType.ReturnOrder>, 'agent' | 'endDate' | 'expires' | 'project' | 'startDate' | 'status' | 'typeOf'> | Exclude<keyof factory.transaction.ITransaction<factory.transactionType.ReturnOrder>, 'id'>;
+type IStartedTransactionFields = 'expires' | 'id' | 'startDate' | 'status';
+export type IStartedTransaction = Pick<factory.transaction.ITransaction<factory.transactionType.ReturnOrder>, IStartedTransactionFields>;
+/**
+ * 返品取引リポジトリ
+ */
+export declare class ReturnOrderRepo {
+    private readonly transactionModel;
+    constructor(connection: Connection);
+    static CREATE_MONGO_CONDITIONS(params: factory.transaction.ISearchConditions<factory.transactionType.ReturnOrder>): FilterQuery<import("@chevre/factory/lib/transaction/returnOrder").ITransaction>[];
+    countReturnOrder(params: factory.transaction.ISearchConditions<factory.transactionType.ReturnOrder>): Promise<{
+        count: number;
+    }>;
+    /**
+     * 取引を検索する
+     */
+    findReturnOrderTransactions(params: factory.transaction.ISearchConditions<factory.transactionType.ReturnOrder> & {
+        inclusion: IKeyOfProjection[];
+    }): Promise<(Pick<factory.transaction.ITransaction<factory.transactionType.ReturnOrder>, IKeyOfProjection> & {
+        id: string;
+    })[]>;
+    /**
+     * 取引を開始する
+     */
+    startReturnOrder(params: factory.transaction.IStartParams<factory.transactionType.ReturnOrder>): Promise<IStartedTransaction>;
+    /**
+     * 特定取引検索
+     */
+    findReturnOrderById(params: {
+        typeOf: factory.transactionType.ReturnOrder;
+        id: string;
+    }, inclusion: IKeyOfProjection[]): Promise<factory.transaction.ITransaction<factory.transactionType.ReturnOrder>>;
+    /**
+     * 取引を確定する
+     */
+    confirmReturnOrder(params: {
+        typeOf: factory.transactionType.ReturnOrder;
+        id: string;
+        result: factory.transaction.IResult<factory.transactionType.ReturnOrder>;
+        potentialActions: factory.transaction.IPotentialActions<factory.transactionType.ReturnOrder>;
+    }): Promise<void>;
+}
+export {};