@chevre/domain 23.2.0-alpha.42 → 23.2.0-alpha.43

package/example/src/chevre/orderNumber/testRandomness.ts

@@ -0,0 +1,48 @@
+// tslint:disable:object-literal-key-quotes no-console
+import * as mongoose from 'mongoose';
+
+import { chevre } from '../../../../lib/index';
+
+async function testGeneration() {
+    await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
+
+    const orderNumberRepo = await chevre.repository.OrderNumber.createInstance({
+        connection: mongoose.connection
+    });
+
+    const ts = new Date(); // 同一ミリ秒固定
+    const results: Record<string, string>[] = [];
+
+    console.log(`--- 同一ミリ秒(${ts})内での連続生成テスト ---`);
+
+    // tslint:disable-next-line:no-magic-numbers
+    for (let i = 0; i < 100; i += 1) {
+        // 同一ミリ秒内でシーケンス(00-99)だけが変わる状況を再現
+        const orderNumber = await orderNumberRepo.publishByTimestamp({
+            project: { alternateName: 'CIN' },
+            orderDate: ts
+
+        });
+
+        // 復号して元のデータに戻るかチェック
+        const decoded = await orderNumberRepo.decrypt(orderNumber);
+        const isSuccess = decoded === `${ts.valueOf()}${(i + 1).toString()
+            // tslint:disable-next-line:no-magic-numbers
+            .padStart(2, '0')}`;
+
+        results.push({
+            timestamp: ts.valueOf()
+                .toString(),
+            'シーケンス': (i + 1).toString(),
+            '生成された番号 (17桁)': orderNumber,
+            // tslint:disable-next-line:no-magic-numbers
+            'ソルト(2文字目)': orderNumber[2],
+            '復号結果': decoded,
+            '復号確認': isSuccess ? '✅OK' : '❌NG'
+        });
+    }
+
+    console.table(results);
+}
+
+testGeneration();

package/example/src/chevre/reIndex.ts

@@ -11,7 +11,7 @@ mongoose.Model.on('index', (...args) => {
 async function main() {
     await mongoose.connect(<string>process.env.MONGOLAB_URI, { autoIndex: false });
 
-    await chevre.repository.EventSeries.createInstance(mongoose.connection);
+    await chevre.repository.OfferCatalogItem.createInstance(mongoose.connection);
     console.log('success!');
 }
 

package/example/src/chevre/transactionNumber/publishByTimestamp.ts

@@ -1,8 +1,5 @@
 // tslint:disable:no-console
 import * as mongoose from 'mongoose';
-import * as fpe2Module from 'node-fpe-v2';
-
-const fpe2 = (fpe2Module as unknown) as typeof fpe2Module.default;
 
 import { chevre } from '../../../../lib/index';
 
@@ -17,14 +14,6 @@ async function main() {
     const result = await transactionNumberRepo.publishByTimestamp({ startDate: new Date() });
     console.log(result);
     console.log('length:', result.transactionNumber.length);
-
-    const decryptResult = fpe2({ secret: String(result.secret) })
-        // tslint:disable-next-line:no-magic-numbers
-        .decrypt(result.transactionNumber.slice(2));
-    console.log(decryptResult);
-    console.log(decryptResult === `${result.timestamp}${result.incrReply.toString()
-        // tslint:disable-next-line:no-magic-numbers
-        .padStart(2, '0')}`);
 }
 
 main()

package/lib/chevre/factory/transactionNumber.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 取引番号ファクトリー
+ */
+export declare class TransactionNumberFactory {
+    private readonly fpeSecret;
+    private readonly version;
+    constructor(params: {
+        fpeSecret: string;
+        version: string;
+    });
+    /**
+     * 生成: SEQが100を超えると自動で18桁に拡張
+     */
+    generate(timestamp: string, seq: number): string;
+    /**
+     * 復号: 17桁でも18桁でも、2文字目以降をまるごとデコード
+     */
+    decrypt(transactionNumber: string): string;
+}

package/lib/chevre/factory/transactionNumber.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionNumberFactory = void 0;
+const crypto_1 = require("crypto");
+const fpe2Module = require("node-fpe-v2");
+const factory = require("../factory");
+// 型定義が新しいtypescriptに適合しないので、強制的に型変更
+const fpe2 = fpe2Module;
+const TRANSACTION_NUMBER_MIN_LENGTH = 17;
+const SEQUENCE_MAX_LENGTH = 2;
+/**
+ * 取引番号ファクトリー
+ */
+class TransactionNumberFactory {
+    constructor(params) {
+        const { fpeSecret, version } = params;
+        this.fpeSecret = fpeSecret;
+        this.version = version;
+    }
+    /**
+     * 生成: SEQが100を超えると自動で18桁に拡張
+     */
+    generate(timestamp, seq) {
+        // tslint:disable-next-line:no-magic-numbers
+        const saltDigit = (0, crypto_1.randomInt)(0, 10);
+        const saltStr = saltDigit.toString();
+        const cipher = fpe2({ secret: `${this.fpeSecret}${saltStr}` });
+        // incrReplyが 0〜99 なら "00"〜"99" になり（15桁）
+        // incrReplyが 100〜999 なら "100"〜"999" になる（16桁）
+        const zeroPaddingSequence = seq.toString()
+            .padStart(SEQUENCE_MAX_LENGTH, '0');
+        const rawBody = `${timestamp}${zeroPaddingSequence}`;
+        const encryptedBody = cipher.encrypt(rawBody);
+        // ソルトを「あえて」2文字目に含める
+        const transactionNumber = `${this.version}${saltStr}${encryptedBody}`;
+        if (transactionNumber.length < TRANSACTION_NUMBER_MIN_LENGTH) {
+            throw new factory.errors.Internal(`transactionNumber length should be >= ${TRANSACTION_NUMBER_MIN_LENGTH}`);
+        }
+        return transactionNumber;
+    }
+    /**
+     * 復号: 17桁でも18桁でも、2文字目以降をまるごとデコード
+     */
+    decrypt(transactionNumber) {
+        const saltStr = transactionNumber[1]; // 2文字目からソルト（鍵のヒント）を回収
+        // tslint:disable-next-line:no-magic-numbers
+        const encryptedBody = transactionNumber.slice(2);
+        const cipher = fpe2({
+            secret: `${this.fpeSecret}${saltStr}`
+        });
+        return cipher.decrypt(encryptedBody);
+    }
+}
+exports.TransactionNumberFactory = TransactionNumberFactory;

package/lib/chevre/repo/mongoose/schemas/offerCatalog.js

@@ -8,7 +8,7 @@ const settings_1 = require("../../../settings");
 const modelName = 'OfferCatalog';
 exports.modelName = modelName;
 const schemaDefinition = {
-    project: mongoose_1.SchemaTypes.Mixed,
+    project: { type: mongoose_1.SchemaTypes.Mixed, required: true },
     _id: String,
     identifier: {
         type: String,
@@ -22,7 +22,7 @@ const schemaDefinition = {
         required: true
     },
     itemListElement: [mongoose_1.SchemaTypes.Mixed],
-    itemOffered: mongoose_1.SchemaTypes.Mixed,
+    itemOffered: { type: mongoose_1.SchemaTypes.Mixed, required: true },
     additionalProperty: [mongoose_1.SchemaTypes.Mixed],
     dateSynced: Date // 追加(2023-09-13~)
     // createdAt: SchemaTypes.Mixed,
@@ -60,12 +60,6 @@ const indexes = [
             name: 'searchByIdentifier'
         }
     ],
-    [
-        { 'project.id': 1, identifier: 1 },
-        {
-            name: 'searchByProjectId-v20220721'
-        }
-    ],
     [
         { 'itemListElement.typeOf': 1, identifier: 1 },
         {

package/lib/chevre/repo/mongoose/schemas/offerCatalogItem.js

@@ -8,7 +8,7 @@ const settings_1 = require("../../../settings");
 const modelName = 'OfferCatalogItem';
 exports.modelName = modelName;
 const schemaDefinition = {
-    project: mongoose_1.SchemaTypes.Mixed,
+    project: { type: mongoose_1.SchemaTypes.Mixed, required: true },
     identifier: {
         type: String,
         required: true
@@ -21,7 +21,7 @@ const schemaDefinition = {
         required: true
     },
     itemListElement: [mongoose_1.SchemaTypes.Mixed],
-    itemOffered: mongoose_1.SchemaTypes.Mixed,
+    itemOffered: { type: mongoose_1.SchemaTypes.Mixed, required: true },
     additionalProperty: [mongoose_1.SchemaTypes.Mixed],
     dateSynced: Date,
     relatedOffer: mongoose_1.SchemaTypes.Mixed
@@ -61,6 +61,32 @@ const indexes = [
             unique: true,
             name: 'uniqueIdentifier'
         }
+    ],
+    [
+        { identifier: 1 },
+        { name: 'identifier' }
+    ],
+    [
+        { 'itemOffered.typeOf': 1, identifier: 1 },
+        { name: 'itemOfferedTypeOf' }
+    ],
+    [
+        { 'itemListElement.typeOf': 1, identifier: 1 },
+        {
+            name: 'itemListElementTypeOf',
+            partialFilterExpression: {
+                'itemListElement.typeOf': { $exists: true }
+            }
+        }
+    ],
+    [
+        { 'itemListElement.id': 1, identifier: 1 },
+        {
+            name: 'itemListElementId',
+            partialFilterExpression: {
+                'itemListElement.id': { $exists: true }
+            }
+        }
     ]
 ];
 exports.indexes = indexes;

package/lib/chevre/repo/mongoose/schemas/setting.d.ts

@@ -110,6 +110,16 @@ export interface IJWTSetting {
      */
     algorithm: Algorithm;
 }
+export interface IOrderNumberSetting {
+    /**
+     * fpe暗号鍵
+     */
+    fpeSecret: string;
+    /**
+     * "1"
+     */
+    version: string;
+}
 export interface ITransactionNumberSetting {
     /**
      * fpe暗号鍵
@@ -131,6 +141,7 @@ export interface ISetting {
         informResource?: factory.project.IInformParams[];
     };
     onTransactionStatusChanged?: IOnTransactionStatusChanged;
+    orderNumber?: IOrderNumberSetting;
     project: {
         id: string;
         typeOf: factory.organizationType.Project;

package/lib/chevre/repo/mongoose/schemas/setting.js

@@ -17,6 +17,7 @@ const schemaDefinition = {
     onTaskStatusChanged: mongoose_1.SchemaTypes.Mixed,
     onResourceUpdated: mongoose_1.SchemaTypes.Mixed,
     onTransactionStatusChanged: mongoose_1.SchemaTypes.Mixed,
+    orderNumber: mongoose_1.SchemaTypes.Mixed,
     quota: mongoose_1.SchemaTypes.Mixed,
     storage: mongoose_1.SchemaTypes.Mixed,
     transactionNumber: mongoose_1.SchemaTypes.Mixed,

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

@@ -4,6 +4,7 @@ import type { Connection } from 'mongoose';
  */
 export declare class OrderNumberRepo {
     private readonly counterRepo;
+    private readonly settingModel;
     constructor(params: {
         connection: Connection;
     });
@@ -19,4 +20,6 @@ export declare class OrderNumberRepo {
          */
         orderDate: Date;
     }): Promise<string>;
+    decrypt(id: string): Promise<string>;
+    private findSetting;
 }

package/lib/chevre/repo/orderNumber.js

@@ -16,7 +16,10 @@ const moment = require("moment-timezone");
 // tslint:disable-next-line:no-require-imports no-var-requires
 const fpe = require('node-fpe-v1');
 // import { createSchema as createSettingSchema, modelName as settingModelName } from './mongoose/schemas/setting';
-const transactionNumber_1 = require("./mongoose/schemas/transactionNumber");
+const factory = require("../factory");
+const transactionNumber_1 = require("../factory/transactionNumber");
+const setting_1 = require("./mongoose/schemas/setting");
+const transactionNumber_2 = require("./mongoose/schemas/transactionNumber");
 const transactionNumberCounter_1 = require("./transactionNumberCounter");
 const ORDER_NUMBER_SEPARATOR = '-';
 /**
@@ -27,6 +30,7 @@ class OrderNumberRepo {
         // const { connection } = params;
         // this.settingModel = connection.model(settingModelName, createSettingSchema());
         this.counterRepo = new transactionNumberCounter_1.TransactionNumberCounterRepo(params);
+        this.settingModel = params.connection.model(setting_1.modelName, (0, setting_1.createSchema)());
     }
     // private static createKey(params: {
     //     orderDate: Date;
@@ -45,6 +49,7 @@ class OrderNumberRepo {
      */
     publishByTimestamp(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { fpeSecret, version } = yield this.findSetting();
             const timestamp = moment(params.orderDate)
                 .valueOf()
                 .toString();
@@ -59,25 +64,79 @@ class OrderNumberRepo {
                 .toDate();
             incrReply = yield this.counterRepo.incrementByMongo({
                 identifier: dataFeedIdentifier,
-                includedInDataCatalog: { identifier: transactionNumber_1.DataCatalogIdentifier.orderNumber },
+                includedInDataCatalog: { identifier: transactionNumber_2.DataCatalogIdentifier.orderNumber },
                 expires: dataFeedExpires
             });
-            let orderNumber = `${timestamp}${incrReply}`;
-            // checkdigit
-            const cd = cdigit.luhn.compute(orderNumber);
-            orderNumber = fpe({ password: cd })
-                .encrypt(orderNumber);
-            orderNumber = `${projectPrefix}${cd}${orderNumber}`;
-            orderNumber = `${[
-                // tslint:disable-next-line:no-magic-numbers
-                orderNumber.slice(0, 4),
-                // tslint:disable-next-line:no-magic-numbers
-                orderNumber.slice(4, 11),
-                // tslint:disable-next-line:no-magic-numbers
-                orderNumber.slice(11)
-            ].join(ORDER_NUMBER_SEPARATOR)}`;
+            let orderNumber;
+            if (typeof fpeSecret === 'string' && typeof version === 'string') {
+                const transactionFactory = new transactionNumber_1.TransactionNumberFactory({ fpeSecret, version });
+                orderNumber = transactionFactory.generate(timestamp, incrReply);
+                orderNumber = `${projectPrefix.at(0)}${orderNumber}`;
+                orderNumber = `${[
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(0, 4),
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(4, 11),
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(11)
+                ].join(ORDER_NUMBER_SEPARATOR)}`;
+            }
+            else {
+                orderNumber = `${timestamp}${incrReply}`;
+                // checkdigit
+                const cd = cdigit.luhn.compute(orderNumber);
+                orderNumber = fpe({ password: cd })
+                    .encrypt(orderNumber);
+                orderNumber = `${projectPrefix}${cd}${orderNumber}`;
+                orderNumber = `${[
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(0, 4),
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(4, 11),
+                    // tslint:disable-next-line:no-magic-numbers
+                    orderNumber.slice(11)
+                ].join(ORDER_NUMBER_SEPARATOR)}`;
+            }
             return orderNumber;
         });
     }
+    decrypt(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { fpeSecret, version } = yield this.findSetting();
+            if (typeof fpeSecret === 'string' && typeof version === 'string') {
+                const transactionFactory = new transactionNumber_1.TransactionNumberFactory({ fpeSecret, version });
+                const originalOrderNumber = id.replace(/-/g, '')
+                    // tslint:disable-next-line:no-magic-numbers
+                    .slice(1);
+                return transactionFactory.decrypt(originalOrderNumber);
+            }
+            else {
+                throw new factory.errors.NotImplemented('no version not implemented');
+            }
+        });
+    }
+    findSetting() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filterQuery = { 'project.id': { $eq: '*' } };
+            const projection = {
+                _id: 0,
+                orderNumber: 1
+            };
+            const setting = yield this.settingModel.findOne(filterQuery, projection)
+                .lean()
+                .exec();
+            if (setting === null || setting.orderNumber === undefined) {
+                return {};
+            }
+            const { fpeSecret, version } = setting.orderNumber;
+            if (typeof fpeSecret !== 'string' || fpeSecret === '') {
+                throw new factory.errors.NotFound('setting.orderNumber.secret');
+            }
+            if (typeof version !== 'string' || version === '') {
+                throw new factory.errors.NotFound('setting.orderNumber.version');
+            }
+            return { fpeSecret, version };
+        });
+    }
 }
 exports.OrderNumberRepo = OrderNumberRepo;

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

@@ -3,7 +3,6 @@ interface IPublishResult {
     transactionNumber: string;
     timestamp: string;
     incrReply: number;
-    secret?: string;
 }
 /**
  * 取引番号リポジトリ

package/lib/chevre/repo/transactionNumber.js

@@ -11,16 +11,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionNumberRepo = void 0;
 const cdigit = require("cdigit");
-const crypto_1 = require("crypto");
 const moment = require("moment-timezone");
-const fpe2Module = require("node-fpe-v2");
-// 型定義が新しいtypescriptに適合しないので、強制的に型変更
-const fpe2 = fpe2Module;
 // tslint:disable-next-line:no-require-imports no-var-requires
 const fpe1 = require('node-fpe-v1');
 const factory = require("../factory");
+const transactionNumber_1 = require("../factory/transactionNumber");
 const setting_1 = require("./mongoose/schemas/setting");
-const transactionNumber_1 = require("./mongoose/schemas/transactionNumber");
+const transactionNumber_2 = require("./mongoose/schemas/transactionNumber");
 const transactionNumberCounter_1 = require("./transactionNumberCounter");
 /**
  * 取引番号リポジトリ
@@ -48,25 +45,27 @@ class TransactionNumberRepo {
                 .toDate();
             incrReply = yield this.counterRepo.incrementByMongo({
                 identifier: dataFeedIdentifier,
-                includedInDataCatalog: { identifier: transactionNumber_1.DataCatalogIdentifier.transactionNumber },
+                includedInDataCatalog: { identifier: transactionNumber_2.DataCatalogIdentifier.transactionNumber },
                 expires: dataFeedExpires
             });
             let transactionNumber;
-            let secret;
+            // let secret: string | undefined;
             if (typeof fpeSecret === 'string' && typeof version === 'string') {
-                // tslint:disable-next-line:no-magic-numbers
-                const saltDigit = (0, crypto_1.randomInt)(0, 10);
-                const saltStr = saltDigit.toString();
-                secret = `${fpeSecret}${saltStr}`;
-                const cipher = fpe2({ secret });
-                // incrReplyが 0〜99 なら "00"〜"99" になり（15桁）
-                // incrReplyが 100〜999 なら "100"〜"999" になる（16桁）
-                const rawBody = `${timestamp}${incrReply.toString()
-                    // tslint:disable-next-line:no-magic-numbers
-                    .padStart(2, '0')}`;
-                const encryptedBody = cipher.encrypt(rawBody);
-                // ソルトを「あえて」2文字目に含める
-                transactionNumber = `${version}${saltStr}${encryptedBody}`;
+                const transactionFactory = new transactionNumber_1.TransactionNumberFactory({ fpeSecret, version });
+                transactionNumber = transactionFactory.generate(timestamp, incrReply);
+                // // tslint:disable-next-line:no-magic-numbers
+                // const saltDigit = randomInt(0, 10);
+                // const saltStr = saltDigit.toString();
+                // secret = `${fpeSecret}${saltStr}`;
+                // const cipher = fpe2({ secret });
+                // // incrReplyが 0〜99 なら "00"〜"99" になり（15桁）
+                // // incrReplyが 100〜999 なら "100"〜"999" になる（16桁）
+                // const rawBody = `${timestamp}${incrReply.toString()
+                //     // tslint:disable-next-line:no-magic-numbers
+                //     .padStart(2, '0')}`;
+                // const encryptedBody = cipher.encrypt(rawBody);
+                // // ソルトを「あえて」2文字目に含める
+                // transactionNumber = `${version}${saltStr}${encryptedBody}`;
             }
             else {
                 transactionNumber = `${timestamp}${incrReply}`;
@@ -76,19 +75,19 @@ class TransactionNumberRepo {
                     .encrypt(transactionNumber);
                 transactionNumber = `${cd}${transactionNumber}`;
             }
-            return { transactionNumber, timestamp, incrReply, secret };
+            return { transactionNumber, timestamp, incrReply };
         });
     }
     decrypt(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { fpeSecret } = yield this.findSetting();
-            const saltStr = id[1]; // 2文字目からソルト（鍵のヒント）を回収
-            // tslint:disable-next-line:no-magic-numbers
-            const encryptedBody = id.slice(2);
-            const cipher = fpe2({
-                secret: `${fpeSecret}${saltStr}`
-            });
-            return cipher.decrypt(encryptedBody);
+            const { fpeSecret, version } = yield this.findSetting();
+            if (typeof fpeSecret === 'string' && typeof version === 'string') {
+                const transactionFactory = new transactionNumber_1.TransactionNumberFactory({ fpeSecret, version });
+                return transactionFactory.decrypt(id);
+            }
+            else {
+                throw new factory.errors.NotImplemented('no version not implemented');
+            }
         });
     }
     findSetting() {

package/package.json

@@ -117,5 +117,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "23.2.0-alpha.42"
+  "version": "23.2.0-alpha.43"
 }