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

package/dist/types/index.d.ts

@@ -99,7 +99,17 @@ export type ValidationMessage = {
  * - `unknown`: The validation status is unknown, which is the default status when a ValidationInfo object is created but the validation process has not yet been executed.
  */
 export type ValidationResultStatus = 'pass' | 'warning' | 'error' | 'not-applicable' | 'unknown';
+export declare const ValidationRuleIds: readonly ["item-sharing-level", "item-credits-attribution-info", "item-description", "item-license-info", "item-snippet", "item-ssl", "item-tags", "item-thumbnail", "item-title", "item-deprecated", "item-delete-protection", "item-title-and-summary-searchability", "user-profile-description", "user-profile-full-name", "user-profile-thumbnail", "feature-service-field-value-types", "feature-service-field-aliases", "feature-service-field-descriptions"];
+/**
+ * Validation rule identifier
+ */
+export type ValidationRuleId = (typeof ValidationRuleIds)[number];
 export type ValidationInfo = {
+    /**
+     * The identifier of the validation rule, e.g., "item-sharing-level" or "item-description".
+     * It serves as a unique, human-readable identifier for each rule.
+     */
+    validationRuleId: ValidationRuleId;
     /**
      * The title string tells the user what this validation rule checks, e.g., "Check Thumbnail" or "Check Number of Layers".
      */
@@ -125,9 +135,10 @@ export type ValidationInfo = {
      */
     weight: number;
     /**
-     * A factor ranging between 0 and 1 used to calculate the final score by multiplying it with the weight number.
+     * A scoring factor ranging between 0 and 1 used to calculate the final score by multiplying it with the weight number.
+     * 0 means the validation rule received no points, while 1 means it received the maximum score.
      */
-    weightFactor: number;
+    scoringFactor: number;
     /**
      * Status of the validation result
      */
@@ -138,90 +149,239 @@ export type ValidationInfo = {
     isBinaryCheck: boolean;
 };
 /**
- * Validation result returned by the `validate` function
+ * Represents the result of validating an ArcGIS Online item and its owner's profile.
+ *
+ * This type is returned by the `validate` function and contains detailed validation results
+ * for both the item and its owner's profile, as well as overall scoring and nomination eligibility.
  */
 export type ValidationResult = {
+    /**
+     * Validation results for the ArcGIS Online item.
+     * Each property corresponds to a specific validation rule applied to the item.
+     */
     validatedItem: {
         /**
-         * validation result of item's Sharing Level
+         * Validation result for the item's sharing level (access).
          */
         access: ValidationInfo;
         /**
-         * validation result of item's Credits/Attribution Info
+         * Validation result for the item's credits/attribution information.
          */
         accessInformation: ValidationInfo;
         /**
-         * validation result of item's Description text
+         * Validation result for the item's description text.
          */
         description: ValidationInfo;
         /**
-         * validation result of item's License Info
+         * Validation result for the item's license information.
          */
         licenseInfo: ValidationInfo;
         /**
-         * validation result of item's snippet (summary text)
+         *  Validation result for the item's snippet (summary text).
          */
         snippet: ValidationInfo;
+        /**
+         *  Validation result for the item's HTTPS URL.
+         */
         ssl: ValidationInfo;
         /**
-         * validation result of item's tags
+         * Validation result for the item's tags.
          */
         tags: ValidationInfo;
         /**
-         * validation result of item's thumbnail
+         * Validation result for the item's thumbnail image.
          */
         thumbnail: ValidationInfo;
         /**
-         * validation result of item's title
+         * Validation result for the item's title.
          */
         title: ValidationInfo;
         /**
-         * validation result of item's contentStatus
+         * Validation result for the item's deprecated/content status.
          */
         deprecated: ValidationInfo;
         /**
-         * validation result of item's "delete protection" property
+         * Validation result for the item's delete protection property.
          */
         deleteProtection: ValidationInfo;
         /**
-         * validation result of checking recommended text in item's title and summary text
+         * Validation result for searchability the item's title and summary.
+         * Applicable only to English layer items.
          */
         recommendedTextInTitleAndSummary: ValidationInfo;
+        /**
+         * Validation result for field aliases in feature layers of a feature service item.
+         * Applicable only to feature service items.
+         */
+        featureServiceFieldAliases: ValidationInfo;
+        /**
+         * Validation result for field descriptions in feature layers of a feature service item.
+         * Applicable only to feature service items.
+         */
+        featureServiceFieldDescriptions: ValidationInfo;
+        /**
+         * Validation result for field value types in feature layers of a feature service item.
+         * Applicable only to feature service items.
+         */
+        featureServiceFieldValueTypes: ValidationInfo;
     };
+    /**
+     * Validation results for the item owner's profile.
+     * Each property corresponds to a specific validation rule applied to the user profile.
+     */
     validatedProfile: {
         /**
-         * validation result of item owner's profile descriotion
+         * Validation result for the owner's profile description.
          */
         userProfileDescription: ValidationInfo;
         /**
-         * validation result of item owner's full name
+         * Validation result for the owner's full name.
          */
         userProfileFullName: ValidationInfo;
         /**
-         * validation result of item owner's thumbnail image
+         * Validation result for the owner's thumbnail image.
          */
         userProfileThumbnail: ValidationInfo;
     };
     /**
-     * Id of the ArcGIS Online Item
+     * The ArcGIS Online Item ID.
      */
     id: string;
     /**
-     * total score of the validation result
+     * The total score calculated from all validation rules.
      */
     totalScore: number;
     /**
-     * if true, this item meets all minimum requirements
-     * and it can be nominated to Living Atlas.
-     *
-     * An item can be nominated to Living Atlas only if its total score meets the minimum required threshold of 80 and it also passes
-     * the following checks:
+     * Indicates if the item meets all minimum requirements and can be nominated to Living Atlas.
      *
-     * - 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
+     * An item is eligible for nomination if:
+     * - The total score meets the minimum threshold (e.g., 80).
+     * - It is shared with the public.
+     * - The thumbnail image meets required dimensions.
+     * - It has a snippet (summary) text.
+     * - It has a description text.
+     * - The item owner has a user profile description.
      */
     canBeNominated: boolean;
 };
+/**
+ * Represents a Feature Service in JSON format.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service/
+ */
+export type FeatureServiceJSON = {
+    /**
+     * the feature layers published by this service
+     */
+    layers: {
+        id: number;
+        name: string;
+        type: string;
+        geometryType: string;
+    }[];
+    /**
+     * the tables published by this service
+     */
+    tables: {
+        id: number;
+        name: string;
+    }[];
+};
+/**
+ * Represents a Feature Layer field in JSON format.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-layer.htm
+ */
+type FeatureLayerField = {
+    name: string;
+    type: string;
+    alias: string;
+    length?: number;
+    domain?: any;
+    defaultValue?: any;
+    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?: {
+        /**
+         * A brief description of the field, up to 500 characters.
+         */
+        value: string;
+        /**
+         * 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.
+ *
+ * @see https://doc.arcgis.com/en/arcgis-online/manage-data/describe-fields.htm
+ * @see https://www.esri.com/arcgis-blog/products/arcgis-online/data-management/describing-layer-attributes-with-field-descriptions-march-2019
+ */
+export type FeatureLayerFieldValueType = 'nameOrTitle' | 'description' | 'typeOrCategory' | 'countOrAmount' | 'percentageOrRatio' | 'measurement' | 'uniqueIdentifier' | 'orderedOrRanked' | 'binary' | 'locationOrPlaceName' | 'coordinate' | 'dateAndTime';
+/**
+ * Represents a Feature Layer in JSON format.
+ *
+ * An individual Feature Layer resource represents a single feature layer or a non-spatial table in a feature service.
+ * - For tables, it provides basic information about the table such as its ID, name, fields, types and templates.
+ * - For feature layers, in addition to the table information above, it provides information such as its geometry type, min and max scales, and spatial reference. A feature layer is a table or view with at least one spatial column.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-layer/
+ */
+export type FeatureLayerJSON = {
+    id: number;
+    name: string;
+    type: string;
+    description: string;
+    copyrightText: string;
+    supportsRollbackOnFailures: boolean;
+    geometryType?: string;
+    minScale?: number;
+    maxScale?: number;
+    'extent?': {
+        xmin: number;
+        ymin: number;
+        xmax: number;
+        ymax: number;
+        spatialReference: {
+            wkid: number;
+            latestWkid: number;
+        };
+    };
+    /**
+     * the feature layer's fields
+     */
+    fields: FeatureLayerFieldRaw[];
+};
+/**
+ * Represents the response from the Feature Service layers endpoint.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service.htm
+ */
+export type FeatureServiceLayersResponse = {
+    layers: FeatureLayerJSON[];
+    tables: FeatureLayerJSON[];
+    error?: Error;
+};
+export {};

package/dist/types/index.js

@@ -13,4 +13,25 @@
  * @see https://stackoverflow.com/questions/56018167/typescript-does-not-copy-d-ts-files-to-build
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationRuleIds = void 0;
+exports.ValidationRuleIds = [
+    'item-sharing-level',
+    'item-credits-attribution-info',
+    'item-description',
+    'item-license-info',
+    'item-snippet',
+    'item-ssl',
+    'item-tags',
+    'item-thumbnail',
+    'item-title',
+    'item-deprecated',
+    'item-delete-protection',
+    'item-title-and-summary-searchability',
+    'user-profile-description',
+    'user-profile-full-name',
+    'user-profile-thumbnail',
+    'feature-service-field-value-types',
+    'feature-service-field-aliases',
+    'feature-service-field-descriptions',
+];
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAoIU,QAAA,iBAAiB,GAAG;IAC7B,oBAAoB;IACpB,+BAA+B;IAC/B,kBAAkB;IAClB,mBAAmB;IACnB,cAAc;IACd,UAAU;IACV,WAAW;IACX,gBAAgB;IAChB,YAAY;IACZ,iBAAiB;IACjB,wBAAwB;IACxB,sCAAsC;IACtC,0BAA0B;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,mCAAmC;IACnC,+BAA+B;IAC/B,oCAAoC;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vannizhang/living-atlas-content-validator",
-  "version": "1.5.19-beta.2",
+  "version": "1.5.19-beta.4",
   "description": "Validation and Scoring rules for curating content in the ArcGIS Living Atlas",
   "repository": {
     "type": "git",
@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.0",
+    "@types/node": "^22.15.18",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
     "eslint": "^8.38.0",
@@ -49,9 +50,9 @@
     "jest-environment-jsdom": "^29.7.0",
     "lint-staged": "^13.2.1",
     "prettier": "^2.8.7",
-    "rimraf": "^5.0.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.0.4"
+    "rimraf": "^5.0.10",
+    "ts-jest": "^29.3.3",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
     "sanitize-html": "^2.10.0"

package/dist/lib/accessInformation/scoringRulesConfig.js

@@ -1,36 +0,0 @@
-// import { ScoringRulesConfig } from '../../types';
-// const config: ScoringRulesConfig = {
-//     // Scoring
-//     SCORING: {
-//         DEFAULT: {
-//             WEB_MAP: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 8,
-//             },
-//             WEB_SCENE: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 9,
-//             },
-//             APPLICATION: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 9,
-//             },
-//         },
-//         INTERNATIONAL: {
-//             WEB_MAP: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 8,
-//             },
-//             WEB_SCENE: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 9,
-//             },
-//             APPLICATION: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 EXIST_SCORE: 9,
-//             },
-//         },
-//     },
-// };
-// export default config;
-//# sourceMappingURL=scoringRulesConfig.js.map

package/dist/lib/accessInformation/scoringRulesConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scoringRulesConfig.js","sourceRoot":"","sources":["../../../src/lib/accessInformation/scoringRulesConfig.ts"],"names":[],"mappings":"AAAA,oDAAoD;AAEpD,uCAAuC;AACvC,iBAAiB;AACjB,iBAAiB;AACjB,qBAAqB;AACrB,yBAAyB;AACzB,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,2BAA2B;AAC3B,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,6BAA6B;AAC7B,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,aAAa;AAEb,2BAA2B;AAC3B,yBAAyB;AACzB,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,2BAA2B;AAC3B,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,6BAA6B;AAC7B,yCAAyC;AACzC,kCAAkC;AAClC,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AAEL,yBAAyB"}

package/dist/lib/layers/scoringRulesConfig.js

@@ -1,48 +0,0 @@
-// import { ScoringRulesConfig } from '../../types';
-// const config: ScoringRulesConfig = {
-//     // Scoring
-//     SCORING: {
-//         DEFAULT: {
-//             WEB_MAP: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 8,
-//                 LAYER_COUNT_BETTER_SCORE: 4,
-//                 LAYER_COUNT_GOOD_SCORE: 1,
-//             },
-//             WEB_SCENE: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 0,
-//                 LAYER_COUNT_BETTER_SCORE: 0,
-//                 LAYER_COUNT_GOOD_SCORE: 0,
-//             },
-//             APPLICATION: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 0,
-//                 LAYER_COUNT_BETTER_SCORE: 0,
-//                 LAYER_COUNT_GOOD_SCORE: 0,
-//             },
-//         },
-//         INTERNATIONAL: {
-//             WEB_MAP: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 8,
-//                 LAYER_COUNT_BETTER_SCORE: 4,
-//                 LAYER_COUNT_GOOD_SCORE: 1,
-//             },
-//             WEB_SCENE: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 0,
-//                 LAYER_COUNT_BETTER_SCORE: 0,
-//                 LAYER_COUNT_GOOD_SCORE: 0,
-//             },
-//             APPLICATION: {
-//                 EMPTY_STRING_SCORE: 0,
-//                 LAYER_COUNT_BEST_SCORE: 0,
-//                 LAYER_COUNT_BETTER_SCORE: 0,
-//                 LAYER_COUNT_GOOD_SCORE: 0,
-//             },
-//         },
-//     },
-// };
-// export default config;
-//# sourceMappingURL=scoringRulesConfig.js.map

package/dist/lib/layers/scoringRulesConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scoringRulesConfig.js","sourceRoot":"","sources":["../../../src/lib/layers/scoringRulesConfig.ts"],"names":[],"mappings":"AAAA,oDAAoD;AAEpD,uCAAuC;AACvC,iBAAiB;AACjB,iBAAiB;AACjB,qBAAqB;AACrB,yBAAyB;AACzB,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,2BAA2B;AAC3B,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,6BAA6B;AAC7B,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,aAAa;AAEb,2BAA2B;AAC3B,yBAAyB;AACzB,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,2BAA2B;AAC3B,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,6BAA6B;AAC7B,yCAAyC;AACzC,6CAA6C;AAC7C,+CAA+C;AAC/C,6CAA6C;AAC7C,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AAEL,yBAAyB"}