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

package/dist/lib/checkTitleAndSnippetSearchability/data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../../src/lib/checkTitleAndSnippetSearchability/data.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,qBAAqB;AACrB,iBAAiB;AACjB,iBAAiB;AACjB,wBAAwB;AACxB,iBAAiB;AACjB,gBAAgB;AAChB,kBAAkB;AAClB,oBAAoB;AACpB,6BAA6B;AAC7B,mBAAmB;AACnB,iBAAiB;AACjB,eAAe;AACf,mBAAmB;AACnB,iBAAiB;AACjB,oBAAoB;AACpB,gBAAgB;AAChB,iBAAiB;AACjB,iBAAiB;AACjB,oBAAoB;AACpB,kBAAkB;AAClB,iBAAiB;AACjB,iBAAiB;AACjB,gBAAgB;AAChB,eAAe;AACf,iBAAiB;AACjB,gBAAgB;AAChB,iBAAiB;AACjB,iBAAiB;AACjB,gCAAgC;AAChC,kBAAkB;AAClB,uBAAuB;AACvB,gBAAgB;AAChB,wCAAwC;AACxC,gCAAgC;AAChC,2BAA2B;AAC3B,kBAAkB;AAClB,sBAAsB;AACtB,iBAAiB;AACjB,oBAAoB;AACpB,kBAAkB;AAClB,kBAAkB;AAClB,gBAAgB;AAChB,kBAAkB;AAClB,wBAAwB;AACxB,kCAAkC;AAClC,cAAc;AACd,eAAe;AACf,eAAe;AACf,0BAA0B;AAC1B,uBAAuB;AACvB,kBAAkB;AAClB,iBAAiB;AACjB,eAAe;AACf,mBAAmB;AACnB,sBAAsB;AACtB,oBAAoB;AACpB,uBAAuB;AACvB,iBAAiB;AACjB,cAAc;AACd,iBAAiB;AACjB,gBAAgB;AAChB,wBAAwB;AACxB,iBAAiB;AACjB,kBAAkB;AAClB,kBAAkB;AAClB,4BAA4B;AAC5B,iBAAiB;AACjB,eAAe;AACf,qBAAqB;AACrB,2BAA2B;AAC3B,iBAAiB;AACjB,iBAAiB;AACjB,kBAAkB;AAClB,kBAAkB;AAClB,0BAA0B;AAC1B,uBAAuB;AACvB,cAAc;AACd,iBAAiB;AACjB,gBAAgB;AAChB,uBAAuB;AACvB,0BAA0B;AAC1B,qCAAqC;AACrC,eAAe;AACf,gBAAgB;AAChB,iBAAiB;AACjB,iBAAiB;AACjB,eAAe;AACf,mBAAmB;AACnB,0BAA0B;AAC1B,gBAAgB;AAChB,mBAAmB;AACnB,iBAAiB;AACjB,oBAAoB;AACpB,cAAc;AACd,mBAAmB;AACnB,kBAAkB;AAClB,gBAAgB;AAChB,uBAAuB;AACvB,gBAAgB;AAChB,eAAe;AACf,2CAA2C;AAC3C,kBAAkB;AAClB,iBAAiB;AACjB,iBAAiB;AACjB,eAAe;AACf,mBAAmB;AACnB,cAAc;AACd,cAAc;AACd,iBAAiB;AACjB,qBAAqB;AACrB,gBAAgB;AAChB,eAAe;AACf,iBAAiB;AACjB,eAAe;AACf,gBAAgB;AAChB,gBAAgB;AAChB,6BAA6B;AAC7B,oBAAoB;AACpB,eAAe;AACf,kBAAkB;AAClB,gBAAgB;AAChB,oBAAoB;AACpB,cAAc;AACd,gBAAgB;AAChB,iBAAiB;AACjB,iBAAiB;AACjB,iBAAiB;AACjB,eAAe;AACf,uBAAuB;AACvB,mBAAmB;AACnB,oBAAoB;AACpB,oBAAoB;AACpB,iBAAiB;AACjB,gBAAgB;AAChB,kBAAkB;AAClB,kBAAkB;AAClB,cAAc;AACd,eAAe;AACf,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,mBAAmB;AACnB,iBAAiB;AACjB,gBAAgB;AAChB,oBAAoB;AACpB,iBAAiB;AACjB,gBAAgB;AAChB,kBAAkB;AAClB,oBAAoB;AACpB,oBAAoB;AACpB,iBAAiB;AACjB,oBAAoB;AACpB,iBAAiB;AACjB,iBAAiB;AACjB,eAAe;AACf,eAAe;AACf,qBAAqB;AACrB,uBAAuB;AACvB,qBAAqB;AACrB,mBAAmB;AACnB,eAAe;AACf,iBAAiB;AACjB,cAAc;AACd,wBAAwB;AACxB,qBAAqB;AACrB,yBAAyB;AACzB,kCAAkC;AAClC,gBAAgB;AAChB,cAAc;AACd,kBAAkB;AAClB,eAAe;AACf,+BAA+B;AAC/B,gBAAgB;AAChB,0BAA0B;AAC1B,kBAAkB;AAClB,cAAc;AACd,qBAAqB;AACrB,kBAAkB;AAClB,gBAAgB;AAChB,kBAAkB;AAClB,qBAAqB;AACrB,eAAe;AACf,iBAAiB;AACjB,iBAAiB;AACjB,4BAA4B;AAC5B,gBAAgB;AAChB,cAAc;AACd,0BAA0B;AAC1B,yBAAyB;AACzB,sBAAsB;AACtB,+BAA+B;AAC/B,qBAAqB;AACrB,sBAAsB;AACtB,mCAAmC;AACnC,0CAA0C;AAC1C,eAAe;AACf,oBAAoB;AACpB,+BAA+B;AAC/B,sBAAsB;AACtB,iBAAiB;AACjB,gBAAgB;AAChB,oBAAoB;AACpB,sBAAsB;AACtB,mBAAmB;AACnB,sBAAsB;AACtB,kBAAkB;AAClB,kBAAkB;AAClB,yBAAyB;AACzB,iBAAiB;AACjB,sBAAsB;AACtB,kDAAkD;AAClD,qBAAqB;AACrB,qBAAqB;AACrB,eAAe;AACf,mBAAmB;AACnB,eAAe;AACf,kBAAkB;AAClB,kBAAkB;AAClB,gBAAgB;AAChB,qBAAqB;AACrB,eAAe;AACf,oBAAoB;AACpB,kBAAkB;AAClB,kBAAkB;AAClB,qBAAqB;AACrB,cAAc;AACd,iBAAiB;AACjB,eAAe;AACf,6BAA6B;AAC7B,iBAAiB;AACjB,iBAAiB;AACjB,sBAAsB;AACtB,kCAAkC;AAClC,gBAAgB;AAChB,gBAAgB;AAChB,iBAAiB;AACjB,8BAA8B;AAC9B,wBAAwB;AACxB,uBAAuB;AACvB,iBAAiB;AACjB,2BAA2B;AAC3B,oBAAoB;AACpB,iBAAiB;AACjB,sBAAsB;AACtB,mBAAmB;AACnB,iBAAiB;AACjB,2BAA2B;AAC3B,eAAe;AACf,gBAAgB;AAChB,kBAAkB;AAElB,iBAAiB;AACjB,gBAAgB;AAChB,iBAAiB;AACjB,kBAAkB;AAClB,oBAAoB;AACpB,kBAAkB;AAClB,qBAAqB;AACrB,kBAAkB;AAClB,8BAA8B;AAC9B,iBAAiB;AACjB,iBAAiB;AACjB,gBAAgB;AAChB,eAAe;AACf,kBAAkB;AAClB,iBAAiB;AACjB,cAAc;AACd,gBAAgB;AAChB,kBAAkB;AAClB,mBAAmB;AACnB,eAAe;AACf,kBAAkB;AAClB,uBAAuB;AACvB,kBAAkB;AAClB,mBAAmB;AACnB,qBAAqB;AACrB,kBAAkB;AAClB,iBAAiB;AACjB,kBAAkB;AAClB,gBAAgB;AAChB,uBAAuB;AACvB,oBAAoB;AACpB,oBAAoB;AACpB,kBAAkB;AAClB,wBAAwB;AACxB,sBAAsB;AACtB,cAAc;AACd,kBAAkB;AAClB,gBAAgB;AAChB,sBAAsB;AACtB,sBAAsB;AACtB,wBAAwB;AACxB,sBAAsB;AACtB,mBAAmB;AACnB,eAAe;AACf,cAAc;AACd,iBAAiB;AACjB,kBAAkB;AAClB,oBAAoB;AACpB,uBAAuB;AACvB,mBAAmB;AACnB,iBAAiB;AACjB,0BAA0B;AAC1B,wBAAwB;AACxB,uBAAuB;AACvB,cAAc;AAEd,iBAAiB;AACjB,eAAe;AACf,kBAAkB;AAClB,qBAAqB;AACrB,qBAAqB;AACrB,sBAAsB;AACtB,cAAc;AACd,eAAe;AACf,gBAAgB;AAChB,mBAAmB;AACnB,uBAAuB;AACvB,mBAAmB;AACnB,iBAAiB;AACjB,iBAAiB;AACjB,wBAAwB;AACxB,yBAAyB;AACzB,oBAAoB;AACpB,gBAAgB;AAChB,oBAAoB;AACpB,eAAe;AACf,kBAAkB;AAClB,mBAAmB;AACnB,uBAAuB;AACvB,iBAAiB;AACjB,kBAAkB;AAClB,mBAAmB;AACnB,eAAe;AACf,eAAe;AACf,kBAAkB;AAClB,mBAAmB;AACnB,gBAAgB;AAChB,iBAAiB;AACjB,mBAAmB;AACnB,mBAAmB;AACnB,sBAAsB;AACtB,mBAAmB;AACnB,uBAAuB;AACvB,iBAAiB;AACjB,oBAAoB;AACpB,gBAAgB;AAChB,iBAAiB;AACjB,kBAAkB;AAClB,qBAAqB;AACrB,qBAAqB;AACrB,kBAAkB;AAClB,kBAAkB;AAClB,iBAAiB;AACjB,0BAA0B;AAC1B,kBAAkB;AAClB,oBAAoB;AACpB,oBAAoB;AACpB,uBAAuB;AACvB,oBAAoB;AACpB,gBAAgB;AAChB,oBAAoB;AACpB,uBAAuB;AACvB,kBAAkB;AAClB,iBAAiB;AACjB,gBAAgB;AAChB,sBAAsB;AACtB,qBAAqB;AACrB,oBAAoB;AACpB,iBAAiB;AACjB,sBAAsB;AACtB,gBAAgB;AAChB,qBAAqB;AACrB,qBAAqB;AACrB,mBAAmB;AACnB,gBAAgB;AAChB,uBAAuB;AACvB,iBAAiB;AACjB,kBAAkB;AAClB,eAAe;AACf,0BAA0B;AAC1B,eAAe;AACf,kBAAkB;AAClB,iBAAiB;AACjB,oBAAoB;AACpB,gBAAgB;AAChB,oBAAoB;AACpB,qBAAqB;AACrB,kBAAkB;AAClB,qBAAqB;AACrB,kBAAkB;AAClB,oBAAoB;AACpB,oBAAoB;AACpB,yBAAyB;AACzB,kBAAkB;AAClB,mBAAmB;AACnB,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,kBAAkB;AAClB,mBAAmB;AACnB,gBAAgB;AAChB,yBAAyB;AACzB,kBAAkB;AAClB,mBAAmB;AACnB,mBAAmB;AACnB,sBAAsB;AACtB,mBAAmB;AACnB,kBAAkB;AAClB,gBAAgB;AAChB,iBAAiB;AACjB,iBAAiB;AACjB,kBAAkB;AAClB,mBAAmB;AACnB,eAAe;AACf,iBAAiB;AACjB,kBAAkB;AAClB,qBAAqB;AACrB,gBAAgB;AAChB,uBAAuB;AACvB,gBAAgB;AAChB,qBAAqB;AACrB,gBAAgB;AAChB,iBAAiB;AACjB,oBAAoB;AACpB,mBAAmB;AACnB,0BAA0B;AAC1B,uBAAuB;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,kBAAkB;AAClB,cAAc;AACd,kBAAkB;AAClB,iBAAiB;AACjB,mBAAmB;AACnB,gBAAgB;AAChB,sBAAsB;AACtB,cAAc;AACd,kBAAkB;AAClB,gBAAgB;AAChB,gBAAgB;AAChB,gBAAgB;AAChB,0BAA0B;AAC1B,qBAAqB;AACrB,gBAAgB;AAChB,iBAAiB;AACjB,kBAAkB;AAClB,iBAAiB;AACjB,kBAAkB;AAClB,kBAAkB;AAClB,mBAAmB;AACnB,kBAAkB;AAClB,mBAAmB;AACnB,kBAAkB;AAClB,kBAAkB;AAClB,oBAAoB;AACpB,kBAAkB;AAClB,oBAAoB;AACpB,kBAAkB;AAClB,oBAAoB;AACpB,gBAAgB;AAChB,mBAAmB;AACnB,gBAAgB;AAChB,kBAAkB;AAClB,kBAAkB;AAClB,sBAAsB;AACtB,mBAAmB;AACnB,iBAAiB;AACjB,iBAAiB;AACjB,mBAAmB;AACnB,qBAAqB;AACrB,kBAAkB;AAClB,qBAAqB;AACrB,gBAAgB;AAChB,2BAA2B;AAC3B,oBAAoB;AACpB,kBAAkB;AAClB,iBAAiB;AACjB,iBAAiB;AACjB,qBAAqB;AACrB,qBAAqB;AACrB,kBAAkB;AAClB,sBAAsB;AACtB,wBAAwB;AACxB,sBAAsB;AACtB,mBAAmB;AACnB,mBAAmB;AACnB,0BAA0B;AAC1B,cAAc;AACd,iBAAiB;AACjB,eAAe;AACf,mBAAmB;AACnB,gBAAgB;AAChB,oBAAoB;AACpB,gBAAgB;AAChB,eAAe;AACf,qBAAqB;AACrB,yBAAyB;AACzB,sBAAsB;AACtB,qBAAqB;AACrB,oBAAoB;AACpB,eAAe;AACf,mBAAmB;AACnB,mBAAmB;AACnB,oBAAoB;AACpB,gBAAgB;AAChB,kBAAkB;AAClB,qBAAqB;AACrB,oBAAoB;AACpB,kBAAkB;AAClB,uBAAuB;AACvB,qBAAqB;AACrB,kBAAkB;AAClB,uBAAuB;AACvB,0BAA0B;AAC1B,sBAAsB;AACtB,wBAAwB;AACxB,kBAAkB;AAClB,gBAAgB;AAChB,oBAAoB;AACpB,oBAAoB;AACpB,gBAAgB;AAChB,iBAAiB;AACjB,qBAAqB;AACrB,wBAAwB;AACxB,uBAAuB;AACvB,mBAAmB;AACnB,kBAAkB;AAClB,iBAAiB;AACjB,sBAAsB;AACtB,uBAAuB;AACvB,mBAAmB;AACnB,iBAAiB;AACjB,oBAAoB;AACpB,oBAAoB;AACpB,uBAAuB;AACvB,iBAAiB;AACjB,gBAAgB;AAChB,oBAAoB;AACpB,wBAAwB;AACxB,iBAAiB;AACjB,kBAAkB;AAClB,qBAAqB;AACrB,uBAAuB;AACvB,iBAAiB;AACjB,iBAAiB;AACjB,oBAAoB;AACpB,iBAAiB;AACjB,mBAAmB;AACnB,oBAAoB;AACpB,iBAAiB;AACjB,oBAAoB;AACpB,kBAAkB;AAClB,oBAAoB;AACpB,uBAAuB;AACvB,gBAAgB;AAChB,gBAAgB;AAChB,iBAAiB;AACjB,wBAAwB;AACxB,yBAAyB;AACzB,oBAAoB;AACpB,cAAc;AACd,iBAAiB;AACjB,iBAAiB;AACjB,gBAAgB;AAChB,qBAAqB;AACrB,kBAAkB;AAClB,iBAAiB;AACjB,gBAAgB;AAChB,eAAe;AACf,iBAAiB;AACjB,mBAAmB;AACnB,qBAAqB;AACrB,oBAAoB;AACpB,mBAAmB;AACnB,oBAAoB;AACpB,iBAAiB;AACjB,gBAAgB;AAChB,oBAAoB;AACpB,mBAAmB;AACnB,kBAAkB;AAClB,gBAAgB;AAChB,mBAAmB;AACnB,mBAAmB;AACnB,wBAAwB;AACxB,kBAAkB;AAClB,2BAA2B;AAC3B,iBAAiB;AACjB,wBAAwB;AACxB,mBAAmB;AACnB,qBAAqB;AACrB,eAAe;AACf,gBAAgB;AAChB,oBAAoB;AACpB,mBAAmB;AACnB,iBAAiB;AACjB,qBAAqB;AACrB,eAAe;AACf,qBAAqB;AACrB,iBAAiB;AACjB,eAAe;AACf,wBAAwB;AACxB,oBAAoB;AACpB,iBAAiB;AACjB,0BAA0B;AAC1B,eAAe;AACf,iBAAiB;AACjB,cAAc;AACd,qBAAqB;AACrB,oBAAoB;AACpB,gBAAgB;AAChB,gBAAgB;AAChB,qBAAqB;AACrB,mBAAmB;AACnB,mBAAmB;AACnB,iBAAiB;AACjB,iBAAiB;AACjB,mBAAmB;AACnB,kBAAkB;AAClB,gBAAgB;AAChB,iBAAiB;AACjB,uBAAuB;AACvB,mBAAmB;AACnB,oBAAoB;AACpB,gBAAgB;AAChB,iBAAiB;AACjB,uBAAuB;AACvB,mBAAmB;AACnB,sBAAsB;AACtB,kBAAkB;AAClB,oBAAoB;AACpB,sBAAsB;AACtB,gBAAgB;AAChB,kBAAkB;AAClB,gBAAgB;AAChB,mBAAmB;AACnB,qBAAqB;AACrB,sBAAsB;AACtB,iBAAiB;AACjB,iBAAiB;AACjB,iBAAiB;AACjB,qBAAqB;AACrB,kBAAkB;AAElB,oBAAoB;AACpB,mBAAmB;AACnB,yBAAyB;AACzB,sBAAsB;AACtB,wBAAwB;AACxB,sBAAsB;AACtB,wBAAwB;AACxB,yBAAyB;AACzB,mBAAmB;AACnB,oBAAoB;AACpB,uBAAuB;AACvB,yBAAyB;AACzB,0BAA0B;AAC1B,yBAAyB;AACzB,mBAAmB;AACnB,uBAAuB;AACvB,2BAA2B;AAC3B,yBAAyB;AACzB,uBAAuB;AACvB,yBAAyB;AACzB,wBAAwB;AACxB,sBAAsB;AACtB,wBAAwB;AAExB,uBAAuB;AACvB,kCAAkC;AAClC,aAAa;AACb,6BAA6B;AAC7B,eAAe;AACf,gBAAgB;AAChB,uBAAuB;AACvB,uBAAuB;AACvB,gBAAgB;AAChB,gBAAgB;AAChB,cAAc;AACd,iBAAiB;AACjB,mBAAmB;AACnB,gBAAgB;AAChB,kBAAkB;AAClB,iBAAiB;AACjB,uBAAuB;AACvB,sBAAsB;AACtB,oBAAoB;AACpB,uBAAuB;AACvB,mBAAmB;AACnB,wBAAwB;AACxB,qBAAqB;AACrB,mBAAmB;AACnB,gBAAgB;AAChB,oBAAoB;AACpB,KAAK"}

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

@@ -0,0 +1,117 @@
+import { IItem } from '../../types';
+type MatchUsingMultiplePatternsParams = {
+    /**
+     * The item to be checked for searchability.
+     */
+    item: IItem;
+    /**
+     * The predefined patterns to match against the item's title and snippet.
+     */
+    predefinedPatterns: RegExp;
+    /**
+     * Additional patterns to match against the item's title and snippet if no match is found with predefined patterns.
+     * These extra matching patterns are the patterns submitted by the user that have been approved by the Living Atlas team.
+     */
+    extraPatterns: RegExp;
+    /**
+     * Custom terms to match against the item's title and snippet if no match is found with predefined or extra patterns.
+     * These custom terms are the terms users submitted using the Nominatim App
+     */
+    customTerms: string[];
+    /**
+     * A set of terms that have been rejected by the Living Atlas team.
+     * any custom term that is found in this set will be ignored.
+     */
+    rejectedSet: Set<string>;
+};
+/**
+ * Represents the source of a match pattern.
+ *
+ */
+export type MatchPatternSource = 'predefined' | 'additional' | 'custom';
+/**
+ * Represents the result of a pattern match operation.
+ */
+export type MatchResult = {
+    /**
+     * The string that was matched by the pattern.
+     */
+    matchedString: string;
+    /**
+     * The source of the pattern that was used for matching: `'predefined' | 'additional' | 'custom'`
+     */
+    patternSource: MatchPatternSource;
+};
+/**
+ * Checks if a string is found in a set of strings.
+ * @param str string to be checked
+ * @param set set of strings to be checked against
+ * @returns true if the string is found in the set, false otherwise
+ */
+export declare const isFoundInSet: (str: string, set: Set<string>) => boolean;
+/**
+ * Matches patterns in an item's title and snippet using a hierarchical approach:
+ * predefined patterns first, followed by extra patterns, and finally custom terms.
+ *
+ * @param {MatchUsingMultiplePatternsParams} params - The parameters for pattern matching.
+ * @param {IItem} params.item - The item containing the title and snippet to search for patterns.
+ * @param {RegExp} params.predefinedPatterns - The predefined patterns to match against the item's title and snippet.
+ * @param {RegExp} params.extraPatterns - Additional patterns to match against the item's title and snippet if no match is found with predefined patterns. These extra matching patterns are the patterns submitted by users and approved by the Living Atlas team.
+ * @param {string[]} params.customTerms - Custom terms to match against the item's title and snippet if no match is found with predefined or extra patterns. These custom terms are user-submitted via the Nominatim App.
+ * @param {Set<string>} params.rejectedSet - A set of terms rejected by the Living Atlas team. Any custom term found in this set will be ignored.
+ *
+ * @returns {string[]} - An array of matched strings after deduplication and filtering.
+ */
+export declare const matchUsingMultiplePatterns: ({ item, predefinedPatterns, extraPatterns, customTerms, rejectedSet, }: MatchUsingMultiplePatternsParams) => MatchResult[];
+/**
+ * Matches patterns in the title and snippet of an item.
+ * @param item ArcGIS item object to be matched.
+ * @param regex Regular expression to match.
+ * @returns Array of matched strings.
+ */
+export declare const matchPatternsInTitleAndSnippet: (item: IItem, regex: RegExp, patternSource: MatchPatternSource) => MatchResult[];
+/**
+ * Matches custom patterns in the title and snippet of an item.
+ * @param item ArcGIS item object to be matched.
+ * @param customMatchingPatterns Array of custom patterns to match.
+ * @param rejectedSet Set of rejected patterns.
+ *
+ * @returns Array of matched strings.
+ */
+export declare const matchWithCustomPatterns: (item: IItem, customMatchingPatterns: string[], rejectedSet: Set<string>) => MatchResult[];
+/**
+ * Get a Set from an array of strings and convert all strings to lowercase.
+ * @param arr - The array of strings to convert to a Set
+ * @returns set - A Set containing the strings from the array
+ */
+export declare const toLowercaseSet: (arr: string[]) => Set<string>;
+/**
+ * Determines if an item is eligible for checking title and snippet searchability.
+ *
+ * @param item {IITem} - The item to check.
+ * @returns {boolean} if the item meets the criteria for checking title and snippet searchability, otherwise `false`.
+ *
+ * The criteria for eligibility are:
+ * 1. The item is a layer.
+ * 2. The item is English-based.
+ * 3. The item's culture is 'en' or the item's owner is one of the English-based owners.
+ *
+ * @remarks
+ * - The locale is determined by both the item's culture and the item's owner.
+ */
+export declare const isEligibleForCheckingTitleAndSnippetSearchability: (item: IItem) => boolean;
+/**
+ * Clean up matched results by removing duplicates and overlapping strings.
+ * @param matchedResults array of matched results
+ * @returns an array of cleaned up matched MatchResult
+ */
+export declare const cleanUpMatchedResults: (matchedResults: MatchResult[]) => MatchResult[];
+export declare const removeOverlapped: (arr: MatchResult[]) => MatchResult[];
+/**
+ * Removes duplicate matched results from an array, ignoring case sensitivity.
+ *
+ * @param arr - The array of MatchResult to deduplicate.
+ * @returns A new array with duplicates removed, preserving the original case of the first occurrence.
+ */
+export declare const deduplicate: (arr: MatchResult[]) => MatchResult[];
+export {};

package/dist/lib/checkTitleAndSnippetSearchability/helpers.js

@@ -0,0 +1,241 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deduplicate = exports.removeOverlapped = exports.cleanUpMatchedResults = exports.isEligibleForCheckingTitleAndSnippetSearchability = exports.toLowercaseSet = exports.matchWithCustomPatterns = exports.matchPatternsInTitleAndSnippet = exports.matchUsingMultiplePatterns = exports.isFoundInSet = void 0;
+const isLayer_1 = require("../util/isLayer");
+const getScoringRules_1 = require("../util/getScoringRules");
+const createWordBoundaryRegex_1 = require("../util/createWordBoundaryRegex");
+/**
+ * Checks if a string is found in a set of strings.
+ * @param str string to be checked
+ * @param set set of strings to be checked against
+ * @returns true if the string is found in the set, false otherwise
+ */
+const isFoundInSet = (str, set) => {
+    if (!set) {
+        return false;
+    }
+    // str = escapeSpecialCharacters([str])[0];
+    if (!str) {
+        return false;
+    }
+    return set.has(str.toLowerCase());
+};
+exports.isFoundInSet = isFoundInSet;
+/**
+ * Matches patterns in an item's title and snippet using a hierarchical approach:
+ * predefined patterns first, followed by extra patterns, and finally custom terms.
+ *
+ * @param {MatchUsingMultiplePatternsParams} params - The parameters for pattern matching.
+ * @param {IItem} params.item - The item containing the title and snippet to search for patterns.
+ * @param {RegExp} params.predefinedPatterns - The predefined patterns to match against the item's title and snippet.
+ * @param {RegExp} params.extraPatterns - Additional patterns to match against the item's title and snippet if no match is found with predefined patterns. These extra matching patterns are the patterns submitted by users and approved by the Living Atlas team.
+ * @param {string[]} params.customTerms - Custom terms to match against the item's title and snippet if no match is found with predefined or extra patterns. These custom terms are user-submitted via the Nominatim App.
+ * @param {Set<string>} params.rejectedSet - A set of terms rejected by the Living Atlas team. Any custom term found in this set will be ignored.
+ *
+ * @returns {string[]} - An array of matched strings after deduplication and filtering.
+ */
+const matchUsingMultiplePatterns = ({ item, predefinedPatterns, extraPatterns, customTerms, rejectedSet, }) => {
+    // try to match with predefined patterns first
+    const matchedByPredefinedPatterns = (0, exports.matchPatternsInTitleAndSnippet)(item, predefinedPatterns, 'predefined');
+    if (matchedByPredefinedPatterns.length) {
+        return matchedByPredefinedPatterns;
+    }
+    // if no match, try to match with extra patterns
+    const matchedByAdditionalPatterns = (0, exports.matchPatternsInTitleAndSnippet)(item, extraPatterns, 'additional');
+    if (matchedByAdditionalPatterns.length) {
+        return matchedByAdditionalPatterns;
+    }
+    // if no match, try to match with custom terms
+    return (0, exports.matchWithCustomPatterns)(item, customTerms, rejectedSet);
+};
+exports.matchUsingMultiplePatterns = matchUsingMultiplePatterns;
+/**
+ * Matches patterns in the title and snippet of an item.
+ * @param item ArcGIS item object to be matched.
+ * @param regex Regular expression to match.
+ * @returns Array of matched strings.
+ */
+const matchPatternsInTitleAndSnippet = (item, regex, patternSource) => {
+    const title = (item === null || item === void 0 ? void 0 : item.title) || '';
+    const snippet = (item === null || item === void 0 ? void 0 : item.snippet) || '';
+    if (!title && !snippet) {
+        return [];
+    }
+    if (!regex) {
+        return [];
+    }
+    try {
+        // const matchedStrFromTitle: string[] = title.match(regex) || [];
+        // const matchedStrFromSnippet: string[] = snippet.match(regex) || [];
+        // return cleanUpMatchedResults([
+        //     ...matchedStrFromTitle,
+        //     ...matchedStrFromSnippet,
+        // ]);
+        if (!regex.flags.includes('g')) {
+            regex = new RegExp(regex.source, `${regex.flags}g`);
+        }
+        const combined = `${title}\n${snippet}`;
+        const matches = combined.match(regex) || [];
+        const matchResults = matches.map((matchedString) => ({
+            matchedString,
+            patternSource,
+        }));
+        return (0, exports.cleanUpMatchedResults)(matchResults);
+    }
+    catch (error) {
+        console.error('Error in matchPatternsInTitleAndSnippet:', error);
+        return [];
+    }
+};
+exports.matchPatternsInTitleAndSnippet = matchPatternsInTitleAndSnippet;
+/**
+ * Matches custom patterns in the title and snippet of an item.
+ * @param item ArcGIS item object to be matched.
+ * @param customMatchingPatterns Array of custom patterns to match.
+ * @param rejectedSet Set of rejected patterns.
+ *
+ * @returns Array of matched strings.
+ */
+const matchWithCustomPatterns = (item, customMatchingPatterns, rejectedSet) => {
+    if (!customMatchingPatterns || customMatchingPatterns.length === 0) {
+        return [];
+    }
+    // remove any leading and trailing spaces
+    // and filter out any empty strings and rejected patterns
+    // return an empty array if no patterns left after filtering
+    customMatchingPatterns = customMatchingPatterns
+        .map((pattern) => pattern.trim())
+        .filter((pattern) => pattern !== '' && (0, exports.isFoundInSet)(pattern, rejectedSet) === false);
+    if (customMatchingPatterns.length === 0) {
+        return [];
+    }
+    // const escapedCustomPatterns = escapeSpecialCharacters(
+    //     customMatchingPatterns
+    // );
+    // const customPatternsRegex = new RegExp(
+    //     `\\b(${escapedCustomPatterns.join('|')})\\b`,
+    //     'gi'
+    // );
+    // const matchedStrFromTitle = title.match(customPatternsRegex) || [];
+    // const matchedStrFromSnippet = snippet.match(customPatternsRegex) || [];
+    // if (!matchedStrFromTitle.length && !matchedStrFromSnippet.length) {
+    //     return [];
+    // }
+    // // console.log('matchedStrFromTitle', matchedStrFromTitle);
+    // // console.log('matchedStrFromSnippet', matchedStrFromSnippet);
+    // const output = deduplicate([
+    //     ...matchedStrFromTitle,
+    //     ...matchedStrFromSnippet,
+    // ]);
+    // // console.log('output', output);
+    // return removeOverlapped(output);
+    const customPatternsRegex = (0, createWordBoundaryRegex_1.createWordBoundaryRegex)(customMatchingPatterns);
+    return (0, exports.matchPatternsInTitleAndSnippet)(item, customPatternsRegex, 'custom');
+};
+exports.matchWithCustomPatterns = matchWithCustomPatterns;
+/**
+ * Get a Set from an array of strings and convert all strings to lowercase.
+ * @param arr - The array of strings to convert to a Set
+ * @returns set - A Set containing the strings from the array
+ */
+const toLowercaseSet = (arr) => {
+    if (!arr || arr.length === 0) {
+        return new Set();
+    }
+    const strs = arr.map((d) => d.toLowerCase());
+    return new Set(strs);
+};
+exports.toLowercaseSet = toLowercaseSet;
+/**
+ * Determines if an item is eligible for checking title and snippet searchability.
+ *
+ * @param item {IITem} - The item to check.
+ * @returns {boolean} if the item meets the criteria for checking title and snippet searchability, otherwise `false`.
+ *
+ * The criteria for eligibility are:
+ * 1. The item is a layer.
+ * 2. The item is English-based.
+ * 3. The item's culture is 'en' or the item's owner is one of the English-based owners.
+ *
+ * @remarks
+ * - The locale is determined by both the item's culture and the item's owner.
+ */
+const isEligibleForCheckingTitleAndSnippetSearchability = (item) => {
+    if (!item) {
+        return false;
+    }
+    const isLayerItem = (0, isLayer_1.isLayer)(item);
+    if (!isLayerItem) {
+        return false;
+    }
+    const localeByCultreProperty = (0, getScoringRules_1.getScoringRulesLocale)(item.culture);
+    const localeByItemOwner = (0, getScoringRules_1.getScoringRulesLocaleByItemOwner)(item.owner);
+    // const title = item?.title || '';
+    // const snippet = item?.snippet || '';
+    // We removed the non-English character check since it was too restrictive.
+    // Some valid English-based content (like Esri Oceans data) may contain special characters
+    // such as Greek letters while still being primarily English content.
+    const isEnglishedBased = localeByCultreProperty === 'en' && localeByItemOwner === 'en';
+    // && containsNonEnglishCharacters(title + ' ' + snippet) === false;
+    return isEnglishedBased;
+};
+exports.isEligibleForCheckingTitleAndSnippetSearchability = isEligibleForCheckingTitleAndSnippetSearchability;
+/**
+ * Clean up matched results by removing duplicates and overlapping strings.
+ * @param matchedResults array of matched results
+ * @returns an array of cleaned up matched MatchResult
+ */
+const cleanUpMatchedResults = (matchedResults) => {
+    if (!matchedResults || matchedResults.length === 0) {
+        return [];
+    }
+    // remove any leading and trailing spaces
+    // and filter out any empty strings
+    matchedResults = matchedResults.filter((d) => d.matchedString.trim() !== '');
+    const candidates = (0, exports.deduplicate)(matchedResults);
+    return (0, exports.removeOverlapped)(candidates);
+};
+exports.cleanUpMatchedResults = cleanUpMatchedResults;
+const removeOverlapped = (arr) => {
+    const output = [];
+    arr.sort((a, b) => b.matchedString.length - a.matchedString.length);
+    for (const candidate of arr) {
+        let shouldNotInclude = false;
+        for (const item of output) {
+            if (item.matchedString
+                .toLowerCase()
+                .includes(candidate.matchedString.toLowerCase())) {
+                shouldNotInclude = true;
+                break;
+            }
+        }
+        if (shouldNotInclude) {
+            continue;
+        }
+        output.push(candidate);
+    }
+    return output;
+};
+exports.removeOverlapped = removeOverlapped;
+/**
+ * Removes duplicate matched results from an array, ignoring case sensitivity.
+ *
+ * @param arr - The array of MatchResult 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((d) => {
+        const lowerStr = d.matchedString.toLowerCase();
+        if (seen.has(lowerStr)) {
+            return false;
+        }
+        seen.add(lowerStr);
+        return true;
+    });
+};
+exports.deduplicate = deduplicate;
+//# sourceMappingURL=helpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/lib/checkTitleAndSnippetSearchability/helpers.ts"],"names":[],"mappings":";;;AACA,6CAA0C;AAC1C,6DAGiC;AAEjC,6EAA0E;AAiD1E;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,GAAgB,EAAE,EAAE;IAC1D,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,KAAK,CAAC;KAChB;IAED,2CAA2C;IAE3C,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AAZW,QAAA,YAAY,gBAYvB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,0BAA0B,GAAG,CAAC,EACvC,IAAI,EACJ,kBAAkB,EAClB,aAAa,EACb,WAAW,EACX,WAAW,GACoB,EAAiB,EAAE;IAClD,8CAA8C;IAC9C,MAAM,2BAA2B,GAC7B,IAAA,sCAA8B,EAAC,IAAI,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC;IAE3E,IAAI,2BAA2B,CAAC,MAAM,EAAE;QACpC,OAAO,2BAA2B,CAAC;KACtC;IAED,gDAAgD;IAChD,MAAM,2BAA2B,GAAG,IAAA,sCAA8B,EAC9D,IAAI,EACJ,aAAa,EACb,YAAY,CACf,CAAC;IAEF,IAAI,2BAA2B,CAAC,MAAM,EAAE;QACpC,OAAO,2BAA2B,CAAC;KACtC;IAED,8CAA8C;IAC9C,OAAO,IAAA,+BAAuB,EAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACnE,CAAC,CAAC;AA5BW,QAAA,0BAA0B,8BA4BrC;AAEF;;;;;GAKG;AACI,MAAM,8BAA8B,GAAG,CAC1C,IAAW,EACX,KAAa,EACb,aAAiC,EACpB,EAAE;IACf,MAAM,KAAK,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,KAAI,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,KAAI,EAAE,CAAC;IAEpC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE;QACpB,OAAO,EAAE,CAAC;KACb;IAED,IAAI,CAAC,KAAK,EAAE;QACR,OAAO,EAAE,CAAC;KACb;IAED,IAAI;QACA,kEAAkE;QAClE,sEAAsE;QAEtE,iCAAiC;QACjC,8BAA8B;QAC9B,gCAAgC;QAChC,MAAM;QAEN,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC5B,KAAK,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;SACvD;QAED,MAAM,QAAQ,GAAG,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC;QACxC,MAAM,OAAO,GAAa,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAEtD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YACjD,aAAa;YACb,aAAa;SAChB,CAAC,CAAC,CAAC;QAEJ,OAAO,IAAA,6BAAqB,EAAC,YAAY,CAAC,CAAC;KAC9C;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;QACjE,OAAO,EAAE,CAAC;KACb;AACL,CAAC,CAAC;AA1CW,QAAA,8BAA8B,kCA0CzC;AAEF;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,CACnC,IAAW,EACX,sBAAgC,EAChC,WAAwB,EAC1B,EAAE;IACA,IAAI,CAAC,sBAAsB,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE;QAChE,OAAO,EAAE,CAAC;KACb;IAED,yCAAyC;IACzC,yDAAyD;IACzD,4DAA4D;IAC5D,sBAAsB,GAAG,sBAAsB;SAC1C,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAChC,MAAM,CACH,CAAC,OAAO,EAAE,EAAE,CACR,OAAO,KAAK,EAAE,IAAI,IAAA,oBAAY,EAAC,OAAO,EAAE,WAAW,CAAC,KAAK,KAAK,CACrE,CAAC;IAEN,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,OAAO,EAAE,CAAC;KACb;IAED,yDAAyD;IACzD,6BAA6B;IAC7B,KAAK;IAEL,0CAA0C;IAC1C,oDAAoD;IACpD,WAAW;IACX,KAAK;IAEL,sEAAsE;IACtE,0EAA0E;IAE1E,sEAAsE;IACtE,iBAAiB;IACjB,IAAI;IACJ,8DAA8D;IAC9D,kEAAkE;IAElE,+BAA+B;IAC/B,8BAA8B;IAC9B,gCAAgC;IAChC,MAAM;IACN,oCAAoC;IAEpC,mCAAmC;IAEnC,MAAM,mBAAmB,GAAG,IAAA,iDAAuB,EAAC,sBAAsB,CAAC,CAAC;IAE5E,OAAO,IAAA,sCAA8B,EAAC,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AAC/E,CAAC,CAAC;AApDW,QAAA,uBAAuB,2BAoDlC;AAEF;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAAC,GAAa,EAAe,EAAE;IACzD,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,IAAI,GAAG,EAAE,CAAC;KACpB;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAE7C,OAAO,IAAI,GAAG,CAAS,IAAI,CAAC,CAAC;AACjC,CAAC,CAAC;AARW,QAAA,cAAc,kBAQzB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,iDAAiD,GAAG,CAC7D,IAAW,EACJ,EAAE;IACT,IAAI,CAAC,IAAI,EAAE;QACP,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,WAAW,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,CAAC;IAElC,IAAI,CAAC,WAAW,EAAE;QACd,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,sBAAsB,GAAG,IAAA,uCAAqB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEnE,MAAM,iBAAiB,GAAG,IAAA,kDAAgC,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEvE,mCAAmC;IACnC,uCAAuC;IAEvC,2EAA2E;IAC3E,0FAA0F;IAC1F,qEAAqE;IACrE,MAAM,gBAAgB,GAClB,sBAAsB,KAAK,IAAI,IAAI,iBAAiB,KAAK,IAAI,CAAC;IAClE,oEAAoE;IAEpE,OAAO,gBAAgB,CAAC;AAC5B,CAAC,CAAC;AA5BW,QAAA,iDAAiD,qDA4B5D;AAEF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,cAA6B,EAAE,EAAE;IACnE,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAChD,OAAO,EAAE,CAAC;KACb;IAED,yCAAyC;IACzC,mCAAmC;IACnC,cAAc,GAAG,cAAc,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,CACvC,CAAC;IAEF,MAAM,UAAU,GAAkB,IAAA,mBAAW,EAAC,cAAc,CAAC,CAAC;IAE9D,OAAO,IAAA,wBAAgB,EAAC,UAAU,CAAC,CAAC;AACxC,CAAC,CAAC;AAdW,QAAA,qBAAqB,yBAchC;AAEK,MAAM,gBAAgB,GAAG,CAAC,GAAkB,EAAiB,EAAE;IAClE,MAAM,MAAM,GAAkB,EAAE,CAAC;IAEjC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAEpE,KAAK,MAAM,SAAS,IAAI,GAAG,EAAE;QACzB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE;YACvB,IACI,IAAI,CAAC,aAAa;iBACb,WAAW,EAAE;iBACb,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,EACtD;gBACE,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;AA3BW,QAAA,gBAAgB,oBA2B3B;AAEF;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAC,GAAkB,EAAiB,EAAE;IAC7D,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,CAAC,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;QAC/C,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/checkTitleAndSnippetSearchability/matchDateTimeInfo.d.ts

@@ -0,0 +1,34 @@
+import { IItem } from '../../types';
+import { MatchResult } from './helpers';
+/**
+ * Sets the extra matching patterns and rejected patterns for date-time information.
+ *
+ * @param extraMatchingPatterns - An array of strings representing the extra matching patterns.
+ * @param extraRejectedPatterns - An array of strings representing the extra rejected patterns.
+ * @param {boolean} [shouldAvoidUsingWordBoundary=false] - A boolean indicating whether to avoid using word boundaries (useful for languages like Chinese and Japanese).
+ *
+ * @remarks
+ * - For languages like Japanese that don't use spaces between words (or where word boundaries are not easily determined by spaces or punctuation),
+ *   set `shouldAvoidUsingWordBoundary` to true to remove `\b` and use lookarounds to ensure correct boundaries.
+ */
+export declare const setExtraDateTimeInfoMatchingPatterns: (extraMatchingPatterns: string[], extraRejectedPatterns: string[], shouldAvoidUsingWordBoundary?: boolean) => void;
+/**
+ * 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[]) => MatchResult[];
+/**
+ * Check if the provided string contains recognized date and time information.
+ * @param str - The string to check.
+ * @returns {boolean} - True if the string contains recognized date and time information, false otherwise.
+ */
+export declare const isRecognizedDateTimeInfo: (str: string) => boolean;
+/**
+ * Determines if a given string is a rejected topic.
+ * @param str - The string to check.
+ * @returns {boolean} - True if the string is a rejected topic, false otherwise.
+ */
+export declare const isRejectedDateTimeInfo: (str: string) => boolean;

package/dist/lib/checkTitleAndSnippetSearchability/matchDateTimeInfo.js

@@ -0,0 +1,207 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRejectedDateTimeInfo = exports.isRecognizedDateTimeInfo = exports.matchDateTimeInfo = exports.setExtraDateTimeInfoMatchingPatterns = void 0;
+const helpers_1 = require("./helpers");
+const TitleSummaryMatchingPatterns_Time_json_1 = __importDefault(require("../../data/TitleSummaryMatchingPatterns_Time.json"));
+const TitleSummaryRejectedPatterns_json_1 = __importDefault(require("../../data/TitleSummaryRejectedPatterns.json"));
+const createWordBoundaryRegex_1 = require("../util/createWordBoundaryRegex");
+/**
+ *  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", "quarter", "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|quarter|calendar year)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 patterns like "3-5 years".
+ * Here's a breakdown of the regular expression:
+ *
+ * - `\b`: Word boundary to ensure we match whole words and not substrings.
+ * - `(\d+)`: A capturing group to match one or more digits.
+ * - `\s*`: Zero or more spaces.
+ * - `(?:-|to)`: A non-capturing group to match a hyphen (-) or the word "to".
+ * - `\s*`: Zero or more spaces.
+ * - `(\d+)`: A capturing group to match one or more digits.
+ * - `\s*`: Zero or more spaces.
+ * - `(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 rangeWithUnitsRegEx = /\b(\d+)\s*(?:-|to)\s*(\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;
+/**
+ * A regular expression that matches month names and abbreviations.
+ * Matches full month names (e.g., January, February) and common abbreviations (e.g., Jan, Feb).
+ */
+const monthRegEx = /\b(?:january|february|march|april|may|june|july|august|september|october|november|december|jan|feb|mar|apr|jun|jul|aug|sep|sept|oct|nov|dec)\b/gi;
+/**
+ * A regular expression that matches weekday names and abbreviations.
+ * Matches full weekday names (e.g., Monday, Tuesday) and common abbreviations (e.g., Mon, Tue).
+ */
+const weekdayRegEx = /\b(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday|mon|tue|wed|thu|fri|sat|sun)\b/gi;
+/**
+ * Match text like '20th century'
+ */
+const centuryRegEx = /\b(\d{1,2}(?:st|nd|rd|th)\s+century)\b/gi;
+/**
+ * Additional patterns for matching date and time information.
+ * This includes phrases like 'once a day', 'monthly', 'daily', etc.
+ */
+const additionalPatterns = /\b(once\s+a\s+day|monthly|daily|hourly|weekly|bi-weekly|quarterly|semi-annually|annual|annually)\b/gi;
+// const dateTimeMatchingPatterns = TitleSummaryMatchingPatterns.time;
+const regex4DateTimeInfo = (0, createWordBoundaryRegex_1.createWordBoundaryRegex)(TitleSummaryMatchingPatterns_Time_json_1.default);
+/**
+ * Set of rejected date and time information.
+ */
+let rejectedDateTimeInfoSet = null; //new Set<string>(TitleSummaryMatchingPatterns.topics)
+/**
+ * Regular expression to match additional date and time information.
+ */
+let regexForExtraDateTimeInfo = null;
+/**
+ * Create a set of rejected date and time information.
+ * @param extraRejectedPatternsForDateTimeInfo
+ */
+const createRejectedDateTimeInfoSet = (extraRejectedPatternsForDateTimeInfo = []) => {
+    rejectedDateTimeInfoSet = (0, helpers_1.toLowercaseSet)([
+        ...TitleSummaryRejectedPatterns_json_1.default.common,
+        ...TitleSummaryRejectedPatterns_json_1.default.time,
+        ...extraRejectedPatternsForDateTimeInfo,
+    ]);
+};
+/**
+ * Sets the extra matching patterns and rejected patterns for date-time information.
+ *
+ * @param extraMatchingPatterns - An array of strings representing the extra matching patterns.
+ * @param extraRejectedPatterns - An array of strings representing the extra rejected patterns.
+ * @param {boolean} [shouldAvoidUsingWordBoundary=false] - A boolean indicating whether to avoid using word boundaries (useful for languages like Chinese and Japanese).
+ *
+ * @remarks
+ * - For languages like Japanese that don't use spaces between words (or where word boundaries are not easily determined by spaces or punctuation),
+ *   set `shouldAvoidUsingWordBoundary` to true to remove `\b` and use lookarounds to ensure correct boundaries.
+ */
+const setExtraDateTimeInfoMatchingPatterns = (extraMatchingPatterns, extraRejectedPatterns, shouldAvoidUsingWordBoundary = false) => {
+    if (extraMatchingPatterns && extraMatchingPatterns.length) {
+        regexForExtraDateTimeInfo = (0, createWordBoundaryRegex_1.createWordBoundaryRegex)(extraMatchingPatterns, {
+            shouldAvoidUsingWordBoundary,
+        });
+    }
+    createRejectedDateTimeInfoSet(extraRejectedPatterns);
+};
+exports.setExtraDateTimeInfoMatchingPatterns = setExtraDateTimeInfoMatchingPatterns;
+/**
+ * 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 regex4TimeInfo = [
+        relativeDateTimeRegex,
+        timeDurationRegEx,
+        yearRangeRegEx,
+        centuryRegEx,
+        additionalPatterns,
+        rangeWithUnitsRegEx,
+        monthRegEx,
+        weekdayRegEx,
+    ];
+    // console.log(dateInfoText, patternsFromTextLabelingData)
+    // regex4TimeInfo.push(patternsFromTextLabelingData);
+    const matchedByCommonTimePatterns = [];
+    const combined = `${title}\n${snippet}`;
+    for (const regex of regex4TimeInfo) {
+        // const matchedLocationsFromTitle: string[] = title.match(regex) || [];
+        // const matchedLocationsFromSnippet: string[] =
+        //     snippet.match(regex) || [];
+        // for (const text of matchedLocationsFromTitle) {
+        //     matchedByCommonTimePatterns.push(text);
+        // }
+        // for (const text of matchedLocationsFromSnippet) {
+        //     matchedByCommonTimePatterns.push(text);
+        // }
+        const matches = combined.match(regex) || [];
+        for (const match of matches) {
+            matchedByCommonTimePatterns.push(match);
+        }
+        // const matched = [
+        //     ...matchedLocationsFromTitle,
+        //     ...matchedLocationsFromSnippet,
+        // ];
+    }
+    const matchResultsByCommonPatterns = matchedByCommonTimePatterns.map((matchedString) => ({
+        matchedString,
+        patternSource: 'predefined',
+    }));
+    if (!rejectedDateTimeInfoSet) {
+        createRejectedDateTimeInfoSet();
+    }
+    const matchedByTerms = (0, helpers_1.matchUsingMultiplePatterns)({
+        item,
+        predefinedPatterns: regex4DateTimeInfo,
+        extraPatterns: regexForExtraDateTimeInfo,
+        customTerms: customMatchingPattenrs,
+        rejectedSet: rejectedDateTimeInfoSet,
+    });
+    return (0, helpers_1.cleanUpMatchedResults)([
+        ...matchResultsByCommonPatterns,
+        ...matchedByTerms,
+    ]);
+    // if (!candidates.length) {
+    //     return matchWithCustomPatterns(
+    //         item,
+    //         customMatchingPattenrs,
+    //         RejectedDateTimeInfosSet
+    //     );
+    // }
+    // return cleanUpMatchedResults(candidates);
+};
+exports.matchDateTimeInfo = matchDateTimeInfo;
+/**
+ * Check if the provided string contains recognized date and time information.
+ * @param str - The string to check.
+ * @returns {boolean} - True if the string contains recognized date and time information, false otherwise.
+ */
+const isRecognizedDateTimeInfo = (str) => {
+    const dateTimeInfo = (0, exports.matchDateTimeInfo)({
+        title: str,
+        snippet: '',
+    });
+    return dateTimeInfo.length > 0;
+};
+exports.isRecognizedDateTimeInfo = isRecognizedDateTimeInfo;
+/**
+ * Determines if a given string is a rejected topic.
+ * @param str - The string to check.
+ * @returns {boolean} - True if the string is a rejected topic, false otherwise.
+ */
+const isRejectedDateTimeInfo = (str) => {
+    if (!rejectedDateTimeInfoSet) {
+        createRejectedDateTimeInfoSet();
+    }
+    return (0, helpers_1.isFoundInSet)(str, rejectedDateTimeInfoSet);
+};
+exports.isRejectedDateTimeInfo = isRejectedDateTimeInfo;
+//# sourceMappingURL=matchDateTimeInfo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"matchDateTimeInfo.js","sourceRoot":"","sources":["../../../src/lib/checkTitleAndSnippetSearchability/matchDateTimeInfo.ts"],"names":[],"mappings":";;;;;;AACA,uCAOmB;AACnB,+HAAyF;AACzF,qHAAwF;AACxF,6EAA0E;AAE1E;;;;;;;GAOG;AACH,MAAM,qBAAqB,GACvB,sHAAsH,CAAC;AAE3H;;GAEG;AACH,MAAM,iBAAiB,GACnB,yDAAyD,CAAC;AAE9D;;;;;;;;;;;;GAYG;AACH,MAAM,mBAAmB,GACrB,sEAAsE,CAAC;AAE3E;;;;;;;;;;GAUG;AACH,MAAM,cAAc,GAChB,iEAAiE,CAAC;AAEtE;;;GAGG;AACH,MAAM,UAAU,GACZ,kJAAkJ,CAAC;AAEvJ;;;GAGG;AACH,MAAM,YAAY,GACd,gGAAgG,CAAC;AAErG;;GAEG;AACH,MAAM,YAAY,GAAG,0CAA0C,CAAC;AAEhE;;;GAGG;AACH,MAAM,kBAAkB,GACpB,sGAAsG,CAAC;AAE3G,sEAAsE;AAEtE,MAAM,kBAAkB,GAAG,IAAA,iDAAuB,EAAC,gDAAwB,CAAC,CAAC;AAE7E;;GAEG;AACH,IAAI,uBAAuB,GAAgB,IAAI,CAAC,CAAC,sDAAsD;AAEvG;;GAEG;AACH,IAAI,yBAAyB,GAAW,IAAI,CAAC;AAE7C;;;GAGG;AACH,MAAM,6BAA6B,GAAG,CAClC,uCAAiD,EAAE,EACrD,EAAE;IACA,uBAAuB,GAAG,IAAA,wBAAc,EAAC;QACrC,GAAG,2CAA4B,CAAC,MAAM;QACtC,GAAG,2CAA4B,CAAC,IAAI;QACpC,GAAG,oCAAoC;KAC1C,CAAC,CAAC;AACP,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,oCAAoC,GAAG,CAChD,qBAA+B,EAC/B,qBAA+B,EAC/B,4BAA4B,GAAG,KAAK,EACtC,EAAE;IACA,IAAI,qBAAqB,IAAI,qBAAqB,CAAC,MAAM,EAAE;QACvD,yBAAyB,GAAG,IAAA,iDAAuB,EAC/C,qBAAqB,EACrB;YACI,4BAA4B;SAC/B,CACJ,CAAC;KACL;IAED,6BAA6B,CAAC,qBAAqB,CAAC,CAAC;AACzD,CAAC,CAAC;AAfW,QAAA,oCAAoC,wCAe/C;AAEF;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAC7B,IAAW,EACX,sBAAiC,EACpB,EAAE;IACf,yCAAyC;IAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAEnC,MAAM,cAAc,GAAG;QACnB,qBAAqB;QACrB,iBAAiB;QACjB,cAAc;QACd,YAAY;QACZ,kBAAkB;QAClB,mBAAmB;QACnB,UAAU;QACV,YAAY;KACf,CAAC;IAEF,0DAA0D;IAC1D,qDAAqD;IAErD,MAAM,2BAA2B,GAAa,EAAE,CAAC;IAEjD,MAAM,QAAQ,GAAG,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC;IAExC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE;QAChC,wEAAwE;QACxE,gDAAgD;QAChD,kCAAkC;QAElC,kDAAkD;QAClD,8CAA8C;QAC9C,IAAI;QAEJ,oDAAoD;QACpD,8CAA8C;QAC9C,IAAI;QAEJ,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAE5C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YACzB,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC3C;QAED,oBAAoB;QACpB,oCAAoC;QACpC,sCAAsC;QACtC,KAAK;KACR;IAED,MAAM,4BAA4B,GAC9B,2BAA2B,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAChD,aAAa;QACb,aAAa,EAAE,YAAY;KAC9B,CAAC,CAAC,CAAC;IAER,IAAI,CAAC,uBAAuB,EAAE;QAC1B,6BAA6B,EAAE,CAAC;KACnC;IAED,MAAM,cAAc,GAAG,IAAA,oCAA0B,EAAC;QAC9C,IAAI;QACJ,kBAAkB,EAAE,kBAAkB;QACtC,aAAa,EAAE,yBAAyB;QACxC,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE,uBAAuB;KACvC,CAAC,CAAC;IAEH,OAAO,IAAA,+BAAqB,EAAC;QACzB,GAAG,4BAA4B;QAC/B,GAAG,cAAc;KACpB,CAAC,CAAC;IAEH,4BAA4B;IAC5B,sCAAsC;IACtC,gBAAgB;IAChB,kCAAkC;IAClC,mCAAmC;IACnC,SAAS;IACT,IAAI;IAEJ,4CAA4C;AAChD,CAAC,CAAC;AApFW,QAAA,iBAAiB,qBAoF5B;AAEF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,GAAW,EAAW,EAAE;IAC7D,MAAM,YAAY,GAAG,IAAA,yBAAiB,EAAC;QACnC,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,EAAE;KACL,CAAC,CAAC;IAEZ,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAPW,QAAA,wBAAwB,4BAOnC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAW,EAAE;IAC3D,IAAI,CAAC,uBAAuB,EAAE;QAC1B,6BAA6B,EAAE,CAAC;KACnC;IAED,OAAO,IAAA,sBAAY,EAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;AACtD,CAAC,CAAC;AANW,QAAA,sBAAsB,0BAMjC"}