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

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ValidationMessage, ValidationInfo, ValidationResult, ValidationResultStatus, FeatureLayerField, FeatureLayerJSON, FeatureLayerFieldValueType, FeatureServiceJSON } from './types';
+import { ValidationMessage, ValidationInfo, ValidationResult, ValidationResultStatus, FeatureLayerFieldRaw, FeatureLayerFieldFormatted, FeatureLayerJSON, FeatureLayerFieldValueType, FeatureServiceJSON } from './types';
 import { isValidTitle } from './lib/title/isValidTitle';
 import { isValidAccessInformation } from './lib/accessInformation/isValidAccessInformation';
 import { isValidDescription } from './lib/description/isValidDescription';
@@ -41,4 +41,4 @@ import { fetchFeatureServiceLayersAndTables } from './services/feature-service/f
 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, };
 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, FeatureLayerField, FeatureLayerJSON, FeatureLayerFieldValueType, FeatureServiceJSON, };
+export type { ValidationMessage, ValidationInfo, ValidationResult, ValidationRulesStringJSON, ValidationResultStatus, MatchResult, CustomTermFeature, CustomTermCategory, CustomTermStatus, CustomTermsReviewResultLifecycle, CustomTermReviewResultFeature, AdditionalPatterns4TitleAndSnippetSearchability, AddFeaturesResponse, LivingAtlasSupportedItemType, FeatureLayerFieldRaw, FeatureLayerFieldFormatted, FeatureLayerJSON, FeatureLayerFieldValueType, FeatureServiceJSON, };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAgBA,2DAAwD;AA6GpD,6FA7GK,2BAAY,OA6GL;AA5GhB,+FAA4F;AA6GxF,yGA7GK,mDAAwB,OA6GL;AA5G5B,6EAA0E;AA6GtE,mGA7GK,uCAAkB,OA6GL;AA5GtB,yEAAyE;AACzE,6EAA0E;AA6GtE,mGA7GK,uCAAkB,OA6GL;AA5GtB,+DAA4D;AA6GxD,8FA7GK,6BAAa,OA6GL;AA5GjB,qDAAkD;AA6G9C,2FA7GK,uBAAU,OA6GL;AA5Gd,iEAA8D;AA6G1D,+FA7GK,+BAAc,OA6GL;AA5GlB,wDAAqD;AA6GjD,4FA7GK,yBAAW,OA6GL;AA5Gf,uEAAoE;AA6GhE,iGA7GK,mCAAgB,OA6GL;AA5GpB,8GAA2G;AA6GvG,8GA7GK,6DAA6B,OA6GL;AA5GjC,yFAAsF;AA6GlF,uGA7GK,+CAAsB,OA6GL;AA5G1B,wGAAqG;AA6GjG,4GA7GK,yDAA2B,OA6GL;AA5G/B,gEAA6D;AA6GzD,6FA7GK,2BAAY,OA6GL;AA5GhB,sDAAmD;AA6F/C,yFA7FK,mBAAQ,OA6FL;AA5FZ,gGAA6F,CAAC,kCAAkC;AA4G5H,0GA5GK,qDAAyB,OA4GL;AA3G7B,0EAA0E;AAC1E,iIAA8H;AA2G1H,kHA3GK,qEAAiC,OA2GL;AA1GrC,iGAImE;AAuG/D,kGA1GA,qCAAiB,OA0GA;AAIjB,qGA7GA,wCAAoB,OA6GA;AAIpB,uGAhHA,0CAAsB,OAgHA;AA9G1B,iGAImE;AAmG/D,kGAtGA,qCAAiB,OAsGA;AAIjB,yGAzGA,4CAAwB,OAyGA;AAIxB,uGA5GA,0CAAsB,OA4GA;AA1G1B,6FAIiE;AA+F7D,gGAlGA,iCAAe,OAkGA;AAIf,mGArGA,oCAAkB,OAqGA;AAIlB,qGAxGA,sCAAoB,OAwGA;AAtGxB,2FAIgE;AA2F5D,+FA9FA,+BAAc,OA8FA;AAId,kGAjGA,kCAAiB,OAiGA;AAIjB,oGApGA,oCAAmB,OAoGA;AAlGvB,6EAGyD;AAgGrD,kIAlGA,2DAAiD,OAkGA;AA/FrD,wEAAqE;AA8H5D,oGA9HA,yCAAmB,OA8HA;AA7H5B,0DAAuD;AAiGnD,6FAjGK,2BAAY,OAiGL;AA/FhB,4DAIkC;AA4F9B,iGA/FA,gCAAgB,OA+FA;AAChB,wGA9FA,uCAAuB,OA8FA;AA3F3B,2DAAwD;AAuDpD,kGAvDK,qCAAiB,OAuDL;AArDrB,0DAOiC;AA4F7B,wGAjGA,sCAAuB,OAiGA;AACvB,iGAjGA,+BAAgB,OAiGA;AAChB,4GAjGA,0CAA2B,OAiGA;AAC3B,wHAjGA,sDAAuC,OAiGA;AAQvC,mHAxGA,iDAAkC,OAwGA;AAnGtC,iKAGiG;AAmF7F,oIArFA,yGAAmD,OAqFA;AA5EvD,wFAWgD;AA4E5C,8GAtFA,2DAA6B,OAsFA;AAC7B,kHAtFA,+DAAiC,OAsFA;AANjC,yGA/EA,sDAAwB,OA+EA;AACxB,yGA/EA,sDAAwB,OA+EA;AACxB,2GA/EA,wDAA0B,OA+EA;AAC1B,yGA/EA,sDAAwB,OA+EA;AACxB,kHA/EA,+DAAiC,OA+EA;AAIjC,gIAhFA,6EAA+C,OAgFA;AA7EnD,gFAA6E;AAiF/C,wGAjFrB,iDAAuB,OAiFqB;AAhFrD,mGAAgG;AA+D5F,qGA/DK,2CAAoB,OA+DL;AA9DxB,8EAA4E;AA4ExE,kGA5EK,oCAAiB,OA4EL;AA3ErB,kGAGqD;AA6CjD,iHA/CA,mEAAgC,OA+CA;AAChC,oHA/CA,sEAAmC,OA+CA;AA1CvC,qIAAkI;AA+C9H,qHA/CK,2EAAoC,OA+CL;AA7CxC,sHAAmH;AA4C/G,gHA5CK,iEAA+B,OA4CL;AA1CnC,+HAA4H;AA4CxH,mHA5CK,uEAAkC,OA4CL;AA1CtC,sHAAmH;AA2C/G,mHA3CK,uEAAkC,OA2CL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAiBA,2DAAwD;AA6GpD,6FA7GK,2BAAY,OA6GL;AA5GhB,+FAA4F;AA6GxF,yGA7GK,mDAAwB,OA6GL;AA5G5B,6EAA0E;AA6GtE,mGA7GK,uCAAkB,OA6GL;AA5GtB,yEAAyE;AACzE,6EAA0E;AA6GtE,mGA7GK,uCAAkB,OA6GL;AA5GtB,+DAA4D;AA6GxD,8FA7GK,6BAAa,OA6GL;AA5GjB,qDAAkD;AA6G9C,2FA7GK,uBAAU,OA6GL;AA5Gd,iEAA8D;AA6G1D,+FA7GK,+BAAc,OA6GL;AA5GlB,wDAAqD;AA6GjD,4FA7GK,yBAAW,OA6GL;AA5Gf,uEAAoE;AA6GhE,iGA7GK,mCAAgB,OA6GL;AA5GpB,8GAA2G;AA6GvG,8GA7GK,6DAA6B,OA6GL;AA5GjC,yFAAsF;AA6GlF,uGA7GK,+CAAsB,OA6GL;AA5G1B,wGAAqG;AA6GjG,4GA7GK,yDAA2B,OA6GL;AA5G/B,gEAA6D;AA6GzD,6FA7GK,2BAAY,OA6GL;AA5GhB,sDAAmD;AA6F/C,yFA7FK,mBAAQ,OA6FL;AA5FZ,gGAA6F,CAAC,kCAAkC;AA4G5H,0GA5GK,qDAAyB,OA4GL;AA3G7B,0EAA0E;AAC1E,iIAA8H;AA2G1H,kHA3GK,qEAAiC,OA2GL;AA1GrC,iGAImE;AAuG/D,kGA1GA,qCAAiB,OA0GA;AAIjB,qGA7GA,wCAAoB,OA6GA;AAIpB,uGAhHA,0CAAsB,OAgHA;AA9G1B,iGAImE;AAmG/D,kGAtGA,qCAAiB,OAsGA;AAIjB,yGAzGA,4CAAwB,OAyGA;AAIxB,uGA5GA,0CAAsB,OA4GA;AA1G1B,6FAIiE;AA+F7D,gGAlGA,iCAAe,OAkGA;AAIf,mGArGA,oCAAkB,OAqGA;AAIlB,qGAxGA,sCAAoB,OAwGA;AAtGxB,2FAIgE;AA2F5D,+FA9FA,+BAAc,OA8FA;AAId,kGAjGA,kCAAiB,OAiGA;AAIjB,oGApGA,oCAAmB,OAoGA;AAlGvB,6EAGyD;AAgGrD,kIAlGA,2DAAiD,OAkGA;AA/FrD,wEAAqE;AA8H5D,oGA9HA,yCAAmB,OA8HA;AA7H5B,0DAAuD;AAiGnD,6FAjGK,2BAAY,OAiGL;AA/FhB,4DAIkC;AA4F9B,iGA/FA,gCAAgB,OA+FA;AAChB,wGA9FA,uCAAuB,OA8FA;AA3F3B,2DAAwD;AAuDpD,kGAvDK,qCAAiB,OAuDL;AArDrB,0DAOiC;AA4F7B,wGAjGA,sCAAuB,OAiGA;AACvB,iGAjGA,+BAAgB,OAiGA;AAChB,4GAjGA,0CAA2B,OAiGA;AAC3B,wHAjGA,sDAAuC,OAiGA;AAQvC,mHAxGA,iDAAkC,OAwGA;AAnGtC,iKAGiG;AAmF7F,oIArFA,yGAAmD,OAqFA;AA5EvD,wFAWgD;AA4E5C,8GAtFA,2DAA6B,OAsFA;AAC7B,kHAtFA,+DAAiC,OAsFA;AANjC,yGA/EA,sDAAwB,OA+EA;AACxB,yGA/EA,sDAAwB,OA+EA;AACxB,2GA/EA,wDAA0B,OA+EA;AAC1B,yGA/EA,sDAAwB,OA+EA;AACxB,kHA/EA,+DAAiC,OA+EA;AAIjC,gIAhFA,6EAA+C,OAgFA;AA7EnD,gFAA6E;AAiF/C,wGAjFrB,iDAAuB,OAiFqB;AAhFrD,mGAAgG;AA+D5F,qGA/DK,2CAAoB,OA+DL;AA9DxB,8EAA4E;AA4ExE,kGA5EK,oCAAiB,OA4EL;AA3ErB,kGAGqD;AA6CjD,iHA/CA,mEAAgC,OA+CA;AAChC,oHA/CA,sEAAmC,OA+CA;AA1CvC,qIAAkI;AA+C9H,qHA/CK,2EAAoC,OA+CL;AA7CxC,sHAAmH;AA4C/G,gHA5CK,iEAA+B,OA4CL;AA1CnC,+HAA4H;AA4CxH,mHA5CK,uEAAkC,OA4CL;AA1CtC,sHAAmH;AA2C/G,mHA3CK,uEAAkC,OA2CL"}

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

@@ -1,4 +1,4 @@
-import { FeatureLayerField, FeatureLayerJSON } from '../../types';
+import { FeatureLayerFieldFormatted, FeatureLayerJSON } from '../../types';
 /**
  * Extracts and returns relevant fields from an array of feature layer JSON objects.
  *
@@ -10,4 +10,4 @@ import { FeatureLayerField, FeatureLayerJSON } from '../../types';
  * @param featureLayers - An array of `FeatureLayerJSON` objects to extract fields from.
  * @returns An array of `FeatureLayerField` objects that are considered relevant.
  */
-export declare const getRelevantFeatureLayerFields: (featureLayers: FeatureLayerJSON[]) => FeatureLayerField[];
+export declare const getRelevantFeatureLayerFields: (featureLayers: FeatureLayerJSON[]) => FeatureLayerFieldFormatted[];

package/dist/lib/util/getRelevantFeatureLayerFields.js

@@ -36,7 +36,17 @@ const getRelevantFeatureLayerFields = (featureLayers) => {
             if (fieldName === 'SHAPE__AREA' || fieldName === 'SHAPE__LENGTH') {
                 continue;
             }
-            featureLayerFields.push(field);
+            let parsedDescription = null;
+            if (typeof field.description === 'string') {
+                try {
+                    parsedDescription = JSON.parse(field.description);
+                }
+                catch (_a) {
+                    parsedDescription = null;
+                }
+            }
+            const formattedField = Object.assign(Object.assign({}, field), { description: parsedDescription });
+            featureLayerFields.push(formattedField);
         }
     }
     return featureLayerFields;

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

@@ -1 +1 @@
-{"version":3,"file":"getRelevantFeatureLayerFields.js","sourceRoot":"","sources":["../../../src/lib/util/getRelevantFeatureLayerFields.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACI,MAAM,6BAA6B,GAAG,CACzC,aAAiC,EACd,EAAE;IACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAA,EAAE,CAAC;QAC1D,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,kBAAkB,GAAwB,EAAE,CAAC;IAEnD,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CAAC,KAAK,KAAK,EAAE,CAAC;YAChD,SAAS;QACb,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACtC,IACI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAA;gBACZ,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAA;gBACZ,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;gBAC9B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAChC,CAAC;gBACC,SAAS;YACb,CAAC;YAED,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;YAE7B,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;gBAC/D,SAAS;YACb,CAAC;YAED,IAAI,SAAS,KAAK,aAAa,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;gBAC/D,SAAS;YACb,CAAC;YAED,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC;AAxCW,QAAA,6BAA6B,iCAwCxC"}
+{"version":3,"file":"getRelevantFeatureLayerFields.js","sourceRoot":"","sources":["../../../src/lib/util/getRelevantFeatureLayerFields.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACI,MAAM,6BAA6B,GAAG,CACzC,aAAiC,EACL,EAAE;IAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAA,EAAE,CAAC;QAC1D,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,kBAAkB,GAAiC,EAAE,CAAC;IAE5D,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CAAC,KAAK,KAAK,EAAE,CAAC;YAChD,SAAS;QACb,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACtC,IACI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAA;gBACZ,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAA;gBACZ,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;gBAC9B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAChC,CAAC;gBACC,SAAS;YACb,CAAC;YAED,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;YAE7B,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;gBAC/D,SAAS;YACb,CAAC;YAED,IAAI,SAAS,KAAK,aAAa,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;gBAC/D,SAAS;YACb,CAAC;YAED,IAAI,iBAAiB,GAAG,IAAI,CAAC;YAC7B,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACxC,IAAI,CAAC;oBACD,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBACtD,CAAC;gBAAC,WAAM,CAAC;oBACL,iBAAiB,GAAG,IAAI,CAAC;gBAC7B,CAAC;YACL,CAAC;YACD,MAAM,cAAc,mCACb,KAAK,KACR,WAAW,EAAE,iBAAiB,GACjC,CAAC;YAEF,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC;AArDW,QAAA,6BAA6B,iCAqDxC"}

package/dist/package-info.json

@@ -1 +1 @@
-{"lastCompiledTime":1747487766583}
+{"lastCompiledTime":1747775562296}

package/dist/types/index.d.ts

@@ -292,7 +292,7 @@ export type FeatureServiceJSON = {
  *
  * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-layer.htm
  */
-export type FeatureLayerField = {
+type FeatureLayerField = {
     name: string;
     type: string;
     alias: string;
@@ -302,16 +302,36 @@ export type FeatureLayerField = {
     sqlType?: string;
     nullable?: boolean;
     editable?: boolean;
+};
+/**
+ * Represents a raw Feature Layer field as returned by the Feature Layer JSON.
+ *
+ * The `description` property is typically returned by the server as a stringified JSON object,
+ * for example: `"{\"value\":\"\",\"fieldValueType\":\"dateAndTime\"}"`.
+ */
+export type FeatureLayerFieldRaw = FeatureLayerField & {
+    /**
+     * The field description as a stringified JSON object, if present.
+     */
+    description?: string;
+};
+/**
+ * Represents a Feature Layer field with a parsed and formatted description.
+ *
+ * The `description` property is an object containing the description text and the field value type,
+ * or `null` if not present or not properly formatted.
+ */
+export type FeatureLayerFieldFormatted = FeatureLayerField & {
     description?: {
         /**
-         * Description of the field - a few words, a sentence, or a paragraph of text that describes the values in the field. The description can be up to 500 characters.
+         * A brief description of the field, up to 500 characters.
          */
         value: string;
         /**
-         * Field value type – a keyword that categorizes the type of values contained in the field. The keyword helps people understand how to use the values and allows ArcGIS Online to make smarter suggestions for working with them.
+         * A keyword categorizing the type of values in the field, used for smarter suggestions in ArcGIS Online.
          */
         fieldValueType: FeatureLayerFieldValueType;
-    };
+    } | null;
 };
 /**
  * Represents the field value type of a feature layer.
@@ -352,7 +372,7 @@ export type FeatureLayerJSON = {
     /**
      * the feature layer's fields
      */
-    fields: FeatureLayerField[];
+    fields: FeatureLayerFieldRaw[];
 };
 /**
  * Represents the response from the Feature Service layers endpoint.
@@ -364,3 +384,4 @@ export type FeatureServiceLayersResponse = {
     tables: FeatureLayerJSON[];
     error?: Error;
 };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vannizhang/living-atlas-content-validator",
-  "version": "1.5.19-beta.3",
+  "version": "1.5.19-beta.4",
   "description": "Validation and Scoring rules for curating content in the ArcGIS Living Atlas",
   "repository": {
     "type": "git",