@vannizhang/living-atlas-content-validator 1.5.13 → 1.5.14

package/dist/index.d.ts

@@ -14,5 +14,9 @@ import { isValidUserProfileName } from './lib/userProfileName/isValidUserProfile
 import { isValidUserProfileThumbnail } from './lib/userProfileThumbnail/isValidUserProfileThumbnail';
 import { isDeprecated } from './lib/deprecated/isDeprecated';
 import { validate, meetMinimumTotalScore } from './lib/validate/validate';
+import { matchLocationInfo } from './lib/recommendedText/matchLocationInfo';
+import { matchDateTimeInfo } from './lib/recommendedText/matchDateTimeInfo';
+import { matchSourceInfo } from './lib/recommendedText/matchSourceInfo';
+import { matchTopicInfo } from './lib/recommendedText/matchTopicInfo';
 import { setStrings, getStringsConfig, ValidationRulesStringJSON } from './lib/util/stringsConfig';
-export { ValidationMessage, ValidationInfo, ValidationResult, ValidationRulesStringJSON, setStrings, getStringsConfig, validate, meetMinimumTotalScore, isValidTitle, isValidAccessInformation, isValidDescription, isValidLayerCount, isValidLicenseInfo, isValidAccess, isValidSSL, isValidSummary, isValidTags, isValidThumbnail, isValidUserProfileDescription, isValidUserProfileName, isValidUserProfileThumbnail, isDeprecated, };
+export { ValidationMessage, ValidationInfo, ValidationResult, ValidationRulesStringJSON, setStrings, getStringsConfig, validate, meetMinimumTotalScore, isValidTitle, isValidAccessInformation, isValidDescription, isValidLayerCount, isValidLicenseInfo, isValidAccess, isValidSSL, isValidSummary, isValidTags, isValidThumbnail, isValidUserProfileDescription, isValidUserProfileName, isValidUserProfileThumbnail, isDeprecated, matchLocationInfo, matchDateTimeInfo, matchSourceInfo, matchTopicInfo, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDeprecated = exports.isValidUserProfileThumbnail = exports.isValidUserProfileName = exports.isValidUserProfileDescription = exports.isValidThumbnail = exports.isValidTags = exports.isValidSummary = exports.isValidSSL = exports.isValidAccess = exports.isValidLicenseInfo = exports.isValidLayerCount = exports.isValidDescription = exports.isValidAccessInformation = exports.isValidTitle = exports.meetMinimumTotalScore = exports.validate = exports.getStringsConfig = exports.setStrings = void 0;
+exports.matchTopicInfo = exports.matchSourceInfo = exports.matchDateTimeInfo = exports.matchLocationInfo = exports.isDeprecated = exports.isValidUserProfileThumbnail = exports.isValidUserProfileName = exports.isValidUserProfileDescription = exports.isValidThumbnail = exports.isValidTags = exports.isValidSummary = exports.isValidSSL = exports.isValidAccess = exports.isValidLicenseInfo = exports.isValidLayerCount = exports.isValidDescription = exports.isValidAccessInformation = exports.isValidTitle = exports.meetMinimumTotalScore = exports.validate = exports.getStringsConfig = exports.setStrings = void 0;
 const isValidTitle_1 = require("./lib/title/isValidTitle");
 Object.defineProperty(exports, "isValidTitle", { enumerable: true, get: function () { return isValidTitle_1.isValidTitle; } });
 const isValidAccessInformation_1 = require("./lib/accessInformation/isValidAccessInformation");
@@ -32,6 +32,14 @@ Object.defineProperty(exports, "isDeprecated", { enumerable: true, get: function
 const validate_1 = require("./lib/validate/validate");
 Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return validate_1.validate; } });
 Object.defineProperty(exports, "meetMinimumTotalScore", { enumerable: true, get: function () { return validate_1.meetMinimumTotalScore; } });
+const matchLocationInfo_1 = require("./lib/recommendedText/matchLocationInfo");
+Object.defineProperty(exports, "matchLocationInfo", { enumerable: true, get: function () { return matchLocationInfo_1.matchLocationInfo; } });
+const matchDateTimeInfo_1 = require("./lib/recommendedText/matchDateTimeInfo");
+Object.defineProperty(exports, "matchDateTimeInfo", { enumerable: true, get: function () { return matchDateTimeInfo_1.matchDateTimeInfo; } });
+const matchSourceInfo_1 = require("./lib/recommendedText/matchSourceInfo");
+Object.defineProperty(exports, "matchSourceInfo", { enumerable: true, get: function () { return matchSourceInfo_1.matchSourceInfo; } });
+const matchTopicInfo_1 = require("./lib/recommendedText/matchTopicInfo");
+Object.defineProperty(exports, "matchTopicInfo", { enumerable: true, get: function () { return matchTopicInfo_1.matchTopicInfo; } });
 const stringsConfig_1 = require("./lib/util/stringsConfig");
 Object.defineProperty(exports, "setStrings", { enumerable: true, get: function () { return stringsConfig_1.setStrings; } });
 Object.defineProperty(exports, "getStringsConfig", { enumerable: true, get: function () { return stringsConfig_1.getStringsConfig; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAWA,2DAAwD;AAwCpD,6FAxCK,2BAAY,OAwCL;AAvChB,+FAA4F;AAwCxF,yGAxCK,mDAAwB,OAwCL;AAvC5B,6EAA0E;AAwCtE,mGAxCK,uCAAkB,OAwCL;AAvCtB,sEAAmE;AAwC/D,kGAxCK,qCAAiB,OAwCL;AAvCrB,6EAA0E;AAwCtE,mGAxCK,uCAAkB,OAwCL;AAvCtB,+DAA4D;AAwCxD,8FAxCK,6BAAa,OAwCL;AAvCjB,qDAAkD;AAwC9C,2FAxCK,uBAAU,OAwCL;AAvCd,iEAA8D;AAwC1D,+FAxCK,+BAAc,OAwCL;AAvClB,wDAAqD;AAwCjD,4FAxCK,yBAAW,OAwCL;AAvCf,uEAAoE;AAwChE,iGAxCK,mCAAgB,OAwCL;AAvCpB,8GAA2G;AAwCvG,8GAxCK,6DAA6B,OAwCL;AAvCjC,yFAAsF;AAwClF,uGAxCK,+CAAsB,OAwCL;AAvC1B,wGAAqG;AAwCjG,4GAxCK,yDAA2B,OAwCL;AAvC/B,gEAA6D;AAwCzD,6FAxCK,2BAAY,OAwCL;AAvChB,sDAA0E;AAwBtE,yFAxBK,mBAAQ,OAwBL;AACR,sGAzBe,gCAAqB,OAyBf;AAvBzB,4DAIkC;AAgB9B,2FAnBA,0BAAU,OAmBA;AACV,iGAnBA,gCAAgB,OAmBA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAWA,2DAAwD;AA4CpD,6FA5CK,2BAAY,OA4CL;AA3ChB,+FAA4F;AA4CxF,yGA5CK,mDAAwB,OA4CL;AA3C5B,6EAA0E;AA4CtE,mGA5CK,uCAAkB,OA4CL;AA3CtB,sEAAmE;AA4C/D,kGA5CK,qCAAiB,OA4CL;AA3CrB,6EAA0E;AA4CtE,mGA5CK,uCAAkB,OA4CL;AA3CtB,+DAA4D;AA4CxD,8FA5CK,6BAAa,OA4CL;AA3CjB,qDAAkD;AA4C9C,2FA5CK,uBAAU,OA4CL;AA3Cd,iEAA8D;AA4C1D,+FA5CK,+BAAc,OA4CL;AA3ClB,wDAAqD;AA4CjD,4FA5CK,yBAAW,OA4CL;AA3Cf,uEAAoE;AA4ChE,iGA5CK,mCAAgB,OA4CL;AA3CpB,8GAA2G;AA4CvG,8GA5CK,6DAA6B,OA4CL;AA3CjC,yFAAsF;AA4ClF,uGA5CK,+CAAsB,OA4CL;AA3C1B,wGAAqG;AA4CjG,4GA5CK,yDAA2B,OA4CL;AA3C/B,gEAA6D;AA4CzD,6FA5CK,2BAAY,OA4CL;AA3ChB,sDAA0E;AA4BtE,yFA5BK,mBAAQ,OA4BL;AACR,sGA7Be,gCAAqB,OA6Bf;AA5BzB,+EAA4E;AA2CxE,kGA3CK,qCAAiB,OA2CL;AA1CrB,+EAA4E;AA2CxE,kGA3CK,qCAAiB,OA2CL;AA1CrB,2EAAwE;AA2CpE,gGA3CK,iCAAe,OA2CL;AA1CnB,yEAAsE;AA2ClE,+FA3CK,+BAAc,OA2CL;AAzClB,4DAIkC;AAgB9B,2FAnBA,0BAAU,OAmBA;AACV,iGAnBA,gCAAgB,OAmBA"}

package/dist/lib/layers/scoringConfig.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scoringConfig = void 0;
 exports.scoringConfig = {
-    weight: 8,
+    weight: 1,
     weightFactors: {
         DEFAULT: {
             LAYER_COUNT_BEST_FACTOR: 1,

package/dist/lib/recommendedText/checkRecommendedText.d.ts

@@ -0,0 +1,15 @@
+import { IItem, ValidationInfo } from '../../types';
+/**
+ * Check for required and recommended text in items' title and summary text.
+ * We want Title and Summary to do a great job establishing the 4 key things: topic from a source for year and region.
+ *
+ * Title/summary text are required to state what the thing is, e.g. "Earthquakes" or "Public Health Dashboard"
+ * Title/summary text often benefit from having words like "Global" or "World" to indicate the area included.
+ * Title/summary text often benefit from having a source indicated (unless the source name is very long)
+ * Title/summary text often benefit from having a version, vintage or year indicated
+ *
+ *
+ * @see https://devtopia.esri.com/kenn4005/Curator_Suggestions/issues/9
+ *
+ */
+export declare const checkRecommendedText: (item: IItem) => ValidationInfo;

package/dist/lib/recommendedText/checkRecommendedText.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkRecommendedText = void 0;
+const stringsConfig_1 = require("../util/stringsConfig");
+const isLayer_1 = require("../util/isLayer");
+const getScoringRules_1 = require("../util/getScoringRules");
+const matchLocationInfo_1 = require("./matchLocationInfo");
+const matchDateTimeInfo_1 = require("./matchDateTimeInfo");
+const matchSourceInfo_1 = require("./matchSourceInfo");
+const matchTopicInfo_1 = require("./matchTopicInfo");
+const scoringConfig_1 = require("./scoringConfig");
+const shouldValidateByBetaRules_1 = require("../util/shouldValidateByBetaRules");
+/**
+ * Check for required and recommended text in items' title and summary text.
+ * We want Title and Summary to do a great job establishing the 4 key things: topic from a source for year and region.
+ *
+ * Title/summary text are required to state what the thing is, e.g. "Earthquakes" or "Public Health Dashboard"
+ * Title/summary text often benefit from having words like "Global" or "World" to indicate the area included.
+ * Title/summary text often benefit from having a source indicated (unless the source name is very long)
+ * Title/summary text often benefit from having a version, vintage or year indicated
+ *
+ *
+ * @see https://devtopia.esri.com/kenn4005/Curator_Suggestions/issues/9
+ *
+ */
+const checkRecommendedText = (item) => {
+    const localeByCultreProperty = (0, getScoringRules_1.getScoringRulesLocale)(item.culture);
+    const localeByItemOwner = (0, getScoringRules_1.getScoringRulesLocaleByItemOwner)(item.owner);
+    const isEnglishedBased = localeByCultreProperty === 'en' && localeByItemOwner === 'en';
+    const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
+    const weightFactors = scoringConfig_1.scoringConfig.weightFactors.DEFAULT;
+    /**
+     * Jim Herris has confirmed that we should only check the recommend text for items meeting the following criteria:
+     * 1. The item is a layer
+     * 2. The item is English-based
+     * 3. The item is qualified for validation under beta rule (this is a temporary condition for the beta release of this rule)
+     */
+    const shouldCheckRecommendedText = (0, isLayer_1.isLayer)(item) && isEnglishedBased && (0, shouldValidateByBetaRules_1.shouldValidateByBetaRules)(item);
+    const validationResult = {
+        property: 'recommendedTextInTitleAndSummary',
+        label: stringsConfig.recommendedTextInTitleAndSummary.LABEL,
+        title: stringsConfig.recommendedTextInTitleAndSummary.TITLE,
+        maxScore: 0,
+        score: 0,
+        messages: [],
+        weight: scoringConfig_1.scoringConfig.weight,
+        weightFactor: 0,
+        critical: true,
+    };
+    // Return the validationResult with a weight of 0 (so this rule does not contribute to the final score)
+    // if the recommended text does not need to be checked.
+    if (shouldCheckRecommendedText === false) {
+        return Object.assign(Object.assign({}, validationResult), { weight: 0, critical: false });
+    }
+    const matchedLocationInfo = (0, matchLocationInfo_1.matchLocationInfo)(item);
+    const matchedTimeInfo = (0, matchDateTimeInfo_1.matchDateTimeInfo)(item);
+    const matchedSourceInfo = (0, matchSourceInfo_1.matchSourceInfo)(item);
+    const matchedTopicInfo = (0, matchTopicInfo_1.matchTopicInfo)(item);
+    if (!matchedLocationInfo.length) {
+        validationResult.messages.push({
+            message: stringsConfig.recommendedTextInTitleAndSummary
+                .ADD_LOCATION_INFO,
+        });
+    }
+    else {
+        validationResult.weightFactor += weightFactors.CONTAINS_LOCATION_INFO;
+    }
+    if (!matchedTimeInfo.length) {
+        validationResult.messages.push({
+            message: stringsConfig.recommendedTextInTitleAndSummary.ADD_TIME_INFO,
+        });
+    }
+    else {
+        validationResult.weightFactor += weightFactors.CONTAINS_TIME_INFO;
+    }
+    if (!matchedSourceInfo.length) {
+        validationResult.messages.push({
+            message: stringsConfig.recommendedTextInTitleAndSummary.ADD_SOURCE_INFO,
+        });
+    }
+    else {
+        validationResult.weightFactor += weightFactors.CONTAINS_SOURCE_INFO;
+    }
+    if (!matchedTopicInfo.length) {
+        validationResult.messages.push({
+            message: stringsConfig.recommendedTextInTitleAndSummary.ADD_TOPIC_INFO,
+        });
+    }
+    else {
+        validationResult.weightFactor += weightFactors.CONTAINS_TOPIC_INFO;
+    }
+    return validationResult;
+};
+exports.checkRecommendedText = checkRecommendedText;
+//# sourceMappingURL=checkRecommendedText.js.map

package/dist/lib/recommendedText/checkRecommendedText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkRecommendedText.js","sourceRoot":"","sources":["../../../src/lib/recommendedText/checkRecommendedText.ts"],"names":[],"mappings":";;;AAGA,yDAAyD;AAEzD,6CAA0C;AAC1C,6DAGiC;AACjC,2DAAwD;AACxD,2DAAwD;AACxD,uDAAoD;AACpD,qDAAkD;AAClD,mDAAgD;AAChD,iFAA8E;AAE9E;;;;;;;;;;;;GAYG;AACI,MAAM,oBAAoB,GAAG,CAAC,IAAW,EAAkB,EAAE;IAChE,MAAM,sBAAsB,GAAG,IAAA,uCAAqB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEnE,MAAM,iBAAiB,GAAG,IAAA,kDAAgC,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEvE,MAAM,gBAAgB,GAClB,sBAAsB,KAAK,IAAI,IAAI,iBAAiB,KAAK,IAAI,CAAC;IAElE,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,aAAa,GAAG,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC;IAE1D;;;;;OAKG;IACH,MAAM,0BAA0B,GAC5B,IAAA,iBAAO,EAAC,IAAI,CAAC,IAAI,gBAAgB,IAAI,IAAA,qDAAyB,EAAC,IAAI,CAAC,CAAC;IAEzE,MAAM,gBAAgB,GAAmB;QACrC,QAAQ,EAAE,kCAAkC;QAC5C,KAAK,EAAE,aAAa,CAAC,gCAAgC,CAAC,KAAK;QAC3D,KAAK,EAAE,aAAa,CAAC,gCAAgC,CAAC,KAAK;QAC3D,QAAQ,EAAE,CAAC;QACX,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,IAAI;KACjB,CAAC;IAEF,uGAAuG;IACvG,uDAAuD;IACvD,IAAI,0BAA0B,KAAK,KAAK,EAAE;QACtC,uCACO,gBAAgB,KACnB,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,KAAK,IACjB;KACL;IAED,MAAM,mBAAmB,GAAa,IAAA,qCAAiB,EAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAa,IAAA,qCAAiB,EAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,iBAAiB,GAAa,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAa,IAAA,+BAAc,EAAC,IAAI,CAAC,CAAC;IAExD,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE;QAC7B,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3B,OAAO,EACH,aAAa,CAAC,gCAAgC;iBACzC,iBAAiB;SAC7B,CAAC,CAAC;KACN;SAAM;QACH,gBAAgB,CAAC,YAAY,IAAI,aAAa,CAAC,sBAAsB,CAAC;KACzE;IAED,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;QACzB,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3B,OAAO,EACH,aAAa,CAAC,gCAAgC,CAAC,aAAa;SACnE,CAAC,CAAC;KACN;SAAM;QACH,gBAAgB,CAAC,YAAY,IAAI,aAAa,CAAC,kBAAkB,CAAC;KACrE;IAED,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE;QAC3B,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3B,OAAO,EACH,aAAa,CAAC,gCAAgC,CAAC,eAAe;SACrE,CAAC,CAAC;KACN;SAAM;QACH,gBAAgB,CAAC,YAAY,IAAI,aAAa,CAAC,oBAAoB,CAAC;KACvE;IAED,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;QAC1B,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3B,OAAO,EACH,aAAa,CAAC,gCAAgC,CAAC,cAAc;SACpE,CAAC,CAAC;KACN;SAAM;QACH,gBAAgB,CAAC,YAAY,IAAI,aAAa,CAAC,mBAAmB,CAAC;KACtE;IAED,OAAO,gBAAgB,CAAC;AAC5B,CAAC,CAAC;AAtFW,QAAA,oBAAoB,wBAsF/B"}

package/dist/lib/recommendedText/helpers.d.ts

@@ -0,0 +1,8 @@
+export declare const removeOverlapped: (arr: string[]) => string[];
+/**
+ * Removes duplicate strings from an array, ignoring case sensitivity.
+ *
+ * @param arr - The array of strings to deduplicate.
+ * @returns A new array with duplicates removed, preserving the original case of the first occurrence.
+ */
+export declare const deduplicate: (arr: string[]) => string[];

package/dist/lib/recommendedText/helpers.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deduplicate = exports.removeOverlapped = void 0;
+const removeOverlapped = (arr) => {
+    const output = [];
+    arr.sort((a, b) => b.length - a.length);
+    for (const candidate of arr) {
+        let shouldNotInclude = false;
+        for (const word of output) {
+            if (word.toLocaleLowerCase().includes(candidate.toLowerCase())) {
+                shouldNotInclude = true;
+                break;
+            }
+        }
+        if (shouldNotInclude) {
+            continue;
+        }
+        output.push(candidate);
+    }
+    return output;
+};
+exports.removeOverlapped = removeOverlapped;
+/**
+ * Removes duplicate strings from an array, ignoring case sensitivity.
+ *
+ * @param arr - The array of strings to deduplicate.
+ * @returns A new array with duplicates removed, preserving the original case of the first occurrence.
+ */
+const deduplicate = (arr) => {
+    if (!arr || arr.length === 0) {
+        return [];
+    }
+    const seen = new Set();
+    return arr.filter((str) => {
+        const lowerStr = str.toLocaleLowerCase();
+        if (seen.has(lowerStr)) {
+            return false;
+        }
+        seen.add(lowerStr);
+        return true;
+    });
+};
+exports.deduplicate = deduplicate;
+//# sourceMappingURL=helpers.js.map

package/dist/lib/recommendedText/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/lib/recommendedText/helpers.ts"],"names":[],"mappings":";;;AAAO,MAAM,gBAAgB,GAAG,CAAC,GAAa,EAAY,EAAE;IACxD,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAExC,KAAK,MAAM,SAAS,IAAI,GAAG,EAAE;QACzB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE;YACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE;gBAC5D,gBAAgB,GAAG,IAAI,CAAC;gBACxB,MAAM;aACT;SACJ;QAED,IAAI,gBAAgB,EAAE;YAClB,SAAS;SACZ;QAED,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC1B;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAvBW,QAAA,gBAAgB,oBAuB3B;AAEF;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAC,GAAa,EAAY,EAAE;IACnD,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,EAAE,CAAC;KACb;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACtB,MAAM,QAAQ,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACpB,OAAO,KAAK,CAAC;SAChB;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAfW,QAAA,WAAW,eAetB"}

package/dist/lib/recommendedText/matchDateTimeInfo.d.ts

@@ -0,0 +1,9 @@
+import { IItem } from '../../types';
+/**
+ * Matches date and time information from the title and snippet of an item.
+ *
+ * @param {IItem} item - The item containing title and snippet to be matched against.
+ * @param {string[]} [customMatchingPattenrs] - Optional custom matching patterns to be included in the regex.
+ * @returns {string[]} - An array of matched date and time information strings.
+ */
+export declare const matchDateTimeInfo: (item: IItem, customMatchingPattenrs?: string[]) => string[];

package/dist/lib/recommendedText/matchDateTimeInfo.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchDateTimeInfo = void 0;
+const helpers_1 = require("./helpers");
+const TitleSummaryMatchingPatterns_json_1 = __importDefault(require("../../data/TitleSummaryMatchingPatterns.json"));
+/**
+ *  Match time intervals relative to the present moment rather than specifying an absolute date or time
+ * - `\b`: Word boundary to ensure we match whole words and not substrings.
+ * - `(?:(last|past|next|current|latest|every)\s+)?`: A non-capturing group to optionally match words like "last", "past", "next", "current", "latest", and "every" followed by one or more spaces (\s+). The ? at the end makes this group optional.
+ * - `(\d+)?`: An optional capturing group to match one or more digits. This covers patterns like "7", "14", "48", etc.
+ * - `\s*`: Zero or more spaces. This handles cases where there might or might not be spaces between the number and the time unit.
+ * - `(year|month|week|day|hour|minute)s?`: A capturing group to match the time units: "year", "month", "week", "day", "hour", and "minute". The s? makes the "s" optional to handle both singular and plural forms (e.g., "day" and "days").
+ */
+const relativeDateTimeRegex = /\b(?:(last|past|next|current|latest|every)\s+)(\d+)?\s*(year|month|week|day|hour|minute)s?\b/gi;
+/**
+ * A regular expression that matches time duration: e.g. '10-months', '5 Year', '3 hours'
+ */
+const timeDurationRegEx = /\b(\d+)(?:-)?\s*(year|month|week|day|hour|minute)s?\b/gi;
+/**
+ * A regular expression that matches the provided year-related patterns. e.g. '2022', '2020-2024', '1950 to 2050'
+ * Here's a breakdown of the regular expression:
+ *
+ * - `\b`: Word boundary to ensure we match whole words and not substrings.
+ * - `(?:\d{4}|present)`: A non-capturing group to match either a four-digit year (\d{4}) or the word "present".
+ * - `(?:\s*(?:-|and|to)\s*(?:\d{4}|present))?`: An optional non-capturing group to match a range or conjunction with:
+ *   - `(?:-|and|to)`: A non-capturing group to match a hyphen (-), the word "and", or the word "to".
+ *   - `(?:\d{4}|present)`: A non-capturing group to match either a four-digit year or the word "present".
+ * - `\b`: Word boundary to ensure we match whole words and not substrings.
+ */
+const yearRangeRegEx = /\b(?:\d{4}|present)(?:\s*(?:-|and|to)\s*(?:\d{4}|present))?\b/gi;
+/**
+ * Match text like '20th century'
+ */
+const centuryRegEx = /\b(\d{1,2}(?:st|nd|rd|th)\s+century)\b/gi;
+const additionalPatterns = /\b(once\s+a\s+day|monthly|daily|hourly|annual)\b/gi;
+let matchingPatterns = TitleSummaryMatchingPatterns_json_1.default.time.join('|');
+/**
+ * Matches date and time information from the title and snippet of an item.
+ *
+ * @param {IItem} item - The item containing title and snippet to be matched against.
+ * @param {string[]} [customMatchingPattenrs] - Optional custom matching patterns to be included in the regex.
+ * @returns {string[]} - An array of matched date and time information strings.
+ */
+const matchDateTimeInfo = (item, customMatchingPattenrs) => {
+    // const regex = new RegExp(regex1, 'gi')
+    const title = item.title || '';
+    const snippet = item.snippet || '';
+    const combined = [
+        relativeDateTimeRegex,
+        timeDurationRegEx,
+        yearRangeRegEx,
+        centuryRegEx,
+        additionalPatterns,
+    ];
+    if (customMatchingPattenrs) {
+        matchingPatterns = `${matchingPatterns}|${customMatchingPattenrs.join('|')}`;
+    }
+    const patternsFromTextLabelingData = new RegExp(`\\b(${matchingPatterns})\\b`, 'gi');
+    // console.log(dateInfoText, patternsFromTextLabelingData)
+    combined.push(patternsFromTextLabelingData);
+    let candidates = [];
+    for (const regex of combined) {
+        const matchedLocationsFromTitle = title.match(regex) || [];
+        const matchedLocationsFromSnippet = snippet.match(regex) || [];
+        const matched = [
+            ...matchedLocationsFromTitle,
+            ...matchedLocationsFromSnippet,
+        ];
+        for (const text of matched) {
+            candidates.push(text);
+        }
+    }
+    candidates = (0, helpers_1.deduplicate)(candidates);
+    return (0, helpers_1.removeOverlapped)(candidates);
+};
+exports.matchDateTimeInfo = matchDateTimeInfo;
+//# sourceMappingURL=matchDateTimeInfo.js.map

package/dist/lib/recommendedText/matchDateTimeInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchDateTimeInfo.js","sourceRoot":"","sources":["../../../src/lib/recommendedText/matchDateTimeInfo.ts"],"names":[],"mappings":";;;;;;AACA,uCAA0D;AAC1D,qHAAwF;AAExF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GACvB,gGAAgG,CAAC;AAErG;;GAEG;AACH,MAAM,iBAAiB,GACnB,yDAAyD,CAAC;AAE9D;;;;;;;;;;GAUG;AACH,MAAM,cAAc,GAChB,iEAAiE,CAAC;AAEtE;;GAEG;AACH,MAAM,YAAY,GAAG,0CAA0C,CAAC;AAEhE,MAAM,kBAAkB,GAAG,oDAAoD,CAAC;AAEhF,IAAI,gBAAgB,GAAG,2CAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEnE;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAC7B,IAAW,EACX,sBAAiC,EACzB,EAAE;IACV,yCAAyC;IAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAEnC,MAAM,QAAQ,GAAG;QACb,qBAAqB;QACrB,iBAAiB;QACjB,cAAc;QACd,YAAY;QACZ,kBAAkB;KACrB,CAAC;IAEF,IAAI,sBAAsB,EAAE;QACxB,gBAAgB,GAAG,GAAG,gBAAgB,IAAI,sBAAsB,CAAC,IAAI,CACjE,GAAG,CACN,EAAE,CAAC;KACP;IAED,MAAM,4BAA4B,GAAG,IAAI,MAAM,CAC3C,OAAO,gBAAgB,MAAM,EAC7B,IAAI,CACP,CAAC;IACF,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAE5C,IAAI,UAAU,GAAa,EAAE,CAAC;IAE9B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;QAC1B,MAAM,yBAAyB,GAAa,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACrE,MAAM,2BAA2B,GAC7B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAE/B,MAAM,OAAO,GAAG;YACZ,GAAG,yBAAyB;YAC5B,GAAG,2BAA2B;SACjC,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;YACxB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;KACJ;IAED,UAAU,GAAG,IAAA,qBAAW,EAAC,UAAU,CAAC,CAAC;IAErC,OAAO,IAAA,0BAAgB,EAAC,UAAU,CAAC,CAAC;AACxC,CAAC,CAAC;AAlDW,QAAA,iBAAiB,qBAkD5B"}

package/dist/lib/recommendedText/matchLocationInfo.d.ts

@@ -0,0 +1,9 @@
+import { IItem } from '../../types';
+/**
+ * Matches location information from an item's title and snippet using predefined or custom matching patterns.
+ *
+ * @param {IItem} item - The item containing title and snippet to search for location information.
+ * @param {string[]} [customMatchingPattenrs] - Optional custom matching patterns to be included in the search.
+ * @returns {string[]} - An array of matched location strings after deduplication and removing overlaps.
+ */
+export declare const matchLocationInfo: (item: IItem, customMatchingPattenrs?: string[]) => string[];