feat: add required serialnumberpattern

migrations/20211212200953-fulltext-search.cjs

@@ -39,7 +39,7 @@ module.exports = {
           countryJurisdictionOfOwner,
           inCountryJurisdictionOfOwner,
           serialNumberBlock,
-          customSerialNumberPattern,
+          serialNumberPattern,
           unitIdentifier,
           unitType,
           intendedBuyerOrgUid,

migrations/20211219184405-sqlite-triggers-units.cjs

@@ -12,7 +12,7 @@ module.exports = {
           countryJurisdictionOfOwner,
           inCountryJurisdictionOfOwner,
           serialNumberBlock,
-          customSerialNumberPattern,
+          serialNumberPattern,
           unitIdentifier,
           unitType,
           intendedBuyerOrgUid,
@@ -36,7 +36,7 @@ module.exports = {
           new.countryJurisdictionOfOwner,
           new.inCountryJurisdictionOfOwner,
           new.serialNumberBlock,
-          new.customSerialNumberPattern,
+          new.serialNumberPattern,
           new.unitIdentifier,
           new.unitType,
           new.intendedBuyerOrgUid,
@@ -72,7 +72,7 @@ module.exports = {
           countryJurisdictionOfOwner,
           inCountryJurisdictionOfOwner,
           serialNumberBlock,
-          customSerialNumberPattern,
+          serialNumberPattern,
           unitIdentifier,
           unitType,
           intendedBuyerOrgUid,
@@ -96,7 +96,7 @@ module.exports = {
           new.countryJurisdictionOfOwner,
           new.inCountryJurisdictionOfOwner,
           new.serialNumberBlock,
-          new.customSerialNumberPattern,
+          new.serialNumberPattern,
           new.unitIdentifier,
           new.unitType,
           new.intendedBuyerOrgUid,

package.json

@@ -36,7 +36,6 @@
     "socket.io": "^4.4.0",
     "socket.io-client": "^4.4.0",
     "sqlite3": "4.1.1",
-    "updeep": "^1.2.1",
     "uuidv4": "^6.2.12"
   },
   "devDependencies": {

src/controllers/units.controller.js

@@ -221,6 +221,7 @@ export const split = async (req, res) => {
 
     const { unitBlockStart } = assertSumOfSplitUnitsIsValid(
       originalRecord.serialNumberBlock,
+      new RegExp(originalRecord.serialNumberPattern),
       req.body.records,
     );
 

src/fullnode/index.js

@@ -1 +1 @@
-export * from './fullnode';
+export * from './dispatcher';

src/models/units/units.modeltypes.cjs

@@ -15,7 +15,10 @@ module.exports = {
   countryJurisdictionOfOwner: Sequelize.STRING,
   inCountryJurisdictionOfOwner: Sequelize.STRING,
   serialNumberBlock: Sequelize.STRING,
-  customSerialNumberPattern: Sequelize.STRING,
+  serialNumberPattern: {
+    type: Sequelize.STRING,
+    defaultValue: '[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$',
+  },
   unitIdentifier: Sequelize.STRING,
   unitType: Sequelize.STRING,
   intendedBuyerOrgUid: Sequelize.STRING,

src/models/units/units.stub.json

@@ -5,6 +5,7 @@
     "unitOwnerOrgUid": "f1c54511-865e-4611-976c-7c3c1f704662",
     "countryJurisdictionOfOwner": "USA",
     "serialNumberBlock": "AXJJFSLGHSHEJ1000-AXJJFSLGHSHEJ1010",
+    "serialNumberPattern": "[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$",
     "unitIdentifier": "XYZ",
     "unitType": "heard reduction",
     "intendedBuyerOrgUid": "70150fde-57f6-44a6-9486-1fef49528475",
@@ -30,6 +31,7 @@
     "unitOwnerOrgUid": "f1c54511-865e-4611-976c-7c3c1f704662",
     "countryJurisdictionOfOwner": "USA",
     "serialNumberBlock": "AXJJFSLGHSHEJ2000-AXJJFSLGHSHEJ2010",
+    "serialNumberPattern": "[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$",
     "unitIdentifier": "XYZ",
     "unitType": "heard reduction",
     "intendedBuyerOrgUid": "70150fde-57f6-44a6-9486-1fef49528475",
@@ -54,6 +56,7 @@
     "unitOwnerOrgUid": "f1c54511-865e-4611-976c-7c3c1f704662",
     "countryJurisdictionOfOwner": "USA",
     "serialNumberBlock": "AXJJFSLGHSHEJ3000-AXJJFSLGHSHEJ3010",
+    "serialNumberPattern": "[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$",
     "unitIdentifier": "XYZ",
     "unitType": "heard reduction",
     "intendedBuyerOrgUid": "70150fde-57f6-44a6-9486-1fef49528475",
@@ -78,6 +81,7 @@
     "unitOwnerOrgUid": "f1c54511-865e-4611-976c-7c3c1f704662",
     "countryJurisdictionOfOwner": "USA",
     "serialNumberBlock": "AXJJFSLGHSHEJ4000-AXJJFSLGHSHEJ4010",
+    "serialNumberPattern": "[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$",
     "unitIdentifier": "XYZ",
     "unitType": "heard reduction",
     "intendedBuyerOrgUid": "70150fde-57f6-44a6-9486-1fef49528475",
@@ -101,6 +105,7 @@
     "orgUid": "35f92331-c8d7-4e9e-a8d2-cd0a86cbb2cf",
     "unitOwnerOrgUid": "f1c54511-865e-4611-976c-7c3c1f704662",
     "serialNumberBlock": "AXJJFSLGHSHEJ5000-AXJJFSLGHSHEJ5010",
+    "serialNumberPattern": "[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$",
     "unitIdentifier": "XYZ",
     "unitType": "heard reduction",
     "countryJurisdictionOfOwner": "USA",

src/utils/data-assertions.js

@@ -83,15 +83,18 @@ export const assertProjectRecordExists = async (
 
 export const assertSumOfSplitUnitsIsValid = (
   serialNumberBlock,
+  serialNumberPattern,
   splitRecords,
 ) => {
   const sumOfSplitUnits = splitRecords.reduce(
     (previousValue, currentValue) =>
       previousValue.unitCount + currentValue.unitCount,
   );
 
-  const [unitBlockStart, unitBlockEnd, unitCount] =
-    transformSerialNumberBlock(serialNumberBlock);
+  const [unitBlockStart, unitBlockEnd, unitCount] = transformSerialNumberBlock(
+    serialNumberBlock,
+    serialNumberPattern,
+  );
 
   if (sumOfSplitUnits !== unitCount) {
     throw new Error(

src/utils/helpers.js

@@ -69,8 +69,9 @@ export const defaultSerialNumberPattern = /[.*\D]+([0-9]+)+[-][.*\D]+([0-9]+)$/;
 export const transformSerialNumberBlock = (
   serialNumberBlock,
   // serial number format: ABC1000-ABC1010
-  serialNumberPattern = defaultSerialNumberPattern,
+  serialNumberPattern,
 ) => {
+  console.log(serialNumberPattern);
   const unitBlocks = serialNumberBlock.match(serialNumberPattern);
 
   if (!unitBlocks) {

src/validations/units.validations.js

@@ -3,12 +3,12 @@ import { transformSerialNumberBlock } from '../utils/helpers';
 import { newVintageScheme, existingVintageSchema } from './vintages.validation';
 
 const customSerialNumberValidator = (obj, helper) => {
-  const { serialNumberBlock, customSerialNumberPattern } = obj;
+  const { serialNumberBlock, serialNumberPattern } = obj;
 
   // eslint-disable-next-line no-unused-vars
   const [_, __, unitCount] = transformSerialNumberBlock(
     serialNumberBlock,
-    customSerialNumberPattern || undefined,
+    new RegExp(serialNumberPattern),
   );
 
   if (!unitCount) {
@@ -30,7 +30,10 @@ const unitsBaseSchema = {
   inCountryJurisdictionOfOwner: Joi.string().optional(),
   // must be in the form ABC123-XYZ456
   serialNumberBlock: Joi.string().required(),
-  customSerialNumberPattern: Joi.string().optional(),
+  serialNumberPattern: Joi.string().required().messages({
+    'any.required':
+      'serialNumberPattern is required. This pattern must be a regex expression with 2 match groups to match block start and block end. Example: [.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$ that matches ABC1000-ABC1010 TODO: ADD LINK HERE FOR DOCUMENTATION',
+  }),
   unitIdentifier: Joi.string().required(),
   unitType: Joi.string().valid('heard reduction', 'removal').required(),
   intendedBuyerOrgUid: Joi.string().optional(),

tests/integration/unit.spec.js

@@ -19,6 +19,7 @@ describe('Create Unit Integration', function () {
     // create and commit the unit to be deleted
     const payload = {
       serialNumberBlock: 'AXJJFSLGHSHEJ9000-AXJJFSLGHSHEJ9010',
+      serialNumberPattern: '[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$',
       countryJurisdictionOfOwner: 'USA',
       unitType: 'removal',
       unitIdentifier: 'XYZ',
@@ -360,6 +361,7 @@ describe('Create Unit Integration', function () {
 
     const payload = {
       serialNumberBlock: 'AXJJFSLGHSHEJ9000-AXJJFSLGHSHEJ9010',
+      serialNumberPattern: '[.*\\D]+([0-9]+)+[-][.*\\D]+([0-9]+)$',
       countryJurisdictionOfOwner: 'USA',
       unitType: 'removal',
       unitIdentifier: 'XYZ',