@vannizhang/living-atlas-content-validator 1.5.16 → 1.5.18-beta.1

package/README.md

@@ -1,185 +1,1398 @@
 # ArcGIS Living Atlas Content Validator
-This package provides validation and scoring rules for curating content in the ArcGIS Living Atlas.
 
-## Background
-The ArcGIS Living Atlas is a collection of curated GIS content. This content is submitted for inclusion in the Living Atlas by Esri Cartographers and Data Scientists from around the world.
+![npm](https://img.shields.io/npm/v/@vannizhang/living-atlas-content-validator) ![license](https://img.shields.io/npm/l/@vannizhang/living-atlas-content-validator) ![downloads](https://img.shields.io/npm/dt/@vannizhang/living-atlas-content-validator)
 
-The Living Atlas consists of items in ArcGIS Online. Users can nominate items for inclusion in the Living Atlas. During the nomination process, items are validated and scored based on the completeness of the item and its metadata. The score helps to identify key characteristics of your item that will ensure others can find and understand the item.
+This package provides a comprehensive set of **validation and scoring rules** designed to assist in the curation of content for the ArcGIS Living Atlas. It plays a crucial role in ensuring that nominated items meet the high-quality standards required for inclusion in the Living Atlas of the World. 
+The package is utilized in two key applications:
 
-The details page of an item in ArcGIS Online provides information about the item being shared, along with additional information to help others find and use the item. The goal is to create a well-documented item description page so that others will understand what they have found, where the data is from, and what they can expect to see when opening the item.
+- **Living Atlas Nomination App** – Enables item owners to validate their own content before submitting it for nomination.
+- **Living Atlas Curation App** – Used by Living Atlas Curators to perform a detailed evaluation of nominated items.
+
+The validation process evaluates whether an item meets all necessary criteria, such as metadata completeness and adherence to best practices. By enforcing these validation and scoring rules, the package helps to ensure that only high-quality, well-documented, and properly formatted content is nominated and included in the ArcGIS Living Atlas of the World.
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [API Reference](#api-reference)
+  - [validate](#validate)
+  - [isValidTitle](#isvalidtitle)
+  - [isValidAccessInformation](#isvalidaccessinformation)
+  - [isValidDescription](#isvaliddescription)
+  - [isValidLicenseInfo](#isvalidlicenseinfo)
+  - [isValidAccess](#isvalidaccess)
+  - [isValidSummary](#isvalidsummary)
+  - [isValidTags](#isvalidtags)
+  - [isValidThumbnail](#isvalidthumbnail)
+  - [isDeprecated](#isdeprecated)
+  - [isDeleteProtectionEnabled](#isdeleteprotectionenabled)
+  - [isValidUserProfileName](#isvaliduserprofilename)
+  - [isValidUserProfileDescription](#isvaliduserprofiledescription)
+  - [isValidUserProfileThumbnail](#isvaliduserprofilethumbnail)
+  - [checkTitleAndSnippetSearchability](#checktitleandsnippetsearchability)
+  - [isEligibleForCheckingTitleAndSnippetSearchability](#iseligibleforcheckingtitleandsnippetsearchability)
+  - [matchLocationInfo](#matchlocationinfo)
+  - [isRecognizedLocation](#isrecognizedlocation)
+  - [isRejectedLocationInfo](#isrejectedlocationinfo)
+  - [matchSourceInfo](#matchsourceinfo)
+  - [isRecognizedSource](#isrecognizedsource)
+  - [isRejectedSourceInfo](#isrejectedsourceinfo)
+  - [matchTopicInfo](#matchtopicinfo)
+  - [isRecognizedTopic](#isrecognizedtopic)
+  - [isRejectedTopicInfo](#isrejectedtopicinfo)
+  - [matchDateTimeInfo](#matchdatetimeinfo)
+  - [isRecognizedDateTimeInfo](#isrecognizeddatetimeinfo)
+  - [isRejectedDateTimeInfo](#isrejecteddatetimeinfo)
+  - [getLivingAtlasSupportedItemTypes](#getlivingatlassupporteditemtypes)
+  - [checkIsLivingAtlasSupportedItemType](#checkislivingatlassupporteditemtype)
+- [Types](#types)
+    - [ValidationResult](#validationresult)
+    - [ValidationResultStatus](#validationresultstatus)
+    - [ValidationInfo](#validationinfo)
+    - [MatchResult](#matchresult)
+- [Issues](#issues)
+- [License](#license)
 
 ## Installation
 
-To install this Package, simply run:
+Install the package using npm:
 
-```shell
+```sh
 npm install @vannizhang/living-atlas-content-validator
 ```
 
-## Example
-Here is an example of how to validate an item and the item owner's user profile in ArcGIS Online:
+## Usage
+
+Import and use the validator in your project:
+    
+```ts   
+import {
+    validate,
+} from '@vannizhang/living-atlas-content-validator';
+
+// ArcGIS Online Item to validate
+const item = {
+    id: 'mock-item-id',
+    owner: 'mock-owner',
+    title: 'Mock Item Title',
+    snippet: 'This is a short summary of the item.',
+    description: 'This is a detailed description of the item.',
+    type: 'Web Map',
+    tags: ['tag1', 'tag2'],
+    // Other properties...
+}
+
+// User profile of the owner of the item being validated. 
+const userProfile = {
+    fullName: 'mock-owner',
+    description: 'mocked user profile',
+    thumbnail: 'thumbnail/avatar.png',
+    // Other properties...
+}
+
+const validationResults = validate(item, userProfile);
+```
+
+## Configuration
+
+The package provides a `configureSettings` function that allows customization of language, service tier, and additional validation patterns.
+
+### `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.
+
+**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.  
+  - `matchingPatternsLocation` (`string[]`) - List of location matching patterns.  
+  - `rejectedPatternsLocation` (`string[]`) - List of rejected location patterns.  
+  - `matchingPatternsSource` (`string[]`) - List of source matching patterns.  
+  - `rejectedPatternsSource` (`string[]`) - List of rejected source patterns.  
+  - `matchingPatternsTopic` (`string[]`) - List of topic matching patterns.  
+  - `rejectedPatternsTopic` (`string[]`) - List of rejected topic patterns.  
+  - `matchingPatternsYearVintage` (`string[]`) - List of matching year vintage patterns.  
+  - `rejectedPatternsYearVintage` (`string[]`) - List of rejected year vintage patterns.  
+  - `shouldAvoidUsingWordBoundary` (`boolean`) - Determines if word boundaries should be avoided (for non-Latin languages).  
+
+- `profanities` (`string[]`, optional) - List of words considered profane for validation.  
+
+### Example Usage
+
 ```js
-import { validate } from ' @vannizhang/living-atlas-content-validator';
-
-const validationResult = validate(
-    // ArcGIS Online Item
-    {
-        id: 'fd61b9e0c69c4e14bebd50a9a968348c',
-        owner: 'esri',
-        title: 'Sentinel-2 Views',
-        snippet: 'Sentinel-2, 10m Multispectral, Multitemporal, 13-band images with visual renderings and indices...',
-        type: 'Imagery Layer ',
-        thumbnail: 'thumbnail/thumbnail1577152707660.jpeg',
-        access: 'shared',
-        description: 'Sentinel-2, 10, 20, and 60m Multispectral, Multitemporal, 13-band imagery is rendered on-the-fly and available for visualization and analytics...',
-        // this is a custom property that provides the dimension of the thumbnail image
-        dimension: {
-            width: 400,
-            height: 240
-        }
+import { 
+    configureSettings 
+} from '@vannizhang/living-atlas-content-validator';
+
+configureSettings({
+    language: 'en',
+    serviceTier: 'prod',
+    additionalPatternsForTitleAndSnippetSearchability: {
+        matchingPatternsLocation: ['New York', 'Los Angeles'],
+        rejectedPatternsLocation: ['Unknown', 'Unknown Location'],
+        matchingPatternsSource: ['NOAA', 'Department of Energy'],
+        rejectedPatternsSource: ['Unknown', 'Unknown Source'],
+        matchingPatternsTopic: ['Climate Change', 'Renewable Energy'],
+        rejectedPatternsTopic: ['Unknown', 'Unknown Topic'],
+        matchingPatternsYearVintage: ['bi-weekly', 'monthly'],
+        rejectedPatternsYearVintage: ['Unknown', 'Unknown Year Vintage'],
+        shouldAvoidUsingWordBoundary: false
     },
-    // ArcGIS Online User Profile
-    { 
-        fullName: 'Esri Inc.',
-        description: 'Esri develops geographic information systems (GIS) solutions that function as an integral component in nearly every type of organization....',
-        thumbnail: 'esri_150.jpg',
+    profanities: ['badword1', 'badword2']
+});
+```
+
+If `serviceTier` is not `dev` or `prod`, or if an unsupported language is provided, an error will be thrown.
+
+## API Reference
+
+### `validate`
+Validates an ArcGIS Online item and its owner's user profile against Living Atlas criteria.
+
+```ts
+import { validate } from '@vannizhang/living-atlas-content-validator';
+
+validate(
+    item: IItem, 
+    userProfile: IUser, 
+    options?: ValidateOptions
+): ValidationResult
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to validate.  
+- `userProfile` (`IUser`, required): The user profile of the item's owner.  
+- `options` (`ValidateOptions`, optional): Additional configuration for validation.  
+  - `customPatternsForLocationInfo` (`string[]`, optional): Custom patterns for location information.  
+  - `customPatternsForDataVintageInfo` (`string[]`, optional): Custom patterns for data vintage information.  
+  - `customPatternsForSourceInfo` (`string[]`, optional): Custom patterns for source information.  
+  - `customPatternsForTopicInfo` (`string[]`, optional): Custom patterns for topic information.  
+  - `thumbnailDimension` (`{ width: number; height: number; }`, optional): Expected dimensions for the item's thumbnail.
+
+**Returns:**
+- `ValidationResult`: An object containing detailed validation results, a total score, and a flag indicating whether the item can be nominated to Living Atlas.
+
+**Example:**
+```ts
+import { validate } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-item-id',
+    owner: 'mock-owner',
+    title: 'Mock Item Title',
+    snippet: 'This is a short summary of the item.',
+    description: 'This is a detailed description of the item.',
+    type: 'Web Map',
+    tags: ['tag1', 'tag2'],
+    // Other properties...
+};
+
+const userProfile = {
+    fullName: 'mock-owner',
+    description: 'mocked user profile',
+    thumbnail: 'thumbnail/avatar.png',
+    culture: 'en',
+    // Other properties...
+};
+
+const options = {
+    customPatternsForLocationInfo: ['New York','Los Angeles'], 
+    customPatternsForDataVintageInfo: ['bi-weekly'], 
+    customPatternsForSourceInfo: ['NOAA'],  
+    customPatternsForTopicInfo: [ 'Climate Change' ],
+    thumbnailDimension: { width: 600, height: 400 },
+};
+
+const validationResults = validate(item, userProfile, options);
+console.log(validationResults);
+```
+
+---
+
+### `isValidTitle`
+Validates an item's title against ArcGIS Online and Living Atlas-specific rules.
+
+```ts
+import { isValidTitle } from '@vannizhang/living-atlas-content-validator';
+
+isValidTitle(
+    item: IItem, 
+    prohibitedList?: string[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose title needs validation.
+- `prohibitedList` (`string[]`, optional): A list of prohibited words or strings. Defaults to `PROHIBITED_LIST`.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the title.
+
+**Example:**
+```ts
+import { isValidTitle } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Mock Item Title',
+    culture: 'en',
+    // Other properties...
+};
+
+const prohibitedList = ['test', 'demo', 'eval'];
+
+const validationInfo = isValidTitle(item, prohibitedList);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidAccessInformation`
+Validates an item's "Credits (Attribution)" field, which provides information on the source of the item and its copyright status.
+
+```ts
+import { isValidAccessInformation } from '@vannizhang/living-atlas-content-validator';
+
+isValidAccessInformation(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose "Credits (Attribution)" field needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the "Credits (Attribution)" field.
+
+**Example:**
+```ts
+import { isValidAccessInformation } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    accessInformation: 'National Oceanic and Atmospheric Administration (NOAA)',
+    // Other properties...
+};
+
+const validationInfo = isValidAccessInformation(item);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidDescription`
+Validates an item's description field.
+
+```ts
+import { isValidDescription } from '@vannizhang/living-atlas-content-validator';
+
+isValidDescription(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose description field needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the description field.
+
+**Example:**
+```ts
+import { isValidDescription } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    description: 'This is a detailed description of the item. It provides comprehensive information about the data, its sources, and how to use it effectively.',
+    // Other properties...
+};
+
+const validationInfo = isValidDescription(item);
+console.log(validationInfo);
+```
+---
+
+### `isValidLicenseInfo`
+Validates an item's "Terms of Use (license info)" field.
+
+```ts
+import { isValidLicenseInfo } from '@vannizhang/living-atlas-content-validator';
+
+isValidLicenseInfo(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose "Terms of Use (license info)" field needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the "Terms of Use (license info)" field.
+
+**Example:**
+```ts
+import { isValidLicenseInfo } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    licenseInfo: 'This data is licensed under the Open Data Commons Open Database License (ODbL). For more information, visit <a href="https://opendatacommons.org/licenses/odbl/">ODbL License</a>.',
+    // Other properties...
+};
+
+const validationInfo = isValidLicenseInfo(item);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidAccess`
+Validates an item's sharing level to ensure it meets Living Atlas requirements.
+
+```ts
+import { isValidAccess } from '@vannizhang/living-atlas-content-validator';
+
+isValidAccess(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose sharing level needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the sharing level.
+
+**Example:**
+```ts
+import { isValidAccess } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    access: 'public', // Sharing level of the item
+    // Other properties...
+};
+
+const validationInfo = isValidAccess(item);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidSummary`
+Validates an item's summary (snippet) field.
+
+```ts
+import { isValidSummary } from '@vannizhang/living-atlas-content-validator';
+
+isValidSummary(
+    item: IItem,
+    prohibitedList?: string[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose summary (snippet) field needs validation.
+- `prohibitedList` (`string[]`, optional): A list of prohibited words or strings. Defaults to `PROHIBITED_LIST`.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the summary field.
+
+**Example:**
+```ts
+import { isValidSummary } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    snippet: 'This is a brief summary of the item, providing key details and context for users.',
+    culture: 'en',
+    // Other properties...
+};
+
+const prohibitedList = ['test', 'demo', 'eval'];
+
+const validationInfo = isValidSummary(item, prohibitedList);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidTags`
+Validates an item's tags to ensure they meet ArcGIS Online and Living Atlas-specific rules.
+
+```ts
+import { isValidTags } from '@vannizhang/living-atlas-content-validator';
+
+isValidTags(
+    item: IItem,
+    prohibitedList?: string[]
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose tags need validation.
+- `prohibitedList` (`string[]`, optional): A list of prohibited tags. Defaults to `PROHIBITED_LIST`.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the tags.
+
+**Example:**
+```ts
+import { isValidTags } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    tags: ['climate', 'renewable energy', 'NOAA'],
+    // Other properties...
+};
+
+const prohibitedList = ['test', 'demo', 'eval'];
+
+const validationInfo = isValidTags(item, prohibitedList);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidThumbnail`
+Validates an item's thumbnail to ensure it meets Living Atlas-specific rules.
+
+```ts
+import { isValidThumbnail } from '@vannizhang/living-atlas-content-validator';
+
+isValidThumbnail(
+    item: IItem,
+    thumbnailDimension?: { width: number; height: number }
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose thumbnail needs validation.
+- `thumbnailDimension` (`{ width: number; height: number }`, optional): The dimensions of the item's thumbnail.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the thumbnail.
+
+**Example:**
+```ts
+import { isValidThumbnail } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    thumbnail: 'custom-thumbnail.png',
+    // Other properties...
+};
+
+const thumbnailDimension = { width: 610, height: 405 };
+
+const validationInfo = isValidThumbnail(item, thumbnailDimension);
+console.log(validationInfo);
+```
+
+---
+
+### `isDeprecated`
+Validates an item's `contentStatus` to ensure it is not marked as **deprecated**.
+
+```ts
+import { isDeprecated } from '@vannizhang/living-atlas-content-validator';
+
+isDeprecated(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose `contentStatus` needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the `contentStatus`.
+
+**Example:**
+```ts
+import { isDeprecated } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    contentStatus: 'deprecated', // Content status of the item
+    // Other properties...
+};
+
+const validationInfo = isDeprecated(item);
+console.log(validationInfo);
+```
+
+---
+
+### `isDeleteProtectionEnabled`
+Validates an item's `protected` property to ensure **Delete Protection** is enabled.
+
+```ts
+import { isDeleteProtectionEnabled } from '@vannizhang/living-atlas-content-validator';
+
+isDeleteProtectionEnabled(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose `protected` property needs validation.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the `protected` property.
+
+**Remark:**
+- The delete protection status is **only exposed** to the item owner. The Living Atlas team has been using a workaround to determine the delete protection status for items owned by other users.
+
+**Example:**
+```ts
+import { isDeleteProtectionEnabled } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    protected: true, // Indicates whether Delete Protection is enabled
+    // Other properties...
+};
+
+const validationInfo = isDeleteProtectionEnabled(item);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidUserProfileName`
+Validates an item owner's profile name to ensure it meets Living Atlas-specific rules.
+
+```ts
+import { isValidUserProfileName } from '@vannizhang/living-atlas-content-validator';
+
+isValidUserProfileName(
+    userProfile: IUser
+): ValidationInfo
+```
+
+**Parameters:**
+- `userProfile` (`IUser`, required): The user profile of the item's owner.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the user profile name.
+
+**Example:**
+```ts
+import { isValidUserProfileName } from '@vannizhang/living-atlas-content-validator';
+
+const userProfile = {
+    fullName: 'John_Doe',
+    culture: 'en',
+    // Other properties...
+};
+
+const validationInfo = isValidUserProfileName(userProfile);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidUserProfileDescription`
+Validates an item owner's profile description to ensure it meets Living Atlas-specific rules.
+
+```ts
+import { isValidUserProfileDescription } from '@vannizhang/living-atlas-content-validator';
+
+isValidUserProfileDescription(
+    userProfile: IUser
+): ValidationInfo
+```
+
+**Parameters:**
+- `userProfile` (`IUser`, required): The user profile of the item's owner.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the user profile description.
+
+**Example:**
+```ts
+import { isValidUserProfileDescription } from '@vannizhang/living-atlas-content-validator';
+
+const userProfile = {
+    description: 'I am a GIS professional with expertise in mapping and spatial analysis. Contact me at john.doe@example.com. Visit my portfolio at https://johndoe.com.',
+    culture: 'en',
+    // Other properties...
+};
+
+const validationInfo = isValidUserProfileDescription(userProfile);
+console.log(validationInfo);
+```
+
+---
+
+### `isValidUserProfileThumbnail`
+Validates a user's profile thumbnail to ensure it meets Living Atlas-specific rules.
+
+```ts
+import { isValidUserProfileThumbnail } from '@vannizhang/living-atlas-content-validator';
+
+isValidUserProfileThumbnail(
+    userProfile: IUser
+): ValidationInfo
+```
+
+**Parameters:**
+- `userProfile` (`IUser`, required): The user profile of the item's owner.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the user profile thumbnail.
+
+**Example:**
+```ts
+import { isValidUserProfileThumbnail } from '@vannizhang/living-atlas-content-validator';
+
+const userProfile = {
+    thumbnail: 'custom-thumbnail.png',
+    // Other properties...
+};
+
+const validationInfo = isValidUserProfileThumbnail(userProfile);
+console.log(validationInfo);
+```
+
+---
+
+### `checkTitleAndSnippetSearchability`
+Checks for required and recommended text in an item's title and summary (snippet) to ensure they are search-friendly.
+
+```ts
+import { checkTitleAndSnippetSearchability } from '@vannizhang/living-atlas-content-validator';
+
+checkTitleAndSnippetSearchability(
+    item: IItem,
+    options?: {
+        customPatternsForLocationInfo?: string[];
+        customPatternsForDataVintageInfo?: string[];
+        customPatternsForSourceInfo?: string[];
+        customPatternsForTopicInfo?: string[];
     }
-);
+): ValidationInfo
 ```
 
-Here is an example of output returned by `validate`:
-```js
-{
-    "id": "12345",
-    "totalScore": 60,
-    "validatedItem": {
-        "access": {
-            "property": "access",
-            "label": "Must be public",
-            "maxScore": 9,
-            "score": 2,
-            "messages": [
-                {
-                    "code": "",
-                    "message": "Must be public"
-                }
-            ],
-            "weight": 4,
-            "critical": true
-        },
-        "accessInformation": {
-            "property": "accessInformation",
-            "label": "Add credits",
-            "maxScore": 8,
-            "score": 0,
-            "messages": [
-                {
-                    "code": "",
-                    "message": "Add credits"
-                }
-            ],
-            "weight": 7,
-            "critical": false
-        },
-        "description": {
-            "property": "description",
-            "label": "Improve description",
-            "maxScore": 8,
-            "score": 1,
-            "messages": [
-                {
-                    "code": "",
-                    "message": "Description has no links"
-                },
-                {
-                    "code": "",
-                    "message": "Description too short"
-                }
-            ],
-            "weight": 3,
-            "critical": true
-        },
-        "layerCount": {
-            "property": "layers",
-            "label": "Reduce the number of layers",
-            //...
-        },
-        "licenseInfo": {
-            "property": "licenseInfo",
-            "label": "Improve access and use constraints",
-            //...
-        },
-        "snippet": {
-            "property": "snippet",
-            "label": "Improve summary",
-            //...
-        },
-        "ssl": {
-            "property": "ssl",
-            "label": "Use HTTPS in the URL",
-            //...
-        },
-        "tags": {
-            "property": "tags",
-            "label": "Improve tags",
-            //...
-        },
-        "thumbnail": {
-            "property": "thumbnail",
-            "label": "Improve thumbnail",
-            //...
-        },
-        "title": {
-            "property": "title",
-            "label": "Improve title",
-            //...
-        }
-    },
-    "validatedProfile": {
-        "userProfileDescription": {
-            "property": "userProfileDescription",
-            "label": "Improve profile description",
-            "maxScore": 7,
-            "score": 1,
-            "messages": [
-                {
-                    "code": "",
-                    "message": "Profile description does not contain an email"
-                },
-                {
-                    "code": "",
-                    "message": "Profile description does not contain a link"
-                },
-                //...
-            ],
-            "weight": 12,
-            "critical": true
-        },
-        "userProfileFullName": {
-            "property": "userProfileName",
-            "label": "Improve profile full name",
-            //...
-        },
-        "userProfileThumbnail": {
-            "property": "userProfileThumbnail",
-            "label": "Improve profile thumbnail",
-            //...
-        }
-    },
-}
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item whose title and snippet need validation.
+- `options` (optional): Custom patterns for matching specific information.
+  - `customPatternsForLocationInfo` (`string[]`): Custom patterns for location information.
+  - `customPatternsForDataVintageInfo` (`string[]`): Custom patterns for data vintage information.
+  - `customPatternsForSourceInfo` (`string[]`): Custom patterns for source information.
+  - `customPatternsForTopicInfo` (`string[]`): Custom patterns for topic information.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation results for the title and snippet.
+
+**Example:**
+```ts
+import { checkTitleAndSnippetSearchability } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Global Earthquake Data 2023',
+    snippet: 'Earthquake data from NOAA for the year 2023.',
+    // Other properties...
+};
+
+const options = {
+    customPatternsForLocationInfo: ['Global', 'New York'],
+    customPatternsForDataVintageInfo: ['2023', 'Monthly'],
+    customPatternsForSourceInfo: ['NOAA', 'Esri'],
+    customPatternsForTopicInfo: ['Earthquakes', 'Public Health Dashboard'],
+};
+
+const validationInfo = checkTitleAndSnippetSearchability(item, options);
+console.log(validationInfo);
 ```
 
-## Configuration
-You can set the language to be used in the output validation messages with the `setStrings` function. Here is an example:
-```js
-import { setStrings } from `@vannizhang/living-atlas-content-validator`
+---
 
-// You can choose any of these six languages: 'en', 'de', 'es', 'fr', 'ja', 'pt-br'
-setStrings('de'); // use German 
+### `isEligibleForCheckingTitleAndSnippetSearchability`
+Determines if an item is eligible for checking title and snippet searchability.
+
+```ts
+import { isEligibleForCheckingTitleAndSnippetSearchability } from '@vannizhang/living-atlas-content-validator';
+
+isEligibleForCheckingTitleAndSnippetSearchability(
+    item: IItem
+): boolean
 ```
 
-### License
-Copyright &copy; 2022 Esri
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to check.
+
+**Returns:**
+- `boolean`: `true` if the item meets the criteria for checking title and snippet searchability, otherwise `false`.
+
+**Eligibility Criteria:**
+1. The item is a layer.
+2. The item is English-based.
+
+**Remarks:**
+- The locale is determined by both the item's `culture` property and the item's owner.
+
+**Example:**
+```ts
+import { isEligibleForCheckingTitleAndSnippetSearchability } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-item-id',
+    owner: 'mock-owner',
+    title: 'Mock Item Title',
+    culture: 'en',
+    type: 'Feature Layer',
+    // Other properties...
+};
+
+const isEligible = isEligibleForCheckingTitleAndSnippetSearchability(item);
+console.log(isEligible); // true or false
+```
+
+---
+
+### `matchLocationInfo`
+Matches location information from an item's title and snippet using predefined or custom matching patterns.
+
+```ts
+import { matchLocationInfo } from '@vannizhang/living-atlas-content-validator';
+
+matchLocationInfo(
+    item: IItem,
+    customMatchingPatterns?: string[]
+): MatchResult[]
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item containing the title and snippet to search for location information.
+- `customMatchingPatterns` (`string[]`, optional): Custom matching patterns to include in the search.
+
+**Returns:**
+- `MatchResult[]`: An array of matched results for location information after deduplication and removing overlaps.
+
+**Example:**
+```ts
+import { matchLocationInfo } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Earthquake Data for California',
+    snippet: 'This dataset provides earthquake information for the state of California.',
+    // Other properties...
+};
+
+const customPatterns = ['California', 'Los Angeles'];
+
+const matchedLocations = matchLocationInfo(item, customPatterns);
+console.log(matchedLocations);
+```
+
+---
+
+### `isRecognizedLocation`
+Determines if a given string is recognized as location information.
+
+```ts
+import { isRecognizedLocation } from '@vannizhang/living-atlas-content-validator';
+
+isRecognizedLocation(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is recognized as location information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRecognizedLocation } from '@vannizhang/living-atlas-content-validator';
+
+const location = 'California';
+
+const isRecognized = isRecognizedLocation(location);
+console.log(isRecognized); // true or false
+```
+
+---
+
+### `isRejectedLocationInfo`
+Determines if a given string is rejected as location information.
+
+```ts
+import { isRejectedLocationInfo } from '@vannizhang/living-atlas-content-validator';
+
+isRejectedLocationInfo(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is rejected as location information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRejectedLocationInfo } from '@vannizhang/living-atlas-content-validator';
+
+const location = 'Unknown Location';
+
+const isRejected = isRejectedLocationInfo(location);
+console.log(isRejected); // true or false
+```
+
+---
+
+### `matchSourceInfo`
+Matches source information from an item's title and snippet using predefined or custom matching patterns.
+
+```ts
+import { matchSourceInfo } from '@vannizhang/living-atlas-content-validator';
+
+matchSourceInfo(
+    item: IItem,
+    customMatchingPatterns?: string[]
+): MatchResult[]
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item containing the title and snippet to search for source information.
+- `customMatchingPatterns` (`string[]`, optional): Custom matching patterns to include in the search.
+
+**Returns:**
+- `MatchResult[]`: An array of matched results for source information after deduplication and removing overlaps.
+
+**Example:**
+```ts
+import { matchSourceInfo } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Earthquake Data from NOAA',
+    snippet: 'This dataset provides earthquake information sourced from NOAA.',
+    // Other properties...
+};
+
+const customPatterns = ['NOAA', 'USGS'];
+
+const matchedSources = matchSourceInfo(item, customPatterns);
+console.log(matchedSources);
+```
+
+---
+
+### `isRecognizedSource`
+Determines if a given string is recognized as source information.
+
+```ts
+import { isRecognizedSource } from '@vannizhang/living-atlas-content-validator';
+
+isRecognizedSource(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is recognized as source information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRecognizedSource } from '@vannizhang/living-atlas-content-validator';
+
+const source = 'NOAA';
+
+const isRecognized = isRecognizedSource(source);
+console.log(isRecognized); // true or false
+```
+
+---
+
+### `isRejectedSourceInfo`
+Determines if a given string is rejected as source information.
+
+```ts
+import { isRejectedSourceInfo } from '@vannizhang/living-atlas-content-validator';
+
+isRejectedSourceInfo(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is rejected as source information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRejectedSourceInfo } from '@vannizhang/living-atlas-content-validator';
+
+const source = 'Unknown Source';
+
+const isRejected = isRejectedSourceInfo(source);
+console.log(isRejected); // true or false
+```
+
+---
+
+### `matchTopicInfo`
+Matches topic information from an item's title and snippet using predefined or custom matching patterns.
+
+```ts
+import { matchTopicInfo } from '@vannizhang/living-atlas-content-validator';
+
+matchTopicInfo(
+    item: IItem,
+    customMatchingPatterns?: string[]
+): MatchResult[]
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item containing the title and snippet to search for topic information.
+- `customMatchingPatterns` (`string[]`, optional): Custom matching patterns to include in the search.
+
+**Returns:**
+- `MatchResult[]`: An array of matched results for topic information after deduplication and removing overlaps.
+
+**Example:**
+```ts
+import { matchTopicInfo } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Climate Change Impact Analysis',
+    snippet: 'This dataset provides insights into the impact of climate change on global ecosystems.',
+    // Other properties...
+};
+
+const customPatterns = ['Climate Change', 'Global Warming'];
+
+const matchedTopics = matchTopicInfo(item, customPatterns);
+console.log(matchedTopics);
+```
+
+---
+
+### `isRecognizedTopic`
+Determines if a given string is recognized as topic information.
+
+```ts
+import { isRecognizedTopic } from '@vannizhang/living-atlas-content-validator';
+
+isRecognizedTopic(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is recognized as topic information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRecognizedTopic } from '@vannizhang/living-atlas-content-validator';
+
+const topic = 'Climate Change';
+
+const isRecognized = isRecognizedTopic(topic);
+console.log(isRecognized); // true or false
+```
+
+---
+
+### `isRejectedTopicInfo`
+Determines if a given string is rejected as topic information.
+
+```ts
+import { isRejectedTopicInfo } from '@vannizhang/living-atlas-content-validator';
+
+isRejectedTopicInfo(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is rejected as topic information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRejectedTopicInfo } from '@vannizhang/living-atlas-content-validator';
+
+const topic = 'Unknown Topic';
+
+const isRejected = isRejectedTopicInfo(topic);
+console.log(isRejected); // true or false
+```
+
+---
+
+### `matchDateTimeInfo`
+Matches date and time information from an item's title and snippet using predefined or custom matching patterns.
+
+```ts
+import { matchDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+matchDateTimeInfo(
+    item: IItem,
+    customMatchingPatterns?: string[]
+): MatchResult[]
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item containing the title and snippet to search for date and time information.
+- `customMatchingPatterns` (`string[]`, optional): Custom matching patterns to include in the search.
+
+**Returns:**
+- `MatchResult[]`: An array of matched results for date and time information after deduplication and removing overlaps.
+
+**Example:**
+```ts
+import { matchDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    title: 'Climate Data for 2020-2025',
+    snippet: 'This dataset provides monthly climate data for the years 2020 to 2025.',
+    // Other properties...
+};
+
+const customPatterns = ['2020', '2025'];
+
+const matchedDateTimeInfo = matchDateTimeInfo(item, customPatterns);
+console.log(matchedDateTimeInfo);
+```
+
+---
+
+### `isRecognizedDateTimeInfo`
+Determines if a given string is recognized as date and time information.
+
+```ts
+import { isRecognizedDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+isRecognizedDateTimeInfo(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is recognized as date and time information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRecognizedDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+const dateTimeInfo = '2020-2025';
+
+const isRecognized = isRecognizedDateTimeInfo(dateTimeInfo);
+console.log(isRecognized); // true or false
+```
+
+---
+
+### `isRejectedDateTimeInfo`
+Determines if a given string is rejected as date and time information.
+
+```ts
+import { isRejectedDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+isRejectedDateTimeInfo(
+    str: string
+): boolean
+```
+
+**Parameters:**
+- `str` (`string`, required): The string to check.
+
+**Returns:**
+- `boolean`: `true` if the string is rejected as date and time information, `false` otherwise.
+
+**Example:**
+```ts
+import { isRejectedDateTimeInfo } from '@vannizhang/living-atlas-content-validator';
+
+const dateTimeInfo = 'Unknown Year';
+
+const isRejected = isRejectedDateTimeInfo(dateTimeInfo);
+console.log(isRejected); // true or false
+```
+
+---
+
+### `getLivingAtlasSupportedItemTypes`
+Returns an array of item types supported by Living Atlas.
+
+```ts
+import { getLivingAtlasSupportedItemTypes } from '@vannizhang/living-atlas-content-validator';
+
+getLivingAtlasSupportedItemTypes(): LivingAtlasSupportedItemType[]
+```
+
+**Returns:**
+- `LivingAtlasSupportedItemType[]`: An array of Living Atlas supported item types.
+
+**Description:**
+This function creates a new array containing all the predefined item types that are supported by Living Atlas from the configuration.
+
+**Example:**
+```ts
+import { getLivingAtlasSupportedItemTypes } from '@vannizhang/living-atlas-content-validator';
+
+const supportedItemTypes = getLivingAtlasSupportedItemTypes();
+console.log(supportedItemTypes);
+```
+
+---
+
+### `checkIsLivingAtlasSupportedItemType`
+Checks if a given item type is supported by Living Atlas.
+
+```ts
+import { checkIsLivingAtlasSupportedItemType } from '@vannizhang/living-atlas-content-validator';
+
+checkIsLivingAtlasSupportedItemType(
+    item: IItem
+): boolean
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to check.
+
+**Returns:**
+- `boolean`: `true` if the item type is supported by Living Atlas, otherwise `false`.
+
+**Description:**
+This function determines whether the provided item type string is included in the predefined list of item types supported by Living Atlas.
+
+**Example:**
+```ts
+import { checkIsLivingAtlasSupportedItemType } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-item-id',
+    type: 'Web Map',
+    // Other properties...
+};
+
+const isSupported = checkIsLivingAtlasSupportedItemType(item);
+console.log(isSupported); // true or false
+```
+
+---
+
+
+
+## Types
+
+### `ValidationResult`
+The `ValidationResult` type represents the outcome of the validation process, providing detailed assessments for both the ArcGIS Online item and its owner's profile. It helps determine whether an item meets the necessary criteria for nomination to the ArcGIS Living Atlas.
+
+```ts
+export type ValidationResult = {
+    validatedItem: {
+        /**
+         * Validation result for the item's sharing level.
+         */
+        access: ValidationInfo;
+        
+        /**
+         * Validation result for the item's credits/attribution information.
+         */
+        accessInformation: ValidationInfo;
+        
+        /**
+         * Validation result for the item's description text.
+         */
+        description: ValidationInfo;
+        
+        /**
+         * Validation result for the item's license information.
+         */
+        licenseInfo: ValidationInfo;
+        
+        /**
+         * Validation result for the item's snippet (short summary text).
+         */
+        snippet: ValidationInfo;
+        
+        /**
+         * Validation result for the item's SSL configuration, ensuring HTTPS support.
+         */
+        ssl: ValidationInfo;
+        
+        /**
+         * Validation result for the item's tags.
+         */
+        tags: ValidationInfo;
+        
+        /**
+         * Validation result for the item's thumbnail image.
+         */
+        thumbnail: ValidationInfo;
+        
+        /**
+         * Validation result for the item's title.
+         */
+        title: ValidationInfo;
+        
+        /**
+         * Validation result for the item's content status, checking for deprecated content.
+         */
+        deprecated: ValidationInfo;
+        
+        /**
+         * Validation result for the item's "delete protection" property.
+         */
+        deleteProtection: ValidationInfo;
+        
+        /**
+         * Validation result for ensuring recommended text is included in the item's title and summary.
+         */
+        recommendedTextInTitleAndSummary: ValidationInfo;
+    };
+    validatedProfile: {
+        /**
+         * Validation result for the item owner's profile description.
+         */
+        userProfileDescription: ValidationInfo;
+        
+        /**
+         * Validation result for the item owner's full name.
+         */
+        userProfileFullName: ValidationInfo;
+        
+        /**
+         * Validation result for the item owner's profile thumbnail image.
+         */
+        userProfileThumbnail: ValidationInfo;
+    };
+    /**
+     * Id of the ArcGIS Online Item
+     */
+    id: string;
+    /**
+     * total score of the validation result
+     */
+    totalScore: number;
+    /**
+     * Indicate if the item can be nominated to Living Atlas based on the validation results.
+     * This property is determined based on the following criteria:
+     * 
+     * - the total score of the validation result is greater than or equal to the minimum score required for nomination (default is 80%).
+     * - It is shared with the public.
+     * - Its thumbnail image meets the required dimension.
+     * - It has a snippet text.
+     * - It has a description text.
+     * - The item owner has a user profile description.
+     */
+    canBeNominated: boolean;
+};
+```
+---
+
+### `ValidationResultStatus`
+Represents the status of a validation result for a specific rule. This type indicates the outcome of the validation process for each rule and helps in understanding how well the item meets the criteria defined by the validation rules.
+
+- `pass`: The item meets the criteria for this validation rule.
+- `warning`: The item meets the criteria but there are some suggestions for improvement or potential issues to address.
+- `error`: The item does not meet the criteria for this validation rule and requires correction.
+- `not-applicable`: Indicates that the validation rule is not applicable to the item being validated. This can happen if the rule does not apply to the type of item or if certain conditions are not met for the validation to be relevant.
+- `unknown`: This is the default status when a `ValidationInfo` object is created but the validation process has not yet been executed. It indicates that the validation status is yet to be determined.
+
+```ts
+export type ValidationResultStatus =
+    | 'pass' 
+    | 'warning'
+    | 'error' 
+    | 'not-applicable' 
+    | 'unknown';
+```
+
+---
+
+### `ValidationInfo`
+
+The `ValidationInfo` type provides detailed information about a specific validation rule, including its purpose, scoring criteria, and status.
+
+```ts
+export type ValidationInfo = {
+    /**
+     * The title string tells the user what this validation rule checks, e.g., "Check Thumbnail" or "Check Number of Layers".
+     */
+    title: string;
+    /**
+     * The label text will be used to instruct the user what they should do, e.g., "Improve Thumbnail" or "Reduce Number of Layers".
+     */
+    label: string;
+    /**
+     * Array of validation messages.
+     */
+    messages: ValidationMessage[];
+    /**
+     * Maximum score this validation rule can receive.
+     */
+    maxScore: number;
+    /**
+     * Final score that the item received for this validation rule.
+     */
+    score: number;
+    /**
+     * Weight assigned to this validation rule.
+     */
+    weight: number;
+    /**
+     * A factor ranging between 0 and 1 used to calculate the final score by multiplying it with the weight number.
+     */
+    weightFactor: number;
+    /**
+     * Status of the validation result.
+     */
+    status: ValidationResultStatus;
+    /**
+     * If true, this validation rule is a binary check, i.e., it can only pass or fail.
+     */
+    isBinaryCheck: boolean;
+};
+```
+
+---
+
+### `MatchResult`
+Represents the result of a pattern match operation.
+
+```ts
+export type MatchResult = {
+    /**
+     * The string that was matched by the pattern.
+     */
+    matchedString: string;
+    /**
+     * The source of the pattern that was used for matching:
+     * - 'predefined' - This indicates that the matched string was found using predefined patterns that are built into the validator.
+     * - 'additional' - This indicates that the matched string was found using additional custom patterns loaded via configureSettings.
+     * - 'custom' - This indicates that the matched string was found using custom patterns defined by the user.
+     */
+    patternSource: MatchPatternSource;
+};
+```
+
+## Issues
+Find a bug or want to request a new feature? Please let us know by submitting an issue.
+
+## License
+Copyright &copy; 5 Esri
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -193,4 +1406,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-A copy of the license is available in the repository's [LICENSE](./LICENSE) file.
+A copy of the license is available in the repository's [LICENSE](./LICENSE) file.
+````