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

package/dist/lib/layers/isValidLayerCount.d.ts

@@ -1,12 +0,0 @@
-import { IItem, ValidationInfo } from '../../types';
-/**
- * Validates the number of layers of an item.
- *
- * **IMPORTANT**: The `data` object is no longer included in the item JSON. It has to be fetched via a separate request
- * (e.g., `https://www.arcgis.com/sharing/rest/content/items/ITEM_ID/data?f=json`).
- *
- * Currently, all items are assigned the score `LAYER_COUNT_BEST_SCORE` because `numLayers` is always 0, which is less than 3.
- * This module will need to be updated in a future release to score items using the actual `data` object.
- *
- */
-export declare const isValidLayerCount: (item: IItem) => ValidationInfo;

package/dist/lib/layers/isValidLayerCount.js

@@ -1,171 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidLayerCount = void 0;
-const stringsConfig_1 = require("../util/stringsConfig");
-const isDefined_1 = require("../util/isDefined");
-const scoringConfig_1 = require("./scoringConfig");
-/**
- * Validates the number of layers of an item.
- *
- * **IMPORTANT**: The `data` object is no longer included in the item JSON. It has to be fetched via a separate request
- * (e.g., `https://www.arcgis.com/sharing/rest/content/items/ITEM_ID/data?f=json`).
- *
- * Currently, all items are assigned the score `LAYER_COUNT_BEST_SCORE` because `numLayers` is always 0, which is less than 3.
- * This module will need to be updated in a future release to score items using the actual `data` object.
- *
- */
-const isValidLayerCount = (item) => {
-    const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
-    const itemType = item.type;
-    /**
-     * Had a meeting with Jim Herries on May/30/2023, Jim confirmed that we should only check layer count for these three item types
-     */
-    const shouldCheckLayerCount = itemType === 'Feature Service' ||
-        itemType === 'Feature Collection' ||
-        itemType === 'Map Service' ||
-        itemType === 'Image Service';
-    if (shouldCheckLayerCount === false) {
-        return {
-            property: 'layers',
-            label: stringsConfig.layers.LABEL,
-            title: stringsConfig.layers.TITLE,
-            maxScore: 0,
-            score: 0,
-            messages: [],
-            weight: 0,
-            weightFactor: 0,
-            critical: false,
-        };
-    }
-    // let baseMaps = [];
-    // let operationalLayers = [];
-    let layers = [];
-    let numLayers = 0;
-    // // scoring rules
-    // const SCORING = getScoringRules(item, scoringRulesConfig);
-    const issues = {
-        property: 'layers',
-        label: stringsConfig.layers.LABEL,
-        title: stringsConfig.layers.TITLE,
-        maxScore: 0,
-        score: 0,
-        messages: [],
-        weight: scoringConfig_1.scoringConfig.weight,
-        weightFactor: 0,
-        critical: false,
-    };
-    switch (itemType) {
-        case 'Feature Collection':
-            if ((0, isDefined_1.isDefined)(item === null || item === void 0 ? void 0 : item.data)) {
-                if ((0, isDefined_1.isDefined)(item.data.layers)) {
-                    item.data.layers.forEach((layer) => {
-                        numLayers += layer.featureSet.features.length;
-                    });
-                }
-                layers = (0, isDefined_1.isDefined)(item.data.layers) ? item.data.layers : [];
-            }
-            else {
-                numLayers = 1;
-            }
-            break;
-        case 'Feature Service':
-            if ((0, isDefined_1.isDefined)(item.data)) {
-                layers = (0, isDefined_1.isDefined)(item.data.layers) ? item.data.layers : [];
-                numLayers = layers.length;
-            }
-            else {
-                numLayers = 1;
-            }
-            break;
-        case 'Image Service':
-            if ((0, isDefined_1.isDefined)(item.data)) {
-                layers = (0, isDefined_1.isDefined)(item.data.layers) ? item.data.layers : [];
-                numLayers = layers.length;
-            }
-            else {
-                numLayers = 1;
-            }
-            break;
-        case 'Map Service':
-            if ((0, isDefined_1.isDefined)(item.data)) {
-                layers = (0, isDefined_1.isDefined)(item.data.layers) ? item.data.layers : [];
-                numLayers = layers.length;
-            }
-            else {
-                numLayers = 1;
-            }
-            break;
-        // case 'Scene Service':
-        //     if (isDefined(item.data)) {
-        //         // operationalLayers = isDefined(item.data.operationalLayers) ? item.data.operationalLayers : [];
-        //         layers = isDefined(item.data.layers) ? item.data.layers : [];
-        //         numLayers = layers.length;
-        //     }
-        //     break;
-        // case 'Vector Tile Service':
-        //     if (isDefined(item.data)) {
-        //         operationalLayers = isDefined(item.data.operationalLayers)
-        //             ? item.data.operationalLayers
-        //             : [];
-        //         layers = isDefined(item.data.layers) ? item.data.layers : [];
-        //     }
-        //     numLayers = 0;
-        //     break;
-        // case 'Web Map':
-        //     if (isDefined(item.data)) {
-        //         baseMaps = isDefined(item.data.baseMap)
-        //             ? item.data.baseMap.baseMapLayers
-        //             : [];
-        //         operationalLayers = isDefined(item.data.operationalLayers)
-        //             ? item.data.operationalLayers
-        //             : [];
-        //         layers = isDefined(item.data.layers) ? item.data.layers : [];
-        //         // sometimes operational layers returns false
-        //         numLayers =
-        //             baseMaps.length +
-        //             (operationalLayers.length ? operationalLayers.length : 0) +
-        //             layers.length;
-        //     } else {
-        //         numLayers = 1;
-        //     }
-        //     break;
-        // case 'Web Scene':
-        //     if (isDefined(item.data)) {
-        //         layers = isDefined(item.data.layers) ? item.data.layers : [];
-        //         numLayers = layers.length;
-        //     }
-        //     break;
-        default:
-            break;
-    }
-    if (numLayers <= 3) {
-        // issues.score = SCORING.LAYER_COUNT_BEST_SCORE;
-        issues.weightFactor =
-            scoringConfig_1.scoringConfig.weightFactors.DEFAULT.LAYER_COUNT_BEST_FACTOR;
-        // issues.messages.push({
-        //     // code: stringsConfig.layers.BEST_CODE,
-        //     message: stringsConfig.layers.BEST_MESSAGE,
-        // });
-    }
-    if (numLayers > 3 && numLayers <= 7) {
-        // issues.score = SCORING.LAYER_COUNT_BETTER_SCORE;
-        issues.weightFactor =
-            scoringConfig_1.scoringConfig.weightFactors.DEFAULT.LAYER_COUNT_BETTER_FACTOR;
-        issues.messages.push({
-            // code: stringsConfig.layers.BETTER_CODE,
-            message: stringsConfig.layers.BETTER_MESSAGE,
-        });
-    }
-    if (numLayers > 7) {
-        // issues.score = SCORING.LAYER_COUNT_GOOD_SCORE;
-        issues.weightFactor =
-            scoringConfig_1.scoringConfig.weightFactors.DEFAULT.LAYER_COUNT_GOOD_FACTOR;
-        issues.messages.push({
-            // code: stringsConfig.layers.GOOD_CODE,
-            message: stringsConfig.layers.GOOD_MESSAGE,
-        });
-    }
-    return issues;
-};
-exports.isValidLayerCount = isValidLayerCount;
-//# sourceMappingURL=isValidLayerCount.js.map

package/dist/lib/layers/isValidLayerCount.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isValidLayerCount.js","sourceRoot":"","sources":["../../../src/lib/layers/isValidLayerCount.ts"],"names":[],"mappings":";;;AAGA,yDAAyD;AAEzD,iDAA8C;AAC9C,mDAAgD;AAEhD;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAW,EAAkB,EAAE;IAC7D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAoC,CAAC;IAE3D;;OAEG;IACH,MAAM,qBAAqB,GACvB,QAAQ,KAAK,iBAAiB;QAC9B,QAAQ,KAAK,oBAAoB;QACjC,QAAQ,KAAK,aAAa;QAC1B,QAAQ,KAAK,eAAe,CAAC;IAEjC,IAAI,qBAAqB,KAAK,KAAK,EAAE;QACjC,OAAO;YACH,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK;YACjC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK;YACjC,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE,EAAE;YACZ,MAAM,EAAE,CAAC;YACT,YAAY,EAAE,CAAC;YACf,QAAQ,EAAE,KAAK;SAClB,CAAC;KACL;IAED,qBAAqB;IACrB,8BAA8B;IAC9B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,mBAAmB;IACnB,6DAA6D;IAE7D,MAAM,MAAM,GAAmB;QAC3B,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK;QACjC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK;QACjC,QAAQ,EAAE,CAAC;QACX,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,6BAAa,CAAC,MAAM;QAC5B,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,KAAK;KAClB,CAAC;IAEF,QAAQ,QAAQ,EAAE;QACd,KAAK,oBAAoB;YACrB,IAAI,IAAA,qBAAS,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAC,EAAE;gBACvB,IAAI,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC/B,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAClD,CAAC,CAAC,CAAC;iBACN;gBACD,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;aAChE;iBAAM;gBACH,SAAS,GAAG,CAAC,CAAC;aACjB;YACD,MAAM;QACV,KAAK,iBAAiB;YAClB,IAAI,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;aAC7B;iBAAM;gBACH,SAAS,GAAG,CAAC,CAAC;aACjB;YACD,MAAM;QACV,KAAK,eAAe;YAChB,IAAI,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;aAC7B;iBAAM;gBACH,SAAS,GAAG,CAAC,CAAC;aACjB;YACD,MAAM;QACV,KAAK,aAAa;YACd,IAAI,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;aAC7B;iBAAM;gBACH,SAAS,GAAG,CAAC,CAAC;aACjB;YACD,MAAM;QACV,wBAAwB;QACxB,kCAAkC;QAClC,4GAA4G;QAC5G,wEAAwE;QACxE,qCAAqC;QACrC,QAAQ;QACR,aAAa;QACb,8BAA8B;QAC9B,kCAAkC;QAClC,qEAAqE;QACrE,4CAA4C;QAC5C,oBAAoB;QACpB,wEAAwE;QACxE,QAAQ;QACR,qBAAqB;QACrB,aAAa;QACb,kBAAkB;QAClB,kCAAkC;QAClC,kDAAkD;QAClD,gDAAgD;QAChD,oBAAoB;QACpB,qEAAqE;QACrE,4CAA4C;QAC5C,oBAAoB;QACpB,wEAAwE;QACxE,wDAAwD;QACxD,sBAAsB;QACtB,gCAAgC;QAChC,0EAA0E;QAC1E,6BAA6B;QAC7B,eAAe;QACf,yBAAyB;QACzB,QAAQ;QACR,aAAa;QACb,oBAAoB;QACpB,kCAAkC;QAClC,wEAAwE;QACxE,qCAAqC;QACrC,QAAQ;QACR,aAAa;QACb;YACI,MAAM;KACb;IAED,IAAI,SAAS,IAAI,CAAC,EAAE;QAChB,iDAAiD;QACjD,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAChE,yBAAyB;QACzB,+CAA+C;QAC/C,kDAAkD;QAClD,MAAM;KACT;IAED,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,CAAC,EAAE;QACjC,mDAAmD;QACnD,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,yBAAyB,CAAC;QAClE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,0CAA0C;YAC1C,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,cAAc;SAC/C,CAAC,CAAC;KACN;IAED,IAAI,SAAS,GAAG,CAAC,EAAE;QACf,iDAAiD;QACjD,MAAM,CAAC,YAAY;YACf,6BAAa,CAAC,aAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAChE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,wCAAwC;YACxC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,YAAY;SAC7C,CAAC,CAAC;KACN;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AA/JW,QAAA,iBAAiB,qBA+J5B"}

package/dist/lib/layers/scoringConfig.d.ts

@@ -1,10 +0,0 @@
-export declare const scoringConfig: {
-    weight: number;
-    weightFactors: {
-        DEFAULT: {
-            LAYER_COUNT_BEST_FACTOR: number;
-            LAYER_COUNT_BETTER_FACTOR: number;
-            LAYER_COUNT_GOOD_FACTOR: number;
-        };
-    };
-};

package/dist/lib/layers/scoringConfig.js

@@ -1,20 +0,0 @@
-"use strict";
-// import { ScoringConfig } from '../../types';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.scoringConfig = void 0;
-exports.scoringConfig = {
-    weight: 1,
-    weightFactors: {
-        DEFAULT: {
-            LAYER_COUNT_BEST_FACTOR: 1,
-            LAYER_COUNT_BETTER_FACTOR: 0.5,
-            LAYER_COUNT_GOOD_FACTOR: 0.125,
-        },
-        // INTERNATIONAL: {
-        //     LAYER_COUNT_BEST_FACTOR: 1,
-        //     LAYER_COUNT_BETTER_FACTOR: 0.5,
-        //     LAYER_COUNT_GOOD_FACTOR: 0.125,
-        // },
-    },
-};
-//# sourceMappingURL=scoringConfig.js.map

package/dist/lib/layers/scoringConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scoringConfig.js","sourceRoot":"","sources":["../../../src/lib/layers/scoringConfig.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAElC,QAAA,aAAa,GAAG;IACzB,MAAM,EAAE,CAAC;IACT,aAAa,EAAE;QACX,OAAO,EAAE;YACL,uBAAuB,EAAE,CAAC;YAC1B,yBAAyB,EAAE,GAAG;YAC9B,uBAAuB,EAAE,KAAK;SACjC;QACD,mBAAmB;QACnB,kCAAkC;QAClC,sCAAsC;QACtC,sCAAsC;QACtC,KAAK;KACR;CACJ,CAAC"}

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

@@ -1,15 +0,0 @@
-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.map

@@ -1 +0,0 @@
-{"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

@@ -1,15 +0,0 @@
-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[];
-/**
- * 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/recommendedText/helpers.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeSpecialCharacters = 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;
-/**
- * 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=helpers.js.map

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

@@ -1 +0,0 @@
-{"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;AAEF;;;;;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/recommendedText/matchDateTimeInfo.d.ts

@@ -1,9 +0,0 @@
-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

@@ -1,81 +0,0 @@
-"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,
-    ];
-    customMatchingPattenrs = (0, helpers_1.escapeSpecialCharacters)(customMatchingPattenrs);
-    if (customMatchingPattenrs && customMatchingPattenrs.length > 0) {
-        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

@@ -1 +0,0 @@
-{"version":3,"file":"matchDateTimeInfo.js","sourceRoot":"","sources":["../../../src/lib/recommendedText/matchDateTimeInfo.ts"],"names":[],"mappings":";;;;;;AACA,uCAImB;AACnB,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,sBAAsB,GAAG,IAAA,iCAAuB,EAAC,sBAAsB,CAAC,CAAC;IAEzE,IAAI,sBAAsB,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7D,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;AApDW,QAAA,iBAAiB,qBAoD5B"}

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

@@ -1,9 +0,0 @@
-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[];