@esri/hub-common 9.18.0 → 9.21.0

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

@@ -0,0 +1,115 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../types";
+import { IHubContentEnrichments, IHubContent } from "../core";
+/**
+ * The possible values for updateFrequency
+ *
+ * @enum {string}
+ */
+export declare enum UpdateFrequency {
+    Continual = "continual",
+    Daily = "daily",
+    Weekly = "weekly",
+    Fortnightly = "fortnightly",
+    Monthly = "monthly",
+    Quarterly = "quarterly",
+    Biannually = "biannually",
+    Annually = "annually",
+    AsNeeded = "as-needed",
+    Irregular = "irregular",
+    NotPlanned = "not-planned",
+    Unknown = "unknown",
+    Semimonthly = "semimonthly"
+}
+/**
+ * DEPRECATED: Compute the content type icon based on the content type
+ * @param content type
+ * @returns content type icon
+ */
+export declare const getContentTypeIcon: (contentType: string) => any;
+/**
+ * get portal URLs (home, API, data, and thumbnail) for an item
+ *
+ * @param item Item
+ * @param requestOptions Request options
+ * @returns a hash with the portal URLs
+ * @export
+ */
+export declare const getPortalUrls: (item: IItem, requestOptions: IHubRequestOptions) => {
+    portalHome: string;
+    portalApi: string;
+    portalData: string;
+    thumbnail: string;
+};
+/**
+ * If an item is a proxied csv, returns the url for the proxying feature layer.
+ * If the item is not a proxied csv, returns undefined.
+ *
+ * @param item
+ * @param requestOptions Hub Request Options (including whether we're in portal)
+ * @returns
+ */
+export declare const getProxyUrl: (item: IItem, requestOptions?: IHubRequestOptions) => string;
+/**
+ * parse layer id from a service URL
+ * @param {string} url
+ * @returns {string} layer id
+ */
+export declare const getLayerIdFromUrl: (url: string) => string;
+/**
+ * Case-insensitive check if the type is "Feature Service"
+ * @param {string} type - item's type
+ * @returns {boolean}
+ */
+export declare const isFeatureService: (type: string) => boolean;
+/**
+ * ```js
+ * import { normalizeItemType } from "@esri/hub-common";
+ * //
+ * normalizeItemType(item)
+ * > [ 'Hub Site Application' ]
+ * ```
+ * @param item Item object.
+ * @returns type of the input item.
+ *
+ */
+export declare function normalizeItemType(item?: any): string;
+/**
+ * return the layerId if we can tell that item is a single layer service
+ * @param {*} item from AGO
+ * @returns {string} layer id
+ */
+export declare const getItemLayerId: (item: IItem) => string;
+/**
+ * given an item, get the id to use w/ the Hub API
+ * @param item
+ * @returns Hub API id (hubId)
+ */
+export declare const getItemHubId: (item: IItem) => string;
+/**
+ * Splits item category strings at slashes and discards the "Categories" keyword
+ *
+ * ```
+ * ["/Categories/Boundaries", "/Categories/Planning and cadastre/Property records", "/Categories/Structure"]
+ * ```
+ * Should end up being
+ * ```
+ * ["Boundaries", "Planning and cadastre", "Property records", "Structure"]
+ * ```
+ *
+ * @param categories - an array of strings
+ * @private
+ */
+export declare function parseItemCategories(categories: string[]): string[];
+export interface IComposeContentOptions extends IHubContentEnrichments {
+    layerId?: number;
+    slug?: string;
+    requestOptions?: IHubRequestOptions;
+}
+/**
+ * Compose a new content object out of an item, enrichments, and context
+ * @param item
+ * @param options any enrichments, current state (selected layerId), or context (requestOptions)
+ * @returns new content object
+ */
+export declare const composeContent: (item: IItem, options?: IComposeContentOptions) => IHubContent;

package/dist/types/content/get-family.d.ts

@@ -0,0 +1,7 @@
+import { HubFamily } from "../types";
+/**
+ * return the Hub family given an item's type
+ * @param type item type
+ * @returns Hub family
+ */
+export declare function getFamily(type: string): HubFamily;

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

@@ -1,7 +1,9 @@
 import { ResourceObject } from "jsonapi-typescript";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { HubType, HubFamily, IModel, IHubRequestOptions } from "../types";
-import { IHubContent } from "..";
+import { HubType, IModel } from "../types";
+import { IHubContent } from "../core";
+export * from "./compose";
+export * from "./get-family";
 /**
  * JSONAPI dataset resource returned by the Hub API
  */
@@ -34,18 +36,6 @@ export declare function getCategory(itemType?: string): string;
  *
  */
 export declare function getTypes(category?: string): string[];
-/**
- * ```js
- * import { normalizeItemType } from "@esri/hub-common";
- * //
- * normalizeItemType(item)
- * > [ 'Hub Site Application' ]
- * ```
- * @param item Item object.
- * @returns type of the input item.
- *
- */
-export declare function normalizeItemType(item?: any): string;
 /**
  * ```js
  * import { getTypeCategories } from "@esri/hub-common";
@@ -58,42 +48,6 @@ export declare function normalizeItemType(item?: any): string;
  *
  */
 export declare function getTypeCategories(item?: any): string[];
-/**
- * ```js
- * import { getCollection } from "@esri/hub-common";
- * //
- * getCollection('Feature Layer')
- * > 'dataset'
- * ```
- * Get the Hub collection for a given item type
- * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
- * @returns the Hub collection of a given item type.
- */
-export declare function getCollection(itemType?: string): string;
-/**
- * Case-insensitive check if the type is "Feature Service"
- * @param {string} type - item's type
- * @returns {boolean}
- */
-export declare const isFeatureService: (type: string) => boolean;
-/**
- * parse layer id from a service URL
- * @param {string} url
- * @returns {string} layer id
- */
-export declare const getLayerIdFromUrl: (url: string) => string;
-/**
- * return the layerId if we can tell that item is a single layer service
- * @param {*} item from AGO
- * @returns {string} layer id
- */
-export declare const getItemLayerId: (item: IItem) => string;
-/**
- * given an item, get the id to use w/ the Hub API
- * @param item
- * @returns Hub API id (hubId)
- */
-export declare const getItemHubId: (item: IItem) => string;
 /**
  * ```js
  * import { getContentIdentifier } from "@esri/hub-common";
@@ -149,27 +103,6 @@ export declare function addContextToSlug(slug: string, context: string): string;
  * @returns slug without context
  */
 export declare function removeContextFromSlug(slug: string, context: string): string;
-/**
- * Splits item category strings at slashes and discards the "Categories" keyword
- *
- * ```
- * ["/Categories/Boundaries", "/Categories/Planning and cadastre/Property records", "/Categories/Structure"]
- * ```
- * Should end up being
- * ```
- * ["Boundaries", "Planning and cadastre", "Property records", "Structure"]
- * ```
- *
- * @param categories - an array of strings
- * @private
- */
-export declare function parseItemCategories(categories: string[]): string[];
-/**
- * return the Hub family given an item's type
- * @param type item type
- * @returns Hub family
- */
-export declare function getFamily(type: string): HubFamily;
 /**
  * DEPRECATED: Use getFamily() instead.
  *
@@ -210,12 +143,6 @@ export declare function datasetToItem(dataset: DatasetResource): IItem;
  * @returns new content
  */
 export declare const setContentType: (content: IHubContent, type: string) => IHubContent;
-/**
- * Compute the content type icon based on the content type
- * @param content type
- * @returns content type icon
- */
-export declare const getContentTypeIcon: (contentType: string) => any;
 /**
  * Compute the content type label
  * @param contentType
@@ -249,12 +176,3 @@ export declare const getContentSiteUrls: (content: IHubContent, siteModel: IMode
  * @returns
  */
 export declare const setContentSiteUrls: (content: IHubContent, siteModel: IModel) => IHubContent;
-/**
- * If an item is a proxied csv, returns the url for the proxying feature layer.
- * If the item is not a proxied csv, returns undefined.
- *
- * @param item
- * @param requestOptions Hub Request Options (including whether we're in portal)
- * @returns
- */
-export declare const getProxyUrl: (item: IItem, requestOptions: IHubRequestOptions) => string;

package/dist/types/core/types/IHubAdditionalResource.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Data model for additional resources that are pulled from formal item metadata
+ * and transformed into a hub-friendly interface
+ */
+export interface IHubAdditionalResource {
+    name?: string;
+    url: string;
+    /** whether the url points to the service of the related item */
+    isDataSource: boolean;
+}

package/dist/types/core/types/IHubContent.d.ts

@@ -1,12 +1,14 @@
 import { IItem, IGroup } from "@esri/arcgis-rest-portal";
 import { ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
-import { Visibility, AccessControl, HubFamily, IActionLink, IStructuredLicense } from "../..";
+import { AccessControl, HubFamily, IActionLink, Visibility } from "../../types";
+import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubItemEntity } from ".";
-import { IContentEnrichments } from "./IContentEnrichments";
+import { IHubContentEnrichments } from "./IHubContentEnrichments";
+import { IHubAdditionalResource } from "./IHubAdditionalResource";
 /**
  * Data model for content
  */
-export interface IHubContent extends IHubItemEntity, IContentEnrichments, IItem {
+export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IItem {
     /**
      * The underlying portal item referenced by this content
      */
@@ -71,6 +73,10 @@ export interface IHubContent extends IHubItemEntity, IContentEnrichments, IItem
     hubActions?: object;
     /** Information about the layer referenced by this content (geometryType, fields, etc) */
     layer?: Partial<ILayerDefinition>;
+    /** Whether or not the layer or table is actually a proxied CSV */
+    isProxied?: boolean;
+    /** links to additional resources specified in the formal item metadata */
+    additionalResources?: IHubAdditionalResource[];
     itemCategories?: string[];
     normalizedType?: string;
     orgId?: string;

package/dist/types/core/types/IHubContentEnrichments.d.ts

@@ -0,0 +1,15 @@
+import { IHubGeography } from "../../types";
+import { IItemEnrichments } from "./IItemEnrichments";
+import { IServerEnrichments } from "./IServerEnrichments";
+export interface IHubContentEnrichments extends IItemEnrichments, IServerEnrichments {
+    /**
+     * 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;
+    /**
+     *
+     */
+    statistics?: any;
+}

package/dist/types/core/types/IHubItemEntity.d.ts

@@ -1,5 +1,5 @@
 import { IHubEntityBase } from "./IHubEntityBase";
-import { IHubGeography } from "../..";
+import { IHubGeography } from "../../types";
 /**
  * Properties exposed by Entities that are backed by Items
  */

package/dist/types/core/types/{IContentEnrichments.d.ts → IServerEnrichments.d.ts}

@@ -1,6 +1,5 @@
 import { IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
-import { IItemEnrichments } from "./IItemEnrichments";
-export interface IContentEnrichments extends IItemEnrichments {
+export interface IServerEnrichments {
     /** Information about the service referenced by this content (currentVersion, capabilities, maxRecordCount etc) */
     server?: Partial<IFeatureServiceDefinition>;
     /** Detailed information about the service's layers (geometryType, fields, etc) for related layers in the service */
@@ -8,3 +7,5 @@ export interface IContentEnrichments extends IItemEnrichments {
     /** The count of records for the layer referenced by this content */
     recordCount?: number;
 }
+export interface IContentEnrichments extends IServerEnrichments {
+}

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

@@ -1,5 +1,5 @@
-export * from "./IContentEnrichments";
 export * from "./IItemEnrichments";
+export * from "./IHubContentEnrichments";
 export * from "./IHubContent";
 export * from "./IHubEntityBase";
 export * from "./IHubItemEntity";
@@ -12,3 +12,4 @@ export * from "./IHubPage";
 export * from "./IHubProject";
 export * from "./IHubSite";
 export * from "./IHubTimeline";
+export * from "./IServerEnrichments";

package/dist/types/sites/domains/index.d.ts

@@ -13,6 +13,7 @@ export * from "./is-domain-used-elsewhere";
 export * from "./is-valid-domain";
 export * from "./lookup-domain";
 export * from "./remove-domain";
+export * from "./remove-domains-by-site-id";
 export * from "./update-domain";
 export * from "./_ensure-safe-domain-length";
 export * from "./ensure-unique-domain-name";

package/dist/types/sites/domains/remove-domains-by-site-id.d.ts

@@ -0,0 +1,8 @@
+import { IHubRequestOptions } from "../../types";
+/**
+ * Remove all domain entries by site id.
+ * User must be a member of the org that owns the domain entry.
+ * @param {int} domainSiteId of the domain entries to remove
+ * @param {IHubRequestOptions} hubRequestOptions`dom
+ */
+export declare function removeDomainsBySiteId(domainSiteId: string, hubRequestOptions: IHubRequestOptions): Promise<any>;