@vannizhang/living-atlas-content-validator 1.5.19-beta.9 → 1.5.19

package/README.md

@@ -14,7 +14,7 @@ The validation process evaluates whether an item meets all necessary criteria, s
 - [Installation](#installation)
 - [Usage](#usage)
 - [Configuration](#configuration)
-- [API Reference](#api-reference)
+- [API Reference - Core Functions](#api-reference---core-functions)
   - [validate](#validate)
   - [isValidTitle](#isvalidtitle)
   - [isValidAccessInformation](#isvalidaccessinformation)
@@ -29,7 +29,11 @@ The validation process evaluates whether an item meets all necessary criteria, s
   - [isValidUserProfileName](#isvaliduserprofilename)
   - [isValidUserProfileDescription](#isvaliduserprofiledescription)
   - [isValidUserProfileThumbnail](#isvaliduserprofilethumbnail)
+  - [checkFeatureServiceFieldAliases](#checkfeatureservicefieldaliases)
+  - [checkFeatureServiceFieldDescriptions](#checkFeatureServiceFieldDescriptions)
+  - [checkFeatureServiceFieldValueTypes](#checkFeatureServiceFieldValueTypes)
   - [checkTitleAndSnippetSearchability](#checktitleandsnippetsearchability)
+- [API Reference - Helper Functions](#api-reference---helper-functions)
   - [isEligibleForCheckingTitleAndSnippetSearchability](#iseligibleforcheckingtitleandsnippetsearchability)
   - [matchLocationInfo](#matchlocationinfo)
   - [isRecognizedLocation](#isrecognizedlocation)
@@ -43,12 +47,8 @@ The validation process evaluates whether an item meets all necessary criteria, s
   - [matchDateTimeInfo](#matchdatetimeinfo)
   - [isRecognizedDateTimeInfo](#isrecognizeddatetimeinfo)
   - [isRejectedDateTimeInfo](#isrejecteddatetimeinfo)
-  - [checkFeatureServiceFieldAliases](#checkfeatureservicefieldaliases)
-  - [checkFeatureServiceFieldDescriptions](#checkFeatureServiceFieldDescriptions)
-  - [checkFeatureServiceFieldValueTypes](#checkFeatureServiceFieldValueTypes)
   - [getLivingAtlasSupportedItemTypes](#getlivingatlassupporteditemtypes)
   - [checkIsLivingAtlasSupportedItemType](#checkislivingatlassupporteditemtype)
-
 - [Types](#types)
     - [ValidationResult](#validationresult)
     - [ValidationResultStatus](#validationresultstatus)
@@ -102,26 +102,13 @@ const validationResults = validate(item, userProfile);
 
 ## Configuration
 
-The package provides a `configureSettings` function that allows customization of language, service tier, and additional validation patterns.
+The package provides a `configureSettings` function that allows customization of language, additional validation patterns and etc.
 
 ### `configureSettings(params)`
-Configures the package settings including language preferences, service tier selection, and customization options for validation patterns. This function should be called before using any validation functionality to ensure the validator operates with the correct context and rule set.
+Configures the package settings including language preferences, additional matching patterns to be used for title and snippet searchability rule and etc. This function should be called before using any validation functionality to ensure the validator operates with the correct context and rule set.
 
 **Parameters:**
-- `language` (`string`, required) - The language of the library. Default is `'en'`.  
-  Supported languages:  
-  - `'en'` (English)  
-  - `'de'` (German)  
-  - `'es'` (Spanish)  
-  - `'fr'` (French)  
-  - `'ja'` (Japanese)  
-  - `'pt-br'` (Brazilian Portuguese)  
-
-- `serviceTier` (`string`, required) - The service tier of the application.  
-  - `'dev'`: Development tier, points to `devext.arcgis.com`.  
-  - `'prod'`: Production tier, points to `www.arcgis.com`.  
-
-- `additionalPatternsForTitleAndSnippetSearchability` (*object*, optional) - Additional validation patterns for title and snippet searchability.  
+- `additionalPatternsForTitleAndSnippetSearchability` (*object*, optional) - Additional validation patterns for title and snippet searchability. These additional patterns are global, will be used for all items validated by the package. If you want to use custom patterns for a specific item, you can pass them as options to the [`validate`](#validate) function.
   - `matchingPatternsLocation` (`string[]`) - List of location matching patterns.  
   - `rejectedPatternsLocation` (`string[]`) - List of rejected location patterns.  
   - `matchingPatternsSource` (`string[]`) - List of source matching patterns.  
@@ -132,9 +119,27 @@ Configures the package settings including language preferences, service tier sel
   - `rejectedPatternsYearVintage` (`string[]`) - List of rejected year vintage patterns.  
   - `shouldAvoidUsingWordBoundary` (`boolean`) - Determines if word boundaries should be avoided (for non-Latin languages).  
 
+- `language` (`string`, optional) - This setting determines the language used for displaying messages of the validation results. Default is `'en'`. Supported languages:  
+  - `'en'` (English)  
+  - `'de'` (German)  
+  - `'es'` (Spanish)  
+  - `'fr'` (French)  
+  - `'ja'` (Japanese)  
+  - `'pt-br'` (Brazilian Portuguese)  
+
 - `profanities` (`string[]`, optional) - List of words considered profane for validation.  
 
-### Example Usage
+- `serviceTier` (`string`, option) - The service tier of the application. Some helper modules (not part of the core evaluation logic) depend on this setting. If you're only using the library to evaluate content, you can safely ignore this.
+  - `'dev'`: Development tier, points to `devext.arcgis.com`.  
+  - `'prod'`: Production tier, points to `www.arcgis.com`.  
+  
+### When should I use `configureSettings`?
+
+You should use `configureSettings` if you want to define additional matching patterns for title and snippet searchability, especially in cases where the default patterns may not account for all special scenarios. This is particularly helpful for non-English languages or specialized domains with frequently used terms.
+
+The Living Atlas team also uses the `configureSettings` function to incorporate matching patterns suggested by users of the Living Atlas Nomination App.
+
+### Example Usage of `configureSettings`
 
 ```js
 import { 
@@ -142,8 +147,6 @@ import {
 } from '@vannizhang/living-atlas-content-validator';
 
 configureSettings({
-    language: 'en',
-    serviceTier: 'prod',
     additionalPatternsForTitleAndSnippetSearchability: {
         matchingPatternsLocation: ['New York', 'Los Angeles'],
         rejectedPatternsLocation: ['Unknown', 'Unknown Location'],
@@ -155,13 +158,15 @@ configureSettings({
         rejectedPatternsYearVintage: ['Unknown', 'Unknown Year Vintage'],
         shouldAvoidUsingWordBoundary: false
     },
-    profanities: ['badword1', 'badword2']
+    language: 'en',
+    profanities: ['badword1', 'badword2'],
+    serviceTier: 'prod',
 });
 ```
 
-If `serviceTier` is not `dev` or `prod`, or if an unsupported language is provided, an error will be thrown.
+## API Reference - Core Functions
 
-## API Reference
+These are the core functions provided by the package for validating ArcGIS Online items against Living Atlas criteria. The `validate` function serves as the main entry point, performing comprehensive validation by internally invoking the other functions. Each of these functions can also be used independently for targeted validation tasks.
 
 ### `validate`
 Validates an ArcGIS Online item and its owner's user profile against Living Atlas criteria.
@@ -185,7 +190,7 @@ validate(
   - `customPatternsForSourceInfo` (`string[]`, optional): Custom patterns for identifying source information in the item's title and snippet.  
   - `customPatternsForTopicInfo` (`string[]`, optional): Custom patterns for identifying topic information in the item's title and snippet.
   - `thumbnailDimension` (`{ width: number; height: number; }`, optional): The dimensions (in pixels) of the item's largest thumbnail image, used for validating thumbnail requirements.
-  - `featureLayers` (`FeatureLayerJSON[]`, optional): An array of `FeatureLayerJSON` objects representing the feature layers associated with the Feature Service item. Used for validating field value types, aliases, and descriptions within those layers.
+  - `featureLayers` (`FeatureLayerJSON[]`, optional): An array of [`Feature Layer JSON`](https://developers.arcgis.com/rest/services-reference/online/feature-layer/#json-response-syntax) objects representing the feature layers associated with the Feature Service item. Used for validating field value types, aliases, and descriptions within those layers.
 
 **Returns:**
 - `ValidationResult`: An object containing detailed validation results, a total score, and a flag indicating whether the item can be nominated to Living Atlas.
@@ -721,6 +726,156 @@ console.log(validationInfo);
 
 ---
 
+
+### `checkFeatureServiceFieldAliases`
+Validates that relevant fields in feature layers have appropriate aliases.
+
+```ts
+import { checkFeatureServiceFieldAliases } from '@vannizhang/living-atlas-content-validator';
+
+checkFeatureServiceFieldAliases(
+    item: IItem,
+    featureLayers: FeatureLayerJSON[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to validate
+- `featureLayers` (`FeatureLayerJSON[]`, required): An array of [`Feature Layer JSON`](https://developers.arcgis.com/rest/services-reference/online/feature-layer/#json-response-syntax) objects representing the feature layers published to this feature service to check for field aliases.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages, and scoring for field aliases.
+
+**Description:**
+This function checks the provided feature layers for relevant fields and evaluates whether those fields have aliases defined.
+
+**Example:**
+```ts
+import { checkFeatureServiceFieldAliases } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-feature-layer-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+const featureLayers = [
+    {
+        fields: [
+            { name: 'field1', alias: 'Field 1' },
+            { name: 'field2', alias: '' },
+            // Other fields...
+        ],
+        // Other properties...
+    }
+    // Additional feature layers if needed...
+];
+
+const validationInfo = checkFeatureServiceFieldAliases(item, featureLayers);
+console.log(validationInfo);
+```
+
+---
+
+### `checkFeatureServiceFieldDescriptions`
+Validates that relevant fields in feature layers have appropriate descriptions.
+
+```ts
+import { checkFeatureServiceFieldDescriptions } from '@vannizhang/living-atlas-content-validator';
+
+checkFeatureServiceFieldDescriptions(
+    item: IItem,
+    featureLayers: FeatureLayerJSON[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to validate, expected to be a feature layer.
+- `featureLayers` (`FeatureLayerJSON[]`, required): An array of [`Feature Layer JSON`](https://developers.arcgis.com/rest/services-reference/online/feature-layer/#json-response-syntax) objects representing the feature layers published to this feature service to check for field descriptions.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages, score, and scoring factors for field descriptions.
+
+**Description:**
+This function checks if the given item is a feature layer and evaluates the presence of field descriptions for relevant fields within the provided feature layers.
+**Example:**
+```ts
+import { checkFeatureServiceFieldDescriptions } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-feature-layer-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+const featureLayers = [
+    {
+        fields: [
+            { name: 'field1', description: { value: 'Description for field 1' } },
+            { name: 'field2', description: { value: '' } },
+            // Other fields...
+        ],
+        // Other properties...
+    }
+    // Additional feature layers if needed...
+];
+
+const validationInfo = checkFeatureServiceFieldDescriptions(item, featureLayers);
+console.log(validationInfo);
+```
+
+---
+
+### `checkFeatureServiceFieldValueTypes`
+Validates that relevant fields in feature layers have a `fieldValueType` defined in their field descriptions.
+
+```ts
+import { checkFeatureServiceFieldValueTypes } from '@vannizhang/living-atlas-content-validator';
+
+checkFeatureServiceFieldValueTypes(
+    item: IItem,
+    featureLayers: FeatureLayerJSON[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to validate.
+- `featureLayers` (`FeatureLayerJSON[]`, required): An array of [`Feature Layer JSON`](https://developers.arcgis.com/rest/services-reference/online/feature-layer/#json-response-syntax) objects representing the feature layers published to this feature service.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages, and scoring for field value types.
+
+**Description:**
+This function checks the provided feature layers for relevant fields and evaluates whether those fields have a `fieldValueType` defined in their descriptions.
+
+**Example:**
+```ts
+import { checkFeatureServiceFieldValueTypes } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-feature-layer-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+const featureLayers = [
+    {
+        fields: [
+            { name: 'field1', description: { fieldValueType: 'type1' } },
+            { name: 'field2', description: { fieldValueType: '' } },
+            // Other fields...
+        ],
+        // Other properties...
+    }
+    // Additional feature layers if needed...
+];
+
+const validationInfo = checkFeatureServiceFieldValueTypes(item, featureLayers);
+console.log(validationInfo);
+```
+
+---
+
 ### `checkTitleAndSnippetSearchability`
 Checks for required and recommended text in an item's title and summary (snippet) to ensure they are search-friendly.
 
@@ -772,6 +927,10 @@ console.log(validationInfo);
 
 ---
 
+## API Reference - Helper Functions
+
+These are helper functions used internally by the core validation functions, but they can also be called independently for specific use cases. For example, a user may call `checkIsLivingAtlasSupportedItemType` to determine if an item is a supported Living Atlas type before invoking validate. Similarly, `isRecognizedLocation` can be used to verify whether a string qualifies as recognized location information before using it as a custom pattern in `matchLocationInfo`.
+
 ### `isEligibleForCheckingTitleAndSnippetSearchability`
 Determines if an item is eligible for checking title and snippet searchability.
 
@@ -1254,171 +1413,6 @@ const isSupported = checkIsLivingAtlasSupportedItemType(item);
 console.log(isSupported); // true or false
 ```
 
----
-
-### `checkFeatureServiceFieldAliases`
-Validates that relevant fields in feature layers have appropriate aliases.
-
-```ts
-import { checkFeatureServiceFieldAliases } from '@vannizhang/living-atlas-content-validator';
-
-checkFeatureServiceFieldAliases(
-    item: IItem,
-    featureLayers: FeatureLayerJSON[]
-): ValidationInfo
-```
-
-**Parameters:**
-- `item` (`IItem`, required): The ArcGIS Online item to validate
-- `featureLayers` (`FeatureLayerJSON[]`, required): An array of JSON objects representing the feature layers published to this feature service to check for field aliases.
-
-**Returns:**
-- `ValidationInfo`: An object containing the validation result, messages, and scoring for field aliases.
-
-**Description:**
-This function checks the provided feature layers for relevant fields and evaluates whether those fields have aliases defined. The scoring logic is as follows:
-- If the item is not a feature layer, the rule does not contribute to the final score (weight is 0).
-- If there are no feature layers, a message is added and the result is returned.
-- If none of the relevant fields have aliases, a message is added to prompt adding aliases.
-- If less than 80% of relevant fields have aliases, a message is added to prompt improvement and half score is given.
-- If at least 80% of relevant fields have aliases, the rule receives full score.
-
-**Example:**
-```ts
-import { checkFeatureServiceFieldAliases } from '@vannizhang/living-atlas-content-validator';
-
-const item = {
-    id: 'mock-feature-layer-id',
-    type: 'Feature Service',
-    // Other properties...
-};
-
-const featureLayers = [
-    {
-        fields: [
-            { name: 'field1', alias: 'Field 1' },
-            { name: 'field2', alias: '' },
-            // Other fields...
-        ],
-        // Other properties...
-    }
-    // Additional feature layers if needed...
-];
-
-const validationInfo = checkFeatureServiceFieldAliases(item, featureLayers);
-console.log(validationInfo);
-```
-
----
-
-### `checkFeatureServiceFieldDescriptions`
-Validates that relevant fields in feature layers have appropriate descriptions.
-
-```ts
-import { checkFeatureServiceFieldDescriptions } from '@vannizhang/living-atlas-content-validator';
-
-checkFeatureServiceFieldDescriptions(
-    item: IItem,
-    featureLayers: FeatureLayerJSON[]
-): ValidationInfo
-```
-
-**Parameters:**
-- `item` (`IItem`, required): The ArcGIS Online item to validate, expected to be a feature layer.
-- `featureLayers` (`FeatureLayerJSON[]`, required): An array of JSON objects representing the feature layers published to this feature service to check for field descriptions.
-
-**Returns:**
-- `ValidationInfo`: An object containing the validation result, messages, score, and scoring factors for field descriptions.
-
-**Description:**
-This function checks if the given item is a feature layer and evaluates the presence of field descriptions for relevant fields within the provided feature layers. The scoring logic is as follows:
-- If the item is not a feature layer, the rule does not contribute to the final score (weight is 0).
-- If there are no feature layers, a message is added and the result is returned.
-- If none of the relevant fields have descriptions, a message is added and the score is zero.
-- If less than 80% of relevant fields have descriptions, a message is added and half score is given.
-- If at least 80% of relevant fields have descriptions, the rule receives full score.
-
-**Example:**
-```ts
-import { checkFeatureServiceFieldDescriptions } from '@vannizhang/living-atlas-content-validator';
-
-const item = {
-    id: 'mock-feature-layer-id',
-    type: 'Feature Service',
-    // Other properties...
-};
-
-const featureLayers = [
-    {
-        fields: [
-            { name: 'field1', description: { value: 'Description for field 1' } },
-            { name: 'field2', description: { value: '' } },
-            // Other fields...
-        ],
-        // Other properties...
-    }
-    // Additional feature layers if needed...
-];
-
-const validationInfo = checkFeatureServiceFieldDescriptions(item, featureLayers);
-console.log(validationInfo);
-```
-
----
-
-### `checkFeatureServiceFieldValueTypes`
-Validates that relevant fields in feature layers have a `fieldValueType` defined in their field descriptions.
-
-```ts
-import { checkFeatureServiceFieldValueTypes } from '@vannizhang/living-atlas-content-validator';
-
-checkFeatureServiceFieldValueTypes(
-    item: IItem,
-    featureLayers: FeatureLayerJSON[]
-): ValidationInfo
-```
-
-**Parameters:**
-- `item` (`IItem`, required): The ArcGIS Online item to validate.
-- `featureLayers` (`FeatureLayerJSON[]`, required): An array of JSON objects representing the feature layers published to this feature service.
-
-**Returns:**
-- `ValidationInfo`: An object containing the validation result, messages, and scoring for field value types.
-
-**Description:**
-This function checks the provided feature layers for relevant fields and evaluates whether those fields have a `fieldValueType` defined in their descriptions. The scoring logic is as follows:
-- If the item is not a feature layer, the rule does not contribute to the final score (weight is 0).
-- If there are no feature layers, a message is added and the result is returned.
-- If there are no relevant fields to check, the rule is considered fully satisfied.
-- If none of the relevant fields have a `fieldValueType`, a message is added and the score is zero.
-- If less than 80% of relevant fields have a `fieldValueType`, a message is added and half score is given.
-- If at least 80% of relevant fields have a `fieldValueType`, the rule receives full score.
-
-**Example:**
-```ts
-import { checkFeatureServiceFieldValueTypes } from '@vannizhang/living-atlas-content-validator';
-
-const item = {
-    id: 'mock-feature-layer-id',
-    type: 'Feature Service',
-    // Other properties...
-};
-
-const featureLayers = [
-    {
-        fields: [
-            { name: 'field1', description: { fieldValueType: 'type1' } },
-            { name: 'field2', description: { fieldValueType: '' } },
-            // Other fields...
-        ],
-        // Other properties...
-    }
-    // Additional feature layers if needed...
-];
-
-const validationInfo = checkFeatureServiceFieldValueTypes(item, featureLayers);
-console.log(validationInfo);
-```
 
 ## Types
 
@@ -1712,21 +1706,24 @@ Below is the list of weights assigned to each validation rule:
 
 | Validation Rule                                | Weight |
 |------------------------------------------------|--------|
-| Check Thumbnail                                | 8      |
+| Check Discoverability of Title and Summary     | 16     |
 | Check Title                                    | 8      |
 | Check Summary                                  | 8      |
+| Check Thumbnail                                | 8      |
 | Check Description                              | 8      |
-| Check Tags                                     | 4      |
-| Check Discoverability of Title and Summary     | 16     |
 | Check Terms of Use                             | 8      |
 | Check Credits (Attribution)                    | 8      |
+| Check Profile Description                      | 8      |
+| Check Feature Service Field Aliases            | 8      |
+| Check Tags                                     | 4      |
+| Check Profile Thumbnail                        | 2      |
+| Check Profile Full Name                        | 2      |
+| Check Feature Service Field Descriptions       | 2      |
+| Check Feature Service Field Value Types        | 2      |
 | Check Sharing Level                            | 1      |
 | Check Delete Protection Setting                | 1      |
 | Check Deprecated Setting                       | 1      |
 | Check HTTPS in URL                             | 1      |
-| Check Profile Thumbnail                        | 2      |
-| Check Profile Full Name                        | 2      |
-| Check Profile Description                      | 8      |
 
 ## Issues
 Find a bug or want to request a new feature? Please let us know by submitting an issue.

package/dist/configureSettings.d.ts

@@ -1,24 +1,5 @@
 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
      */
@@ -102,19 +83,40 @@ type ConfigureSettingsParams = {
          */
         shouldAvoidUsingWordBoundary: boolean;
     };
+    /**
+     * 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;
     /**
      * An array of profanities to be used for validation.
      * This is used to determine if the title or snippet contains any profanities.
      */
     profanities?: string[];
+    /**
+     * Specifies the service tier of the application, either `'dev'` or `'prod'`.
+     * Some helper modules (not part of the core evaluation logic) depend on this setting.
+     * If you're only using the library to evaluate content, you can safely ignore this.
+     *
+     * - `'dev'`: Development tier; uses services hosted on `devext.arcgis.com`.
+     * - `'prod'`: Production tier; uses services hosted on `www.arcgis.com`.
+     */
+    serviceTier?: ServiceTier;
 };
 /**
  * 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 {Object} [params.additionalPatternsForTitleAndSnippetSearchability] - Optional 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.
@@ -124,10 +126,10 @@ type ConfigureSettingsParams = {
  * @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.
+ * @param {string[]} [params.profanities] - Optional array of profanities to be used for validation.
+ * @param {string} [params.serviceTier] - Optional service tier, must be either 'dev' or 'prod'. Defaults to 'prod'.
  *
- * @throws {Error} If the service tier is not 'dev' or 'prod'.
- * @throws {Error} If the language is not provided.
+ * @throws {Error} If the language is not provided or is invalid.
  */
-export declare const configureSettings: ({ serviceTier, language, additionalPatternsForTitleAndSnippetSearchability, profanities, }: ConfigureSettingsParams) => void;
+export declare const configureSettings: ({ language, additionalPatternsForTitleAndSnippetSearchability, profanities, serviceTier, }: ConfigureSettingsParams) => void;
 export {};

package/dist/configureSettings.js

@@ -9,9 +9,8 @@ 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 {Object} [params.additionalPatternsForTitleAndSnippetSearchability] - Optional 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.
@@ -21,24 +20,26 @@ const config_2 = require("./services/shared/config");
  * @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.
+ * @param {string[]} [params.profanities] - Optional array of profanities to be used for validation.
+ * @param {string} [params.serviceTier] - Optional service tier, must be either 'dev' or 'prod'. Defaults to 'prod'.
  *
- * @throws {Error} If the service tier is not 'dev' or 'prod'.
- * @throws {Error} If the language is not provided.
+ * @throws {Error} If the language is not provided or is invalid.
  */
-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 configureSettings = ({ language = 'en', additionalPatternsForTitleAndSnippetSearchability, profanities, serviceTier = 'dev', }) => {
+    // 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);
+    (0, config_2.setServiceTier)(serviceTier || 'dev');
     // Set the language for the application
     (0, stringsConfig_1.setStrings)(language);
     const { matchingPatternsLocation, rejectedPatternsLocation, matchingPatternsSource, rejectedPatternsSource, matchingPatternsTopic, rejectedPatternsTopic, matchingPatternsYearVintage, rejectedPatternsYearVintage, shouldAvoidUsingWordBoundary, } = additionalPatternsForTitleAndSnippetSearchability || {};

package/dist/configureSettings.js.map

@@ -1 +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,CAAC;QAClD,MAAM,IAAI,KAAK,CACX,0DAA0D,CAC7D,CAAC;IACN,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC7C,CAAC;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,CAAC;QAC7C,MAAM,IAAI,KAAK,CACX,8CAA8C,YAAY,CAAC,IAAI,CAC3D,IAAI,CACP,GAAG,CACP,CAAC;IACN,CAAC;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"}
+{"version":3,"file":"configureSettings.js","sourceRoot":"","sources":["../src/configureSettings.ts"],"names":[],"mappings":";;;AAAA,8EAAyE;AACzE,2EAAsH;AACtH,4DAA8D;AAC9D,qDAAuE;AAmHvE;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAC9B,QAAQ,GAAG,IAAI,EACf,iDAAiD,EACjD,WAAW,EACX,WAAW,GAAG,KAAK,GACG,EAAE,EAAE;IAC1B,yDAAyD;IACzD,uBAAuB;IACvB,qEAAqE;IACrE,SAAS;IACT,IAAI;IAEJ,mBAAmB;IACnB,gDAAgD;IAChD,IAAI;IAEJ,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,CAAC;QAC7C,MAAM,IAAI,KAAK,CACX,8CAA8C,YAAY,CAAC,IAAI,CAC3D,IAAI,CACP,GAAG,CACP,CAAC;IACN,CAAC;IAED,2CAA2C;IAC3C,IAAA,uBAAc,EAAC,WAAW,IAAI,KAAK,CAAC,CAAC;IAErC,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"}

package/dist/index.d.ts

@@ -37,10 +37,15 @@ import { LivingAtlasSupportedItemType } from './lib/config';
 import { checkFeatureServiceFieldDescriptions } from './lib/featureServiceFieldDescriptions/checkFeatureServiceFieldDescriptions';
 import { checkFeatureServiceFieldAliases } from './lib/featureServiceFieldAliases/checkFeatureServiceFieldAliases';
 import { checkFeatureServiceFieldValueTypes } from './lib/featureServiceFieldValueTypes/checkFeatureServiceFieldValueTypes';
-import { fetchFeatureServiceLayersAndTables } from './services/feature-service/fetchFeatureServiceLayersAndTables';
-import { getRelevantFeatureLayerFields } from './lib/util/getRelevantFeatureLayerFields';
-import { getFeatureLayerFieldValueTypes } from './lib/util/getFeatureLayerFieldValueTypes';
-export { configureSettings, validate, isValidTitle, isValidAccessInformation, isValidDescription, isValidLicenseInfo, isValidAccess, isValidSSL, isValidSummary, isValidTags, isValidThumbnail, isValidUserProfileDescription, isValidUserProfileName, isValidUserProfileThumbnail, isDeprecated, isDeleteProtectionEnabled, checkTitleAndSnippetSearchability, matchLocationInfo, matchDateTimeInfo, matchSourceInfo, matchTopicInfo, isRecognizedLocation, isRecognizedDateTimeInfo, isRecognizedSource, isRecognizedTopic, isRejectedLocationInfo, isRejectedDateTimeInfo, isRejectedSourceInfo, isRejectedTopicInfo, isEligibleForCheckingTitleAndSnippetSearchability, getLivingAtlasSupportedItemTypes, checkIsLivingAtlasSupportedItemType, sanitizeTags, getStringsConfig, getDefaultStringsConfig, checkFeatureServiceFieldAliases, checkFeatureServiceFieldDescriptions, checkFeatureServiceFieldValueTypes, fetchFeatureServiceLayersAndTables, getRelevantFeatureLayerFields, getFeatureLayerFieldValueTypes, };
+export { configureSettings, validate, isValidTitle, isValidAccessInformation, isValidDescription, isValidLicenseInfo, isValidAccess, isValidSSL, isValidSummary, isValidTags, isValidThumbnail, isValidUserProfileDescription, isValidUserProfileName, isValidUserProfileThumbnail, isDeprecated, isDeleteProtectionEnabled, checkTitleAndSnippetSearchability, matchLocationInfo, matchDateTimeInfo, matchSourceInfo, matchTopicInfo, isRecognizedLocation, isRecognizedDateTimeInfo, isRecognizedSource, isRecognizedTopic, isRejectedLocationInfo, isRejectedDateTimeInfo, isRejectedSourceInfo, isRejectedTopicInfo, isEligibleForCheckingTitleAndSnippetSearchability, getLivingAtlasSupportedItemTypes, checkIsLivingAtlasSupportedItemType, sanitizeTags, getStringsConfig, getDefaultStringsConfig, checkFeatureServiceFieldAliases, checkFeatureServiceFieldDescriptions, checkFeatureServiceFieldValueTypes, };
 export { fetchAdditonalPatterns4TitleAndSnippetSearchability, fetchProfanitiesData, getSubmittedCustomTerms, getMyCustomTerms, addCustomTerms2FeatureTable, updateStatusOfCustomTermsInFeatureTable, getPackagedReviewResults, getReviewedReviewResults, getUnarchivedReviewResults, getDeployedReviewResults, getReviewResultsByTermAndCategory, addReviewResults2FeatureTable, updateReviewResultsInFeatureTable, getCustomTermsFeatureTableItemInfo, getCustomTermsReviewResultsFeatureTableItemInfo, containsProfanity, };
 export { isValidRegexPattern, escapeSpecialCharacters };
 export type { ValidationMessage, ValidationInfo, ValidationResult, ValidationRulesStringJSON, ValidationResultStatus, MatchResult, CustomTermFeature, CustomTermCategory, CustomTermStatus, CustomTermsReviewResultLifecycle, CustomTermReviewResultFeature, AdditionalPatterns4TitleAndSnippetSearchability, AddFeaturesResponse, LivingAtlasSupportedItemType, FeatureLayerFieldRaw, FeatureLayerFieldFormatted, FeatureLayerJSON, FeatureLayerFieldValueType, FeatureServiceJSON, };
+import { getFeatureServerRootURL } from './services/feature-service/getFeatureServerURL';
+import { getPercentOfValidFieldDescriptions, isValidFieldDescription } from './lib/featureServiceFieldDescriptions/helpers';
+import { getPercentOfValidFieldAliases, isValidFieldAlias } from './lib/featureServiceFieldAliases/helpers';
+import { getPercentFieldsWithValueType, isValidFieldValueType } from './lib/featureServiceFieldValueTypes/helpers';
+import { fetchFeatureServiceLayersAndTables } from './services/feature-service/fetchFeatureServiceLayersAndTables';
+import { getRelevantFeatureLayerFields } from './lib/util/getRelevantFeatureLayerFields';
+import { getFeatureLayerFieldValueTypes } from './lib/util/getFeatureLayerFieldValueTypes';
+export { getFeatureServerRootURL, fetchFeatureServiceLayersAndTables, getRelevantFeatureLayerFields, getFeatureLayerFieldValueTypes, getPercentOfValidFieldDescriptions, isValidFieldDescription, getPercentOfValidFieldAliases, isValidFieldAlias, getPercentFieldsWithValueType, isValidFieldValueType, };