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

package/dist/locale/en.json

@@ -172,33 +172,73 @@
         "ADD_TOPIC_INFO": "Add topic to communicate what this item is about."
     },
     "featureLayerFieldAliases": {
-        "GUIDANCE_DEFAULT": "Field aliases are the user-friendly, human-readable names of the fields in your feature service.",
-        "SCORING_MSG_DEFAULT": "Points are awarded if 90% or more of the fields in each feature layer of the feature service have aliases defined.",
+        "GUIDANCE_DEFAULT": "<p>By default, most layers start out using the field <strong>Names</strong> as the field <strong>Aliases</strong>, making them identical. This puts the burden on each user to translate each Field Name to a useful Field Alias (sometimes shown as Display Name). If, as the the owner of this item, you provide Field Aliases now, it cumulatively saves hundreds or thousands of hours of work for others who find your layer and want to use it. By putting this additional metadata &quot;on board&quot; the layer, users do not have to go find that information in metadata documents since the information is already present. As a result, each user can learn what this field represents simply by reading the Field Alias in all the places where it appears: map legend, pop-up, data table, all interfaces where the user is asked to choose a field.</p><br/><p>From the item page, go to the <strong>Data</strong> tab, click on <strong>Fields</strong> button, and click on the first field under the column <strong>Display Name</strong>. To edit the <strong>Field Alias</strong> (also referred to as <strong>Display Name</strong>), click the pencil button and enter an easy to understand Field Alias / Display Name. Tip: copy/paste content from a data dictionary, an official metadata document or PDF that describes each field.</p><br/><p><strong>Examples:</strong> in the Field Alias text, change &quot;LASTEDITOR&quot; to &quot;Last Editor&quot;; change &quot;FEATURECODE&quot; to &quot;Facility Site Code&quot;; change &quot;NUMSTORIES&quot; to &quot;Number of Stories.&quot; Note how the Field Name remains unchanged.</p><br/><p>If your item has more than one layer, you will need to set Field Aliases on each layer.</p>",
+        "SCORING_MSG_DEFAULT": "Points are awarded if 90% of Field Aliases (Display Names) are edited such that they are no longer identical to the Field Names. If your item has more than one layer, be sure to edit all layers.",
         "LABEL": "Improve Field Aliases",
         "TITLE": "Check Field Aliases",
-        "ADD_FIELD_ALIAS": "Add field aliases to your feature service.",
         "IMPROVE_FIELD_ALIAS": "Improve field aliases in your feature service.",
         "NO_FEATURE_LAYER": "This feature service does not have any feature layer or non-spatial table.",
         "NO_RELEVANT_FIELD": "This feature service does not have any relevant fields (non-system generated) to validate."
     },
     "featureLayerFieldTypes": {
-        "GUIDANCE_DEFAULT": "Field types are the data types of the fields in your feature layer.",
-        "SCORING_MSG_DEFAULT": "Points are awarded if 90% or more of the fields in each feature layer of the feature service have value types defined.",
+        "GUIDANCE_DEFAULT": "<p>To help users and client apps identify how field values should be used or represented, define the types of values that are stored in each attribute field in a hosted feature layer. For example, if you define a text field as a phone number, client apps can format the text in the appropriate manner, such as (123) 456-7890. ArcGIS Online uses field value types to show you the most relevant options when drawing a layer in a map or configuring pop-ups. See the <a href=\"https://doc.arcgis.com/en/arcgis-online/manage-data/describe-fields.htm\" target=\"_blank\">Field Value Types listed here</a>.</p><br/><p>By default, a layer usually does not contain a <strong>Field Value Type</strong> on its attribute fields. This is a missed opportunity to share additional context about what type of value is stored in the field. This puts the burden on each user to go find a metadata document, if available, so that they can learn what exactly is stored in that field. If, as the owner of this item, you provide Field Value Types now, it cumulatively saves hundreds or thousands of hours of work for others who find your layer and want to use it. By putting this additional metadata \"on board\" the layer, users do not have to go find that information in metadata documents since the information is already present. As a result, each user can learn a key detail about what this field represents simply by reading the Field Value Type in all the places where it appears, e.g. when the user clicks on a field information button. It also helps software developers to detect whether a field value will contain a count, percent, measurement etc.</p><br/><p>From the item page, go to the <strong>Data</strong> tab, click on <strong>Fields</strong> button, and click on the first field under the column <strong>Display Name</strong>. To edit the <strong>Field Value Type</strong>, click the pencil button and edit the Field Value Type so that it represents what kinds of values the field contains.</p><br/><p>If your item has more than one layer, you will need to set Field Value Types on each layer.</p",
+        "SCORING_MSG_DEFAULT": "Points are awarded if 90% of Field Value Types are set to a value. If your item has more than one layer, be sure to edit all layers.",
         "LABEL": "Improve Field Value Types",
         "TITLE": "Check Field Value Types",
-        "ADD_FIELD_TYPE": "Add field types to your feature service.",
-        "IMRPOVE_FIELD_TYPE": "Improve field types in your feature service.",
+        "IMRPOVE_FIELD_TYPE": "Improve field value types in your feature service.",
         "NO_FEATURE_LAYER": "This feature service does not have any feature layer or non-spatial table.",
         "NO_RELEVANT_FIELD": "This feature service does not have any relevant fields (non-system generated) to validate."
     },
     "featureLayerFieldDescriptions": {
-        "GUIDANCE_DEFAULT": "Field descriptions are the descriptions of the fields in your feature service.",
-        "SCORING_MSG_DEFAULT": "Points are awarded if 90% or more of the fields in each feature layer of the feature service have description defined.",
+        "GUIDANCE_DEFAULT": "<p>By default, a layer usually does not contain a <strong>Field Description</strong> on its attribute fields. This puts the burden on each user to go find a metadata document, if available, so that they can learn what exactly is stored in that field. If, as the the owner of this item, you provide Field Descriptions now, it cumulatively saves hundreds or thousands of hours of work for others who find your layer and want to use it. By putting this additional metadata &quot;on board&quot; the layer, users do not have to go find that information in metadata documents since the information is already present. As a result, each user can learn the details about what this field represents simply by reading the Field Description in all the places where it appears, e.g. when the user clicks on a field information button.</p><br/><p>From the item page, go to the <strong>Data</strong> tab, click on <strong>Fields</strong> button, and click on the first field under the column <strong>Display Name</strong>. To edit the <strong>Field Description</strong>, click the pencil button and edit the description so that it explains what the field contains. Tip: copy/paste content from a data dictionary, an official metadata document or PDF that describes each field.</p><br/><p>If your item has more than one layer, you will need to set Field Descriptions on each layer.</p>",
+        "SCORING_MSG_DEFAULT": "Points are awarded if 90% of Field Descriptions contain a sentence or more of information describing the attribute. The Field Description must be different than the field alias. If your item has more than one layer, be sure to edit all layers.",
         "LABEL": "Improve Field Descriptions",
         "TITLE": "Check Field Descriptions",
-        "ADD_FIELD_DESCRIPTION": "Add field descriptions to your feature service.",
         "IMRPOVE_FIELD_DESCRIPTION": "Improve field descriptions in your feature service.",
         "NO_FEATURE_LAYER": "This feature service does not have any feature layer or non-spatial table.",
         "NO_RELEVANT_FIELD": "This feature service does not have any relevant fields (non-system generated) to validate."
+    },
+    "itemExtent": {
+        "GUIDANCE_DEFAULT": "The item extent defines the bounding rectangle of the item. It is primarily used in search results whenever a user chooses to search based on current map extent. Extent values should always be in WGS84. The item extent is shown visually so that you can confirm it is set correctly for this item.",
+        "SCORING_MSG_DEFAULT": "Points are awarded if the item has a valid extent.",
+        "LABEL": "Set a valid item extent",
+        "TITLE": "Check Item Extent",
+        "NO_EXTENT_MESSAGE": "Extent is not set. Set a valid item extent.",
+        "INVALID_EXTENT_MESSAGE": "Extent is not valid. Set a valid item extent.",
+        "EXTENT_OUT_OF_RANGE_MESSAGE": "Extent is out of range. Update the item extent to a more appropriate value.",
+        "EXTENT_NOT_RECTANGLE_MESSAGE": "Extent is not a rectangle. Update the item extent to a valid rectangle.",
+        "EXTENT_IS_POINT_MESSAGE": "Extent is a point. Update the item extent to a more appropriate value.",
+        "EXTENT_SET_TO_WORLD_MESSAGE": "Extent is set to the world. Update the item extent to a more appropriate value."
+    },
+    "featureServiceCDNSetting": {
+        "GUIDANCE_DEFAULT": "When a layer is shared publicly, it is cached by a Content Delivery Network (CDN). Using a CDN enhances performance and scalability by delivering content from servers geographically closer to users, significantly reducing latency. If the data is not changing daily, it is recommended to set the cache duration to the maximum (one hour) for best performance.",
+        "SCORING_MSG_DEFAULT": "This is an advisory check that does not impact the overall score.",
+        "LABEL": "Enable Feature Service CDN Cache",
+        "TITLE": "Check CDN Setting",
+        "CDN_NOT_ENABLED_MESSAGE": "Enable CDN for the feature service to improve performance and scalability."
+    },
+    "featureServiceExportDataSetting": {
+        "GUIDANCE": "Enabling data export allows others to export the data from your feature service to other formats (e.g. CSV, File Geodatabase, GeoJSON, etc.). Verify that this setting is correct and that it complies with your organization's data sharing, licensing, and privacy policies.",
+        "SCORING": "This is an advisory check that does not impact the overall score.",
+        "LABEL": "Verify Feature Service Data Export Setting",
+        "TITLE": "Check Data Export Setting",
+        "EXPORT_DATA_ENABLED_MESSAGE": "Data export is enabled. Confirm this setting is intentional and that it complies with your organization's data sharing, licensing, and privacy policies."
+    },
+    "featureServiceFieldIndexes": {
+        "GUIDANCE": "Field indexes improve the performance of queries and operations on large datasets. By indexing frequently queried fields, you can significantly speed up data retrieval times and enhance overall application performance. It is recommended to review your feature service's fields and add indexes to those that are commonly used in queries, filters, or sorting operations.",
+        "SCORING": "This is an advisory check that does not impact the overall score.",
+        "LABEL": "Improve Feature Service Field Indexes",
+        "TITLE": "Check Field Indexes",
+        "NO_FEATURE_LAYER": "This feature service does not have any feature layer or non-spatial table.",
+        "IMRPOVE_FIELD_INDEXES": "No non-system generated field indexes found in layer '{{layerName}}'. Consider adding field indexes to frequently queried fields to improve performance."
+    },
+    "featureServiceExtents": {
+        "GUIDANCE": "<p>This advisory check examines your REST endpoint. A feature layer item points to a REST endpoint, which has an Initial Extent and Full Extent on its service, and an Extent on each sublayer in that service. Review each extent in the “Select Extent” option below to ensure your extents are what you would expect.</p><br/><p>If a sublayer is missing an Extent, that layer will cause an error in any geoprocessing tool or function.</p><br/><p>If the service is missing an Initial Extent or Full Extent, that may have negative impacts in apps.</p>",
+        "SCORING": "This is an advisory check that does not impact the overall score. Make sure all extents are populated.",
+        "LABEL": "Verify Feature Service Extents",
+        "TITLE": "Check Feature Service Extents",
+        "FULL_EXTENT_ISSUE_MESSAGE": "The Full Extent of the Feature Service is not set or is invalid.",
+        "INITIAL_EXTENT_ISSUE_MESSAGE": "The Initial Extent of the Feature Service is not set or is invalid.",
+        "LAYER_EXTENT_ISSUE_MESSAGE": "The Extent of layer '{{layerName}}' is not set or is invalid."
     }
 }

package/dist/package-info.json

@@ -1 +1 @@
-{"lastCompiledTime":1749141674753}
+{"lastCompiledTime":1764869234420}

package/dist/services/feature-service/fetchFeatureServiceAdminJSON.d.ts

@@ -0,0 +1,14 @@
+import { FeatureServiceAdminJSON, IItem } from '../../types';
+/**
+ * Fetches the admin JSON of a feature service. This resource provides basic information about the feature service including the feature layers and tables that it contains, the service description, etc.
+ * The administrative feature service resource maintains a set of operations that manage the state and contents of the service.
+ *
+ * @param item - The item representing the feature service.
+ * @param token - The token for authentication.
+ * @param bypassCache - Whether to bypass the cache (default is false). If true, a query timestamp is added to the request to bypass any cached responses.
+ * @returns A promise that resolves to a FeatureServiceAdminJSON object.
+ * @throws An error if the item is not a feature service or if the URL is not found.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/#json-response-syntax
+ */
+export declare const fetchFeatureServiceAdminJSON: (item: IItem, token: string, bypassCache?: boolean) => Promise<FeatureServiceAdminJSON>;

package/dist/services/feature-service/fetchFeatureServiceAdminJSON.js

@@ -0,0 +1,57 @@
+"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.fetchFeatureServiceAdminJSON = void 0;
+const isFeatureService_1 = require("../../lib/util/isFeatureService");
+const getFeatureServerURL_1 = require("./getFeatureServerURL");
+/**
+ * Fetches the admin JSON of a feature service. This resource provides basic information about the feature service including the feature layers and tables that it contains, the service description, etc.
+ * The administrative feature service resource maintains a set of operations that manage the state and contents of the service.
+ *
+ * @param item - The item representing the feature service.
+ * @param token - The token for authentication.
+ * @param bypassCache - Whether to bypass the cache (default is false). If true, a query timestamp is added to the request to bypass any cached responses.
+ * @returns A promise that resolves to a FeatureServiceAdminJSON object.
+ * @throws An error if the item is not a feature service or if the URL is not found.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/hosted-feature-service/#json-response-syntax
+ */
+const fetchFeatureServiceAdminJSON = (item_1, token_1, ...args_1) => __awaiter(void 0, [item_1, token_1, ...args_1], void 0, function* (item, token, bypassCache = false) {
+    if (!item) {
+        throw new Error('Item is required');
+    }
+    if ((0, isFeatureService_1.isFeatureService)(item) === false) {
+        throw new Error('Item is not a feature service');
+    }
+    if (!item.url) {
+        throw new Error('URL of the feature service is not found');
+    }
+    if (!token) {
+        throw new Error('Token is required to access admin endpoint');
+    }
+    // get the feature server URL
+    const url = (0, getFeatureServerURL_1.getFeatureServerRootURL)(item.url, true);
+    const params = new URLSearchParams({
+        f: 'json',
+        token,
+    });
+    if (bypassCache) {
+        params.append('queryTimestamp', new Date().getTime().toString());
+    }
+    const res = yield fetch(`${url}?${params.toString()}`);
+    const data = yield res.json();
+    if (data.error) {
+        throw new Error(data.error.message || 'Error fetching feature service admin JSON');
+    }
+    return data;
+});
+exports.fetchFeatureServiceAdminJSON = fetchFeatureServiceAdminJSON;
+//# sourceMappingURL=fetchFeatureServiceAdminJSON.js.map

package/dist/services/feature-service/fetchFeatureServiceAdminJSON.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchFeatureServiceAdminJSON.js","sourceRoot":"","sources":["../../../src/services/feature-service/fetchFeatureServiceAdminJSON.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sEAAmE;AAEnE,+DAAgE;AAEhE;;;;;;;;;;;GAWG;AACI,MAAM,4BAA4B,GAAG,6BAIR,EAAE,oEAHlC,IAAW,EACX,KAAa,EACb,WAAW,GAAG,KAAK;IAEnB,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,IAAA,mCAAgB,EAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAClE,CAAC;IAED,6BAA6B;IAC7B,MAAM,GAAG,GAAG,IAAA,6CAAuB,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QAC/B,CAAC,EAAE,MAAM;QACT,KAAK;KACR,CAAC,CAAC;IAEH,IAAI,WAAW,EAAE,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAE9B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,2CAA2C,CACpE,CAAC;IACN,CAAC;IAED,OAAO,IAA+B,CAAC;AAC3C,CAAC,CAAA,CAAC;AA3CW,QAAA,4BAA4B,gCA2CvC"}

package/dist/services/feature-service/fetchFeatureServiceLayersAndTables.d.ts

@@ -1,9 +1,14 @@
 import { FeatureLayerJSON, IItem } from '../../types';
 /**
- * Fetches the layers of a feature service from the ArcGIS REST API.
- * @param item - The item representing the feature service.
- * @param token - The token for authentication.
- * @returns A promise that resolves to an array of FeatureLayerJSON objects.
- * @throws An error if the item is not a feature service or if the URL is not found.
+ * Fetches the layers and tables from a given feature service item.
+ *
+ * Attempts to retrieve the feature service layers and tables using the provided authentication token.
+ * If an 'Invalid token' error is encountered, it retries the request without the token.
+ *
+ * @param item - The feature service item to fetch layers and tables from.
+ * @param token - The authentication token to use for the request.
+ * @param bypassCache - Optional flag to bypass any caching mechanisms. Defaults to false.
+ * @returns A promise that resolves to an array of `FeatureLayerJSON` objects representing the layers and tables.
+ * @throws Will throw an error if fetching fails, including after retrying without a token.
  */
-export declare const fetchFeatureServiceLayersAndTables: (item: IItem, token: string) => Promise<FeatureLayerJSON[]>;
+export declare const fetchFeatureServiceLayersAndTables: (item: IItem, token: string, bypassCache?: boolean) => Promise<FeatureLayerJSON[]>;

package/dist/services/feature-service/fetchFeatureServiceLayersAndTables.js

@@ -11,15 +11,51 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchFeatureServiceLayersAndTables = void 0;
 const isFeatureService_1 = require("../../lib/util/isFeatureService");
+const getFeatureServerURL_1 = require("./getFeatureServerURL");
+/**
+ * Fetches the layers and tables from a given feature service item.
+ *
+ * Attempts to retrieve the feature service layers and tables using the provided authentication token.
+ * If an 'Invalid token' error is encountered, it retries the request without the token.
+ *
+ * @param item - The feature service item to fetch layers and tables from.
+ * @param token - The authentication token to use for the request.
+ * @param bypassCache - Optional flag to bypass any caching mechanisms. Defaults to false.
+ * @returns A promise that resolves to an array of `FeatureLayerJSON` objects representing the layers and tables.
+ * @throws Will throw an error if fetching fails, including after retrying without a token.
+ */
+const fetchFeatureServiceLayersAndTables = (item_1, token_1, ...args_1) => __awaiter(void 0, [item_1, token_1, ...args_1], void 0, function* (item, token, bypassCache = false) {
+    try {
+        return yield fetchFeatureServiceLayersAndTablesHelper(item, token, bypassCache);
+    }
+    catch (error) {
+        // Check for 'Invalid token' error and retry without token
+        if (error instanceof Error &&
+            error.message &&
+            error.message.toLowerCase().includes('invalid token')) {
+            try {
+                console.warn('Invalid token error detected while fetching feature service layers. Retrying without token...');
+                return yield fetchFeatureServiceLayersAndTablesHelper(item, undefined, bypassCache);
+            }
+            catch (retryError) {
+                console.error('Error fetching feature service layers and tables after retry:', retryError);
+                throw retryError;
+            }
+        }
+        console.error('Error fetching feature service layers and tables:', error);
+        throw error; // rethrow the error for the caller to handle
+    }
+});
+exports.fetchFeatureServiceLayersAndTables = fetchFeatureServiceLayersAndTables;
 /**
  * Fetches the layers of a feature service from the ArcGIS REST API.
  * @param item - The item representing the feature service.
  * @param token - The token for authentication.
+ * @param bypassCache - Whether to bypass the cache (default is false). If true, a query timestamp is added to the request to bypass any cached responses.
  * @returns A promise that resolves to an array of FeatureLayerJSON objects.
  * @throws An error if the item is not a feature service or if the URL is not found.
  */
-const fetchFeatureServiceLayersAndTables = (item, token) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
+const fetchFeatureServiceLayersAndTablesHelper = (item_1, token_1, ...args_1) => __awaiter(void 0, [item_1, token_1, ...args_1], void 0, function* (item, token, bypassCache = false) {
     if (!item) {
         throw new Error('Item is required');
     }
@@ -29,21 +65,25 @@ const fetchFeatureServiceLayersAndTables = (item, token) => __awaiter(void 0, vo
     if (!item.url) {
         throw new Error('URL of the feature service is not found');
     }
-    try {
-        const res = yield fetch(`${item.url}/layers?f=json&token=${token}`);
-        const data = yield res.json();
-        if (data.error) {
-            throw new Error('Error fetching feature service data: ' +
-                (((_a = data === null || data === void 0 ? void 0 : data.error) === null || _a === void 0 ? void 0 : _a.message) || 'Unknown error'));
-        }
-        const layers = data.layers || [];
-        const tables = data.tables || [];
-        const layersAndTables = [...layers, ...tables];
-        return layersAndTables;
+    // get the feature server URL
+    const url = (0, getFeatureServerURL_1.getFeatureServerRootURL)(item.url);
+    const params = new URLSearchParams({
+        f: 'json',
+    });
+    if (token) {
+        params.append('token', token);
     }
-    catch (error) {
-        throw new Error('Error fetching feature service data: ' + error);
+    if (bypassCache) {
+        params.append('queryTimestamp', new Date().getTime().toString());
+    }
+    const res = yield fetch(`${url}/layers?${params.toString()}`);
+    const data = yield res.json();
+    if (data.error) {
+        throw new Error(data.error.message || 'Error fetching feature service layers');
     }
+    const layers = data.layers || [];
+    const tables = data.tables || [];
+    const layersAndTables = [...layers, ...tables];
+    return layersAndTables;
 });
-exports.fetchFeatureServiceLayersAndTables = fetchFeatureServiceLayersAndTables;
 //# sourceMappingURL=fetchFeatureServiceLayersAndTables.js.map

package/dist/services/feature-service/fetchFeatureServiceLayersAndTables.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchFeatureServiceLayersAndTables.js","sourceRoot":"","sources":["../../../src/services/feature-service/fetchFeatureServiceLayersAndTables.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sEAAmE;AAQnE;;;;;;GAMG;AACI,MAAM,kCAAkC,GAAG,CAC9C,IAAW,EACX,KAAa,EACc,EAAE;;IAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,IAAA,mCAAgB,EAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACpE,MAAM,IAAI,GAAiC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAE5D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACX,uCAAuC;gBACnC,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,OAAO,KAAI,eAAe,CAAC,CAChD,CAAC;QACN,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAEjC,MAAM,eAAe,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;QAE/C,OAAO,eAAe,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,KAAK,CAAC,CAAC;IACrE,CAAC;AACL,CAAC,CAAA,CAAC;AApCW,QAAA,kCAAkC,sCAoC7C"}
+{"version":3,"file":"fetchFeatureServiceLayersAndTables.js","sourceRoot":"","sources":["../../../src/services/feature-service/fetchFeatureServiceLayersAndTables.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,sEAAmE;AAOnE,+DAAgE;AAEhE;;;;;;;;;;;GAWG;AACI,MAAM,kCAAkC,GAAG,6BAInB,EAAE,oEAH7B,IAAW,EACX,KAAa,EACb,WAAW,GAAG,KAAK;IAEnB,IAAI,CAAC;QACD,OAAO,MAAM,wCAAwC,CACjD,IAAI,EACJ,KAAK,EACL,WAAW,CACd,CAAC;IACN,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,0DAA0D;QAC1D,IACI,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,OAAO;YACb,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EACvD,CAAC;YACC,IAAI,CAAC;gBACD,OAAO,CAAC,IAAI,CACR,+FAA+F,CAClG,CAAC;gBACF,OAAO,MAAM,wCAAwC,CACjD,IAAI,EACJ,SAAS,EACT,WAAW,CACd,CAAC;YACN,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CACT,+DAA+D,EAC/D,UAAU,CACb,CAAC;gBACF,MAAM,UAAU,CAAC;YACrB,CAAC;QACL,CAAC;QACD,OAAO,CAAC,KAAK,CACT,mDAAmD,EACnD,KAAK,CACR,CAAC;QACF,MAAM,KAAK,CAAC,CAAC,6CAA6C;IAC9D,CAAC;AACL,CAAC,CAAA,CAAC;AAzCW,QAAA,kCAAkC,sCAyC7C;AAEF;;;;;;;GAOG;AACH,MAAM,wCAAwC,GAAG,6BAIlB,EAAE,oEAH7B,IAAW,EACX,KAAa,EACb,WAAW,GAAG,KAAK;IAEnB,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,IAAA,mCAAgB,EAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IAED,6BAA6B;IAC7B,MAAM,GAAG,GAAG,IAAA,6CAAuB,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QAC/B,CAAC,EAAE,MAAM;KACZ,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,WAAW,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAiC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAE5D,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,uCAAuC,CAChE,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;IAEjC,MAAM,eAAe,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAE/C,OAAO,eAAe,CAAC;AAC3B,CAAC,CAAA,CAAC"}

package/dist/services/feature-service/fetchFeatureServiceRootJSON.d.ts

@@ -0,0 +1,16 @@
+import { FeatureServiceJSON, IItem } from '../../types';
+/**
+ * Fetches the root JSON of a feature service. This resource provides basic information about the feature service,
+ * including the feature layers and tables that it contains, the service description, and so on.
+ *
+ * If an 'Invalid token' error is encountered, it retries the request without the token.
+ *
+ * @param item - The item representing the feature service.
+ * @param token - The token for authentication.
+ * @param bypassCache - Whether to bypass the cache (default is false). If true, a query timestamp is added to the request to bypass any cached responses.
+ * @returns {FeatureServiceJSON} A promise that resolves to a FeatureServiceJSON object.
+ * @throws An error if the item is not a feature service or if the URL is not found.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service/
+ */
+export declare const fetchFeatureServiceRootJSON: (item: IItem, token: string, bypassCache?: boolean) => Promise<FeatureServiceJSON>;

package/dist/services/feature-service/fetchFeatureServiceRootJSON.js

@@ -0,0 +1,84 @@
+"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.fetchFeatureServiceRootJSON = void 0;
+const isFeatureService_1 = require("../../lib/util/isFeatureService");
+const getFeatureServerURL_1 = require("./getFeatureServerURL");
+/**
+ * Fetches the root JSON of a feature service. This resource provides basic information about the feature service,
+ * including the feature layers and tables that it contains, the service description, and so on.
+ *
+ * If an 'Invalid token' error is encountered, it retries the request without the token.
+ *
+ * @param item - The item representing the feature service.
+ * @param token - The token for authentication.
+ * @param bypassCache - Whether to bypass the cache (default is false). If true, a query timestamp is added to the request to bypass any cached responses.
+ * @returns {FeatureServiceJSON} A promise that resolves to a FeatureServiceJSON object.
+ * @throws An error if the item is not a feature service or if the URL is not found.
+ *
+ * @see https://developers.arcgis.com/rest/services-reference/enterprise/feature-service/
+ */
+const fetchFeatureServiceRootJSON = (item_1, token_1, ...args_1) => __awaiter(void 0, [item_1, token_1, ...args_1], void 0, function* (item, token, bypassCache = false) {
+    try {
+        return yield fetchFeatureServiceRootHelper(item, token, bypassCache);
+    }
+    catch (error) {
+        // Check for 'Invalid token' error and retry without token
+        if (error instanceof Error &&
+            error.message &&
+            error.message.toLowerCase().includes('invalid token')) {
+            try {
+                console.warn('Invalid token error detected while fetching feature service root JSON. Retrying without token...');
+                return yield fetchFeatureServiceRootHelper(item, undefined, bypassCache);
+            }
+            catch (retryError) {
+                console.error('Error fetching feature service root JSON retry:', retryError);
+                throw retryError;
+            }
+        }
+        console.error('Error fetching feature service layers and tables:', error);
+        throw error; // rethrow the error for the caller to handle
+    }
+});
+exports.fetchFeatureServiceRootJSON = fetchFeatureServiceRootJSON;
+const fetchFeatureServiceRootHelper = (item_1, token_1, ...args_1) => __awaiter(void 0, [item_1, token_1, ...args_1], void 0, function* (item, token, bypassCache = false) {
+    if (!item) {
+        throw new Error('Item is required');
+    }
+    if ((0, isFeatureService_1.isFeatureService)(item) === false) {
+        throw new Error('Item is not a feature service');
+    }
+    if (!item.url) {
+        throw new Error('URL of the feature service is not found');
+    }
+    // if (!token) {
+    //     throw new Error('Token is required to access admin endpoint');
+    // }
+    // get the feature server URL
+    const url = (0, getFeatureServerURL_1.getFeatureServerRootURL)(item.url);
+    const params = new URLSearchParams({
+        f: 'json',
+        // token,
+    });
+    if (token) {
+        params.append('token', token);
+    }
+    if (bypassCache) {
+        params.append('queryTimestamp', new Date().getTime().toString());
+    }
+    const res = yield fetch(`${url}?${params.toString()}`);
+    const data = yield res.json();
+    if (data.error) {
+        throw new Error(data.error.message || 'Error fetching feature service admin JSON');
+    }
+    return data;
+});
+//# sourceMappingURL=fetchFeatureServiceRootJSON.js.map

package/dist/services/feature-service/fetchFeatureServiceRootJSON.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchFeatureServiceRootJSON.js","sourceRoot":"","sources":["../../../src/services/feature-service/fetchFeatureServiceRootJSON.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sEAAmE;AAEnE,+DAAgE;AAEhE;;;;;;;;;;;;;GAaG;AACI,MAAM,2BAA2B,GAAG,6BAIZ,EAAE,oEAH7B,IAAW,EACX,KAAa,EACb,WAAW,GAAG,KAAK;IAEnB,IAAI,CAAC;QACD,OAAO,MAAM,6BAA6B,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,0DAA0D;QAC1D,IACI,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,OAAO;YACb,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EACvD,CAAC;YACC,IAAI,CAAC;gBACD,OAAO,CAAC,IAAI,CACR,kGAAkG,CACrG,CAAC;gBACF,OAAO,MAAM,6BAA6B,CACtC,IAAI,EACJ,SAAS,EACT,WAAW,CACd,CAAC;YACN,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CACT,iDAAiD,EACjD,UAAU,CACb,CAAC;gBACF,MAAM,UAAU,CAAC;YACrB,CAAC;QACL,CAAC;QACD,OAAO,CAAC,KAAK,CACT,mDAAmD,EACnD,KAAK,CACR,CAAC;QACF,MAAM,KAAK,CAAC,CAAC,6CAA6C;IAC9D,CAAC;AACL,CAAC,CAAA,CAAC;AArCW,QAAA,2BAA2B,+BAqCtC;AAEF,MAAM,6BAA6B,GAAG,6BAIP,EAAE,oEAH7B,IAAW,EACX,KAAa,EACb,WAAW,GAAG,KAAK;IAEnB,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,IAAA,mCAAgB,EAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB;IAChB,qEAAqE;IACrE,IAAI;IAEJ,6BAA6B;IAC7B,MAAM,GAAG,GAAG,IAAA,6CAAuB,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;QAC/B,CAAC,EAAE,MAAM;QACT,SAAS;KACZ,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAE9B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACX,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,2CAA2C,CACpE,CAAC;IACN,CAAC;IAED,OAAO,IAA0B,CAAC;AACtC,CAAC,CAAA,CAAC"}

package/dist/services/feature-service/getFeatureServerURL.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns the URL of the FeatureServer endpoint for a given item URL.
+ *
+ * - If the input URL is empty or falsy, returns an empty string.
+ * - If the URL already ends with '/FeatureServer', returns it as is.
+ * - If the URL ends with a trailing slash, removes it.
+ * - If the URL ends with a layer or table index (e.g., '/0'), removes the index.
+ *
+ * @param itemUrl - The URL of the item to process.
+ * @returns The normalized FeatureServer URL.
+ */
+export declare const getFeatureServerRootURL: (itemUrl: string, amdinEndPoint?: boolean) => string;

package/dist/services/feature-service/getFeatureServerURL.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFeatureServerRootURL = void 0;
+const getFeatureServerAdminRootURL = (itemUrl) => {
+    if (!itemUrl) {
+        return '';
+    }
+    itemUrl = itemUrl.replace(/\/rest\/services/i, '/rest/admin/services');
+    return itemUrl;
+};
+/**
+ * Returns the URL of the FeatureServer endpoint for a given item URL.
+ *
+ * - If the input URL is empty or falsy, returns an empty string.
+ * - If the URL already ends with '/FeatureServer', returns it as is.
+ * - If the URL ends with a trailing slash, removes it.
+ * - If the URL ends with a layer or table index (e.g., '/0'), removes the index.
+ *
+ * @param itemUrl - The URL of the item to process.
+ * @returns The normalized FeatureServer URL.
+ */
+const getFeatureServerRootURL = (itemUrl, amdinEndPoint = false) => {
+    if (!itemUrl) {
+        return '';
+    }
+    if (itemUrl.endsWith('/FeatureServer')) {
+        return amdinEndPoint ? getFeatureServerAdminRootURL(itemUrl) : itemUrl; // Return as is if it already ends with /FeatureServer
+    }
+    if (itemUrl.endsWith('/')) {
+        itemUrl = itemUrl.slice(0, -1); // Remove trailing slash
+    }
+    // /\/\d+$/ matches a forward slash (/) followed by one or more digits (\d+) at the end of the string ($).
+    itemUrl = itemUrl.replace(/\/\d+$/, '');
+    return amdinEndPoint ? getFeatureServerAdminRootURL(itemUrl) : itemUrl;
+};
+exports.getFeatureServerRootURL = getFeatureServerRootURL;
+//# sourceMappingURL=getFeatureServerURL.js.map

package/dist/services/feature-service/getFeatureServerURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFeatureServerURL.js","sourceRoot":"","sources":["../../../src/services/feature-service/getFeatureServerURL.ts"],"names":[],"mappings":";;;AAAA,MAAM,4BAA4B,GAAG,CAAC,OAAe,EAAU,EAAE;IAC7D,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACd,CAAC;IAED,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,CAAC;IAEvE,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,uBAAuB,GAAG,CACnC,OAAe,EACf,aAAa,GAAG,KAAK,EACf,EAAE;IACR,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACd,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACrC,OAAO,aAAa,CAAC,CAAC,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,sDAAsD;IAClI,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;IAC5D,CAAC;IAED,0GAA0G;IAC1G,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAExC,OAAO,aAAa,CAAC,CAAC,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AAC3E,CAAC,CAAC;AApBW,QAAA,uBAAuB,2BAoBlC"}