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

package/dist/configureSettings.d.ts

@@ -0,0 +1,133 @@
+import { ServiceTier } from './services/shared/config';
+type ConfigureSettingsParams = {
+    /**
+     * The language of the library. Default is 'en'.
+     * This setting determines the language used for displaying messages and of the validation results.
+     *
+     * Here is list of supported languages:
+     * - `en`: English
+     * - `de`: German
+     * - `es`: Spanish
+     * - `fr`: French
+     * - `ja`: Japanese
+     * - `pt-br`: Brazilian Portuguese
+     */
+    language: string;
+    /**
+     * The service tier of the application. It can be either 'dev' or 'prod'.
+     * - `dev`: Development tier, pointing to development services on `devext.arcgis.com`.
+     * - `prod`: Production tier, pointing to production services on `www.arcgis.com`.
+     */
+    serviceTier: ServiceTier;
+    /**
+     * additional patterns for title and snippet searchability
+     */
+    additionalPatternsForTitleAndSnippetSearchability?: {
+        /**
+         * A list of additional matching patterns for location matching.
+         *
+         * @example
+         * ```
+         * ["New York", "Los Angeles"]
+         * ```
+         */
+        matchingPatternsLocation: string[];
+        /**
+         * A list of additional rejected patterns for location matching.
+         *
+         * @example
+         * ```
+         * ["Unknown", "Unknown Location"]
+         * ```
+         */
+        rejectedPatternsLocation: string[];
+        /**
+         * A list of additional matching patterns for source matching.
+         *
+         * @example
+         * ```
+         * ["NOAA", "Department of Energy"]
+         * ```
+         */
+        matchingPatternsSource: string[];
+        /**
+         * A list of additional rejected patterns for source matching.
+         *
+         * @example
+         * ```
+         * ["Unknown", "Unknown Source"]
+         * ```
+         */
+        rejectedPatternsSource: string[];
+        /**
+         * A list of additional matching patterns for topic matching.
+         *
+         * @example
+         * ```
+         * ["Climate Change", "Renewable Energy"]
+         * ```
+         */
+        matchingPatternsTopic: string[];
+        /**
+         * A list of additional rejected patterns for topic matching.
+         *
+         * @example
+         * ```
+         * ["Unknown", "Unknown Topic"]
+         * ```
+         */
+        rejectedPatternsTopic: string[];
+        /**
+         * A list of additional matching patterns for title matching.
+         *
+         * @example
+         * ```
+         * ["bi-weekly", "monthly"]
+         * ```
+         */
+        matchingPatternsYearVintage: string[];
+        /**
+         * A list of additional rejected patterns for year vintage matching.
+         *
+         * @example
+         * ```
+         * ["Unknown", "Unknown Year Vintage"]
+         * ```
+         */
+        rejectedPatternsYearVintage: string[];
+        /**
+         * A boolean value indicating whether to avoid using word boundaries in the title and snippet searchability.
+         * This is used to determine if the language is non-Latin.
+         * If the language is non-Latin, word boundaries should be avoided.
+         */
+        shouldAvoidUsingWordBoundary: boolean;
+    };
+    /**
+     * An array of profanities to be used for validation.
+     * This is used to determine if the title or snippet contains any profanities.
+     */
+    profanities?: string[];
+};
+/**
+ * Configures the settings for the application.
+ *
+ * @param {Object} params - The settings parameters.
+ * @param {string} params.serviceTier - The service tier, must be either 'dev' or 'prod'.
+ * @param {string} params.language - The language to be set for the application.
+ * @param {Object} params.additionalPatternsForTitleAndSnippetSearchability - Additional patterns for title and snippet searchability.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsLocation - Matching patterns for location.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsLocation - Rejected patterns for location.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsSource - Matching patterns for source.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsSource - Rejected patterns for source.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsTopic - Matching patterns for topic.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsTopic - Rejected patterns for topic.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsYearVintage - Matching patterns for year vintage.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsYearVintage - Rejected patterns for year vintage.
+ * @param {boolean} params.additionalPatternsForTitleAndSnippetSearchability.shouldAvoidUsingWordBoundary - Flag to avoid using word boundary.
+ * @param {string[]} [params.profanities] - An array of profanities to be used for validation.
+ *
+ * @throws {Error} If the service tier is not 'dev' or 'prod'.
+ * @throws {Error} If the language is not provided.
+ */
+export declare const configureSettings: ({ serviceTier, language, additionalPatternsForTitleAndSnippetSearchability, profanities, }: ConfigureSettingsParams) => void;
+export {};

package/dist/configureSettings.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureSettings = void 0;
+const checkProfanities_1 = require("./lib/checkProfanities/checkProfanities");
+const config_1 = require("./lib/checkTitleAndSnippetSearchability/config");
+const stringsConfig_1 = require("./lib/util/stringsConfig");
+const config_2 = require("./services/shared/config");
+/**
+ * Configures the settings for the application.
+ *
+ * @param {Object} params - The settings parameters.
+ * @param {string} params.serviceTier - The service tier, must be either 'dev' or 'prod'.
+ * @param {string} params.language - The language to be set for the application.
+ * @param {Object} params.additionalPatternsForTitleAndSnippetSearchability - Additional patterns for title and snippet searchability.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsLocation - Matching patterns for location.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsLocation - Rejected patterns for location.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsSource - Matching patterns for source.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsSource - Rejected patterns for source.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsTopic - Matching patterns for topic.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsTopic - Rejected patterns for topic.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.matchingPatternsYearVintage - Matching patterns for year vintage.
+ * @param {string[]} params.additionalPatternsForTitleAndSnippetSearchability.rejectedPatternsYearVintage - Rejected patterns for year vintage.
+ * @param {boolean} params.additionalPatternsForTitleAndSnippetSearchability.shouldAvoidUsingWordBoundary - Flag to avoid using word boundary.
+ * @param {string[]} [params.profanities] - An array of profanities to be used for validation.
+ *
+ * @throws {Error} If the service tier is not 'dev' or 'prod'.
+ * @throws {Error} If the language is not provided.
+ */
+const configureSettings = ({ serviceTier, language, additionalPatternsForTitleAndSnippetSearchability, profanities, }) => {
+    if (serviceTier !== 'dev' && serviceTier !== 'prod') {
+        throw new Error('Invalid service tier. It must be either "dev" or "prod".');
+    }
+    if (!language) {
+        throw new Error('Language is required.');
+    }
+    const validLocales = ['en', 'de', 'es', 'fr', 'ja', 'pt-br'];
+    if (!validLocales.includes(language)) {
+        throw new Error(`Invalid language. Supported languages are: ${validLocales.join(', ')}.`);
+    }
+    // Set the service tier for the application
+    (0, config_2.setServiceTier)(serviceTier);
+    // Set the language for the application
+    (0, stringsConfig_1.setStrings)(language);
+    const { matchingPatternsLocation, rejectedPatternsLocation, matchingPatternsSource, rejectedPatternsSource, matchingPatternsTopic, rejectedPatternsTopic, matchingPatternsYearVintage, rejectedPatternsYearVintage, shouldAvoidUsingWordBoundary, } = additionalPatternsForTitleAndSnippetSearchability || {};
+    // Set additional patterns for title and snippet searchability
+    (0, config_1.setAdditionalPatternsForTitleAndSnippetSearchability)({
+        matchingPatternsLocation,
+        rejectedPatternsLocation,
+        matchingPatternsSource,
+        rejectedPatternsSource,
+        matchingPatternsTopic,
+        rejectedPatternsTopic,
+        matchingPatternsYearVintage,
+        rejectedPatternsYearVintage,
+        shouldAvoidUsingWordBoundary,
+    });
+    // Set profanities for validation
+    (0, checkProfanities_1.setProfanities)(profanities || []);
+};
+exports.configureSettings = configureSettings;
+//# sourceMappingURL=configureSettings.js.map

package/dist/configureSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureSettings.js","sourceRoot":"","sources":["../src/configureSettings.ts"],"names":[],"mappings":";;;AAAA,8EAAyE;AACzE,2EAAsH;AACtH,4DAA8D;AAC9D,qDAAuE;AAgHvE;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAC9B,WAAW,EACX,QAAQ,EACR,iDAAiD,EACjD,WAAW,GACW,EAAE,EAAE;IAC1B,IAAI,WAAW,KAAK,KAAK,IAAI,WAAW,KAAK,MAAM,EAAE;QACjD,MAAM,IAAI,KAAK,CACX,0DAA0D,CAC7D,CAAC;KACL;IAED,IAAI,CAAC,QAAQ,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC5C;IAED,MAAM,YAAY,GAAa,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACvE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAkB,CAAC,EAAE;QAC5C,MAAM,IAAI,KAAK,CACX,8CAA8C,YAAY,CAAC,IAAI,CAC3D,IAAI,CACP,GAAG,CACP,CAAC;KACL;IAED,2CAA2C;IAC3C,IAAA,uBAAc,EAAC,WAAW,CAAC,CAAC;IAE5B,uCAAuC;IACvC,IAAA,0BAAU,EAAC,QAAQ,CAAC,CAAC;IAErB,MAAM,EACF,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,GAC/B,GAAG,iDAAiD,IAAI,EAAE,CAAC;IAE5D,8DAA8D;IAC9D,IAAA,6DAAoD,EAAC;QACjD,wBAAwB;QACxB,wBAAwB;QACxB,sBAAsB;QACtB,sBAAsB;QACtB,qBAAqB;QACrB,qBAAqB;QACrB,2BAA2B;QAC3B,2BAA2B;QAC3B,4BAA4B;KAC/B,CAAC,CAAC;IAEH,iCAAiC;IACjC,IAAA,iCAAc,EAAC,WAAW,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AA1DW,QAAA,iBAAiB,qBA0D5B"}