@esri/hub-common 9.21.2 → 9.23.1

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;
@@ -67,6 +68,9 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     layer?: Partial<ILayerDefinition>;
     isProxied?: boolean;
     additionalResources?: IHubAdditionalResource[];
+    viewDefinition?: {
+        definitionExpression?: string;
+    };
     itemCategories?: string[];
     normalizedType?: string;
     orgId?: string;
@@ -109,18 +113,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 +175,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 +209,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 +247,7 @@ interface IAGOAdditionalResource {
  * @param item
  * @param metadata formal metadata
  * @returns
+ * @private
  */
 export declare const getAdditionalResources: (item: IItem, metadata?: any, requestOptions?: IHubRequestOptions) => IHubAdditionalResource[];
 /**
@@ -181,6 +258,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 +271,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,8 @@
 import { IItem } from "@esri/arcgis-rest-portal";
+import { ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
 import { IHubRequestOptions } from "../types";
 import { IHubContentEnrichments, IHubContent } from "../core";
+import { IHubExtent } from "./_fetch";
 /**
  * The possible values for updateFrequency
  *
@@ -105,7 +107,36 @@ 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;
 }
+/**
+ * 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
+ */
+export declare const getItemLayer: (item: IItem, layers: ILayerDefinition[], layerId?: number) => ILayerDefinition;
+/**
+ * determine if a layer is a layer view
+ * @param layer
+ * @returns
+ * @private
+ */
+export declare const isLayerView: (layer: ILayerDefinition) => boolean;
 /**
  * Compose a new content object out of an item, enrichments, and context
  * @param item

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

@@ -0,0 +1,24 @@
+import { IHubContent } from "../core";
+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<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/core/types/IHubContent.d.ts

@@ -77,6 +77,10 @@ export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IIt
     isProxied?: boolean;
     /** links to additional resources specified in the formal item metadata */
     additionalResources?: IHubAdditionalResource[];
+    /** definition for content that refers to a client-side layer view */
+    viewDefinition?: {
+        definitionExpression?: string;
+    };
     itemCategories?: string[];
     normalizedType?: string;
     orgId?: string;

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>;