@esri/hub-common 9.22.0 → 9.23.2

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.21.2 - Tue Mar 01 2022 21:10:25 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.23.1 - Fri Mar 18 2022 14:46:12 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6067,6 +6067,70 @@
                 })));
     }
 
+    /* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+     * Apache-2.0 */
+    /**
+     * ```js
+     * import { queryFeatures } from '@esri/arcgis-rest-feature-layer';
+     * //
+     * queryFeatures({
+     *   url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3",
+     *   where: "STATE_NAME = 'Alaska'"
+     * })
+     *   .then(result)
+     * ```
+     * Query a feature service. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+     *
+     * @param requestOptions - Options for the request
+     * @returns A Promise that will resolve with the query response.
+     */
+    function queryFeatures(requestOptions) {
+        var queryOptions = appendCustomParams(requestOptions, [
+            "where",
+            "objectIds",
+            "relationParam",
+            "time",
+            "distance",
+            "units",
+            "outFields",
+            "geometry",
+            "geometryType",
+            "spatialRel",
+            "returnGeometry",
+            "maxAllowableOffset",
+            "geometryPrecision",
+            "inSR",
+            "outSR",
+            "gdbVersion",
+            "returnDistinctValues",
+            "returnIdsOnly",
+            "returnCountOnly",
+            "returnExtentOnly",
+            "orderByFields",
+            "groupByFieldsForStatistics",
+            "outStatistics",
+            "returnZ",
+            "returnM",
+            "multipatchOption",
+            "resultOffset",
+            "resultRecordCount",
+            "quantizationParameters",
+            "returnCentroid",
+            "resultType",
+            "historicMoment",
+            "returnTrueCurves",
+            "sqlFormat",
+            "returnExceededLimitFeatures",
+            "f"
+        ], {
+            httpMethod: "GET",
+            params: __assign({ 
+                // set default query parameters
+                where: "1=1", outFields: "*" }, requestOptions.params)
+        });
+        return request(cleanUrl(requestOptions.url) + "/query", queryOptions);
+    }
+
     /* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
      * Apache-2.0 */
     var serviceRegex = new RegExp(/.+(?:map|feature|image)server/i);
@@ -6953,8 +7017,8 @@
 
     // helper fns - move this to _internal if needed elsewhere
     var getOnlyQueryLayer = function (layers) {
-        var layer = layers && layers.length === 1 && layers[0];
-        return layer && layer.capabilities.includes("Query") && layer;
+        var layer = layers && layers.length === 1 ? layers[0] : undefined;
+        return layer && layer.capabilities.includes("Query") ? layer : undefined;
     };
     var shouldUseLayerInfo = function (layer, layers, url) {
         return (layer &&
@@ -6963,6 +7027,13 @@
             // we use item info instead of layer info for single layer items
             !getLayerIdFromUrl(url));
     };
+    // this logic adapted from hub-indexer's determineName(), see
+    // https://github.com/ArcGIS/hub-indexer/blob/8f4dd6f928124c1f35dd02bc11bd996191ee1160/packages/duke/compose/common.js#L7-L34
+    var getContentName = function (item, layer, layers) {
+        return ((shouldUseLayerInfo(layer, layers, item.url)
+            ? layer.name
+            : item.title || item.name) || "").replace(/_/g, " ");
+    };
     /**
      * The possible values for updateFrequency
      *
@@ -7315,6 +7386,38 @@
         var flattened = parsed.reduce(function (acc, arr, _) { return __spreadArrays(acc, arr); }, []);
         return flattened.filter(function (cat) { return !includes(exclude, cat.toLowerCase()); });
     }
+    /**
+     * get the layer object for
+     * - an item that refers to a specific layer of a service
+     * - a multi-layer services (if a layer id was passed in)
+     * - a single layer feature service
+     * @param item
+     * @param layers the layers and tables returned from the service
+     * @param layerId a specific id
+     * @returns layer definition
+     * @private
+     */
+    var getItemLayer = function (item, layers, layerId) {
+        // if item refers to a layer we always want to use that layer id
+        // otherwise use the layer id that was passed in (if any)
+        var _layerIdFromUrl = getLayerIdFromUrl(item.url);
+        var _layerId = _layerIdFromUrl ? parseInt(_layerIdFromUrl, 10) : layerId;
+        return (layers &&
+            (!isNil(_layerId)
+                ? // find the explicitly set layer id
+                    layers.find(function (_layer) { return _layer.id === _layerId; })
+                : // for feature servers with a single layer always show the layer
+                    isFeatureService(item.type) && getOnlyQueryLayer(layers)));
+    };
+    /**
+     * determine if a layer is a layer view
+     * @param layer
+     * @returns
+     * @private
+     */
+    var isLayerView = function (layer) {
+        return layer.isView;
+    };
     /**
      * Compose a new content object out of an item, enrichments, and context
      * @param item
@@ -7325,18 +7428,7 @@
         // extract enrichments and context out of the options
         var _a = options || {}, slug = _a.slug, requestOptions = _a.requestOptions, data = _a.data, metadata = _a.metadata, groupIds = _a.groupIds, ownerUser = _a.ownerUser, org = _a.org, errors = _a.errors, server = _a.server, layers = _a.layers, recordCount = _a.recordCount, boundary = _a.boundary, extent = _a.extent, searchDescription = _a.searchDescription, statistics = _a.statistics;
         // set common variables that we will use in the derived properties below
-        // if item refers to a layer we always want to use that layer id
-        // otherwise use the layer id that was passed in (if any)
-        var _layerIdFromUrl = getLayerIdFromUrl(item.url);
-        var layerId = _layerIdFromUrl
-            ? parseInt(_layerIdFromUrl, 10)
-            : options === null || options === void 0 ? void 0 : options.layerId;
-        var layer = layers &&
-            (!isNil(layerId)
-                ? // find the explicitly set layer id
-                    layers.find(function (_layer) { return _layer.id === layerId; })
-                : // for feature servers with a single layer always show the layer
-                    isFeatureService(item.type) && getOnlyQueryLayer(layers));
+        var layer = getItemLayer(item, layers, options === null || options === void 0 ? void 0 : options.layerId);
         // NOTE: we only set hubId for public items in online
         var hubId = canUseHubApiForItem(item, requestOptions)
             ? layer
@@ -7345,9 +7437,8 @@
             : undefined;
         var identifier = slug || hubId || item.id;
         // whether or not we should show layer info for name, description, etc
-        var _shouldUseLayerInfo = shouldUseLayerInfo(layer, layers, item.url);
-        var name = _shouldUseLayerInfo ? layer.name : item.title;
-        var _layerDescription = _shouldUseLayerInfo && layer.description;
+        var name = getContentName(item, layer, layers);
+        var _layerDescription = shouldUseLayerInfo(layer, layers, item.url) && layer.description;
         // so much depends on type
         var type = layer
             ? // use layer type (Feature Layer, Table, etc) for layer content
@@ -7402,7 +7493,7 @@
             }, get url() {
                 return _proxyUrl
                     ? _proxyUrl
-                    : _shouldUseLayerInfo
+                    : layer
                         ? parseServiceUrl(item.url) + "/" + layer.id
                         : item.url;
             }, get categories() {
@@ -7518,7 +7609,17 @@
                 return (getItemSpatialReference(item) ||
                     getServerSpatialReference(server, layer) ||
                     null);
-            }, get orgId() {
+            }, get viewDefinition() {
+                // if this is a layer view and we have the item data
+                // find the definition that corresponds to the current layer
+                var dataLayer = layer &&
+                    isLayerView(layer) &&
+                    data &&
+                    Array.isArray(data.layers) &&
+                    data.layers.find(function (_layer) { return _layer.id === layer.id; });
+                return dataLayer ? dataLayer.layerDefinition : undefined;
+            },
+            get orgId() {
                 // NOTE: it's undocumented, but the portal API will return orgId for items... sometimes
                 return org ? org.id : item.orgId || (ownerUser === null || ownerUser === void 0 ? void 0 : ownerUser.orgId);
             }, 
@@ -8862,6 +8963,34 @@
         });
     }); };
 
+    var maybeFetchLayerEnrichments = function (itemAndEnrichments, options) { return __awaiter(void 0, void 0, void 0, function () {
+        var item, data, layers, layer, layerEnrichments, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    item = itemAndEnrichments.item, data = itemAndEnrichments.data, layers = itemAndEnrichments.layers;
+                    layer = layers && getItemLayer(item, layers, options && options.layerId);
+                    if (!(layer && isLayerView(layer) && !data)) return [3 /*break*/, 2];
+                    // to store (at least part of) it's view definition in item data
+                    // it seems that most do not, but until we have a reliable signal
+                    // we just fetch the item data for all layer views
+                    return [4 /*yield*/, fetchItemEnrichments(item, ["data"], options)];
+                case 1:
+                    // to store (at least part of) it's view definition in item data
+                    // it seems that most do not, but until we have a reliable signal
+                    // we just fetch the item data for all layer views
+                    _a = _b.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    _a = undefined;
+                    _b.label = 3;
+                case 3:
+                    layerEnrichments = _a;
+                    // TODO: merge errors
+                    return [2 /*return*/, __assign(__assign({}, itemAndEnrichments), layerEnrichments)];
+            }
+        });
+    }); };
     var fetchItemAndEnrichments = function (itemId, options) { return __awaiter(void 0, void 0, void 0, function () {
         var item, enrichmentsToFetch, enrichments;
         return __generator(this, function (_a) {
@@ -8873,7 +9002,7 @@
                     return [4 /*yield*/, fetchItemEnrichments(item, enrichmentsToFetch, options)];
                 case 2:
                     enrichments = _a.sent();
-                    return [2 /*return*/, __assign(__assign({}, enrichments), { item: item })];
+                    return [2 /*return*/, maybeFetchLayerEnrichments(__assign(__assign({}, enrichments), { item: item }), options)];
             }
         });
     }); };
@@ -8886,7 +9015,7 @@
                     return [4 /*yield*/, fetchItemAndEnrichments(itemId, options)];
                 case 1:
                     _a = _d.sent(), item = _a.item, itemEnrichments = __rest(_a, ["item"]);
-                    specifiedLayerId = options && !isNil(options.layerId) && options.layerId;
+                    specifiedLayerId = options && options.layerId;
                     if (!canUseHubApiForItem(item, options)) return [3 /*break*/, 3];
                     return [4 /*yield*/, fetchHubEnrichmentsById(hubId, options)];
                 case 2:
@@ -8898,7 +9027,7 @@
                 case 4:
                     _b = _c, slug = _b.slug, layerId = _b.layerId, boundary = _b.boundary, extent = _b.extent, searchDescription = _b.searchDescription, statistics = _b.statistics;
                     // return a new content object composed from the item and enrichments we fetched
-                    return [2 /*return*/, composeContent(item, __assign(__assign({ requestOptions: options }, itemEnrichments), { slug: slug, layerId: specifiedLayerId || layerId, boundary: boundary,
+                    return [2 /*return*/, composeContent(item, __assign(__assign({ requestOptions: options }, itemEnrichments), { slug: slug, layerId: isNil(specifiedLayerId) ? layerId : specifiedLayerId, boundary: boundary,
                             extent: extent,
                             searchDescription: searchDescription,
                             statistics: statistics }))];
@@ -8917,8 +9046,8 @@
                     return [4 /*yield*/, fetchItemAndEnrichments(itemId, options)];
                 case 2:
                     _a = _b.sent(), item = _a.item, itemEnrichments = __rest(_a, ["item"]);
-                    specifiedLayerId = options && !isNil(options.layerId) && options.layerId;
-                    if (!(specifiedLayerId && specifiedLayerId !== layerId)) return [3 /*break*/, 4];
+                    specifiedLayerId = options && options.layerId;
+                    if (!(!isNil(specifiedLayerId) && specifiedLayerId !== layerId)) return [3 /*break*/, 4];
                     // we fetched Hub enrichments by slug for another dataset,
                     // most likely for the parent service of this layer,
                     // we need to fetch them for the specified layer instead
@@ -8939,6 +9068,24 @@
             }
         });
     }); };
+    var fetchContentRecordCount = function (content) { return __awaiter(void 0, void 0, void 0, function () {
+        var url, viewDefinition, where, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    url = content.url, viewDefinition = content.viewDefinition;
+                    where = viewDefinition === null || viewDefinition === void 0 ? void 0 : viewDefinition.definitionExpression;
+                    return [4 /*yield*/, queryFeatures({
+                            url: url,
+                            where: where,
+                            returnCountOnly: true,
+                        })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.count];
+            }
+        });
+    }); };
     /**
      * Fetch enriched content from the Portal and Hub APIs.
      * @param identifier content slug or id
@@ -8951,11 +9098,38 @@
      * const content = await fetchContent('my-org::item-name')
      * ```
      */
-    var fetchContent = function (identifier, options) {
-        return isSlug(identifier)
-            ? fetchContentBySlug(addContextToSlug(identifier, options === null || options === void 0 ? void 0 : options.siteOrgKey), options)
-            : fetchContentById(identifier, options);
-    };
+    var fetchContent = function (identifier, options) { return __awaiter(void 0, void 0, void 0, function () {
+        var content, _a, isProxied, layer, _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    if (!isSlug(identifier)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, fetchContentBySlug(addContextToSlug(identifier, options === null || options === void 0 ? void 0 : options.siteOrgKey), options)];
+                case 1:
+                    _a = _d.sent();
+                    return [3 /*break*/, 4];
+                case 2: return [4 /*yield*/, fetchContentById(identifier, options)];
+                case 3:
+                    _a = _d.sent();
+                    _d.label = 4;
+                case 4:
+                    content = _a;
+                    isProxied = content.isProxied, layer = content.layer;
+                    _b = content;
+                    if (!(isProxied || !!layer)) return [3 /*break*/, 6];
+                    return [4 /*yield*/, fetchContentRecordCount(content)];
+                case 5:
+                    _c = _d.sent();
+                    return [3 /*break*/, 7];
+                case 6:
+                    _c = undefined;
+                    _d.label = 7;
+                case 7:
+                    _b.recordCount = _c;
+                    return [2 /*return*/, content];
+            }
+        });
+    }); };
 
     // TODO: remove this at next breaking version
     /**
@@ -14481,6 +14655,7 @@
     exports.getItemHomeUrl = getItemHomeUrl;
     exports.getItemHubId = getItemHubId;
     exports.getItemHubType = getItemHubType;
+    exports.getItemLayer = getItemLayer;
     exports.getItemLayerId = getItemLayerId;
     exports.getItemThumbnailUrl = getItemThumbnailUrl;
     exports.getLayerIdFromUrl = getLayerIdFromUrl;
@@ -14529,6 +14704,7 @@
     exports.isFeatureService = isFeatureService;
     exports.isFieldworkerView = isFieldworkerView;
     exports.isGuid = isGuid;
+    exports.isLayerView = isLayerView;
     exports.isMapOrFeatureServerUrl = isMapOrFeatureServerUrl;
     exports.isNil = isNil;
     exports.isSlug = isSlug;