@vannizhang/living-atlas-content-validator 1.5.17 → 1.5.18-beta.2

package/dist/lib/userProfileDescription/isValidUserProfileDescription.js

@@ -9,6 +9,8 @@ const isEmpty_1 = require("../util/isEmpty");
 const isEmail_1 = require("../util/isEmail");
 const isUrl_1 = require("../util/isUrl");
 const scoringConfig_1 = require("./scoringConfig");
+const countSentences_1 = require("../util/countSentences");
+const getNumberOfWords_1 = require("../util/getNumberOfWords");
 /**
  * Validate an item owner's profile description
  *
@@ -33,9 +35,9 @@ const scoringConfig_1 = require("./scoringConfig");
 const isValidUserProfileDescription = (userProfile
 // item: IItem
 ) => {
-    const { description } = userProfile;
+    const { description } = userProfile || {};
     // scoring rules locale
-    const locale = (0, getScoringRules_1.getScoringRulesLocale)(userProfile.culture);
+    const locale = (0, getScoringRules_1.getScoringRulesLocale)(userProfile === null || userProfile === void 0 ? void 0 : userProfile.culture);
     const weightFactors = locale === 'en'
         ? scoringConfig_1.scoringConfig.weightFactors.DEFAULT
         : scoringConfig_1.scoringConfig.weightFactors.INTERNATIONAL;
@@ -43,7 +45,7 @@ const isValidUserProfileDescription = (userProfile
     // const SCORING = getScoringRules(item, scoringRulesConfig);
     const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
     const issues = {
-        property: 'userProfileDescription',
+        // property: 'userProfileDescription',
         label: stringsConfig.userProfileDescription.LABEL,
         title: stringsConfig.userProfileDescription.TITLE,
         maxScore: 0,
@@ -57,7 +59,10 @@ const isValidUserProfileDescription = (userProfile
         messages: [],
         weight: scoringConfig_1.scoringConfig.weight,
         weightFactor: 0,
-        critical: true,
+        // critical: true,
+        // the status will be updated afterward based on the validation result
+        status: 'unknown',
+        isBinaryCheck: false,
     };
     if ((0, assertString_1.assertString)(description) === false || (0, isEmpty_1.isEmpty)(description)) {
         issues.messages.push({
@@ -69,37 +74,38 @@ const isValidUserProfileDescription = (userProfile
     // issues.score += SCORING.USER_PROFILE_DESCRIPTION_HAS_DESCRIPTION;
     issues.weightFactor +=
         weightFactors.USER_PROFILE_DESCRIPTION_HAS_DESCRIPTION_FACTOR;
-    let nWords = 0;
-    let nSentences = 0;
-    let nEmailAddresses = 0;
-    let nUrls = 0;
-    let isAUrl = false;
-    let isEmailAddress = false;
-    const cleanedDescription = description.replace(/(
|
)/gm, ' ');
-    const descriptionArray = cleanedDescription.split(' ');
-    for (const word of descriptionArray) {
-        // skip empty spaces
-        if (!word.length) {
-            continue;
-        }
-        if ((0, isEmail_1.isEmail)(word)) {
-            isEmailAddress = true;
-            nEmailAddresses += 1;
-        }
-        else if ((0, isUrl_1.isUrl)(word)) {
-            isAUrl = true;
-            nUrls += 1;
-        }
-        else {
-            // if it is not an email and not a url
-            nWords += 1;
-        }
-        const lastChar = word[word.length - 1];
-        if (lastChar === '.' || lastChar === '?' || lastChar === '!') {
-            nSentences += 1;
-        }
-    }
-    if (nEmailAddresses > 0) {
+    // let nWords = 0;
+    // let nEmailAddresses = 0;
+    // let nUrls = 0;
+    // let isAUrl = false;
+    // let isEmailAddress = false;
+    // const cleanedDescription = description.replace(/(
|
)/gm, ' ');
+    // const descriptionArray = cleanedDescription.split(' ');
+    const numSentences = (0, countSentences_1.countSentences)(description);
+    const numWords = (0, getNumberOfWords_1.getNumberOfWords)(description);
+    const containsEmail = (0, isEmail_1.isEmail)(description);
+    const foundUrl = (0, isUrl_1.containsUrl)(description);
+    // for (const word of descriptionArray) {
+    //     // skip empty spaces
+    //     if (!word.length) {
+    //         continue;
+    //     }
+    //     if (isEmail(word)) {
+    //         // isEmailAddress = true;
+    //         nEmailAddresses += 1;
+    //     } else if (isUrl(word)) {
+    //         // isAUrl = true;
+    //         nUrls += 1;
+    //     } else {
+    //         // if it is not an email and not a url
+    //         // nWords += 1;
+    //     }
+    //     // const lastChar = word[word.length - 1];
+    //     // if (lastChar === '.' || lastChar === '?' || lastChar === '!') {
+    //     //     nSentences += 1;
+    //     // }
+    // }
+    if (containsEmail) {
         // issues.score += SCORING.USER_PROFILE_DESCRIPTION_HAS_EMAIL;
         issues.weightFactor +=
             weightFactors.USER_PROFILE_DESCRIPTION_HAS_EMAIL_FACTOR;
@@ -110,7 +116,7 @@ const isValidUserProfileDescription = (userProfile
             message: stringsConfig.userProfileDescription.NO_VALID_EMAIL_MESSAGE,
         });
     }
-    if (nUrls > 0) {
+    if (foundUrl) {
         // issues.score += SCORING.USER_PROFILE_DESCRIPTION_HAS_LINK;
         issues.weightFactor +=
             weightFactors.USER_PROFILE_DESCRIPTION_HAS_LINK_FACTOR;
@@ -122,7 +128,7 @@ const isValidUserProfileDescription = (userProfile
         });
     }
     if (locale !== 'international') {
-        if (nWords > 10) {
+        if (numWords > 10) {
             // issues.score += SCORING.USER_PROFILE_DESCRIPTION_HAS_MIN_NUM_WORDS;
             issues.weightFactor +=
                 weightFactors.USER_PROFILE_DESCRIPTION_HAS_MIN_NUM_WORDS_FACTOR;
@@ -133,7 +139,7 @@ const isValidUserProfileDescription = (userProfile
                 message: stringsConfig.userProfileDescription.MIN_NUM_WORDS_MESSAGE,
             });
         }
-        if (nSentences > 2) {
+        if (numSentences > 2) {
             // issues.score +=
             //     SCORING.USER_PROFILE_DESCRIPTION_HAS_MIN_NUM_SENTENCES;
             issues.weightFactor +=

package/dist/lib/userProfileDescription/isValidUserProfileDescription.js.map

@@ -1 +1 @@
-{"version":3,"file":"isValidUserProfileDescription.js","sourceRoot":"","sources":["../../../src/lib/userProfileDescription/isValidUserProfileDescription.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,6DAGiC;AAEjC,yDAAyD;AACzD,uDAAoD;AACpD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AACtC,mDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,6BAA6B,GAAG,CACzC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;IAEpC,uBAAuB;IACvB,MAAM,MAAM,GAAG,IAAA,uCAAqB,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE1D,MAAM,aAAa,GACf,MAAM,KAAK,IAAI;QACX,CAAC,CAAC,6BAAa,CAAC,aAAa,CAAC,OAAO;QACrC,CAAC,CAAC,6BAAa,CAAC,aAAa,CAAC,aAAa,CAAC;IAEpD,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,MAAM,GAAmB;QAC3B,QAAQ,EAAE,wBAAwB;QAClC,KAAK,EAAE,aAAa,CAAC,sBAAsB,CAAC,KAAK;QACjD,KAAK,EAAE,aAAa,CAAC,sBAAsB,CAAC,KAAK;QACjD,QAAQ,EAAE,CAAC;QACX,+BAA+B;QAC/B,qDAAqD;QACrD,2DAA2D;QAC3D,uDAAuD;QACvD,8CAA8C;QAC9C,8CAA8C;QAC9C,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,IAAI;KACjB,CAAC;IAEF,IAAI,IAAA,2BAAY,EAAC,WAAW,CAAC,KAAK,KAAK,IAAI,IAAA,iBAAO,EAAC,WAAW,CAAC,EAAE;QAC7D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,gEAAgE;YAChE,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,oBAAoB;SACrE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,oEAAoE;IACpE,MAAM,CAAC,YAAY;QACf,aAAa,CAAC,+CAA+C,CAAC;IAElE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,MAAM,kBAAkB,GAAG,WAAW,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACvE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvD,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE;QACjC,oBAAoB;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,SAAS;SACZ;QAED,IAAI,IAAA,iBAAO,EAAC,IAAI,CAAC,EAAE;YACf,cAAc,GAAG,IAAI,CAAC;YACtB,eAAe,IAAI,CAAC,CAAC;SACxB;aAAM,IAAI,IAAA,aAAK,EAAC,IAAI,CAAC,EAAE;YACpB,MAAM,GAAG,IAAI,CAAC;YACd,KAAK,IAAI,CAAC,CAAC;SACd;aAAM;YACH,sCAAsC;YACtC,MAAM,IAAI,CAAC,CAAC;SACf;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAEvC,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE;YAC1D,UAAU,IAAI,CAAC,CAAC;SACnB;KACJ;IAED,IAAI,eAAe,GAAG,CAAC,EAAE;QACrB,8DAA8D;QAC9D,MAAM,CAAC,YAAY;YACf,aAAa,CAAC,yCAAyC,CAAC;KAC/D;SAAM;QACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,kEAAkE;YAClE,OAAO,EACH,aAAa,CAAC,sBAAsB,CAAC,sBAAsB;SAClE,CAAC,CAAC;KACN;IAED,IAAI,KAAK,GAAG,CAAC,EAAE;QACX,6DAA6D;QAC7D,MAAM,CAAC,YAAY;YACf,aAAa,CAAC,wCAAwC,CAAC;KAC9D;SAAM;QACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,gEAAgE;YAChE,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,oBAAoB;SACrE,CAAC,CAAC;KACN;IAED,IAAI,MAAM,KAAK,eAAe,EAAE;QAC5B,IAAI,MAAM,GAAG,EAAE,EAAE;YACb,sEAAsE;YACtE,MAAM,CAAC,YAAY;gBACf,aAAa,CAAC,iDAAiD,CAAC;SACvE;aAAM;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,iEAAiE;gBACjE,OAAO,EACH,aAAa,CAAC,sBAAsB,CAAC,qBAAqB;aACjE,CAAC,CAAC;SACN;QACD,IAAI,UAAU,GAAG,CAAC,EAAE;YAChB,kBAAkB;YAClB,8DAA8D;YAC9D,MAAM,CAAC,YAAY;gBACf,aAAa,CAAC,qDAAqD,CAAC;SAC3E;aAAM;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,6CAA6C;gBAC7C,+BAA+B;gBAC/B,OAAO,EACH,aAAa,CAAC,sBAAsB;qBAC/B,yBAAyB;aACrC,CAAC,CAAC;SACN;KACJ;IAED,2FAA2F;IAC3F,IAAI,MAAM,CAAC,YAAY,IAAI,QAAQ,EAAE;QACjC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;KAC3B;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AA7IW,QAAA,6BAA6B,iCA6IxC"}
+{"version":3,"file":"isValidUserProfileDescription.js","sourceRoot":"","sources":["../../../src/lib/userProfileDescription/isValidUserProfileDescription.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,6DAGiC;AAEjC,yDAAyD;AACzD,uDAAoD;AACpD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAmD;AACnD,mDAAgD;AAChD,2DAAwD;AACxD,+DAA4D;AAE5D;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,6BAA6B,GAAG,CACzC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;IAE1C,uBAAuB;IACvB,MAAM,MAAM,GAAG,IAAA,uCAAqB,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC;IAE3D,MAAM,aAAa,GACf,MAAM,KAAK,IAAI;QACX,CAAC,CAAC,6BAAa,CAAC,aAAa,CAAC,OAAO;QACrC,CAAC,CAAC,6BAAa,CAAC,aAAa,CAAC,aAAa,CAAC;IAEpD,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,MAAM,GAAmB;QAC3B,sCAAsC;QACtC,KAAK,EAAE,aAAa,CAAC,sBAAsB,CAAC,KAAK;QACjD,KAAK,EAAE,aAAa,CAAC,sBAAsB,CAAC,KAAK;QACjD,QAAQ,EAAE,CAAC;QACX,+BAA+B;QAC/B,qDAAqD;QACrD,2DAA2D;QAC3D,uDAAuD;QACvD,8CAA8C;QAC9C,8CAA8C;QAC9C,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,kBAAkB;QAClB,sEAAsE;QACtE,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,KAAK;KACvB,CAAC;IAEF,IAAI,IAAA,2BAAY,EAAC,WAAW,CAAC,KAAK,KAAK,IAAI,IAAA,iBAAO,EAAC,WAAW,CAAC,EAAE;QAC7D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,gEAAgE;YAChE,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,oBAAoB;SACrE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,oEAAoE;IACpE,MAAM,CAAC,YAAY;QACf,aAAa,CAAC,+CAA+C,CAAC;IAElE,kBAAkB;IAClB,2BAA2B;IAC3B,iBAAiB;IACjB,sBAAsB;IACtB,8BAA8B;IAE9B,0EAA0E;IAC1E,0DAA0D;IAE1D,MAAM,YAAY,GAAG,IAAA,+BAAc,EAAC,WAAW,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAA,mCAAgB,EAAC,WAAW,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,IAAA,iBAAO,EAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,WAAW,CAAC,CAAC;IAE1C,yCAAyC;IACzC,2BAA2B;IAC3B,0BAA0B;IAC1B,oBAAoB;IACpB,QAAQ;IAER,2BAA2B;IAC3B,oCAAoC;IACpC,gCAAgC;IAChC,gCAAgC;IAChC,4BAA4B;IAC5B,sBAAsB;IACtB,eAAe;IACf,iDAAiD;IACjD,0BAA0B;IAC1B,QAAQ;IAER,iDAAiD;IAEjD,yEAAyE;IACzE,8BAA8B;IAC9B,WAAW;IACX,IAAI;IAEJ,IAAI,aAAa,EAAE;QACf,8DAA8D;QAC9D,MAAM,CAAC,YAAY;YACf,aAAa,CAAC,yCAAyC,CAAC;KAC/D;SAAM;QACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,kEAAkE;YAClE,OAAO,EACH,aAAa,CAAC,sBAAsB,CAAC,sBAAsB;SAClE,CAAC,CAAC;KACN;IAED,IAAI,QAAQ,EAAE;QACV,6DAA6D;QAC7D,MAAM,CAAC,YAAY;YACf,aAAa,CAAC,wCAAwC,CAAC;KAC9D;SAAM;QACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,gEAAgE;YAChE,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,oBAAoB;SACrE,CAAC,CAAC;KACN;IAED,IAAI,MAAM,KAAK,eAAe,EAAE;QAC5B,IAAI,QAAQ,GAAG,EAAE,EAAE;YACf,sEAAsE;YACtE,MAAM,CAAC,YAAY;gBACf,aAAa,CAAC,iDAAiD,CAAC;SACvE;aAAM;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,iEAAiE;gBACjE,OAAO,EACH,aAAa,CAAC,sBAAsB,CAAC,qBAAqB;aACjE,CAAC,CAAC;SACN;QACD,IAAI,YAAY,GAAG,CAAC,EAAE;YAClB,kBAAkB;YAClB,8DAA8D;YAC9D,MAAM,CAAC,YAAY;gBACf,aAAa,CAAC,qDAAqD,CAAC;SAC3E;aAAM;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,6CAA6C;gBAC7C,+BAA+B;gBAC/B,OAAO,EACH,aAAa,CAAC,sBAAsB;qBAC/B,yBAAyB;aACrC,CAAC,CAAC;SACN;KACJ;IAED,2FAA2F;IAC3F,IAAI,MAAM,CAAC,YAAY,IAAI,QAAQ,EAAE;QACjC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;KAC3B;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AApJW,QAAA,6BAA6B,iCAoJxC"}

package/dist/lib/userProfileName/isValidUserProfileName.js

@@ -19,15 +19,15 @@ const scoringConfig_1 = require("./scoringConfig");
 const isValidUserProfileName = (userProfile
 // item: IItem
 ) => {
-    const { fullName } = userProfile;
+    const { fullName } = userProfile || {};
     // scoring rules locale
-    const locale = (0, getScoringRules_1.getScoringRulesLocale)(userProfile.culture);
+    const locale = (0, getScoringRules_1.getScoringRulesLocale)(userProfile === null || userProfile === void 0 ? void 0 : userProfile.culture);
     // // scoring rules
     // const SCORING = getScoringRules(item, scoringRulesConfig);
     const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
     // issues
     const issues = {
-        property: 'userProfileName',
+        // property: 'userProfileName',
         label: stringsConfig.userProfileName.LABEL,
         title: stringsConfig.userProfileName.TITLE,
         maxScore: 0,
@@ -38,9 +38,12 @@ const isValidUserProfileName = (userProfile
         messages: [],
         weight: scoringConfig_1.scoringConfig.weight,
         weightFactor: 0,
-        critical: false,
+        // critical: false,
+        // the status will be updated afterward based on the validation result
+        status: 'unknown',
+        isBinaryCheck: false,
     };
-    if (!(0, assertString_1.assertString)(userProfile.fullName) || (0, isEmpty_1.isEmpty)(fullName)) {
+    if (!(0, assertString_1.assertString)(userProfile === null || userProfile === void 0 ? void 0 : userProfile.fullName) || (0, isEmpty_1.isEmpty)(fullName)) {
         issues.messages.push({
             // code: stringsConfig.userProfileName.EMPTY_STRING_CODE,
             message: stringsConfig.userProfileName.EMPTY_STRING_MESSAGE,

package/dist/lib/userProfileName/isValidUserProfileName.js.map

@@ -1 +1 @@
-{"version":3,"file":"isValidUserProfileName.js","sourceRoot":"","sources":["../../../src/lib/userProfileName/isValidUserProfileName.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,6DAGiC;AAEjC,yDAAyD;AACzD,uDAAoD;AACpD,6CAA0C;AAC1C,+CAA4C;AAC5C,mDAAgD;AAEhD;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CAClC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IAEjC,uBAAuB;IACvB,MAAM,MAAM,GAAG,IAAA,uCAAqB,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE1D,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,SAAS;IACT,MAAM,MAAM,GAAmB;QAC3B,QAAQ,EAAE,iBAAiB;QAC3B,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;QAC1C,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;QAC1C,QAAQ,EAAE,CAAC;QACX,+BAA+B;QAC/B,+BAA+B;QAC/B,+BAA+B;QAC/B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,KAAK;KAClB,CAAC;IAEF,IAAI,CAAC,IAAA,2BAAY,EAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,IAAA,iBAAO,EAAC,QAAQ,CAAC,EAAE;QAC1D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,yDAAyD;YACzD,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,oBAAoB;SAC9D,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,6CAA6C;IAC7C,MAAM,CAAC,YAAY;QACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAE5D,IAAI,MAAM,KAAK,IAAI,IAAI,IAAA,mBAAQ,EAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;QAC5C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,6DAA6D;YAC7D,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,wBAAwB;SAClE,CAAC,CAAC;KACN;SAAM;QACH,+CAA+C;QAC/C,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,oBAAoB,CAAC;KAChE;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAvDW,QAAA,sBAAsB,0BAuDjC"}
+{"version":3,"file":"isValidUserProfileName.js","sourceRoot":"","sources":["../../../src/lib/userProfileName/isValidUserProfileName.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,6DAGiC;AAEjC,yDAAyD;AACzD,uDAAoD;AACpD,6CAA0C;AAC1C,+CAA4C;AAC5C,mDAAgD;AAEhD;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CAClC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;IAEvC,uBAAuB;IACvB,MAAM,MAAM,GAAG,IAAA,uCAAqB,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC;IAE3D,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,SAAS;IACT,MAAM,MAAM,GAAmB;QAC3B,+BAA+B;QAC/B,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;QAC1C,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;QAC1C,QAAQ,EAAE,CAAC;QACX,+BAA+B;QAC/B,+BAA+B;QAC/B,+BAA+B;QAC/B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,mBAAmB;QACnB,sEAAsE;QACtE,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,KAAK;KACvB,CAAC;IAEF,IAAI,CAAC,IAAA,2BAAY,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC,IAAI,IAAA,iBAAO,EAAC,QAAQ,CAAC,EAAE;QAC3D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,yDAAyD;YACzD,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,oBAAoB;SAC9D,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,6CAA6C;IAC7C,MAAM,CAAC,YAAY;QACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAE5D,IAAI,MAAM,KAAK,IAAI,IAAI,IAAA,mBAAQ,EAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;QAC5C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,6DAA6D;YAC7D,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,wBAAwB;SAClE,CAAC,CAAC;KACN;SAAM;QACH,+CAA+C;QAC/C,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,oBAAoB,CAAC;KAChE;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AA1DW,QAAA,sBAAsB,0BA0DjC"}

package/dist/lib/userProfileThumbnail/isValidUserProfileThumbnail.js

@@ -20,12 +20,12 @@ const scoringConfig_1 = require("./scoringConfig");
 const isValidUserProfileThumbnail = (userProfile
 // item: IItem
 ) => {
-    const { thumbnail } = userProfile;
+    const { thumbnail } = userProfile || {};
     // // scoring rules
     // const SCORING = getScoringRules(item, scoringRulesConfig);
     const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
     const issues = {
-        property: 'userProfileThumbnail',
+        // property: 'userProfileThumbnail',
         label: stringsConfig.userProfileThumbnail.LABEL,
         title: stringsConfig.userProfileThumbnail.TITLE,
         maxScore: 
@@ -36,7 +36,10 @@ const isValidUserProfileThumbnail = (userProfile
         messages: [],
         weight: scoringConfig_1.scoringConfig.weight,
         weightFactor: 0,
-        critical: false,
+        // critical: false,
+        // the status will be updated afterward based on the validation result
+        status: 'unknown',
+        isBinaryCheck: false,
     };
     if (!thumbnail) {
         issues.messages.push({

package/dist/lib/userProfileThumbnail/isValidUserProfileThumbnail.js.map

@@ -1 +1 @@
-{"version":3,"file":"isValidUserProfileThumbnail.js","sourceRoot":"","sources":["../../../src/lib/userProfileThumbnail/isValidUserProfileThumbnail.ts"],"names":[],"mappings":";;;AAGA,yDAAyD;AACzD,uEAAoE;AACpE,qGAAkG;AAClG,mDAAgD;AAEhD;;;;;;;;;;;GAWG;AACI,MAAM,2BAA2B,GAAG,CACvC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC;IAElC,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,MAAM,GAAmB;QAC3B,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,aAAa,CAAC,oBAAoB,CAAC,KAAK;QAC/C,KAAK,EAAE,aAAa,CAAC,oBAAoB,CAAC,KAAK;QAC/C,QAAQ;QACJ,+BAA+B;QAC/B,4CAA4C;QAC5C,CAAC;QACL,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,KAAK;KAClB,CAAC;IAEF,IAAI,CAAC,SAAS,EAAE;QACZ,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,8DAA8D;YAC9D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,MAAM,iBAAiB,GAAG,IAAA,2CAAoB,EAAC,SAAS,CAAC,CAAC;IAE1D,uDAAuD;IACvD,IAAI,IAAA,yEAAmC,EAAC,iBAAiB,CAAC,EAAE;QACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,8DAA8D;YAC9D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;KACN;SAAM;QACH,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,iCAAiC,CAAC;KAC7E;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAjDW,QAAA,2BAA2B,+BAiDtC"}
+{"version":3,"file":"isValidUserProfileThumbnail.js","sourceRoot":"","sources":["../../../src/lib/userProfileThumbnail/isValidUserProfileThumbnail.ts"],"names":[],"mappings":";;;AAGA,yDAAyD;AACzD,uEAAoE;AACpE,qGAAkG;AAClG,mDAAgD;AAEhD;;;;;;;;;;;GAWG;AACI,MAAM,2BAA2B,GAAG,CACvC,WAAkB;AAClB,cAAc;EACA,EAAE;IAChB,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;IAExC,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,MAAM,GAAmB;QAC3B,oCAAoC;QACpC,KAAK,EAAE,aAAa,CAAC,oBAAoB,CAAC,KAAK;QAC/C,KAAK,EAAE,aAAa,CAAC,oBAAoB,CAAC,KAAK;QAC/C,QAAQ;QACJ,+BAA+B;QAC/B,4CAA4C;QAC5C,CAAC;QACL,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,mBAAmB;QACnB,sEAAsE;QACtE,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,KAAK;KACvB,CAAC;IAEF,IAAI,CAAC,SAAS,EAAE;QACZ,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,8DAA8D;YAC9D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,MAAM,iBAAiB,GAAG,IAAA,2CAAoB,EAAC,SAAS,CAAC,CAAC;IAE1D,uDAAuD;IACvD,IAAI,IAAA,yEAAmC,EAAC,iBAAiB,CAAC,EAAE;QACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,8DAA8D;YAC9D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;KACN;SAAM;QACH,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,iCAAiC,CAAC;KAC7E;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AApDW,QAAA,2BAA2B,+BAoDtC"}

package/dist/lib/util/containsNonEnglishCharacters.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if a string contains non-English (non-ASCII) characters.
+ *
+ * This function determines whether a string contains any characters outside
+ * the ASCII range (0x00-0x7F).
+ *
+ * @param str - The string to check for non-English characters
+ * @returns True if the string contains any non-English characters after
+ *          removing special characters and whitespace, false otherwise.
+ *          Also returns false if the input is empty, null, or becomes empty
+ *          after removing special characters.
+ */
+export declare const containsNonEnglishCharacters: (str: string) => boolean;

package/dist/lib/util/containsNonEnglishCharacters.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.containsNonEnglishCharacters = void 0;
+/**
+ * Checks if a string contains non-English (non-ASCII) characters.
+ *
+ * This function determines whether a string contains any characters outside
+ * the ASCII range (0x00-0x7F).
+ *
+ * @param str - The string to check for non-English characters
+ * @returns True if the string contains any non-English characters after
+ *          removing special characters and whitespace, false otherwise.
+ *          Also returns false if the input is empty, null, or becomes empty
+ *          after removing special characters.
+ */
+const containsNonEnglishCharacters = (str) => {
+    if (!str) {
+        return false; // If the string is empty or null, return false
+    }
+    // Regular expression to match non-English characters
+    const nonEnglishRegex = /[^\u0020-\u007F]/;
+    // remove all whitespace before checking
+    str = str.trim();
+    if (str.length === 0) {
+        return false; // If the string is empty after removing non-word characters, return false
+    }
+    return nonEnglishRegex.test(str);
+};
+exports.containsNonEnglishCharacters = containsNonEnglishCharacters;
+//# sourceMappingURL=containsNonEnglishCharacters.js.map

package/dist/lib/util/containsNonEnglishCharacters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"containsNonEnglishCharacters.js","sourceRoot":"","sources":["../../../src/lib/util/containsNonEnglishCharacters.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;GAWG;AACI,MAAM,4BAA4B,GAAG,CAAC,GAAW,EAAW,EAAE;IACjE,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,KAAK,CAAC,CAAC,+CAA+C;KAChE;IAED,qDAAqD;IACrD,MAAM,eAAe,GAAG,kBAAkB,CAAC;IAE3C,wCAAwC;IACxC,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAEjB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QAClB,OAAO,KAAK,CAAC,CAAC,0EAA0E;KAC3F;IAED,OAAO,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC,CAAC;AAhBW,QAAA,4BAA4B,gCAgBvC"}

package/dist/lib/util/countSentences.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Counts the number of sentences in a given text.
+ *
+ * This function handles:
+ * - Multiple paragraphs (separated by one or more new lines)
+ * - HTML new line characters (
 and 
)
+ * - Multiple consecutive dots (replacing them with a single dot)
+ * - Empty paragraphs (skips them)
+ * - Sentences ending with punctuation marks (.!?) followed by spaces
+ * - Sentences at the end of the text
+ *
+ * @param text - The input text to count sentences in
+ * @returns The total number of sentences in the text
+ *
+ * @example
+ * // Returns 2
+ * countSentences("Hello world. This is a test.");
+ *
+ * @example
+ * // Also returns 2 (handles HTML newlines)
+ * countSentences("Hello world.
This is a test.");
+ */
+export declare const countSentences: (text: string) => number;

package/dist/lib/util/countSentences.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countSentences = void 0;
+/**
+ * Counts the number of sentences in a given text.
+ *
+ * This function handles:
+ * - Multiple paragraphs (separated by one or more new lines)
+ * - HTML new line characters (
 and 
)
+ * - Multiple consecutive dots (replacing them with a single dot)
+ * - Empty paragraphs (skips them)
+ * - Sentences ending with punctuation marks (.!?) followed by spaces
+ * - Sentences at the end of the text
+ *
+ * @param text - The input text to count sentences in
+ * @returns The total number of sentences in the text
+ *
+ * @example
+ * // Returns 2
+ * countSentences("Hello world. This is a test.");
+ *
+ * @example
+ * // Also returns 2 (handles HTML newlines)
+ * countSentences("Hello world.
This is a test.");
+ */
+const countSentences = (text) => {
+    // split the text into paragraphs using new line as the delimiter
+    // it should also handle multiple new lines and HTML new lines like 
|
+    const paragraphs = text
+        .replace(/
|
/g, '\n') // Replace HTML new lines with actual new lines
+        .split(/\n+/); // Split by one or more new lines
+    let sentenceCount = 0;
+    // iterate over each paragraph
+    for (const paragraph of paragraphs) {
+        // replace multiple dots with a single dot
+        let cleanedParagraph = paragraph.trim(); // trim leading and trailing spaces
+        if (!cleanedParagraph) {
+            continue; // skip empty paragraphs
+        }
+        cleanedParagraph = cleanedParagraph.replace(/\.{2,}/g, '.');
+        // Handle sentences ending with punctuation or the end of text
+        // Split by sentence-ending punctuation followed by a space or end of string
+        // (?<=[.!?])\s+ matches a space after a sentence-ending punctuation
+        // $ matches the end of the string
+        const sentences = cleanedParagraph.split(/(?<=[.!?])\s+|$/);
+        // Filter out empty sentences
+        const validSentences = sentences.filter((s) => s.trim().length > 0);
+        // Count the sentences
+        sentenceCount += validSentences.length;
+    }
+    return sentenceCount;
+};
+exports.countSentences = countSentences;
+//# sourceMappingURL=countSentences.js.map

package/dist/lib/util/countSentences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countSentences.js","sourceRoot":"","sources":["../../../src/lib/util/countSentences.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IACnD,iEAAiE;IACjE,+EAA+E;IAC/E,MAAM,UAAU,GAAG,IAAI;SAClB,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,+CAA+C;SAC7E,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAiC;IAEpD,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,8BAA8B;IAC9B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAChC,0CAA0C;QAC1C,IAAI,gBAAgB,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,mCAAmC;QAE5E,IAAI,CAAC,gBAAgB,EAAE;YACnB,SAAS,CAAC,wBAAwB;SACrC;QAED,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAE5D,8DAA8D;QAC9D,4EAA4E;QAC5E,oEAAoE;QACpE,kCAAkC;QAClC,MAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAE5D,6BAA6B;QAC7B,MAAM,cAAc,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAEpE,sBAAsB;QACtB,aAAa,IAAI,cAAc,CAAC,MAAM,CAAC;KAC1C;IAED,OAAO,aAAa,CAAC;AACzB,CAAC,CAAC;AAlCW,QAAA,cAAc,kBAkCzB"}

package/dist/lib/util/createWordBoundaryRegex.d.ts

@@ -0,0 +1,46 @@
+type CreateWordBoundaryRegexOptions = {
+    /**
+     * A flag indicating whether to avoid using word boundaries in the regular expression.
+     * If true, the resulting regex will not use word boundaries, which is useful for languages like Chinese and Japanese that do not use spaces between words.
+     */
+    shouldAvoidUsingWordBoundary?: boolean;
+    /**
+     * A flag indicating whether to match plural forms of the patterns.
+     * If true, the resulting regex will match both singular and plural forms of the patterns.
+     */
+    shouldMatchPlural?: boolean;
+};
+/**
+ * Creates a regular expression that matches any of the provided patterns with optional word boundaries and plural forms.
+ *
+ * @param {string[]} patterns - An array of string patterns to be included in the regular expression.
+ * @param {CreateWordBoundaryRegexOptions} options - Options for creating the regular expression.
+ * @param {boolean} [options.shouldAvoidUsingWordBoundary=false] - A flag indicating whether to avoid using word boundaries in the regular expression.
+ * @param {boolean} [options.shouldMatchPlural=false] - A flag indicating whether to match plural forms of the patterns.
+ *
+ * @returns {RegExp} - A regular expression that matches any of the provided patterns. If the input patterns array is empty or invalid, returns a regular expression that never matches anything.
+ *
+ * @remarks
+ * - If `shouldAvoidUsingWordBoundary` is `true`, the resulting regular expression will not use word boundaries, which is useful for languages like Chinese and Japanese that do not use spaces between words.
+ * - If `shouldAvoidUsingWordBoundary` is `false`, the resulting regular expression will use word boundaries to match whole words only.
+ * - If `shouldMatchPlural` is `true`, the resulting regular expression will match both singular and plural forms of the patterns.
+ * - Special characters in the patterns are escaped to ensure they are treated as literal characters in the regular expression.
+ * - Patterns are sorted by length in descending order to prioritize longer matches.
+ * - The resulting regular expression is case-insensitive.
+ * - If an error occurs during the creation of the regular expression, a regular expression that never matches anything is returned.
+ *
+ * @throws Will log an error and return an empty regex if there is an error in creating the regex.
+ * @example
+ * // Returns /\b(foo|bar|baz)\b/gi
+ * createWordBoundaryRegex(['foo', 'bar', 'baz']);
+ *
+ * @example
+ * // Returns /(foo|bar|baz)/giu
+ * createWordBoundaryRegex(['foo', 'bar', 'baz'], { shouldAvoidUsingWordBoundary: true });
+ *
+ * @example
+ * // Returns /\b(foo|bars?|baz)\b/gi
+ * createWordBoundaryRegex(['foo', 'bar', 'baz'], { shouldMatchPlural: true });
+ */
+export declare const createWordBoundaryRegex: (patterns: string[], { shouldAvoidUsingWordBoundary, shouldMatchPlural, }?: CreateWordBoundaryRegexOptions) => RegExp;
+export {};

package/dist/lib/util/createWordBoundaryRegex.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWordBoundaryRegex = void 0;
+const escapeSpecialCharacters_1 = require("./escapeSpecialCharacters");
+/**
+ * Creates a regular expression that matches any of the provided patterns with optional word boundaries and plural forms.
+ *
+ * @param {string[]} patterns - An array of string patterns to be included in the regular expression.
+ * @param {CreateWordBoundaryRegexOptions} options - Options for creating the regular expression.
+ * @param {boolean} [options.shouldAvoidUsingWordBoundary=false] - A flag indicating whether to avoid using word boundaries in the regular expression.
+ * @param {boolean} [options.shouldMatchPlural=false] - A flag indicating whether to match plural forms of the patterns.
+ *
+ * @returns {RegExp} - A regular expression that matches any of the provided patterns. If the input patterns array is empty or invalid, returns a regular expression that never matches anything.
+ *
+ * @remarks
+ * - If `shouldAvoidUsingWordBoundary` is `true`, the resulting regular expression will not use word boundaries, which is useful for languages like Chinese and Japanese that do not use spaces between words.
+ * - If `shouldAvoidUsingWordBoundary` is `false`, the resulting regular expression will use word boundaries to match whole words only.
+ * - If `shouldMatchPlural` is `true`, the resulting regular expression will match both singular and plural forms of the patterns.
+ * - Special characters in the patterns are escaped to ensure they are treated as literal characters in the regular expression.
+ * - Patterns are sorted by length in descending order to prioritize longer matches.
+ * - The resulting regular expression is case-insensitive.
+ * - If an error occurs during the creation of the regular expression, a regular expression that never matches anything is returned.
+ *
+ * @throws Will log an error and return an empty regex if there is an error in creating the regex.
+ * @example
+ * // Returns /\b(foo|bar|baz)\b/gi
+ * createWordBoundaryRegex(['foo', 'bar', 'baz']);
+ *
+ * @example
+ * // Returns /(foo|bar|baz)/giu
+ * createWordBoundaryRegex(['foo', 'bar', 'baz'], { shouldAvoidUsingWordBoundary: true });
+ *
+ * @example
+ * // Returns /\b(foo|bars?|baz)\b/gi
+ * createWordBoundaryRegex(['foo', 'bar', 'baz'], { shouldMatchPlural: true });
+ */
+const createWordBoundaryRegex = (patterns, { shouldAvoidUsingWordBoundary = false, shouldMatchPlural = false, } = {}) => {
+    // (?!.*) is a negative lookahead that always fails, meaning it never matches anything.
+    const emptyRegex = new RegExp('(?!.*)', 'gi');
+    if (!Array.isArray(patterns) || patterns.length === 0) {
+        return emptyRegex;
+    }
+    // Escape special regex characters in each pattern
+    const escapedPatterns = (0, escapeSpecialCharacters_1.escapeSpecialCharacters)(patterns);
+    if (!escapedPatterns || escapedPatterns.length === 0) {
+        return emptyRegex;
+    }
+    // Sort patterns by length in descending order to prioritize longer matches
+    // This helps to avoid partial matches on shorter patterns.
+    escapedPatterns.sort((a, b) => b.length - a.length);
+    try {
+        // Use a regex that works well for languages like Chinese and Japanese,
+        // that doesn't use spaces between words
+        if (shouldAvoidUsingWordBoundary) {
+            return new RegExp(`(${escapedPatterns.join('|')})`, 'giu');
+        }
+        // Add `s?` at end to make the letter s optional, allowing it to match both singular and plural forms.
+        if (shouldMatchPlural) {
+            return new RegExp(`(?<!\\w)(${escapedPatterns.join('|')})s?(?!\\w)`, 'gi');
+        }
+        /**
+         * Enhances word boundary handling, including punctuation like periods.
+         *
+         * @remarks
+         * `(?<!\\w)`: Negative lookbehind ensures that the match is not preceded by a word character ([a-zA-Z0-9_])
+         * `(${escapedPatterns.join('|')})` Matches one of the provided patterns.
+         * `(?!\\w)`: Negative lookahead ensures that the match is not followed by a word character.
+         */
+        return new RegExp(`(?<!\\w)(${escapedPatterns.join('|')})(?!\\w)`, 'gi');
+    }
+    catch (error) {
+        console.error('Error in createWordBoundaryRegex:', error);
+        return emptyRegex;
+    }
+};
+exports.createWordBoundaryRegex = createWordBoundaryRegex;
+//# sourceMappingURL=createWordBoundaryRegex.js.map

package/dist/lib/util/createWordBoundaryRegex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createWordBoundaryRegex.js","sourceRoot":"","sources":["../../../src/lib/util/createWordBoundaryRegex.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AAepE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,MAAM,uBAAuB,GAAG,CACnC,QAAkB,EAClB,EACI,4BAA4B,GAAG,KAAK,EACpC,iBAAiB,GAAG,KAAK,MACO,EAAE,EAChC,EAAE;IACR,uFAAuF;IACvF,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAE9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACnD,OAAO,UAAU,CAAC;KACrB;IAED,kDAAkD;IAClD,MAAM,eAAe,GAAG,IAAA,iDAAuB,EAAC,QAAQ,CAAC,CAAC;IAE1D,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE;QAClD,OAAO,UAAU,CAAC;KACrB;IAED,2EAA2E;IAC3E,2DAA2D;IAC3D,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAEpD,IAAI;QACA,uEAAuE;QACvE,wCAAwC;QACxC,IAAI,4BAA4B,EAAE;YAC9B,OAAO,IAAI,MAAM,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAC9D;QAED,sGAAsG;QACtG,IAAI,iBAAiB,EAAE;YACnB,OAAO,IAAI,MAAM,CACb,YAAY,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EACjD,IAAI,CACP,CAAC;SACL;QAED;;;;;;;WAOG;QACH,OAAO,IAAI,MAAM,CACb,YAAY,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAC/C,IAAI,CACP,CAAC;KACL;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC1D,OAAO,UAAU,CAAC;KACrB;AACL,CAAC,CAAC;AAxDW,QAAA,uBAAuB,2BAwDlC"}

package/dist/lib/util/escapeSpecialCharacters.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Cleans up an array of strings by escaping special characters and trimming whitespace.
+ *
+ * @param strs - An array of strings to be cleaned.
+ * @returns A new array of strings with special characters escaped and whitespace trimmed.
+ */
+export declare const escapeSpecialCharacters: (strs: string[]) => string[];

package/dist/lib/util/escapeSpecialCharacters.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeSpecialCharacters = void 0;
+/**
+ * Cleans up an array of strings by escaping special characters and trimming whitespace.
+ *
+ * @param strs - An array of strings to be cleaned.
+ * @returns A new array of strings with special characters escaped and whitespace trimmed.
+ */
+const escapeSpecialCharacters = (strs) => {
+    if (!strs || strs.length === 0) {
+        return [];
+    }
+    const output = strs.map((str) => {
+        // Find all special characters and replaces each one with its escaped version.
+        // The `\\$&` part means "replace with a backslash followed by the matched character".
+        return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&').trim();
+    });
+    return output.filter((str) => str !== '');
+};
+exports.escapeSpecialCharacters = escapeSpecialCharacters;
+//# sourceMappingURL=escapeSpecialCharacters.js.map

package/dist/lib/util/escapeSpecialCharacters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escapeSpecialCharacters.js","sourceRoot":"","sources":["../../../src/lib/util/escapeSpecialCharacters.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACI,MAAM,uBAAuB,GAAG,CAAC,IAAc,EAAE,EAAE;IACtD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,OAAO,EAAE,CAAC;KACb;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC5B,8EAA8E;QAC9E,sFAAsF;QACtF,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC;AAZW,QAAA,uBAAuB,2BAYlC"}

package/dist/lib/util/getLivingAtlasSupportedItemTypes.d.ts

@@ -0,0 +1,21 @@
+import { IItem } from '../../types';
+import { LivingAtlasSupportedItemType } from '../config';
+/**
+ * Returns an array of item types supported by Living Atlas.
+ *
+ * This function creates a new array containing all the predefined item types
+ * that are supported by Living Atlas from the configuration.
+ *
+ * @returns {LivingAtlasSupportedItemType[]} An array of Living Atlas supported item types.
+ */
+export declare const getLivingAtlasSupportedItemTypes: () => LivingAtlasSupportedItemType[];
+/**
+ * Checks if a given item type is supported by Living Atlas.
+ *
+ * This function determines whether the provided item type string is included
+ * in the predefined list of item types supported by Living Atlas.
+ *
+ * @param {string} itemType - The item type to check for support.
+ * @returns {boolean} True if the item type is supported by Living Atlas, false otherwise.
+ */
+export declare const checkIsLivingAtlasSupportedItemType: (item: IItem) => boolean;

package/dist/lib/util/getLivingAtlasSupportedItemTypes.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkIsLivingAtlasSupportedItemType = exports.getLivingAtlasSupportedItemTypes = void 0;
+const config_1 = require("../config");
+/**
+ * Returns an array of item types supported by Living Atlas.
+ *
+ * This function creates a new array containing all the predefined item types
+ * that are supported by Living Atlas from the configuration.
+ *
+ * @returns {LivingAtlasSupportedItemType[]} An array of Living Atlas supported item types.
+ */
+const getLivingAtlasSupportedItemTypes = () => {
+    return [...config_1.LIVING_ATLAS_SUPPORTED_ITEM_TYPES];
+};
+exports.getLivingAtlasSupportedItemTypes = getLivingAtlasSupportedItemTypes;
+/**
+ * Checks if a given item type is supported by Living Atlas.
+ *
+ * This function determines whether the provided item type string is included
+ * in the predefined list of item types supported by Living Atlas.
+ *
+ * @param {string} itemType - The item type to check for support.
+ * @returns {boolean} True if the item type is supported by Living Atlas, false otherwise.
+ */
+const checkIsLivingAtlasSupportedItemType = (item) => {
+    if (!item) {
+        return false;
+    }
+    const itemType = item === null || item === void 0 ? void 0 : item.type;
+    return config_1.LIVING_ATLAS_SUPPORTED_ITEM_TYPES.includes(itemType);
+};
+exports.checkIsLivingAtlasSupportedItemType = checkIsLivingAtlasSupportedItemType;
+//# sourceMappingURL=getLivingAtlasSupportedItemTypes.js.map

package/dist/lib/util/getLivingAtlasSupportedItemTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLivingAtlasSupportedItemTypes.js","sourceRoot":"","sources":["../../../src/lib/util/getLivingAtlasSupportedItemTypes.ts"],"names":[],"mappings":";;;AACA,sCAGmB;AAEnB;;;;;;;GAOG;AACI,MAAM,gCAAgC,GACzC,GAAmC,EAAE;IACjC,OAAO,CAAC,GAAG,0CAAiC,CAAC,CAAC;AAClD,CAAC,CAAC;AAHO,QAAA,gCAAgC,oCAGvC;AAEN;;;;;;;;GAQG;AACI,MAAM,mCAAmC,GAAG,CAAC,IAAW,EAAW,EAAE;IACxE,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,QAAQ,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC;IAE5B,OAAO,0CAAiC,CAAC,QAAQ,CAC7C,QAAwC,CAC3C,CAAC;AACN,CAAC,CAAC;AAVW,QAAA,mCAAmC,uCAU9C"}

package/dist/lib/util/getNumberOfWords.js

@@ -11,8 +11,12 @@ const getNumberOfWords = (s) => {
     if (!(0, assertString_1.assertString)(s)) {
         return 0;
     }
-    // exclude white space
-    let str = s.replace(/(^\s*)|(\s*$)/gi, '');
+    // trim the string to remove leading and trailing spaces
+    let str = s.trim(); //s.replace(/(^\s*)|(\s*$)/gi, '');
+    if (!str) {
+        return 0;
+    }
+    // inds any sequence of 2 or more spaces in the string and replaces it with a single space
     str = str.replace(/[ ]{2,}/gi, ' ');
     // exclude newline with a space at beginning
     str = str.replace(/\n /, '\n');

package/dist/lib/util/getNumberOfWords.js.map

@@ -1 +1 @@
-{"version":3,"file":"getNumberOfWords.js","sourceRoot":"","sources":["../../../src/lib/util/getNumberOfWords.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAU,EAAE;IAClD,IAAI,CAAC,IAAA,2BAAY,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,CAAC,CAAC;KACZ;IAED,sBAAsB;IACtB,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC3C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAEpC,4CAA4C;IAC5C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE/B,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAClD,OAAO,CAAC,CAAC;KACZ;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,gBAAgB,oBAiB3B;AAEF,mEAAmE;AAEnE,wBAAwB;AAExB,uDAAuD;AACvD,yBAAyB;AACzB,uCAAuC;AACvC,MAAM"}
+{"version":3,"file":"getNumberOfWords.js","sourceRoot":"","sources":["../../../src/lib/util/getNumberOfWords.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAU,EAAE;IAClD,IAAI,CAAC,IAAA,2BAAY,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,CAAC,CAAC;KACZ;IAED,wDAAwD;IACxD,IAAI,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,mCAAmC;IAEvD,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,CAAC,CAAC;KACZ;IAED,0FAA0F;IAC1F,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAEpC,4CAA4C;IAC5C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE/B,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAClD,OAAO,CAAC,CAAC;KACZ;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AACjC,CAAC,CAAC;AAvBW,QAAA,gBAAgB,oBAuB3B;AAEF,mEAAmE;AAEnE,wBAAwB;AAExB,uDAAuD;AACvD,yBAAyB;AACzB,uCAAuC;AACvC,MAAM"}