@esri/hub-common 9.21.2 → 9.22.0

package/dist/node/items/_enrichments.js

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchItemEnrichments = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const arcgis_rest_feature_layer_1 = require("@esri/arcgis-rest-feature-layer");
+const utils_1 = require("../utils");
+const OperationStack_1 = require("../OperationStack");
+// TODO: move these functions here under /items
+const arcgis_rest_portal_2 = require("@esri/arcgis-rest-portal");
+const fast_xml_parser_1 = require("fast-xml-parser");
+function parseMetadataXml(metadataXml) {
+    const opts = {
+        // options for fastXmlParser to read tag attrs
+        ignoreAttributes: false,
+        attributeNamePrefix: "@_",
+        textNodeName: "#value",
+    };
+    return fast_xml_parser_1.parse(metadataXml, opts);
+}
+/**
+ * Fetch an [item's metadata](https://doc.arcgis.com/en/arcgis-online/manage-data/metadata.htm) from a portal
+ * and parse and return it as JSON
+ * @param id item id
+ * @param requestOptions
+ */
+function fetchContentMetadata(id, requestOptions) {
+    return arcgis_rest_portal_2.getItemMetadata(id, requestOptions)
+        .then((metadataXml) => parseMetadataXml(metadataXml))
+        .catch(() => {
+        // many items don't have metadata and the request will 404
+        // in these cases we don't want to treat it as an error
+        // content.metadata === null signals to consumers that
+        // we attempted to fetch the metadata, but it doesn't exist
+        // TODO: we should probably still throw the error if it's not a 404
+        return null;
+    });
+}
+const enrichGroupIds = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichGroupIds");
+    return arcgis_rest_portal_1.getItemGroups(data.item.id, requestOptions)
+        .then((response) => {
+        const { admin, member, other } = response;
+        const groupIds = [...admin, ...member, ...other].map((group) => group.id);
+        stack.finish(opId);
+        return {
+            data: Object.assign(Object.assign({}, data), { groupIds }),
+            stack,
+            requestOptions,
+        };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId));
+};
+const enrichMetadata = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichMetadata");
+    return fetchContentMetadata(data.item.id, requestOptions).then((metadata) => {
+        stack.finish(opId);
+        return {
+            data: Object.assign(Object.assign({}, data), { metadata }),
+            stack,
+            requestOptions,
+        };
+    });
+    // TODO: currently fetchContentMetadata will never throw, but
+    // if we update it to throw for non-404 errors, need to uncomment this:
+    // .catch((error) => handleEnrichmentError(error, input, opId));
+};
+const enrichOwnerUser = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichOwner");
+    // w/o the : any here, I get a compile error about
+    // .authentication being incompatible w/ UserSession
+    const options = Object.assign({ username: data.item.owner }, requestOptions);
+    return arcgis_rest_portal_1.getUser(options)
+        .then((ownerUser) => {
+        stack.finish(opId);
+        return {
+            data: Object.assign(Object.assign({}, data), { ownerUser }),
+            stack,
+            requestOptions,
+        };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId));
+};
+const enrichData = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichData");
+    return arcgis_rest_portal_1.getItemData(data.item.id, requestOptions)
+        .then((itemData) => {
+        stack.finish(opId);
+        return { data: Object.assign(Object.assign({}, data), { data: itemData }), stack, requestOptions };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId));
+};
+const enrichServer = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichServer");
+    const url = data.item.url;
+    const options = Object.assign(Object.assign({}, requestOptions), { url });
+    return arcgis_rest_feature_layer_1.getService(options)
+        .then((server) => {
+        stack.finish(opId);
+        return { data: Object.assign(Object.assign({}, data), { server }), stack, requestOptions };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId));
+};
+const enrichLayers = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichLayers");
+    const url = data.item.url;
+    const options = Object.assign(Object.assign({}, requestOptions), { url });
+    return (arcgis_rest_feature_layer_1.getAllLayersAndTables(options)
+        // merge layers and tables into a single array
+        // and filter out any group layers
+        .then((response) => {
+        const merged = [...response.layers, ...response.tables];
+        return merged.filter((layer) => layer.type !== "Group Layer");
+    })
+        .then((layers) => {
+        stack.finish(opId);
+        return { data: Object.assign(Object.assign({}, data), { layers }), stack, requestOptions };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId)));
+};
+// add the error to the content.errors,
+// log current stack operation as finished with an error
+// and return output that can be piped into the next operation
+const handleEnrichmentError = (error, input, opId) => {
+    const { data, stack, requestOptions } = input;
+    stack.finish(opId, { error });
+    const message = typeof error === "string"
+        ? /* istanbul ignore next our tests only throw Error objects */
+            error
+        : error.message;
+    const errors = data.errors || [];
+    errors.push({
+        // NOTE: for now we just return the message and type "Other"
+        // but we could later introspect for HTTP or AGO errors
+        // and/or return the status code if available
+        type: "Other",
+        message,
+    });
+    return { data: Object.assign(Object.assign({}, data), { errors }), stack, requestOptions };
+};
+const enrichmentOperations = {
+    groupIds: enrichGroupIds,
+    metadata: enrichMetadata,
+    ownerUser: enrichOwnerUser,
+    // TOOD: org
+    data: enrichData,
+    server: enrichServer,
+    layers: enrichLayers,
+};
+/**
+ * Fetch enrichments for an item
+ * @param item
+ * @param enrichments the list of enrichments to fetch
+ * @param requestOptions
+ * @returns an object with the item and enrichments
+ * @private
+ */
+exports.fetchItemEnrichments = (item, enrichments, requestOptions) => {
+    // create a pipeline of enrichment operations
+    const operations = enrichments.reduce((ops, enrichment) => {
+        const operation = enrichmentOperations[enrichment];
+        // only include the enrichments that we know how to fetch
+        operation && ops.push(operation);
+        return ops;
+    }, []);
+    const pipeline = utils_1.createOperationPipeline(operations);
+    // execute pipeline and return the item and enrichments
+    return pipeline({
+        data: { item },
+        stack: new OperationStack_1.default(),
+        requestOptions,
+    }).then((output) => output.data);
+};
+//# sourceMappingURL=_enrichments.js.map

package/dist/node/items/_enrichments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_enrichments.js","sourceRoot":"","sources":["../../../src/items/_enrichments.ts"],"names":[],"mappings":";;;AAAA,iEAKkC;AAClC,+EAGyC;AAGzC,oCAA8D;AAC9D,sDAA+C;AAC/C,+CAA+C;AAC/C,iEAA2D;AAC3D,qDAAwC;AAoBxC,SAAS,gBAAgB,CAAC,WAAmB;IAC3C,MAAM,IAAI,GAAG;QACX,8CAA8C;QAC9C,gBAAgB,EAAE,KAAK;QACvB,mBAAmB,EAAE,IAAI;QACzB,YAAY,EAAE,QAAQ;KACvB,CAAC;IACF,OAAO,uBAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAC3B,EAAU,EACV,cAAmC;IAEnC,OAAO,oCAAe,CAAC,EAAE,EAAE,cAAc,CAAC;SACvC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;SACpD,KAAK,CAAC,GAAG,EAAE;QACV,0DAA0D;QAC1D,uDAAuD;QACvD,sDAAsD;QACtD,2DAA2D;QAC3D,mEAAmE;QACnE,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,cAAc,GAAG,CACrB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC3C,OAAO,kCAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC;SAC/C,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC;QAC1C,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1E,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO;YACL,IAAI,kCAAO,IAAI,KAAE,QAAQ,GAAE;YAC3B,KAAK;YACL,cAAc;SACf,CAAC;IACJ,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC3C,OAAO,oBAAoB,CACzB,IAAI,CAAC,IAAI,CAAC,EAAE,EACZ,cAAoC,CACrC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QAClB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO;YACL,IAAI,kCAAO,IAAI,KAAE,QAAQ,GAAE;YAC3B,KAAK;YACL,cAAc;SACf,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,6DAA6D;IAC7D,uEAAuE;IACvE,gEAAgE;AAClE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACxC,kDAAkD;IAClD,oDAAoD;IACpD,MAAM,OAAO,mBACX,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,IACtB,cAAc,CAClB,CAAC;IACF,OAAO,4BAAO,CAAC,OAAO,CAAC;SACpB,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO;YACL,IAAI,kCAAO,IAAI,KAAE,SAAS,GAAE;YAC5B,KAAK;YACL,cAAc;SACf,CAAC;IACJ,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CACjB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,gCAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC;SAC7C,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,EAAE,IAAI,kCAAO,IAAI,KAAE,IAAI,EAAE,QAAQ,GAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IACtE,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CACnB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC1B,MAAM,OAAO,mCACR,cAAc,KACjB,GAAG,GACJ,CAAC;IACF,OAAO,sCAAU,CAAC,OAAO,CAAC;SACvB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,EAAE,IAAI,kCAAO,IAAI,KAAE,MAAM,GAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IAC9D,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CACnB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC1B,MAAM,OAAO,mCACR,cAAc,KACjB,GAAG,GACJ,CAAC;IACF,OAAO,CACL,iDAAqB,CAAC,OAAO,CAAC;QAC5B,8CAA8C;QAC9C,kCAAkC;SACjC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,IAAe,KAAK,aAAa,CACpD,CAAC;IACJ,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,EAAE,IAAI,kCAAO,IAAI,KAAE,MAAM,GAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IAC9D,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAC/D,CAAC;AACJ,CAAC,CAAC;AAEF,uCAAuC;AACvC,wDAAwD;AACxD,8DAA8D;AAC9D,MAAM,qBAAqB,GAAG,CAC5B,KAAqB,EACrB,KAAqC,EACrC,IAAY,EACoB,EAAE;IAClC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,MAAM,OAAO,GACX,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,6DAA6D;YAC7D,KAAK;QACP,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;IACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,CAAC;QACV,4DAA4D;QAC5D,uDAAuD;QACvD,6CAA6C;QAC7C,IAAI,EAAE,OAAO;QACb,OAAO;KACR,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,kCAAO,IAAI,KAAE,MAAM,GAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;AAC9D,CAAC,CAAC;AAQF,MAAM,oBAAoB,GAA0B;IAClD,QAAQ,EAAE,cAAc;IACxB,QAAQ,EAAE,cAAc;IACxB,SAAS,EAAE,eAAe;IAC1B,YAAY;IACZ,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,YAAY;CACrB,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG,CAClC,IAAW,EACX,WAAqC,EACrC,cAAmC,EACnC,EAAE;IACF,6CAA6C;IAC7C,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;QACxD,MAAM,SAAS,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACnD,yDAAyD;QACzD,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,MAAM,QAAQ,GAAG,+BAAuB,CAAsB,UAAU,CAAC,CAAC;IAC1E,uDAAuD;IACvD,OAAO,QAAQ,CAAC;QACd,IAAI,EAAE,EAAE,IAAI,EAAE;QACd,KAAK,EAAE,IAAI,wBAAc,EAAE;QAC3B,cAAc;KACf,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/dist/types/content/_fetch.d.ts

@@ -0,0 +1,61 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { BBox } from "..";
+import { ItemOrServerEnrichment } from "../items/_enrichments";
+import { IHubRequestOptions, IHubGeography } from "../types";
+/**
+ * get the default list of enrichments to fetch for content
+ * @param item
+ * @returns the default list of enrichments to fetch for content
+ * @private
+ */
+export declare const getContentEnrichments: (item: IItem) => ItemOrServerEnrichment[];
+/**
+ * The extent returned by the Hub API
+ */
+export interface IHubExtent {
+    coordinates?: BBox;
+}
+/**
+ * The set of enrichments that we fetch from the Hub API
+ */
+export interface IDatasetEnrichments {
+    itemId: string;
+    layerId?: number;
+    slug?: string;
+    /**
+     * boundary will default to the item extent
+     * but can be overwritten by enrichments from the Hub API (inline)
+     * or fetched from a location such as /resources/boundary.json
+     */
+    boundary?: IHubGeography;
+    /**
+     * Either the item's extent, or the item's
+     * layer or server's extent converted to a lat/lng coordinate pair
+     */
+    extent?: IHubExtent;
+    /**
+     * The appropriate summary to show for the item, coming from either
+     * the item's data (for pages or initiatives) or the item's description
+     */
+    searchDescription?: string;
+    /**
+     * Pre-computed field statistics (min, max, average, etc)
+     */
+    statistics?: any;
+}
+/**
+ * fetch enrichment from the Hub API by slug
+ * @param slug
+ * @param requestOptions
+ * @returns enrichments from the Hub API (slug, boundary, statistic, etc)
+ * @private
+ */
+export declare const fetchHubEnrichmentsBySlug: (slug: string, requestOptions: IHubRequestOptions) => Promise<IDatasetEnrichments>;
+/**
+ * fetch enrichment from the Hub API by id
+ * @param slug
+ * @param requestOptions
+ * @returns enrichments from the Hub API (slug, boundary, statistic, etc)
+ * @private
+ */
+export declare const fetchHubEnrichmentsById: (hubId: string, requestOptions: IHubRequestOptions) => Promise<IDatasetEnrichments>;

package/dist/types/content/_internal.d.ts

@@ -19,6 +19,7 @@ import { IHubAdditionalResource } from "../core/types/IHubAdditionalResource";
  * @param content original content
  * @param boundary boundary provenance
  * @returns
+ * @private
  */
 export declare const setContentBoundary: (content: IHubContent, boundary: GeographyProvenance) => {
     boundary: IHubGeography;
@@ -109,18 +110,60 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     spatialReference?: ISpatialReference;
     properties?: any;
 };
+/**
+ * get a content's boundary based on the item's boundary property
+ * @param item
+ * @returns
+ * @private
+ */
 export declare const getContentBoundary: (item: IItem) => IHubGeography;
+/**
+ * Determine if we are in an enterprise environment
+ * NOTE: when no request options are provided, the underlying
+ * request functions assume that we are online in production
+ * so we only want use enterprise logic if isPortal is explicitly defined
+ * @param requestOptions
+ * @returns
+ * @private
+ */
 export declare const isPortal: (requestOptions?: IHubRequestOptions) => boolean;
+/**
+ * Determine if we can use the Hub API for an item, i.e.
+ * the item is public and we are not in an enterprise environment
+ * @param item
+ * @param requestOptions
+ * @returns
+ * @private
+ */
+export declare const canUseHubApiForItem: (item: IItem, requestOptions?: IHubRequestOptions) => boolean;
 /**
  * Returns whether or not an item is a proxied csv
  *
  * @param item
  * @param requestOptions Hub Request Options (including whether we're in portal)
  * @returns
+ * @private
  */
 export declare const isProxiedCSV: (item: IItem, requestOptions?: IHubRequestOptions) => boolean;
+/**
+ * Get the relative URL to use for the item in a hub site
+ * @param type
+ * @param identifier
+ * @param typeKeywords
+ * @returns
+ * @private
+ */
 export declare const getHubRelativeUrl: (type: string, identifier: string, typeKeywords?: string[]) => string;
+/**
+ * Is this content type a page?
+ * @param type
+ * @returns
+ * @private
+ */
 export declare const isPageType: (type: string) => boolean;
+/**
+ * well known paths to formal metadata values
+ */
 export interface IMetadataPaths {
     updateFrequency: string;
     metadataUpdateFrequency: string;
@@ -129,8 +172,24 @@ export interface IMetadataPaths {
     pubDate: string;
     createDate: string;
 }
+/**
+ * Get the path to a well known metadata value
+ * @param identifier identifier for well known metadata value
+ * @returns path to be used like get(metadata, path)
+ * @private
+ */
 export declare function getMetadataPath(identifier: keyof IMetadataPaths): string;
+/**
+ * Get a well known value from metadata
+ * @param metadata
+ * @param identifier identifier for well known metadata value
+ * @returns
+ * @private
+ */
 export declare function getValueFromMetadata(metadata: any, identifier: keyof IMetadataPaths): any;
+/**
+ * Date precisions
+ */
 export declare enum DatePrecision {
     Year = "year",
     Month = "month",
@@ -147,12 +206,26 @@ export declare enum DatePrecision {
  *
  * @param {string} isoString
  * @return { date: Date, precision: DatePrecision }
+ * @private
  */
 export declare function parseISODateString(isoString: string): {
     date: Date;
     precision: DatePrecision;
 };
+/**
+ * Get the spatial reference from layer or server info
+ * @param server
+ * @param layer
+ * @returns
+ * @private
+ */
 export declare const getServerSpatialReference: (server: Partial<IFeatureServiceDefinition>, layer?: ILayerDefinition) => ISpatialReference;
+/**
+ * Get the spatial reference as an object for an item
+ * @param item
+ * @returns spatial reference object
+ * @private
+ */
 export declare const getItemSpatialReference: (item: IItem) => ISpatialReference;
 /**
  * Data model for additional resources that are extracted
@@ -171,6 +244,7 @@ interface IAGOAdditionalResource {
  * @param item
  * @param metadata formal metadata
  * @returns
+ * @private
  */
 export declare const getAdditionalResources: (item: IItem, metadata?: any, requestOptions?: IHubRequestOptions) => IHubAdditionalResource[];
 /**
@@ -181,6 +255,7 @@ export declare const getAdditionalResources: (item: IItem, metadata?: any, reque
  * @param resource raw additional resource of an item
  * @param item
  * @returns
+ * @private
  */
 export declare const isDataSourceOfItem: (resource: IAGOAdditionalResource, item: IItem) => boolean;
 /**
@@ -193,6 +268,7 @@ export declare const isDataSourceOfItem: (resource: IAGOAdditionalResource, item
  * @param item
  * @param requestOptions IHubRequestOptions, including authentication
  * @returns
+ * @private
  */
 export declare const getAdditionalResourceUrl: (resource: IAGOAdditionalResource, item: IItem, requestOptions?: IHubRequestOptions) => string;
 export {};

package/dist/types/content/compose.d.ts

@@ -1,6 +1,7 @@
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubRequestOptions } from "../types";
 import { IHubContentEnrichments, IHubContent } from "../core";
+import { IHubExtent } from "./_fetch";
 /**
  * The possible values for updateFrequency
  *
@@ -105,6 +106,16 @@ export interface IComposeContentOptions extends IHubContentEnrichments {
     layerId?: number;
     slug?: string;
     requestOptions?: IHubRequestOptions;
+    /**
+     * Either the item's extent, or the item's
+     * layer or server's extent converted to a lat/lng coordinate pair
+     */
+    extent?: IHubExtent;
+    /**
+     * The appropriate summary to show for the item, coming from either
+     * the item's data (for pages or initiatives) or the item's description
+     */
+    searchDescription?: string;
 }
 /**
  * Compose a new content object out of an item, enrichments, and context

package/dist/types/content/fetch.d.ts

@@ -0,0 +1,23 @@
+import { ItemOrServerEnrichment } from "../items/_enrichments";
+import { IHubRequestOptions } from "../types";
+interface IFetchItemAndEnrichmentsOptions extends IHubRequestOptions {
+    enrichments?: ItemOrServerEnrichment[];
+}
+export interface IFetchContentOptions extends IFetchItemAndEnrichmentsOptions {
+    layerId?: number;
+    siteOrgKey?: string;
+}
+/**
+ * Fetch enriched content from the Portal and Hub APIs.
+ * @param identifier content slug or id
+ * @param options Request options with additional options to control how the content or enrichments are fetched
+ * @returns A content object composed of the backing item and enrichments
+ *
+ * ```js
+ * import { fetchContent } from '@esri/hub-common'
+ * // fetch content by slug
+ * const content = await fetchContent('my-org::item-name')
+ * ```
+ */
+export declare const fetchContent: (identifier: string, options?: IFetchContentOptions) => Promise<import("..").IHubContent>;
+export {};

package/dist/types/content/index.d.ts

@@ -1,15 +1,12 @@
-import { ResourceObject } from "jsonapi-typescript";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { HubType, IModel } from "../types";
 import { IHubContent } from "../core";
+import { DatasetResource } from "./types";
 export * from "./compose";
 export * from "./get-family";
-/**
- * JSONAPI dataset resource returned by the Hub API
- */
-export declare type DatasetResource = ResourceObject<"dataset", {
-    [k: string]: any;
-}>;
+export * from "./slugs";
+export * from "./fetch";
+export * from "./types";
 /**
  * ```js
  * import { getCategory } from "@esri/hub-common";
@@ -69,40 +66,6 @@ export declare function getTypeCategories(item?: any): string[];
  * @returns the preferred id for the given content.
  */
 export declare function getContentIdentifier(content: IHubContent, site?: IModel): string;
-/**
- * Parse item ID and layer ID (if any) from dataset record ID
- *
- * @param datasetId Hub API dataset record id ({itemId}_{layerId} or {itemId})
- * @returns A hash with the `itemId` and `layerId` (if any)
- */
-export declare function parseDatasetId(datasetId: string): {
-    itemId: string;
-    layerId?: string;
-};
-/**
- * Determine if an identifier is a Hub API slug
- *
- * @param identifier Hub API slug ({orgKey}::{title-as-slug} or {title-as-slug})
- * or record id ((itemId}_{layerId} or {itemId})
- * @returns true if the identifier is valid _and_ is **not** a record id
- */
-export declare function isSlug(identifier: string): boolean;
-/**
- * Add a context (prefix) to slug if it doesn't already have one
- *
- * @param slug Hub API slug (with or without context)
- * @param context usually a portal's orgKey
- * @returns slug with context ({context}::{slug})
- */
-export declare function addContextToSlug(slug: string, context: string): string;
-/**
- * Remove context (prefix) from a slug
- *
- * @param slug Hub API slug with context
- * @param context usually a portal's orgKey
- * @returns slug without context
- */
-export declare function removeContextFromSlug(slug: string, context: string): string;
 /**
  * DEPRECATED: Use getFamily() instead.
  *

package/dist/types/content/slugs.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Parse item ID and layer ID (if any) from dataset record ID
+ *
+ * @param datasetId Hub API dataset record id ({itemId}_{layerId} or {itemId})
+ * @returns A hash with the `itemId` and `layerId` (if any)
+ */
+export declare function parseDatasetId(datasetId: string): {
+    itemId: string;
+    layerId?: string;
+};
+/**
+ * Determine if an identifier is a Hub API slug
+ *
+ * @param identifier Hub API slug ({orgKey}::{title-as-slug} or {title-as-slug})
+ * or record id ((itemId}_{layerId} or {itemId})
+ * @returns true if the identifier is valid _and_ is **not** a record id
+ */
+export declare function isSlug(identifier: string): boolean;
+/**
+ * Add a context (prefix) to slug if it doesn't already have one
+ *
+ * @param slug Hub API slug (with or without context)
+ * @param context usually a portal's orgKey
+ * @returns slug with context ({context}::{slug})
+ */
+export declare function addContextToSlug(slug: string, context: string): string;
+/**
+ * Remove context (prefix) from a slug
+ *
+ * @param slug Hub API slug with context
+ * @param context usually a portal's orgKey
+ * @returns slug without context
+ */
+export declare function removeContextFromSlug(slug: string, context: string): string;

package/dist/types/content/types.d.ts

@@ -0,0 +1,7 @@
+import { ResourceObject } from "jsonapi-typescript";
+/**
+ * JSONAPI dataset resource returned by the Hub API
+ */
+export declare type DatasetResource = ResourceObject<"dataset", {
+    [k: string]: any;
+}>;

package/dist/types/items/_enrichments.d.ts

@@ -0,0 +1,24 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IItemEnrichments, IServerEnrichments } from "../core";
+import { IHubRequestOptions } from "../types";
+/**
+ * An object containing the item and fetched enrichments
+ */
+export interface IItemAndEnrichments extends IItemEnrichments, IServerEnrichments {
+    item: IItem;
+}
+/**
+ * The name of an enrichment that comes either
+ * from the portal API for the item
+ * or from the server that the item points to
+ */
+export declare type ItemOrServerEnrichment = keyof IItemEnrichments | keyof IServerEnrichments;
+/**
+ * Fetch enrichments for an item
+ * @param item
+ * @param enrichments the list of enrichments to fetch
+ * @param requestOptions
+ * @returns an object with the item and enrichments
+ * @private
+ */
+export declare const fetchItemEnrichments: (item: IItem, enrichments: ItemOrServerEnrichment[], requestOptions?: IHubRequestOptions) => Promise<IItemAndEnrichments>;