@chevre/domain 22.0.0 → 22.1.0-alpha.0

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

@@ -25,7 +25,7 @@
 import type { Connection, FilterQuery } from 'mongoose';
 import * as factory from '../factory';
 type IOrderWithoutAcceptedOffers = factory.order.IOrder;
-type IKeyOfProjection = keyof IOrderWithoutAcceptedOffers | '_id';
+type IKeyOfProjection = Extract<keyof IOrderWithoutAcceptedOffers, 'broker' | 'confirmationNumber' | 'customer' | 'dateReturned' | 'identifier' | 'name' | 'orderDate' | 'orderNumber' | 'orderStatus' | 'orderedItem' | 'paymentMethods' | 'previousOrderStatus' | 'price' | 'priceCurrency' | 'project' | 'returner' | 'seller' | 'typeOf' | 'url'> | 'paymentMethods.accountId' | 'paymentMethods.name' | 'paymentMethods.paymentMethod' | 'paymentMethods.paymentMethodId' | 'paymentMethods.totalPaymentDue' | 'paymentMethods.additionalProperty' | 'paymentMethods.issuedThrough';
 export type IReturnedOrder = Pick<IOrderWithoutAcceptedOffers, 'project' | 'typeOf' | 'orderNumber' | 'dateReturned' | 'id' | 'customer' | 'returner' | 'seller' | 'price' | 'priceCurrency' | 'orderDate'> & {
     id: string;
 };
@@ -155,6 +155,9 @@ export declare class OrderRepo {
         inclusion: {
             [key in IKeyOfProjection]?: 1;
         };
+        /**
+         * @deprecated use inclusion
+         */
         exclusion: {
             [key in IKeyOfProjection]?: 0;
         };

package/lib/chevre/repo/order.js

@@ -14,6 +14,15 @@ const factory = require("../factory");
 const order_1 = require("./mongoose/schemas/order");
 const errorHandler_1 = require("../errorHandler");
 const settings_1 = require("../settings");
+/**
+ * ドキュメント検索時に指定可能なprojectionフィールドを厳密に定義する
+ */
+const AVAILABLE_PROJECT_FIELDS = [
+    'broker', 'confirmationNumber', 'customer', 'dateReturned', 'identifier', 'name', 'orderDate', 'orderNumber', 'orderStatus', 'orderedItem',
+    'paymentMethods', 'previousOrderStatus', 'price', 'priceCurrency', 'project', 'returner', 'seller', 'typeOf', 'url',
+    'paymentMethods.accountId', 'paymentMethods.additionalProperty', 'paymentMethods.issuedThrough', 'paymentMethods.name', 'paymentMethods.paymentMethod',
+    'paymentMethods.paymentMethodId', 'paymentMethods.totalPaymentDue'
+];
 /**
  * 注文リポジトリ
  */
@@ -31,22 +40,6 @@ class OrderRepo {
         if (typeof projectIdEq === 'string') {
             andConditions.push({ 'project.id': { $eq: projectIdEq } });
         }
-        // const additionalPropertyAll = params.additionalProperty?.$all; // 廃止(2024-04-12~)
-        // if (Array.isArray(additionalPropertyAll)) {
-        //     andConditions.push({ additionalProperty: { $exists: true, $all: additionalPropertyAll } });
-        // }
-        // const additionalPropertyIn = params.additionalProperty?.$in; // 廃止(2024-04-12~)
-        // if (Array.isArray(additionalPropertyIn)) {
-        //     andConditions.push({ additionalProperty: { $exists: true, $in: additionalPropertyIn } });
-        // }
-        // const additionalPropertyNin = params.additionalProperty?.$nin; // 廃止(2024-04-12~)
-        // if (Array.isArray(additionalPropertyNin)) {
-        //     andConditions.push({ additionalProperty: { $nin: additionalPropertyNin } });
-        // }
-        // const additionalPropertyElemMatch = params.additionalProperty?.$elemMatch; // 廃止(2024-04-12~)
-        // if (additionalPropertyElemMatch !== undefined && additionalPropertyElemMatch !== null) {
-        //     andConditions.push({ additionalProperty: { $exists: true, $elemMatch: additionalPropertyElemMatch } });
-        // }
         // tslint:disable-next-line:no-single-line-block-comment
         /* istanbul ignore else */
         if (params.identifier !== undefined) {
@@ -83,10 +76,6 @@ class OrderRepo {
         if (Array.isArray(sellerIds)) {
             andConditions.push({ 'seller.id': { $exists: true, $in: sellerIds } });
         }
-        // 不要なので廃止(2023-09-11~)
-        // if (typeof params.seller?.typeOf === 'string') {
-        //     andConditions.push({ 'seller.typeOf': { $exists: true, $eq: params.seller.typeOf } });
-        // }
         const brokerIdEq = (_j = (_h = params.broker) === null || _h === void 0 ? void 0 : _h.id) === null || _j === void 0 ? void 0 : _j.$eq;
         if (typeof brokerIdEq === 'string') {
             andConditions.push({
@@ -768,26 +757,33 @@ class OrderRepo {
      */
     returnOrder(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { dateReturned, returner, orderNumber, project } = params;
             const doc = yield this.orderModel.findOneAndUpdate({
-                orderNumber: { $eq: params.orderNumber },
+                orderNumber: { $eq: orderNumber },
                 orderStatus: { $eq: factory.orderStatus.OrderDelivered },
-                'project.id': { $eq: params.project.id },
+                'project.id': { $eq: project.id },
                 typeOf: { $eq: factory.order.OrderType.Order }
             }, {
-                previousOrderStatus: factory.orderStatus.OrderDelivered,
-                orderStatus: factory.orderStatus.OrderReturned,
-                dateReturned: params.dateReturned,
-                returner: params.returner
+                $set: {
+                    previousOrderStatus: factory.orderStatus.OrderDelivered,
+                    orderStatus: factory.orderStatus.OrderReturned,
+                    dateReturned,
+                    returner
+                }
             }, {
                 new: true,
                 projection: {
-                    _id: 1, project: 1, typeOf: 1, orderNumber: 1, dateReturned: 1,
+                    _id: 0,
+                    id: { $toString: '$_id' },
+                    // _id: 1,
+                    project: 1, typeOf: 1, orderNumber: 1, dateReturned: 1,
                     customer: 1, returner: 1, seller: 1, price: 1, priceCurrency: 1, orderDate: 1 // optimize(2023-12-07~)
                     // __v: 0,
                     // createdAt: 0,
                     // updatedAt: 0
                 }
             })
+                .lean() // lean(2024-07-30~)
                 .exec();
             // NotFoundであれば状態確認
             if (doc === null) {
@@ -795,7 +791,7 @@ class OrderRepo {
                     orderNumber: params.orderNumber,
                     project: { id: params.project.id },
                     inclusion: [
-                        'project', 'typeOf', 'orderNumber', 'dateReturned', 'id',
+                        'project', 'typeOf', 'orderNumber', 'dateReturned',
                         'customer', 'returner', 'seller', 'price', 'priceCurrency', 'orderDate'
                     ]
                 });
@@ -811,7 +807,8 @@ class OrderRepo {
                     throw new factory.errors.Argument('orderNumber', `Order ${order.orderNumber} already changed -> ${order.orderStatus}`);
                 }
             }
-            return doc.toObject();
+            return doc;
+            // return doc.toObject();
         });
     }
     /**
@@ -820,19 +817,21 @@ class OrderRepo {
     updateChangeableAttributes(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const updatedAt = new Date();
+            const { orderNumber, project, name } = params;
             const doc = yield this.orderModel.findOneAndUpdate({
-                orderNumber: { $eq: params.orderNumber },
-                'project.id': { $eq: params.project.id },
+                orderNumber: { $eq: orderNumber },
+                'project.id': { $eq: project.id },
                 typeOf: { $eq: factory.order.OrderType.Order }
             }, {
-                $set: Object.assign({}, (typeof params.name === 'string') ? { name: params.name } : undefined)
+                $set: Object.assign({}, (typeof name === 'string') ? { name } : undefined)
             }, {
-                new: true,
+                new: false,
                 projection: {
                     _id: 1
                     // updatedAt: 1 // discontinue(2024-06-17~)
                 }
             })
+                .lean() // lean(2024-07-30~)
                 .exec();
             if (doc === null) {
                 throw new factory.errors.NotFound(this.orderModel.modelName);
@@ -864,6 +863,7 @@ class OrderRepo {
                     _id: 1
                 }
             })
+                .lean() // lean(2024-07-30~)
                 .exec();
             if (doc === null) {
                 throw new factory.errors.NotFound(this.orderModel.modelName);
@@ -879,7 +879,10 @@ class OrderRepo {
             };
             if (Array.isArray(params.inclusion) && params.inclusion.length > 0) {
                 params.inclusion.forEach((field) => {
-                    if (String(field) !== 'acceptedOffers' && field !== '_id' && field !== 'id') {
+                    // if (String(field) !== 'acceptedOffers' && field !== '_id' && field !== 'id') {
+                    //     projection[field] = 1;
+                    // }
+                    if (AVAILABLE_PROJECT_FIELDS.includes(field)) {
                         projection[field] = 1;
                     }
                 });
@@ -887,12 +890,6 @@ class OrderRepo {
             else {
                 // discontinue(2024-07-25~)
                 throw new factory.errors.ArgumentNull('inclusion', 'inclusion must be specified');
-                // projection = {
-                //     __v: 0,
-                //     createdAt: 0,
-                //     updatedAt: 0,
-                //     acceptedOffers: 0
-                // };
             }
             const doc = yield this.orderModel.findOne({
                 _id: { $eq: params.id },
@@ -920,7 +917,10 @@ class OrderRepo {
             };
             if (Array.isArray(params.inclusion) && params.inclusion.length > 0) {
                 params.inclusion.forEach((field) => {
-                    if (String(field) !== 'acceptedOffers' && field !== '_id' && field !== 'id') {
+                    // if (String(field) !== 'acceptedOffers' && field !== '_id' && field !== 'id') {
+                    //     projection[field] = 1;
+                    // }
+                    if (AVAILABLE_PROJECT_FIELDS.includes(field)) {
                         projection[field] = 1;
                     }
                 });
@@ -928,12 +928,6 @@ class OrderRepo {
             else {
                 // discontinue(2024-07-25~)
                 throw new factory.errors.ArgumentNull('inclusion', 'inclusion must be specified');
-                // projection = {
-                //     __v: 0,
-                //     createdAt: 0,
-                //     updatedAt: 0,
-                //     acceptedOffers: 0 // defaultで除外(2023-12-08~)
-                // };
             }
             const doc = yield this.orderModel.findOne({
                 orderNumber: { $eq: params.orderNumber },
@@ -1008,10 +1002,14 @@ class OrderRepo {
             let projectStage = {};
             const positiveProjectionFields = (inclusion !== undefined && inclusion !== null)
                 ? Object.keys(inclusion)
-                    .filter((key) => inclusion[key] === 1
-                    && key !== 'acceptedOffers' // defaultで隠蔽(2023-12-06~)
-                    && key !== '_id'
-                    && key !== 'id')
+                    .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);
+                })
                 : [];
             if (Array.isArray(positiveProjectionFields) && positiveProjectionFields.length > 0) {
                 useInclusionProjection = true;

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

@@ -30,7 +30,7 @@ function returnOrder(params) {
             orderNumber,
             project: { id: params.project.id },
             inclusion: [
-                'project', 'typeOf', 'orderNumber', 'dateReturned', 'id',
+                'project', 'typeOf', 'orderNumber', 'dateReturned',
                 'customer', 'returner', 'seller', 'price', 'priceCurrency', 'orderDate', 'orderStatus'
             ]
         });

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

@@ -51,7 +51,7 @@ function sendOrder(params) {
             let order = yield repos.order.projectFieldsByOrderNumber({
                 orderNumber,
                 project: { id: params.project.id },
-                inclusion: ['confirmationNumber', 'project', 'typeOf', 'seller', 'orderNumber', 'price', 'priceCurrency', 'orderDate', 'customer', '_id']
+                inclusion: ['confirmationNumber', 'project', 'typeOf', 'seller', 'orderNumber', 'price', 'priceCurrency', 'orderDate', 'customer']
             });
             // プロジェクト条件検証
             if (order.project.id !== params.project.id) {

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.0.0"
+  "version": "22.1.0-alpha.0"
 }