@vannizhang/living-atlas-content-validator 1.5.17 → 1.5.18-beta.2

package/dist/services/shared/applyEdits.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFeatures = void 0;
+/**
+ * Updates features in a feature table using the provided token and updates.
+ *
+ * @param {Object} params - The parameters for the update operation.
+ * @param {string} params.token - The authentication token.
+ * @param {Object[]} params.updates - The array of update objects containing attributes to be updated.
+ * @param {Object} params.updates[].attributes - The attributes to be updated for each feature.
+ * @param {string} params.featureTableUrl - The URL of the feature table to update.
+ * @returns {Promise<ApplyEditsResult[]>} - A promise that resolves to an array of ApplyEditsResult objects.
+ * @throws {Error} - Throws an error if the update operation fails.
+ */
+const updateFeatures = ({ token, updates, featureTableUrl, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const requestURL = `${featureTableUrl}/applyEdits`;
+    const res = yield fetch(requestURL, {
+        method: 'POST',
+        body: new URLSearchParams({
+            f: 'json',
+            token,
+            rollbackOnFailure: 'true',
+            updates: JSON.stringify(updates),
+        }),
+    });
+    const responseBody = yield res.json();
+    if (responseBody === null || responseBody === void 0 ? void 0 : responseBody.error) {
+        throw new Error(((_a = responseBody === null || responseBody === void 0 ? void 0 : responseBody.error) === null || _a === void 0 ? void 0 : _a.message) ||
+            'Failed to apply edits to ' + featureTableUrl);
+    }
+    const updateResults = responseBody === null || responseBody === void 0 ? void 0 : responseBody.updateResults;
+    if (!updateResults) {
+        return [];
+    }
+    for (const res of updateResults) {
+        if ((res === null || res === void 0 ? void 0 : res.success) !== true) {
+            throw new Error(((_b = res === null || res === void 0 ? void 0 : res.error) === null || _b === void 0 ? void 0 : _b.description) || 'Failed to apply edits.');
+        }
+    }
+    return updateResults;
+});
+exports.updateFeatures = updateFeatures;
+//# sourceMappingURL=applyEdits.js.map

package/dist/services/shared/applyEdits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyEdits.js","sourceRoot":"","sources":["../../../src/services/shared/applyEdits.ts"],"names":[],"mappings":";;;;;;;;;;;;AAmBA;;;;;;;;;;GAUG;AACI,MAAM,cAAc,GAAG,CAAO,EACjC,KAAK,EACL,OAAO,EACP,eAAe,GASlB,EAA+B,EAAE;;IAC9B,MAAM,UAAU,GAAG,GAAG,eAAe,aAAa,CAAC;IAEnD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,eAAe,CAAC;YACtB,CAAC,EAAE,MAAM;YACT,KAAK;YACL,iBAAiB,EAAE,MAAM;YACzB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SACnC,CAAC;KACL,CAAC,CAAC;IAEH,MAAM,YAAY,GAAuB,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAE1D,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,EAAE;QACrB,MAAM,IAAI,KAAK,CACX,CAAA,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,0CAAE,OAAO;YACxB,2BAA2B,GAAG,eAAe,CACpD,CAAC;KACL;IAED,MAAM,aAAa,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,aAAmC,CAAC;IAExE,IAAI,CAAC,aAAa,EAAE;QAChB,OAAO,EAAE,CAAC;KACb;IAED,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE;QAC7B,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,MAAK,IAAI,EAAE;YACvB,MAAM,IAAI,KAAK,CACX,CAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,0CAAE,WAAW,KAAI,wBAAwB,CACtD,CAAC;SACL;KACJ;IAED,OAAO,aAAmC,CAAC;AAC/C,CAAC,CAAA,CAAC;AAjDW,QAAA,cAAc,kBAiDzB"}

package/dist/services/shared/config.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Tier of the services.
+ * - `dev`: Development tier, pointing to development services on devext.arcgis.com.
+ * - `prod`: Production tier, pointing to production services on www.arcgis.com.
+ */
+export type ServiceTier = 'prod' | 'dev';
+/**
+ * Category of custom term:
+ * - `topic`: Topic, to understand what this item is about.
+ * - `location`: Location or area of coverage, to understand which geographic area is included.
+ * - `Year`: Year or Vintage, to understand the how recently the data was collected or updated.
+ * - `source`: Source organization/program, to understand where the item’s content originated
+ */
+export type CustomTermCategory = 'topic' | 'location' | 'vintage-year' | 'source';
+/**
+ * Represents the status of a custom term in the contribution process.
+ *
+ * - `staged`: The custom term is in the initial stage and has not yet been submitted.
+ * - `submitted`: The custom term has been submitted for review.
+ * - `approved`: The custom term has been reviewed and approved.
+ * - `rejected`: The custom term has been reviewed and rejected.
+ * - `expired`: The custom term has expired and is no longer valid.
+ */
+export type CustomTermStatus = 'staged' | 'submitted' | 'approved' | 'rejected' | 'expired';
+/**
+ * The service tier of the application.
+ * - `dev`: Development tier, pointing to development services on devext.arcgis.com.
+ * - `prod`: Production tier, pointing to production services on www.arcgis.com.
+ */
+export declare let serviceTier: ServiceTier;
+/**
+ * Indicates if the environment is Node.js.
+ */
+export declare const isNodeEnv: boolean;
+/**
+ * Sets the tier for the services.
+ *
+ * Why is this needed? Why can't we just use the TIER constant based on the hostname?
+ * Because these services can also be used in a node.js environment, where the hostname is not available.
+ * That's why we need to set the tier explicitly.
+ *
+ * @param tier - The tier to set for the services.
+ */
+export declare const setServiceTier: (tier: ServiceTier) => void;

package/dist/services/shared/config.js

@@ -0,0 +1,35 @@
+"use strict";
+// export const TIER =
+//     window.location.hostname === 'livingatlas.arcgis.com' ||
+//     window.location.hostname === 'livingatlasstg.arcgis.com'
+//         ? 'prod'
+//         : 'dev';
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setServiceTier = exports.isNodeEnv = exports.serviceTier = void 0;
+/**
+ * The service tier of the application.
+ * - `dev`: Development tier, pointing to development services on devext.arcgis.com.
+ * - `prod`: Production tier, pointing to production services on www.arcgis.com.
+ */
+exports.serviceTier = 'dev';
+/**
+ * Indicates if the environment is Node.js.
+ */
+exports.isNodeEnv = typeof process !== 'undefined' &&
+    (process === null || process === void 0 ? void 0 : process.versions) != null &&
+    ((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node) != null;
+/**
+ * Sets the tier for the services.
+ *
+ * Why is this needed? Why can't we just use the TIER constant based on the hostname?
+ * Because these services can also be used in a node.js environment, where the hostname is not available.
+ * That's why we need to set the tier explicitly.
+ *
+ * @param tier - The tier to set for the services.
+ */
+const setServiceTier = (tier) => {
+    exports.serviceTier = tier;
+};
+exports.setServiceTier = setServiceTier;
+//# sourceMappingURL=config.js.map

package/dist/services/shared/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/services/shared/config.ts"],"names":[],"mappings":";AAAA,sBAAsB;AACtB,+DAA+D;AAC/D,+DAA+D;AAC/D,mBAAmB;AACnB,mBAAmB;;;;AAsCnB;;;;GAIG;AACQ,QAAA,WAAW,GAAgB,KAAK,CAAC;AAE5C;;GAEG;AACU,QAAA,SAAS,GAClB,OAAO,OAAO,KAAK,WAAW;IAC9B,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI;IACzB,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,0CAAE,IAAI,KAAI,IAAI,CAAC;AAEpC;;;;;;;;GAQG;AACI,MAAM,cAAc,GAAG,CAAC,IAAiB,EAAE,EAAE;IAChD,mBAAW,GAAG,IAAI,CAAC;AACvB,CAAC,CAAC;AAFW,QAAA,cAAc,kBAEzB"}

package/dist/services/shared/getItemInfo.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The response type for the item information fetched from the ArcGIS REST API.
+ */
+export type ItemInfoResponse = {
+    id: string;
+    name: string;
+    owner: string;
+    guid: string;
+    title: string;
+    type: string;
+    typeKeywords: string[];
+    description: string;
+    tags: string[];
+    snippet: string;
+    thumbnail: string;
+    extent: number[];
+    categorites: null | string[];
+    spatialReference: string;
+    url: string;
+    culture: string;
+    licenseInfo: string;
+    accessInformation: string;
+    properties: string | object;
+    access: string;
+    size: number;
+};
+/**
+ * Fetches the item information for a feature table from the ArcGIS REST API.
+ * @param itemInfoEndPoint - The endpoint URL for the itemInfo service of a feature table. This should be the URL to the `/info/itemInfo` endpoint of the feature service.
+ * @param token - The authentication token to access the ArcGIS REST API. This is required for accessing secured resources.
+ * @returns A promise that resolves to an object containing the item information,
+ *          or rejects with an error if the request fails or the response is not in the expected format.
+ *
+ * @see https://developers.arcgis.com/rest/enterprise-administration/server/iteminfo/
+ */
+export declare const getFeatureLayerItemInfo: (itemInfoEndPoint: string, token: string) => Promise<ItemInfoResponse>;

package/dist/services/shared/getItemInfo.js

@@ -0,0 +1,56 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFeatureLayerItemInfo = void 0;
+/**
+ * Fetches the item information for a feature table from the ArcGIS REST API.
+ * @param itemInfoEndPoint - The endpoint URL for the itemInfo service of a feature table. This should be the URL to the `/info/itemInfo` endpoint of the feature service.
+ * @param token - The authentication token to access the ArcGIS REST API. This is required for accessing secured resources.
+ * @returns A promise that resolves to an object containing the item information,
+ *          or rejects with an error if the request fails or the response is not in the expected format.
+ *
+ * @see https://developers.arcgis.com/rest/enterprise-administration/server/iteminfo/
+ */
+const getFeatureLayerItemInfo = (itemInfoEndPoint, token) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    if (!itemInfoEndPoint || !token) {
+        // Validate input parameters
+        throw new Error('Both itemInfoEndPoint and token are required');
+    }
+    try {
+        const params = new URLSearchParams({
+            f: 'json',
+            token,
+        });
+        const res = yield fetch(itemInfoEndPoint + '?' + params.toString());
+        const data = yield res.json();
+        if (data === null || data === void 0 ? void 0 : data.error) {
+            // Handle the error response from the server
+            throw new Error(((_a = data === null || data === void 0 ? void 0 : data.error) === null || _a === void 0 ? void 0 : _a.message) || 'unknown error');
+        }
+        // Check if the response is in the expected format
+        if (!data || typeof data !== 'object') {
+            throw new Error('Invalid response format');
+        }
+        // Check if the response contains the expected properties
+        if (!data.id || !data.owner) {
+            // Ensure that the required properties are present in the response
+            throw new Error('Missing required properties in the response');
+        }
+        // Return the parsed item info response
+        return data;
+    }
+    catch (error) {
+        throw new Error(`Failed to fetch itemInfo (${itemInfoEndPoint}): ${error}`);
+    }
+});
+exports.getFeatureLayerItemInfo = getFeatureLayerItemInfo;
+//# sourceMappingURL=getItemInfo.js.map

package/dist/services/shared/getItemInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getItemInfo.js","sourceRoot":"","sources":["../../../src/services/shared/getItemInfo.ts"],"names":[],"mappings":";;;;;;;;;;;;AA2BA;;;;;;;;GAQG;AACI,MAAM,uBAAuB,GAAG,CACnC,gBAAwB,EACxB,KAAa,EACY,EAAE;;IAC3B,IAAI,CAAC,gBAAgB,IAAI,CAAC,KAAK,EAAE;QAC7B,4BAA4B;QAC5B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACnE;IAED,IAAI;QACA,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;YAC/B,CAAC,EAAE,MAAM;YACT,KAAK;SACR,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,gBAAgB,GAAG,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEpE,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAE9B,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;YACb,4CAA4C;YAC5C,MAAM,IAAI,KAAK,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,OAAO,KAAI,eAAe,CAAC,CAAC;SAC5D;QAED,kDAAkD;QAClD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC9C;QAED,yDAAyD;QACzD,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACzB,kEAAkE;YAClE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;SAClE;QAED,uCAAuC;QACvC,OAAO,IAAwB,CAAC;KACnC;IAAC,OAAO,KAAK,EAAE;QACZ,MAAM,IAAI,KAAK,CACX,6BAA6B,gBAAgB,MAAM,KAAK,EAAE,CAC7D,CAAC;KACL;AACL,CAAC,CAAA,CAAC;AA1CW,QAAA,uBAAuB,2BA0ClC"}

package/dist/types/index.d.ts

@@ -38,13 +38,6 @@ export type IItem = {
     numViews: number;
     size: number;
     protected?: boolean;
-    /**
-     * dimension of the thumbnail image
-     */
-    dimensions?: {
-        width: number;
-        height: number;
-    };
     [key: string]: any;
 };
 /**
@@ -92,15 +85,21 @@ export type ValidationMessage = {
     code?: string;
     message: string;
 };
+/**
+ * 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.
+ *
+ * The possible values for this type include:
+ * - `pass`: The validation rule has been passed successfully.
+ * - `warning`: The validation rule has been passed but with some warnings.
+ * - `error`: The validation rule has failed and requires attention or correction.
+ * - `not-applicable`: The validation rule is not applicable to the item being validated.
+ * - `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 type ValidationInfo = {
-    /**
-     * key of the validation rule
-     */
-    property: string;
-    /**
-     * if true, this is a critical validation rule
-     */
-    critical: boolean;
     /**
      * The title string tells the user what this validation rule checks, e.g., "Check Thumbnail" or "Check Number of Layers".
      */
@@ -129,6 +128,14 @@ export type ValidationInfo = {
      * 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;
 };
 /**
  * Validation result returned by the `validate` function
@@ -147,10 +154,6 @@ export type ValidationResult = {
          * validation result of item's Description text
          */
         description: ValidationInfo;
-        /**
-         * validation result of item's Layers count
-         */
-        layerCount: ValidationInfo;
         /**
          * validation result of item's License Info
          */
@@ -202,11 +205,11 @@ export type ValidationResult = {
     /**
      * Id of the ArcGIS Online Item
      */
-    id?: string;
+    id: string;
     /**
      * total score of the validation result
      */
-    totalScore?: number;
+    totalScore: number;
     /**
      * if true, this item meets all minimum requirements
      * and it can be nominated to Living Atlas.
@@ -220,5 +223,5 @@ export type ValidationResult = {
      * - It has a description text
      * - The item owner has a user profile description
      */
-    canBeNominated?: boolean;
+    canBeNominated: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vannizhang/living-atlas-content-validator",
-  "version": "1.5.17",
+  "version": "1.5.18-beta.2",
   "description": "Validation and Scoring rules for curating content in the ArcGIS Living Atlas",
   "repository": {
     "type": "git",
@@ -16,14 +16,14 @@
   "files": [
     "dist/**/*"
   ],
-  "license": "MIT",
+  "license": "Apache-2.0",
   "scripts": {
     "test": "jest --config jest.config.js --testPathIgnorePatterns=__tests__",
     "test:benchmarks": "jest --config jest.config.js __tests__/benchmarks/",
     "test:regression": "jest --config jest.config.js __tests__/regression/",
     "clean": "rimraf dist",
     "build": "npm run clean && tsc",
-    "postbuild": "node ./scripts/addPackageInfo.js",
+    "postbuild": "node ./scripts/add-package-info/index.js",
     "lint": "eslint src --ext .tsx,.ts --cache --fix",
     "prepare": "husky install && npm run build",
     "prepublishOnly": "npm run test && npm run lint",
@@ -46,6 +46,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.7.0",
     "lint-staged": "^13.2.1",
     "prettier": "^2.8.7",
     "rimraf": "^5.0.0",