@chevre/domain 22.1.0-alpha.2 → 22.1.0-alpha.3

package/example/src/chevre/{searchOrders.ts → projectOrderFields.ts}

@@ -19,9 +19,11 @@ async function main() {
 
     const orderRepo = await chevre.repository.Order.createInstance(mongoose.connection);
 
-    const orders = await orderRepo.search(
+    const orders = await orderRepo.projectFields(
         {
-            limit: 1,
+            limit: 3,
+            page: 1,
+            sort: { orderDate: -1 },
             project: { id: { $eq: project.id } },
             acceptedOffers: {
                 // itemOffered: {
@@ -34,30 +36,13 @@ async function main() {
                 //         issuedThrough: { typeOf: { $eq: chevre.factory.product.ProductType.MembershipService } }
                 //     }
             }
-            // orderedItem: {
-            //     $size: 3
-            // }
-            // paymentMethods: {
-            //     paymentMethod: { identifier: { $in: ['Cash'] } }
-            //     additionalProperty: {
-            //         $in: [
-            //             { name: 'orderId', value: '0102022031518442020' },
-            //             { name: 'orderId', value: '0102022031518423030' }
-            //         ]
-            //     }
-            // }
         },
         {
-            inclusion: {
-                confirmationNumber: 1,
-                // customer: 1,
-                identifier: 1, orderDate: 1, orderNumber: 1, orderStatus: 1,
-                // orderedItem: 1,
-                // paymentMethods: 1,
-                price: 1, priceCurrency: 1, project: 1,
-                // seller: 1,
-                typeOf: 1
-            }
+            inclusion: [
+                'orderNumber', 'orderDate'
+                , 'paymentMethods.name'
+                // , 'confirmationNumber', 'identifier', 'orderDate', 'orderStatus', 'price', 'typeOf'
+            ]
         }
     );
     // tslint:disable-next-line:no-null-keyword

package/lib/chevre/repo/order.d.ts

@@ -55,7 +55,7 @@ export type IOrderOnStatusChanged = Pick<IOrderWithoutAcceptedOffers & {
 export declare class OrderRepo {
     private readonly orderModel;
     constructor(connection: Connection);
-    static CREATE_MONGO_CONDITIONS(params: factory.order.ISearchConditions): FilterQuery<factory.order.IOrder>[];
+    static CREATE_MONGO_CONDITIONS(params: Omit<factory.order.ISearchConditions, 'limit' | 'page' | 'sort'>): FilterQuery<factory.order.IOrder>[];
     /**
      * なければ作成する
      */
@@ -149,12 +149,14 @@ export declare class OrderRepo {
     }): Promise<void>;
     count(params: factory.order.ISearchConditions): Promise<number>;
     /**
-     * 注文を検索する
+     * 注文を検索する(inclusion projection)
+     * redefine from search(2024-07-31~)
      */
-    search(params: factory.order.ISearchConditions, options: {
-        inclusion: {
-            [key in IKeyOfProjection]?: 1;
-        };
+    projectFields(params: factory.order.ISearchConditions & {
+        limit: number;
+        page: number;
+    }, options: {
+        inclusion: IKeyOfProjection[];
     }): Promise<(IOrderWithoutAcceptedOffers & {
         id: string;
     })[]>;

package/lib/chevre/repo/order.js

@@ -988,51 +988,96 @@ class OrderRepo {
                 .exec();
         });
     }
+    // migrate to projectFields(2024-07-31~)
+    // public async search(
+    //     params: factory.order.ISearchConditions,
+    //     // projection: { [key in IKeyOfProjection]?: 0 | 1 } // exclusion+inclusion(2024-07-26~)
+    //     options: {
+    //         inclusion: { [key in IKeyOfProjection]?: 1 };
+    //         // exclusion: { [key in IKeyOfProjection]?: 0 }; // discontinue(2024-07-31~)
+    //     }
+    // ): Promise<(IOrderWithoutAcceptedOffers & { id: string })[]> {
+    //     const { inclusion } = options;
+    //     const conditions = OrderRepo.CREATE_MONGO_CONDITIONS(params);
+    //     let useInclusionProjection: boolean = false;
+    //     let projectStage: { [field: string]: AnyExpression } = {};
+    //     const positiveProjectionFields: string[] = (inclusion !== undefined && inclusion !== null)
+    //         ? Object.keys(inclusion)
+    //             .filter((key) => {
+    //                 // return inclusion[<IKeyOfProjection>key] === 1
+    //                 //     && key !== 'acceptedOffers' // defaultで隠蔽(2023-12-06~)
+    //                 //     && key !== '_id'
+    //                 //     && key !== 'id';
+    //                 return inclusion[<IKeyOfProjection>key] === 1
+    //                     && AVAILABLE_PROJECT_FIELDS.includes(<IKeyOfProjection>key);
+    //             })
+    //         : [];
+    //     if (Array.isArray(positiveProjectionFields) && positiveProjectionFields.length > 0) {
+    //         useInclusionProjection = true;
+    //         projectStage = {
+    //             _id: 0, // hide _id(2024-07-25~)
+    //             id: { $toString: '$_id' }
+    //         };
+    //         positiveProjectionFields.forEach((field) => {
+    //             projectStage[field] = 1;
+    //         });
+    //     } else {
+    //         throw new factory.errors.ArgumentNull('inclusion', 'inclusion must be specified');
+    //         // projectStage = {
+    //         //     __v: 0,
+    //         //     createdAt: 0,
+    //         //     updatedAt: 0,
+    //         //     acceptedOffers: 0, // defaultで隠蔽(2023-12-06~)
+    //         //     ...exclusion
+    //         // };
+    //     }
+    //     const query = this.orderModel.find<HydratedDocument<IOrderWithoutAcceptedOffers & { id: string }>>(
+    //         (conditions.length > 0) ? { $and: conditions } : {},
+    //         projectStage
+    //     );
+    //     // .select(projectStage);
+    //     if (typeof params.limit === 'number' && params.limit > 0) {
+    //         const page: number = (typeof params.page === 'number' && params.page > 0) ? params.page : 1;
+    //         query.limit(params.limit)
+    //             .skip(params.limit * (page - 1));
+    //     }
+    //     // tslint:disable-next-line:no-single-line-block-comment
+    //     /* istanbul ignore else */
+    //     if (params.sort?.orderDate !== undefined) {
+    //         query.sort({ orderDate: params.sort.orderDate });
+    //     }
+    //     // const explainResult = await (<any>query).explain();
+    //     // console.log(explainResult[0].executionStats.allPlansExecution.map((e: any) => e.executionStages.inputStage));
+    //     if (useInclusionProjection) {
+    //         return query.setOptions({ maxTimeMS: MONGO_MAX_TIME_MS })
+    //             .lean<(IOrderWithoutAcceptedOffers & { id: string })[]>() // lean(2024-07-25~)
+    //             .exec();
+    //     } else {
+    //         return query.setOptions({ maxTimeMS: MONGO_MAX_TIME_MS })
+    //             .exec()
+    //             .then((docs) => docs.map((doc) => doc.toObject()));
+    //     }
+    // }
     /**
-     * 注文を検索する
+     * 注文を検索する(inclusion projection)
+     * redefine from search(2024-07-31~)
      */
-    search(params, 
-    // projection: { [key in IKeyOfProjection]?: 0 | 1 } // exclusion+inclusion(2024-07-26~)
-    options) {
+    projectFields(params, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const { inclusion } = options;
             const conditions = OrderRepo.CREATE_MONGO_CONDITIONS(params);
-            let useInclusionProjection = false;
             let projectStage = {};
-            const positiveProjectionFields = (inclusion !== undefined && inclusion !== null)
-                ? Object.keys(inclusion)
-                    .filter((key) => {
-                    // return inclusion[<IKeyOfProjection>key] === 1
-                    //     && key !== 'acceptedOffers' // defaultで隠蔽(2023-12-06~)
-                    //     && key !== '_id'
-                    //     && key !== 'id';
-                    return inclusion[key] === 1
-                        && AVAILABLE_PROJECT_FIELDS.includes(key);
-                })
+            const positiveProjectionFields = (Array.isArray(inclusion))
+                ? inclusion.filter((key) => AVAILABLE_PROJECT_FIELDS.includes(key))
                 : [];
             if (Array.isArray(positiveProjectionFields) && positiveProjectionFields.length > 0) {
-                useInclusionProjection = true;
-                projectStage = {
-                    _id: 0,
-                    id: { $toString: '$_id' }
-                };
-                positiveProjectionFields.forEach((field) => {
-                    projectStage[field] = 1;
-                });
+                projectStage = Object.assign({ _id: 0, id: { $toString: '$_id' } }, Object.fromEntries(positiveProjectionFields.map((key) => ([key, 1]))));
             }
             else {
                 throw new factory.errors.ArgumentNull('inclusion', 'inclusion must be specified');
-                // projectStage = {
-                //     __v: 0,
-                //     createdAt: 0,
-                //     updatedAt: 0,
-                //     acceptedOffers: 0, // defaultで隠蔽(2023-12-06~)
-                //     ...exclusion
-                // };
             }
             const query = this.orderModel.find((conditions.length > 0) ? { $and: conditions } : {}, projectStage);
-            // .select(projectStage);
             if (typeof params.limit === 'number' && params.limit > 0) {
                 const page = (typeof params.page === 'number' && params.page > 0) ? params.page : 1;
                 query.limit(params.limit)
@@ -1045,16 +1090,9 @@ class OrderRepo {
             }
             // const explainResult = await (<any>query).explain();
             // console.log(explainResult[0].executionStats.allPlansExecution.map((e: any) => e.executionStages.inputStage));
-            if (useInclusionProjection) {
-                return query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
-                    .lean() // lean(2024-07-25~)
-                    .exec();
-            }
-            else {
-                return query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
-                    .exec()
-                    .then((docs) => docs.map((doc) => doc.toObject()));
-            }
+            return query.setOptions({ maxTimeMS: settings_1.MONGO_MAX_TIME_MS })
+                .lean() // lean(2024-07-25~)
+                .exec();
         });
     }
     getCursor(conditions, projection) {

package/lib/chevre/service/assetTransaction/pay.js

@@ -463,13 +463,13 @@ function confirm(params) {
         }
         let potentialActions;
         // 注文検証
-        const existingOrders = yield repos.order.search({
+        const existingOrders = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             project: { id: { $eq: transaction.project.id } },
             confirmationNumbers: [confirmationNumber],
             orderNumbers: [orderNumber]
-        }, { inclusion: { orderNumber: 1 } });
+        }, { inclusion: ['orderNumber'] });
         if (existingOrders.length === 0) {
             throw new factory.errors.NotFound(factory.order.OrderType.Order);
         }

package/lib/chevre/service/assetTransaction/reserve/confirm.js

@@ -75,13 +75,13 @@ function fixOrderAsPurpose(params, transaction) {
             && payPurposeConfirmationNumber.length > 0
             && typeof payPurposeOrderNumber === 'string'
             && payPurposeOrderNumber.length > 0) {
-            const orders = yield repos.order.search({
+            const orders = yield repos.order.projectFields({
                 limit: 1,
                 page: 1,
                 project: { id: { $eq: transaction.project.id } },
                 confirmationNumbers: [payPurposeConfirmationNumber],
                 orderNumbers: [payPurposeOrderNumber]
-            }, { inclusion: { customer: 1, orderNumber: 1, typeOf: 1 } });
+            }, { inclusion: ['customer', 'orderNumber', 'typeOf'] });
             order = orders.shift();
             if (order === undefined) {
                 throw new factory.errors.NotFound('Order as purpose');

package/lib/chevre/service/order/deleteOrder.js

@@ -18,9 +18,11 @@ const factory = require("../../factory");
  */
 function deleteOrder(params) {
     return (repos) => __awaiter(this, void 0, void 0, function* () {
-        const orders = yield repos.order.search({
+        const orders = yield repos.order.projectFields({
+            limit: 1,
+            page: 1,
             orderNumbers: [params.object.orderNumber]
-        }, { inclusion: { orderDate: 1, project: 1, customer: 1, orderNumber: 1, seller: 1 } });
+        }, { inclusion: ['orderDate', 'project', 'customer', 'orderNumber', 'seller'] });
         const order = orders.shift();
         if (order === undefined) {
             // すでに削除済

package/lib/chevre/service/order/onAssetTransactionStatusChanged.js

@@ -274,14 +274,14 @@ function cancelOrderIfExist(params) {
             return;
         }
         // 注文のpaymentMethodIdを取得
-        const ordersByPaymentMethodId = yield repos.order.search({
+        const ordersByPaymentMethodId = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             paymentMethods: {
                 paymentMethodIds: [params.paymentMethodId]
             },
             project: { id: { $eq: params.project.id } }
-        }, { inclusion: { confirmationNumber: 1, orderNumber: 1 } });
+        }, { inclusion: ['confirmationNumber', 'orderNumber'] });
         const orderByPaymentMethodId = ordersByPaymentMethodId.shift();
         if (orderByPaymentMethodId !== undefined) {
             const placeOrderTransaction = yield (0, findPlaceOrderTransaction_1.findPlaceOrderTransaction)({

package/lib/chevre/service/payment.js

@@ -21,13 +21,13 @@ function fixOrderAsPurpose(params, transaction) {
         var _a;
         const payPurposeConfirmationNumber = params.potentialActions.pay.purpose.confirmationNumber;
         const payPurposeOrderNumber = (_a = params.potentialActions.pay.purpose) === null || _a === void 0 ? void 0 : _a.orderNumber;
-        const ordersWithoutAcceptedOffers = yield repos.order.search({
+        const ordersWithoutAcceptedOffers = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             project: { id: { $eq: transaction.project.id } },
             confirmationNumbers: [payPurposeConfirmationNumber],
             orderNumbers: [payPurposeOrderNumber]
-        }, { inclusion: { typeOf: 1, confirmationNumber: 1, orderNumber: 1 } });
+        }, { inclusion: ['typeOf', 'confirmationNumber', 'orderNumber'] });
         const orderWithoutAcceptedOffers = ordersWithoutAcceptedOffers.shift();
         if (orderWithoutAcceptedOffers === undefined) {
             throw new factory.errors.NotFound('Order as purpose');
@@ -61,11 +61,11 @@ function payTask2payActionAttributes(params) {
         const { object, potentialActions, purpose, typeOf } = params;
         if (typeOf === factory.actionType.PayAction) {
             // 返金手数料決済の場合
-            const order = (yield repos.order.search({
+            const order = (yield repos.order.projectFields({
                 limit: 1,
                 page: 1,
                 orderNumbers: [params.purpose.object.orderNumber]
-            }, { inclusion: { seller: 1, project: 1 } })).shift();
+            }, { inclusion: ['seller', 'project'] })).shift();
             if (order === undefined) {
                 throw new factory.errors.NotFound(factory.order.OrderType.Order);
             }

package/lib/chevre/service/reserve/searchByOrder.js

@@ -40,11 +40,11 @@ function searchByOrder(params) {
             switch (offeredThroughIdentifier) {
                 // COA対応
                 case factory.service.webAPI.Identifier.COA:
-                    const order = (yield repos.order.search({
+                    const order = (yield repos.order.projectFields({
                         limit: 1,
                         page: 1,
                         orderNumbers: [params.orderNumber]
-                    }, { inclusion: { customer: 1 } })).shift();
+                    }, { inclusion: ['customer'] })).shift();
                     if (order === undefined) {
                         throw new factory.errors.NotFound(factory.order.OrderType.Order);
                     }

package/lib/chevre/service/task/confirmReserveTransaction.js

@@ -117,12 +117,12 @@ function fixOrderAsPurpose(params) {
     return (repos) => __awaiter(this, void 0, void 0, function* () {
         let order;
         const purposeOrderNumber = params.purpose.orderNumber;
-        const orders = yield repos.order.search({
+        const orders = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             project: { id: { $eq: params.project.id } },
             orderNumbers: [purposeOrderNumber]
-        }, { inclusion: { customer: 1, orderNumber: 1, typeOf: 1 } });
+        }, { inclusion: ['customer', 'orderNumber', 'typeOf'] });
         order = orders.shift();
         if (order === undefined) {
             throw new factory.errors.NotFound('Order as purpose');

package/lib/chevre/service/task/returnPayTransaction.js

@@ -66,11 +66,11 @@ function fixOrderAndTransaction(params) {
     return (repos) => __awaiter(this, void 0, void 0, function* () {
         const paymentMethodId = params.object.paymentMethodId;
         // objectから注文を特定する(2024-06-19~)
-        const orderByPaymentMethodId = (yield repos.order.search({
+        const orderByPaymentMethodId = (yield repos.order.projectFields({
             limit: 1,
             page: 1,
             paymentMethods: { paymentMethodIds: [paymentMethodId] }
-        }, { inclusion: { orderNumber: 1 } })).shift();
+        }, { inclusion: ['orderNumber'] })).shift();
         if (orderByPaymentMethodId === undefined) {
             throw new factory.errors.NotFound(factory.order.OrderType.Order);
         }

package/lib/chevre/service/transaction/moneyTransfer.js

@@ -400,14 +400,14 @@ function validateFromLocation(project, fromLocationBeforeStart, issuedThrough) {
             if (fromLocation.typeOf === factory.order.OrderType.Order) {
                 fromLocation = fromLocation;
                 // 注文検索
-                const orders = yield repos.order.search({
+                const orders = yield repos.order.projectFields({
                     limit: 1,
                     page: 1,
                     project: { id: { $eq: project.id } },
                     orderNumbers: [String(fromLocation.orderNumber)],
                     confirmationNumbers: [String(fromLocation.confirmationNumber)]
                 }, {
-                    inclusion: { identifier: 1, orderStatus: 1 }
+                    inclusion: ['identifier', 'orderStatus']
                 });
                 const order = orders.shift();
                 if (order === undefined) {
@@ -454,16 +454,16 @@ function validateToLocation(project, toLocationBeforeStart, issuedThrough) {
             if (toLocation.typeOf === factory.order.OrderType.Order) {
                 toLocation = toLocation;
                 // 注文検索
-                const orders = yield repos.order.search({
+                const orders = yield repos.order.projectFields({
                     limit: 1,
                     page: 1,
                     project: { id: { $eq: project.id } },
                     orderNumbers: [String(toLocation.orderNumber)],
                     confirmationNumbers: [String(toLocation.confirmationNumber)]
                 }, {
-                    inclusion: {
-                        identifier: 1
-                    }
+                    inclusion: [
+                        'identifier'
+                    ]
                 });
                 const order = orders.shift();
                 if (order === undefined) {

package/lib/chevre/service/transaction/returnOrder/preStart.js

@@ -119,7 +119,7 @@ function fixOrders(params) {
             throw new factory.errors.Argument('object.order', 'number of orders must be 1');
         }
         // 注文数を1に限定であれば、findByConfirmationNumberに変更できる(2022-04-28~)
-        const orders = yield repos.order.search({
+        const orders = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             project: { id: { $eq: params.project.id } },
@@ -128,10 +128,10 @@ function fixOrders(params) {
         }, 
         // positive projectionで検索(2023-12-08~)
         {
-            inclusion: {
-                confirmationNumber: 1, dateReturned: 1, orderDate: 1, orderNumber: 1, orderStatus: 1,
-                paymentMethods: 1, price: 1, project: 1, seller: 1, typeOf: 1
-            }
+            inclusion: [
+                'confirmationNumber', 'dateReturned', 'orderDate', 'orderNumber', 'orderStatus',
+                'paymentMethods', 'price', 'project', 'seller', 'typeOf'
+            ]
         }
         // {
         //     // acceptedOffers: 0, // カスタム返品ポリシーに必要

package/lib/chevre/service/transaction/returnOrder.js

@@ -101,17 +101,17 @@ function confirm(params) {
         if (transaction.object.order.length !== 1) {
             throw new factory.errors.Argument('object.order', 'number of orders must be 1');
         }
-        const returningOrders = yield repos.order.search({
+        const returningOrders = yield repos.order.projectFields({
             limit: 1,
             page: 1,
             project: { id: { $eq: transaction.project.id } },
             confirmationNumbers: [transaction.object.order[0].confirmationNumber],
             orderNumbers: [transaction.object.order[0].orderNumber]
         }, {
-            inclusion: {
-                confirmationNumber: 1, customer: 1, identifier: 1, orderDate: 1, orderNumber: 1, orderStatus: 1,
-                orderedItem: 1, paymentMethods: 1, price: 1, priceCurrency: 1, project: 1, seller: 1, typeOf: 1
-            }
+            inclusion: [
+                'confirmationNumber', 'customer', 'identifier', 'orderDate', 'orderNumber', 'orderStatus',
+                'orderedItem', 'paymentMethods', 'price', 'priceCurrency', 'project', 'seller', 'typeOf'
+            ]
         });
         // デフォルトEメールメッセージを検索
         let emailMessageOnOrderReturned;

package/package.json

@@ -110,5 +110,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "22.1.0-alpha.2"
+  "version": "22.1.0-alpha.3"
 }