@vannizhang/living-atlas-content-validator 1.0.0

package/dist/lib/userProfileName/isValidUserProfileName.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidUserProfileName = void 0;
+const scoringRulesConfig_1 = __importDefault(require("./scoringRulesConfig"));
+const getScoringRules_1 = require("../util/getScoringRules");
+const stringsConfig_1 = require("../util/stringsConfig");
+const assertString_1 = require("../util/assertString");
+const isEmpty_1 = require("../util/isEmpty");
+const contains_1 = require("../util/contains");
+/**
+ * Validate an item owner's profile name
+ *
+ * Living Atlas specific (local):
+ * - Cannot be empty
+ * - Cannot contain blacklisted character(s)
+ *
+ */
+const isValidUserProfileName = (userProfile, item) => {
+    const { fullName } = userProfile;
+    // scoring rules locale
+    const culture = (0, getScoringRules_1.getScoringRulesLocale)(item);
+    // scoring rules
+    const SCORING = (0, getScoringRules_1.getScoringRules)(item, scoringRulesConfig_1.default);
+    const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
+    // issues
+    const issues = {
+        property: 'userProfileName',
+        label: stringsConfig.userProfileName.LABEL,
+        maxScore: SCORING.EMPTY_STRING_SCORE +
+            SCORING.HAS_USERNAME_SCORE +
+            SCORING.NO_UNDERSCORE_SCORE,
+        score: SCORING.EMPTY_STRING_SCORE,
+        messages: [],
+        weight: stringsConfig.userProfileName.WEIGHT,
+        critical: false,
+    };
+    if (!(0, assertString_1.assertString)(userProfile.fullName) || (0, isEmpty_1.isEmpty)(fullName)) {
+        issues.messages.push({
+            code: stringsConfig.userProfileName.EMPTY_STRING_CODE,
+            message: stringsConfig.userProfileName.EMPTY_STRING_MESSAGE,
+        });
+        return issues;
+    }
+    issues.score = SCORING.HAS_USERNAME_SCORE;
+    if (culture === 'en' && (0, contains_1.contains)(fullName, '_')) {
+        issues.messages.push({
+            code: stringsConfig.userProfileName.BLACKLISTED_CHARS_CODE,
+            message: stringsConfig.userProfileName.BLACKLISTED_CHARS_MESSAGE,
+        });
+    }
+    else {
+        issues.score += SCORING.NO_UNDERSCORE_SCORE;
+    }
+    return issues;
+};
+exports.isValidUserProfileName = isValidUserProfileName;
+//# sourceMappingURL=isValidUserProfileName.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isValidUserProfileName.js","sourceRoot":"","sources":["../../../src/lib/userProfileName/isValidUserProfileName.ts"],"names":[],"mappings":";;;;;;AAAA,8EAAsD;AACtD,6DAGiC;AAEjC,yDAAyD;AACzD,uDAAoD;AACpD,6CAA0C;AAC1C,+CAA4C;AAE5C;;;;;;;GAOG;AACI,MAAM,sBAAsB,GAAG,CAClC,WAAwB,EACxB,IAAW,EACG,EAAE;IAChB,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IAEjC,uBAAuB;IACvB,MAAM,OAAO,GAAG,IAAA,uCAAqB,EAAC,IAAI,CAAC,CAAC;IAE5C,gBAAgB;IAChB,MAAM,OAAO,GAAG,IAAA,iCAAe,EAAC,IAAI,EAAE,4BAAkB,CAAC,CAAC;IAE1D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,SAAS;IACT,MAAM,MAAM,GAAmB;QAC3B,QAAQ,EAAE,iBAAiB;QAC3B,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;QAC1C,QAAQ,EACJ,OAAO,CAAC,kBAAkB;YAC1B,OAAO,CAAC,kBAAkB;YAC1B,OAAO,CAAC,mBAAmB;QAC/B,KAAK,EAAE,OAAO,CAAC,kBAAkB;QACjC,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,MAAM;QAC5C,QAAQ,EAAE,KAAK;KAClB,CAAC;IAEF,IAAI,CAAC,IAAA,2BAAY,EAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,IAAA,iBAAO,EAAC,QAAQ,CAAC,EAAE;QAC1D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,aAAa,CAAC,eAAe,CAAC,iBAAiB;YACrD,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,oBAAoB;SAC9D,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAE1C,IAAI,OAAO,KAAK,IAAI,IAAI,IAAA,mBAAQ,EAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;QAC7C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,aAAa,CAAC,eAAe,CAAC,sBAAsB;YAC1D,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,yBAAyB;SACnE,CAAC,CAAC;KACN;SAAM;QACH,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC;KAC/C;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAjDW,QAAA,sBAAsB,0BAiDjC"}

package/dist/lib/userProfileName/scoringRulesConfig.d.ts

@@ -0,0 +1,3 @@
+import { ScoringRulesConfig } from '../../types';
+declare const config: ScoringRulesConfig;
+export default config;

package/dist/lib/userProfileName/scoringRulesConfig.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    // Scoring
+    SCORING: {
+        DEFAULT: {
+            WEB_MAP: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 2,
+            },
+            WEB_SCENE: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 3,
+            },
+            APPLICATION: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 2,
+            },
+        },
+        INTERNATIONAL: {
+            WEB_MAP: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 2,
+            },
+            WEB_SCENE: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 2,
+            },
+            APPLICATION: {
+                EMPTY_STRING_SCORE: 0,
+                HAS_USERNAME_SCORE: 5,
+                NO_UNDERSCORE_SCORE: 2,
+            },
+        },
+    },
+};
+exports.default = config;
+//# sourceMappingURL=scoringRulesConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scoringRulesConfig.js","sourceRoot":"","sources":["../../../src/lib/userProfileName/scoringRulesConfig.ts"],"names":[],"mappings":";;AAEA,MAAM,MAAM,GAAuB;IAC/B,UAAU;IACV,OAAO,EAAE;QACL,OAAO,EAAE;YACL,OAAO,EAAE;gBACL,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;YACD,SAAS,EAAE;gBACP,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;YACD,WAAW,EAAE;gBACT,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;SACJ;QAED,aAAa,EAAE;YACX,OAAO,EAAE;gBACL,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;YACD,SAAS,EAAE;gBACP,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;YACD,WAAW,EAAE;gBACT,kBAAkB,EAAE,CAAC;gBACrB,kBAAkB,EAAE,CAAC;gBACrB,mBAAmB,EAAE,CAAC;aACzB;SACJ;KACJ;CACJ,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/dist/lib/userProfileThumbnail/isValidUserProfileThumbnail.d.ts

@@ -0,0 +1,22 @@
+import { IItem, UserProfile } from '../../types';
+/**
+ * Validate the user's profile thumbnail.
+ *
+ * The file name of the thumbnail used for the user. All user thumbnails are relative to the URL https://<community-url>/users/<userName>/info.
+ * It's useful for users to include a thumbnail image, a logo, or anything that represents him/her.
+ * The image should be 150 pixels wide by 150 pixels high in a web file format such as PNG, GIF, or JPEG.
+ * The maximum file size is 1 MB. If the image is a different dimension, it is automatically resized to 150 by 150 and may appear warped.
+ *
+ * Living Atlas specific
+ * - Cannot be empty
+ * - The thumbnail file name cannot be one of the ArcGIS Online Reserved
+ */
+export declare const isValidUserProfileThumbnail: (userProfile: UserProfile, item: IItem) => {
+    property: string;
+    label: string;
+    maxScore: number;
+    score: number;
+    messages: any[];
+    weight: number;
+    critical: boolean;
+};

package/dist/lib/userProfileThumbnail/isValidUserProfileThumbnail.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidUserProfileThumbnail = void 0;
+const scoringRulesConfig_1 = __importDefault(require("./scoringRulesConfig"));
+const getScoringRules_1 = require("../util/getScoringRules");
+const stringsConfig_1 = require("../util/stringsConfig");
+const getThumbnailFileName_1 = require("../util/getThumbnailFileName");
+const isArcGISOnlineReservedThumbnailName_1 = require("../util/isArcGISOnlineReservedThumbnailName");
+/**
+ * Validate the user's profile thumbnail.
+ *
+ * The file name of the thumbnail used for the user. All user thumbnails are relative to the URL https://<community-url>/users/<userName>/info.
+ * It's useful for users to include a thumbnail image, a logo, or anything that represents him/her.
+ * The image should be 150 pixels wide by 150 pixels high in a web file format such as PNG, GIF, or JPEG.
+ * The maximum file size is 1 MB. If the image is a different dimension, it is automatically resized to 150 by 150 and may appear warped.
+ *
+ * Living Atlas specific
+ * - Cannot be empty
+ * - The thumbnail file name cannot be one of the ArcGIS Online Reserved
+ */
+const isValidUserProfileThumbnail = (userProfile, item) => {
+    const { thumbnail } = userProfile;
+    // scoring rules
+    const SCORING = (0, getScoringRules_1.getScoringRules)(item, scoringRulesConfig_1.default);
+    const stringsConfig = (0, stringsConfig_1.getStringsConfig)();
+    const issues = {
+        property: 'userProfileThumbnail',
+        label: stringsConfig.userProfileThumbnail.LABEL,
+        maxScore: SCORING.EMPTY_STRING_SCORE +
+            SCORING.USER_PROFILE_HAS_THUMBNAIL_SCORE,
+        score: SCORING.EMPTY_STRING_SCORE,
+        messages: [],
+        weight: stringsConfig.userProfileThumbnail.WEIGHT,
+        critical: false,
+    };
+    if (!thumbnail) {
+        issues.messages.push({
+            code: stringsConfig.userProfileThumbnail.EMPTY_STRING_CODE,
+            message: stringsConfig.userProfileThumbnail.EMPTY_STRING_MESSAGE,
+        });
+        return issues;
+    }
+    const thumbnailFileName = (0, getThumbnailFileName_1.getThumbnailFileName)(thumbnail);
+    // check if the user is not using the default thumbnail
+    if ((0, isArcGISOnlineReservedThumbnailName_1.isArcGISOnlineReservedThumbnailName)(thumbnailFileName)) {
+        issues.messages.push({
+            code: stringsConfig.userProfileThumbnail.EMPTY_STRING_CODE,
+            message: stringsConfig.userProfileThumbnail.EMPTY_STRING_MESSAGE,
+        });
+    }
+    else {
+        issues.score =
+            SCORING.EMPTY_STRING_SCORE +
+                SCORING.USER_PROFILE_HAS_THUMBNAIL_SCORE;
+    }
+    return issues;
+};
+exports.isValidUserProfileThumbnail = isValidUserProfileThumbnail;
+//# sourceMappingURL=isValidUserProfileThumbnail.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isValidUserProfileThumbnail.js","sourceRoot":"","sources":["../../../src/lib/userProfileThumbnail/isValidUserProfileThumbnail.ts"],"names":[],"mappings":";;;;;;AAAA,8EAAsD;AACtD,6DAGiC;AAEjC,yDAAyD;AACzD,uEAAoE;AACpE,qGAAkG;AAElG;;;;;;;;;;;GAWG;AACI,MAAM,2BAA2B,GAAG,CACvC,WAAwB,EACxB,IAAW,EACb,EAAE;IACA,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC;IAElC,gBAAgB;IAChB,MAAM,OAAO,GAAG,IAAA,iCAAe,EAAC,IAAI,EAAE,4BAAkB,CAAC,CAAC;IAE1D,MAAM,aAAa,GAAG,IAAA,gCAAgB,GAAE,CAAC;IAEzC,MAAM,MAAM,GAAG;QACX,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,aAAa,CAAC,oBAAoB,CAAC,KAAK;QAC/C,QAAQ,EACJ,OAAO,CAAC,kBAAkB;YAC1B,OAAO,CAAC,gCAAgC;QAC5C,KAAK,EAAE,OAAO,CAAC,kBAAkB;QACjC,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,MAAM;QACjD,QAAQ,EAAE,KAAK;KAClB,CAAC;IAEF,IAAI,CAAC,SAAS,EAAE;QACZ,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,aAAa,CAAC,oBAAoB,CAAC,iBAAiB;YAC1D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACjB;IAED,MAAM,iBAAiB,GAAG,IAAA,2CAAoB,EAAC,SAAS,CAAC,CAAC;IAE1D,uDAAuD;IACvD,IAAI,IAAA,yEAAmC,EAAC,iBAAiB,CAAC,EAAE;QACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,aAAa,CAAC,oBAAoB,CAAC,iBAAiB;YAC1D,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,oBAAoB;SACnE,CAAC,CAAC;KACN;SAAM;QACH,MAAM,CAAC,KAAK;YACR,OAAO,CAAC,kBAAkB;gBAC1B,OAAO,CAAC,gCAAgC,CAAC;KAChD;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AA/CW,QAAA,2BAA2B,+BA+CtC"}

package/dist/lib/userProfileThumbnail/scoringRulesConfig.d.ts

@@ -0,0 +1,3 @@
+import { ScoringRulesConfig } from '../../types';
+declare const config: ScoringRulesConfig;
+export default config;

package/dist/lib/userProfileThumbnail/scoringRulesConfig.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    // Scoring
+    SCORING: {
+        DEFAULT: {
+            WEB_MAP: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 7,
+            },
+            WEB_SCENE: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 8,
+            },
+            APPLICATION: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 7,
+            },
+        },
+        INTERNATIONAL: {
+            WEB_MAP: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 7,
+            },
+            WEB_SCENE: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 8,
+            },
+            APPLICATION: {
+                EMPTY_STRING_SCORE: 0,
+                USER_PROFILE_HAS_THUMBNAIL_SCORE: 7,
+            },
+        },
+    },
+};
+exports.default = config;
+//# sourceMappingURL=scoringRulesConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scoringRulesConfig.js","sourceRoot":"","sources":["../../../src/lib/userProfileThumbnail/scoringRulesConfig.ts"],"names":[],"mappings":";;AAEA,MAAM,MAAM,GAAuB;IAC/B,UAAU;IACV,OAAO,EAAE;QACL,OAAO,EAAE;YACL,OAAO,EAAE;gBACL,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;YACD,SAAS,EAAE;gBACP,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;YACD,WAAW,EAAE;gBACT,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;SACJ;QAED,aAAa,EAAE;YACX,OAAO,EAAE;gBACL,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;YACD,SAAS,EAAE;gBACP,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;YACD,WAAW,EAAE;gBACT,kBAAkB,EAAE,CAAC;gBACrB,gCAAgC,EAAE,CAAC;aACtC;SACJ;KACJ;CACJ,CAAC;AAEF,kBAAe,MAAM,CAAC"}

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

@@ -0,0 +1,11 @@
+/**
+ * The function then checks whether the input is a string or not by using the typeof operator to compare it
+ * with the string "string" and checking if it is an instance of the String constructor.
+ *
+ * This function can be used to check if a given value is a string, which can be useful in situations where a string is required,
+ * such as validating user input in a form or checking if a variable is a string before manipulating it.
+ *
+ * @param input
+ * @returns a boolean value, true if input is a string, false otherwise.
+ */
+export declare const assertString: (input: any) => boolean;

package/dist/lib/util/assertString.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertString = void 0;
+/**
+ * The function then checks whether the input is a string or not by using the typeof operator to compare it
+ * with the string "string" and checking if it is an instance of the String constructor.
+ *
+ * This function can be used to check if a given value is a string, which can be useful in situations where a string is required,
+ * such as validating user input in a form or checking if a variable is a string before manipulating it.
+ *
+ * @param input
+ * @returns a boolean value, true if input is a string, false otherwise.
+ */
+const assertString = (input) => {
+    // The typeof operator returns a string indicating the type of the unevaluated operand.
+    const isString = typeof input === 'string' || input instanceof String;
+    return isString;
+};
+exports.assertString = assertString;
+//# sourceMappingURL=assertString.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"assertString.js","sourceRoot":"","sources":["../../../src/lib/util/assertString.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACI,MAAM,YAAY,GAAG,CAAC,KAAU,EAAW,EAAE;IAChD,uFAAuF;IACvF,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAC;IACtE,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAJW,QAAA,YAAY,gBAIvB"}

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

@@ -0,0 +1,7 @@
+/**
+ * Check if the input string contains a string representation of searchElem
+ * @param str
+ * @param searchElem element to search
+ * @returns a boolean value, true if input `str` contains searchElem, false otherwise.
+ */
+export declare const contains: (str: string, searchElem: any) => boolean;

package/dist/lib/util/contains.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contains = void 0;
+const toString_1 = require("./toString");
+/**
+ * Check if the input string contains a string representation of searchElem
+ * @param str
+ * @param searchElem element to search
+ * @returns a boolean value, true if input `str` contains searchElem, false otherwise.
+ */
+const contains = (str, searchElem) => {
+    // The toString() function is used to ensure that the searchElem is converted to a string before being searched for in the str
+    searchElem = (0, toString_1.toString)(searchElem);
+    return str.includes(searchElem);
+};
+exports.contains = contains;
+//# sourceMappingURL=contains.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contains.js","sourceRoot":"","sources":["../../../src/lib/util/contains.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAEtC;;;;;GAKG;AACI,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,UAAU,EAAE,EAAE;IAChD,8HAA8H;IAC9H,UAAU,GAAG,IAAA,mBAAQ,EAAC,UAAU,CAAC,CAAC;IAClC,OAAO,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACpC,CAAC,CAAC;AAJW,QAAA,QAAQ,YAInB"}

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

@@ -0,0 +1,6 @@
+/**
+ * Retrieve the number of words in string separated by space
+ * @param s
+ * @returns
+ */
+export declare const getNumberOfStrings: (s: string) => number;

package/dist/lib/util/getNumberOfStrings.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNumberOfStrings = void 0;
+const assertString_1 = require("./assertString");
+/**
+ * Retrieve the number of words in string separated by space
+ * @param s
+ * @returns
+ */
+const getNumberOfStrings = (s) => {
+    if (!(0, assertString_1.assertString)(s)) {
+        return 0;
+    }
+    // exclude white space
+    let str = s.replace(/(^\s*)|(\s*$)/gi, '');
+    str = str.replace(/[ ]{2,}/gi, ' ');
+    // exclude newline with a space at beginning
+    str = str.replace(/\n /, '\n');
+    if (str.split(' ').length === 1 && str.trim() === '') {
+        return 0;
+    }
+    return str.split(' ').length;
+};
+exports.getNumberOfStrings = getNumberOfStrings;
+//# sourceMappingURL=getNumberOfStrings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getNumberOfStrings.js","sourceRoot":"","sources":["../../../src/lib/util/getNumberOfStrings.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;GAIG;AACI,MAAM,kBAAkB,GAAG,CAAC,CAAS,EAAU,EAAE;IACpD,IAAI,CAAC,IAAA,2BAAY,EAAC,CAAC,CAAC,EAAE;QAClB,OAAO,CAAC,CAAC;KACZ;IAED,sBAAsB;IACtB,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC3C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAEpC,4CAA4C;IAC5C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE/B,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAClD,OAAO,CAAC,CAAC;KACZ;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B"}

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

@@ -0,0 +1,21 @@
+import { IItem, ScoringRules, ScoringRulesConfig } from '../../types';
+/**
+ * Scoring Rule locale
+ */
+type ScoringRulesLocale = 'en' | 'international';
+/**
+ * Determines the locale of scoring rules based on the `culture` property of the input item.
+ * English and Non-English items are scored using different rules.
+ *
+ * @param item An ArcGIS Online item.
+ * @returns Returns 'en' for English items, otherwise returns 'international'.
+ */
+export declare const getScoringRulesLocale: (item: IItem) => ScoringRulesLocale;
+/**
+ * Returns the rules that will be used to score the item based on the item type
+ * @param itemType
+ * @param scoringRulesByType
+ * @returns
+ */
+export declare const getScoringRules: (item: IItem, scoringRulesConfig: ScoringRulesConfig) => ScoringRules;
+export {};

package/dist/lib/util/getScoringRules.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getScoringRules = exports.getScoringRulesLocale = void 0;
+/**
+ * Look up table that maps Living Atlas supported item types to the corresponding Scoring Rules Type.
+ */
+const itemType2ScoringType = {
+    'Feature Collection': 'WEB_MAP',
+    'Feature Service': 'WEB_MAP',
+    'Image Service': 'WEB_MAP',
+    'Map Service': 'WEB_MAP',
+    'Web Map': 'WEB_MAP',
+    'Vector Tile Service': 'WEB_MAP',
+    'CityEngine Web Scene': 'WEB_SCENE',
+    'Deep Learning Package': 'WEB_SCENE',
+    'Raster function template': 'WEB_SCENE',
+    'Rule Package': 'WEB_SCENE',
+    'Scene Service': 'WEB_SCENE',
+    Style: 'WEB_SCENE',
+    'Desktop Style': 'WEB_SCENE',
+    'Web Scene': 'WEB_SCENE',
+    Dashboard: 'APPLICATION',
+    'Document Link': 'APPLICATION',
+    'Project Package': 'APPLICATION',
+    StoryMap: 'APPLICATION',
+    'Web Experience': 'APPLICATION',
+    'Web Experience Template': 'APPLICATION',
+    'Web Mapping Application': 'APPLICATION',
+    WMS: 'APPLICATION',
+};
+/**
+ * Determines the locale of scoring rules based on the `culture` property of the input item.
+ * English and Non-English items are scored using different rules.
+ *
+ * @param item An ArcGIS Online item.
+ * @returns Returns 'en' for English items, otherwise returns 'international'.
+ */
+const getScoringRulesLocale = (item) => {
+    if (!item.culture) {
+        return 'en';
+    }
+    const [itemRegion] = item.culture.split('-');
+    if (itemRegion === 'en' ||
+        item.culture === 'english (united states)' ||
+        item.culture === '') {
+        return 'en';
+    }
+    return 'international';
+};
+exports.getScoringRulesLocale = getScoringRulesLocale;
+/**
+ * Returns the rules that will be used to score the item based on the item type
+ * @param itemType
+ * @param scoringRulesByType
+ * @returns
+ */
+const getScoringRules = (item, scoringRulesConfig) => {
+    const locale = (0, exports.getScoringRulesLocale)(item);
+    const { SCORING } = scoringRulesConfig;
+    const scoringRulesData = locale === 'en' ? SCORING.DEFAULT : SCORING.INTERNATIONAL;
+    const itemType = item.type;
+    const scoringRuleType = itemType2ScoringType[itemType];
+    // switch (itemType) {
+    //     case 'Feature Collection':
+    //     case 'Feature Service':
+    //     case 'Image Service':
+    //     case 'Map Service':
+    //     case 'Web Map':
+    //     case 'Vector Tile Service':
+    //         scoringRules = scoringRulesData['WEB_MAP'];
+    //         break;
+    //     case 'CityEngine Web Scene':
+    //     case 'Deep Learning Package':
+    //     case 'Raster function template':
+    //     case 'Rule Package':
+    //     case 'Scene Service':
+    //     case 'Style':
+    //     case 'Desktop Style':
+    //     case 'Web Scene':
+    //         scoringRules = scoringRulesData['WEB_SCENE'];
+    //         break;
+    //     case 'Dashboard':
+    //     case 'Document Link':
+    //     case 'Project Package':
+    //     case 'StoryMap':
+    //     case 'Web Experience':
+    //     case 'Web Experience Template':
+    //     case 'Web Mapping Application':
+    //     case 'WMS':
+    //         scoringRules = scoringRulesData['APPLICATION'];
+    //         break;
+    //     default:
+    //         break;
+    //     // code block
+    // }
+    return scoringRulesData[scoringRuleType] || null;
+};
+exports.getScoringRules = getScoringRules;
+//# sourceMappingURL=getScoringRules.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getScoringRules.js","sourceRoot":"","sources":["../../../src/lib/util/getScoringRules.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,MAAM,oBAAoB,GAGtB;IACA,oBAAoB,EAAE,SAAS;IAC/B,iBAAiB,EAAE,SAAS;IAC5B,eAAe,EAAE,SAAS;IAC1B,aAAa,EAAE,SAAS;IACxB,SAAS,EAAE,SAAS;IACpB,qBAAqB,EAAE,SAAS;IAChC,sBAAsB,EAAE,WAAW;IACnC,uBAAuB,EAAE,WAAW;IACpC,0BAA0B,EAAE,WAAW;IACvC,cAAc,EAAE,WAAW;IAC3B,eAAe,EAAE,WAAW;IAC5B,KAAK,EAAE,WAAW;IAClB,eAAe,EAAE,WAAW;IAC5B,WAAW,EAAE,WAAW;IACxB,SAAS,EAAE,aAAa;IACxB,eAAe,EAAE,aAAa;IAC9B,iBAAiB,EAAE,aAAa;IAChC,QAAQ,EAAE,aAAa;IACvB,gBAAgB,EAAE,aAAa;IAC/B,yBAAyB,EAAE,aAAa;IACxC,yBAAyB,EAAE,aAAa;IACxC,GAAG,EAAE,aAAa;CACrB,CAAC;AAEF;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,IAAW,EAAsB,EAAE;IACrE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,OAAO,IAAI,CAAC;KACf;IAED,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7C,IACI,UAAU,KAAK,IAAI;QACnB,IAAI,CAAC,OAAO,KAAK,yBAAyB;QAC1C,IAAI,CAAC,OAAO,KAAK,EAAE,EACrB;QACE,OAAO,IAAI,CAAC;KACf;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC,CAAC;AAhBW,QAAA,qBAAqB,yBAgBhC;AAEF;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAC3B,IAAW,EACX,kBAAsC,EAC1B,EAAE;IACd,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAAC,IAAI,CAAC,CAAC;IAE3C,MAAM,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC;IAEvC,MAAM,gBAAgB,GAClB,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAE9D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAoC,CAAC;IAE3D,MAAM,eAAe,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAEvD,sBAAsB;IACtB,iCAAiC;IACjC,8BAA8B;IAC9B,4BAA4B;IAC5B,0BAA0B;IAC1B,sBAAsB;IACtB,kCAAkC;IAClC,sDAAsD;IACtD,iBAAiB;IACjB,mCAAmC;IACnC,oCAAoC;IACpC,uCAAuC;IACvC,2BAA2B;IAC3B,4BAA4B;IAC5B,oBAAoB;IACpB,4BAA4B;IAC5B,wBAAwB;IACxB,wDAAwD;IACxD,iBAAiB;IACjB,wBAAwB;IACxB,4BAA4B;IAC5B,8BAA8B;IAC9B,uBAAuB;IACvB,6BAA6B;IAC7B,sCAAsC;IACtC,sCAAsC;IACtC,kBAAkB;IAClB,0DAA0D;IAC1D,iBAAiB;IACjB,eAAe;IACf,iBAAiB;IACjB,oBAAoB;IACpB,IAAI;IAEJ,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC;AACrD,CAAC,CAAC;AAlDW,QAAA,eAAe,mBAkD1B"}

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

@@ -0,0 +1,15 @@
+/**
+ * Get thumbnail image file name.
+ *
+ * For an ArcGIS Online Item, the thumbnail property contains values like `thumbnail/thumbnail1681504014799.png`,
+ * The string after backslash is the actual file name of the thumbnail image.
+ * @param thumbnail
+ * @returns file name of the thumbnail image
+ *
+ * @example
+ * ```
+ * getThumbnailFileName('thumbnail/thumbnail1681504014799.png');
+ * // returns `thumbnail1681504014799.png`
+ * ```
+ */
+export declare const getThumbnailFileName: (thumbnail: string) => string;

package/dist/lib/util/getThumbnailFileName.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getThumbnailFileName = void 0;
+/**
+ * Get thumbnail image file name.
+ *
+ * For an ArcGIS Online Item, the thumbnail property contains values like `thumbnail/thumbnail1681504014799.png`,
+ * The string after backslash is the actual file name of the thumbnail image.
+ * @param thumbnail
+ * @returns file name of the thumbnail image
+ *
+ * @example
+ * ```
+ * getThumbnailFileName('thumbnail/thumbnail1681504014799.png');
+ * // returns `thumbnail1681504014799.png`
+ * ```
+ */
+const getThumbnailFileName = (thumbnail) => {
+    if (thumbnail.includes('/') === false) {
+        return thumbnail;
+    }
+    const [prefix, filename] = thumbnail.split('/');
+    return filename || '';
+};
+exports.getThumbnailFileName = getThumbnailFileName;
+//# sourceMappingURL=getThumbnailFileName.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getThumbnailFileName.js","sourceRoot":"","sources":["../../../src/lib/util/getThumbnailFileName.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;GAaG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACtD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE;QACnC,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,OAAO,QAAQ,IAAI,EAAE,CAAC;AAC1B,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}

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

@@ -0,0 +1,6 @@
+/**
+ * Check if input URL is hosted under ArcGIS Domain
+ * @param url
+ * @returns
+ */
+export declare const isArcGISDomain: (url: string) => boolean;

package/dist/lib/util/isArcGISDomain.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isArcGISDomain = void 0;
+/**
+ * Check if input URL is hosted under ArcGIS Domain
+ * @param url
+ * @returns
+ */
+const isArcGISDomain = (url) => {
+    if (!url) {
+        return false;
+    }
+    return url.includes('arcgis.com') || url.includes('arcgisonline.com');
+};
+exports.isArcGISDomain = isArcGISDomain;
+//# sourceMappingURL=isArcGISDomain.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isArcGISDomain.js","sourceRoot":"","sources":["../../../src/lib/util/isArcGISDomain.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAAC,GAAW,EAAW,EAAE;IACnD,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAC1E,CAAC,CAAC;AANW,QAAA,cAAc,kBAMzB"}

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

@@ -0,0 +1,6 @@
+/**
+ * check and see if the input thumbnail name is one of the reserved names used by ArcGIS online
+ * @param smallThumbnailFileName
+ * @returns
+ */
+export declare const isArcGISOnlineReservedThumbnailName: (thumbnailName: string) => boolean;

package/dist/lib/util/isArcGISOnlineReservedThumbnailName.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isArcGISOnlineReservedThumbnailName = void 0;
+/**
+ * check and see if the input thumbnail name is one of the reserved names used by ArcGIS online
+ * @param smallThumbnailFileName
+ * @returns
+ */
+const isArcGISOnlineReservedThumbnailName = (thumbnailName) => {
+    return [
+        'thumbnail.jpeg',
+        'nullThumbnail.png',
+        'no-user-thumb.jpg',
+        'ago_downloaded.png',
+        'ago_downloaded.jpg',
+    ].includes(thumbnailName);
+};
+exports.isArcGISOnlineReservedThumbnailName = isArcGISOnlineReservedThumbnailName;
+//# sourceMappingURL=isArcGISOnlineReservedThumbnailName.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isArcGISOnlineReservedThumbnailName.js","sourceRoot":"","sources":["../../../src/lib/util/isArcGISOnlineReservedThumbnailName.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,mCAAmC,GAAG,CAAC,aAAqB,EAAE,EAAE;IACzE,OAAO;QACH,gBAAgB;QAChB,mBAAmB;QACnB,mBAAmB;QACnB,oBAAoB;QACpB,oBAAoB;KACvB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;AAC9B,CAAC,CAAC;AARW,QAAA,mCAAmC,uCAQ9C"}

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

@@ -0,0 +1,8 @@
+/**
+ * Check if  value is defined
+ *
+ * A value is defined if it is not undefined or null
+ * @param value
+ * @returns
+ */
+export declare const isDefined: (value: any) => boolean;

package/dist/lib/util/isDefined.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDefined = void 0;
+/**
+ * Check if  value is defined
+ *
+ * A value is defined if it is not undefined or null
+ * @param value
+ * @returns
+ */
+const isDefined = (value) => {
+    return value !== undefined && value !== null;
+};
+exports.isDefined = isDefined;
+//# sourceMappingURL=isDefined.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isDefined.js","sourceRoot":"","sources":["../../../src/lib/util/isDefined.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACI,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE;IAC/B,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACjD,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}

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

@@ -0,0 +1,6 @@
+/**
+ * Check if input string is a valid email address
+ * @param str
+ * @returns boolean value, true if input is a valid email address, false otherwise.
+ */
+export declare const isEmail: (str: string) => boolean;