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

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,14 @@ The validation process evaluates whether an item meets all necessary criteria, s
   - [isValidUserProfileName](#isvaliduserprofilename)
   - [isValidUserProfileDescription](#isvaliduserprofiledescription)
   - [isValidUserProfileThumbnail](#isvaliduserprofilethumbnail)
+  - [checkFeatureServiceFieldAliases](#checkfeatureservicefieldaliases)
+  - [checkFeatureServiceFieldDescriptions](#checkFeatureServiceFieldDescriptions)
+  - [checkFeatureServiceFieldValueTypes](#checkFeatureServiceFieldValueTypes)
+  - [checkFeatureServiceCDNSetting](#checkfeatureservicecdnsetting)
+  - [checkFeatureServiceExportSetting](#checkfeatureserviceexportsetting)
   - [checkTitleAndSnippetSearchability](#checktitleandsnippetsearchability)
+  - [checkItemExtent](#checkitemextent)
+- [API Reference - Helper Functions](#api-reference---helper-functions)
   - [isEligibleForCheckingTitleAndSnippetSearchability](#iseligibleforcheckingtitleandsnippetsearchability)
   - [matchLocationInfo](#matchlocationinfo)
   - [isRecognizedLocation](#isrecognizedlocation)
@@ -43,12 +50,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 +105,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 +122,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 +150,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 +161,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 +193,8 @@ 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.
+  - `featureServiceAdminJSON` (`FeatureServiceAdminJSON`, optional): The [`Feature Service Admin JSON`](https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/) object representing the Feature Service item's administrative settings. Used for checking the advisories of the Feature Service.
 
 **Returns:**
 - `ValidationResult`: An object containing detailed validation results, a total score, and a flag indicating whether the item can be nominated to Living Atlas.
@@ -258,6 +267,7 @@ const userProfile = {
 
 // Custom options for validate function that include feature layers associated with the Feature Service item
 const options = {
+    // feature layers associated with the Feature Service item
     featureLayers: [
         {
             id: 0,
@@ -274,6 +284,15 @@ const options = {
             ]
         }
     ],
+    // Feature Service Admin JSON object
+    featureServiceAdminJSON: {
+        adminServiceInfo: { 
+            "name": "US County Boundaries",
+            "type": "FeatureServer",
+            "cacheMaxAge": 3600,
+        },
+        // Other properties...
+    },
     thumbnailDimension: { width: 600, height: 400 },
 };
 
@@ -606,7 +625,7 @@ isDeleteProtectionEnabled(
 - `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.
+- The delete protection status is **only exposed** to the item owner.
 
 **Example:**
 ```ts
@@ -721,6 +740,149 @@ console.log(validationInfo);
 
 ---
 
+
+### `checkFeatureServiceFieldAliases`
+This function checks the provided feature layers for relevant fields and evaluates whether those fields have aliases defined.
+
+```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.
+
+**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`
+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.
+
+```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.
+
+**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`
+This function checks the provided feature layers for relevant fields and evaluates whether those fields have a `fieldValueType` defined in their 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.
+
+
+**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 +934,199 @@ console.log(validationInfo);
 
 ---
 
+### `checkFeatureServiceCDNSetting`
+This function checks the CDN setting of the provided Feature Service item using its administrative JSON data. It evaluates whether the CDN is enabled and provides relevant messages. This check is advisory and does not impact the overall validation score of the item. If the CDN is not enabled, a warning message is returned to inform the user about the benefits of enabling CDN for better performance and scalability.
+
+```ts
+import { checkFeatureServiceCDNSetting } from '@vannizhang/living-atlas-content-validator';
+checkFeatureServiceCDNSetting(
+    item: IItem,
+    featureServiceAdminJSON: FeatureServiceAdminJSON
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online Feature Service item to validate
+- `featureServiceAdminJSON` (`FeatureServiceAdminJSON`, required): The [`Feature Service Admin JSON`](https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/) object representing the Feature Service item's administrative settings.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages for the CDN setting.
+
+**Example:**
+```ts
+import { checkFeatureServiceCDNSetting } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-feature-service-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+const featureServiceAdminJSON = {
+    adminServiceInfo: { 
+        "name": "Mock Feature Service",
+        "type": "FeatureServer",
+        "cacheMaxAge": 3600,
+    },
+    // Other properties...
+};
+
+const validationInfo = checkFeatureServiceCDNSetting(item, featureServiceAdminJSON);
+console.log(validationInfo);
+```
+
+---
+
+### `checkFeatureServiceExportSetting`
+This function checks the export setting of the provided Feature Service item using its administrative JSON data. It evaluates whether the export capability is enabled and provides relevant messages. 
+This check is advisory and does not impact the overall validation score of the item. If the export setting is enabled, a warning message is returned to inform the user to make sure that exporting data aligns with their data sharing policies.
+
+```ts
+import { checkFeatureServiceExportSetting } from '@vannizhang/living-atlas-content-validator';
+checkFeatureServiceExportSetting(
+    item: IItem,
+    featureServiceAdminJSON: FeatureServiceAdminJSON
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online Feature Service item to validate
+- `featureServiceAdminJSON` (`FeatureServiceAdminJSON`, required): The [`Feature Service Admin JSON`](https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/) object representing the Feature Service item's administrative settings.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages for the export setting.
+
+
+**Example:**
+```ts
+import { checkFeatureServiceExportSetting } from '@vannizhang/living-atlas-content-validator';
+
+const item = {
+    id: 'mock-feature-service-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+const featureServiceAdminJSON = {
+    capabilities: 'Query,Export',
+    // Other properties...
+};
+
+const validationInfo = checkFeatureServiceExportSetting(item, featureServiceAdminJSON);
+console.log(validationInfo);
+```
+
+---
+
+### `checkItemExtent`
+
+This function checks whether the provided item's spatial extent is valid and meaningful. It evaluates if the extent is defined, not empty, and represents a real-world area.
+
+```ts
+import { checkItemExtent } from '@vannizhang/living-atlas-content-validator';
+checkItemExtent(
+    item: IItem
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online item to validate.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages, and scoring for the item's
+
+**Example:**
+```ts
+import { checkItemExtent } from '@vannizhang/living-atlas-content-validator';
+const item = {
+    extent: [[-120, -45], [120, 45]], // Example extent
+    // Other properties...
+};
+const validationInfo = checkItemExtent(item);
+console.log(validationInfo);
+```
+
+---
+### `checkFeatureServiceExtents`
+This function checks whether the provided feature service has valid initial and full extents defined in its service root JSON. It also checks the extents of each feature layer within the service to ensure they are provided.
+
+```ts
+import { checkFeatureServiceExtents } from '@vannizhang/living-atlas-content-validator';
+checkFeatureServiceExtents(
+    item: IItem,
+    {   
+        featureLayers: FeatureLayerJSON[]
+        featureServiceAdminJSON: FeatureServiceAdminJSON,
+        featureServiceRootJSON: FeatureServiceRootJSON
+        
+    }
+): ValidationInfo
+```
+
+**Parameters:**
+- `item` (`IItem`, required): The ArcGIS Online Feature Service item to validate
+- `options` (required): An object containing:
+  - `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.
+  - `featureServiceAdminJSON` (`FeatureServiceAdminJSON`, optional): The [`Feature Service Admin JSON`](https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/) object representing the Feature Service item's administrative settings. If not provided, only the feature service root JSON will be used for extent validation.
+  - `featureServiceRootJSON` (`FeatureServiceRootJSON`, optional): The [`Feature Service Root JSON`](https://developers.arcgis.com/rest/services-reference/enterprise/feature-service/) object representing the root information of the Feature Service. This is used to validate the initial and full extents of the feature service if the admin JSON is not provided.
+
+**Returns:**
+- `ValidationInfo`: An object containing the validation result, messages, and scoring for the feature service extents.
+
+**Example:**
+```ts
+import { checkFeatureServiceExtents } from '@vannizhang/living-atlas-content-validator';
+
+// An ArcGIS Online Feature Service item to validate
+const item = {
+    id: 'mock-feature-service-id',
+    type: 'Feature Service',
+    // Other properties...
+};
+
+// feature layers associated with the Feature Service item
+const featureLayers = [
+    {
+        id: 0,
+        name: 'Mock Layer',
+        extent: {
+            xmin: -120,
+            ymin: -45,
+            xmax: 120,
+            ymax: 45,
+            spatialReference: { wkid: 4326 }
+        }
+    }
+    // Additional feature layers if needed...
+];
+
+// Feature Service Admin JSON object
+const featureServiceAdminJSON = {
+    // Mock Feature Service Admin JSON properties...
+    initialExtent: {
+        xmin: -120,
+        ymin: -45,
+        xmax: 120,
+        ymax: 45,
+        spatialReference: { wkid: 4326 }
+    },
+    fullExtent: {
+        xmin: -180,
+        ymin: -90,
+        xmax: 180,
+        ymax: 90,
+        spatialReference: { wkid: 4326 }
+    },
+};
+
+const validationInfo = checkFeatureServiceExtents(item, { featureLayers, featureServiceAdminJSON });
+``` 
+---
+
+## 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.
 
@@ -1196,7 +1551,7 @@ console.log(isRejected); // true or false
 ---
 
 ### `getLivingAtlasSupportedItemTypes`
-Returns an array of item types supported by Living Atlas.
+This function returns an array containing all the predefined item types that are supported by Living Atlas from the configuration.
 
 ```ts
 import { getLivingAtlasSupportedItemTypes } from '@vannizhang/living-atlas-content-validator';
@@ -1207,9 +1562,6 @@ 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';
@@ -1221,8 +1573,7 @@ console.log(supportedItemTypes);
 ---
 
 ### `checkIsLivingAtlasSupportedItemType`
-Checks if a given item type is supported by Living Atlas.
-
+This function determines whether the provided item type string is included in the predefined list of item types supported by Living Atlas.
 ```ts
 import { checkIsLivingAtlasSupportedItemType } from '@vannizhang/living-atlas-content-validator';
 
@@ -1237,9 +1588,6 @@ checkIsLivingAtlasSupportedItemType(
 **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';
@@ -1254,171 +1602,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
 
@@ -1521,6 +1704,23 @@ export type ValidationResult = {
          */
         userProfileThumbnail: ValidationInfo;
     };
+    /**
+     * advisory validation results that do not impact the overall score.
+     */
+    advisories: {
+        /** 
+         * Advisory validation result for CDN settings of a feature service item. 
+         */
+        featureServiceCdnSetting: null,
+        /** 
+         * Advisory validation result for field indexes of a feature service item. 
+         */
+        featureServiceFieldIndexes: null,
+        /** 
+         * Advisory validation result for data export settings of a feature service item. 
+         */
+        featureServiceExportDataSetting: null,
+    },
     /** 
      * The ArcGIS Online Item ID. 
      */
@@ -1613,6 +1813,10 @@ export type ValidationInfo = {
      * if true, this validation rule is a binary check, i.e., it can only pass or fail.
      */
     isBinaryCheck: boolean;
+    /**
+     * if true, this validation rule is advisory and does not impact the overall score.
+     */
+    isAdvisory: boolean;
 };
 ```
 
@@ -1712,21 +1916,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.