@esri/hub-common 9.8.1 → 9.10.1

package/dist/types/types.d.ts

@@ -1,415 +0,0 @@
-import { IItem, IUser, IGroup, IGeometry, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-types";
-import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
-import { UserSession } from "@esri/arcgis-rest-auth";
-import { IStructuredLicense } from "./items/get-structured-license";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IFacet } from "./search";
-/**
- * Generic Model, used with all items that have a json
- * `/data` payload
- *
- * @export
- * @interface IModel
- */
-export interface IModel {
-    item: IItem;
-    data?: {
-        [propName: string]: any;
-    };
-    [key: string]: any;
-}
-export interface IDraft {
-    item: Partial<IItem>;
-    data: any;
-}
-/**
- * Defined the Initiative Item as having
- * `type: "Hub Initiative"`
- *
- * @export
- * @interface IInitiativeItem
- * @extends {IItemAdd}
- */
-export interface IInitiativeItem extends IItem {
-    id: string;
-    type: "Hub Initiative";
-}
-/**
- * Initiative Model
- *
- * @export
- * @interface IInitiativeModel
- * @extends {IModel}
- */
-export interface IInitiativeModel extends IModel {
-    item: IInitiativeItem;
-    data?: {
-        [propName: string]: any;
-    };
-}
-export interface IInitiativeModelTemplate {
-    item: Partial<IInitiativeItem>;
-    data: {
-        [propName: string]: any;
-    };
-}
-export declare type IItemTemplate = Record<string, any>;
-export interface ITemplateAsset {
-    mimeType?: "image/png" | "image/jpg" | "image/jpeg";
-    name: string;
-    url?: string;
-    type?: string;
-}
-export interface IModelTemplate {
-    itemId: string;
-    item: IItemTemplate;
-    data: {
-        [propName: string]: any;
-    };
-    properties?: {
-        [propName: string]: any;
-    };
-    type: string;
-    key: string;
-    dependencies?: any[];
-    resources?: string[];
-    assets?: ITemplateAsset[];
-    [propName: string]: any;
-}
-export interface ISolutionTemplate extends IModel {
-    data: {
-        templates: IModelTemplate[];
-    };
-}
-export declare type GenericAsyncFunc = (...args: any) => Promise<any>;
-interface IHubRequestOptionsPortalSelf extends IPortal {
-    user?: IUser;
-}
-export interface IHubRequestOptions extends IRequestOptions {
-    authentication?: UserSession;
-    isPortal?: boolean;
-    hubApiUrl?: string;
-    portalSelf?: IHubRequestOptionsPortalSelf;
-}
-/**
- * Options for requests that require an authenticated user.
- */
-export interface IHubUserRequestOptions extends IHubRequestOptions {
-    authentication: UserSession;
-}
-export interface IItemResource {
-    type?: string;
-    url: string;
-    name: string;
-}
-export declare type IBBox = number[][];
-export declare type IBatch = any[];
-export declare type IBatchTransform = (value: any) => any;
-export interface IGetSurveyModelsResponse {
-    form: IModel;
-    featureService: IModel;
-    fieldworker: IModel;
-    stakeholder: IModel;
-}
-export interface IGetGroupSharingDetailsResults {
-    group: IGroup;
-    modelsToShare: IModel[];
-}
-export interface IRevertableTaskSuccess {
-    status: "fullfilled";
-    revert: (...args: any[]) => Promise<any>;
-    results: any;
-}
-export interface IRevertableTaskFailed {
-    status: "rejected";
-    error: Error;
-}
-export declare type IRevertableTaskResult = IRevertableTaskSuccess | IRevertableTaskFailed;
-/**
- * Types of Hub resources
- * DEPRECATED: Use HubFamily instead
- */
-export declare type HubType = "member" | "team" | "event" | "dataset" | "document" | "map" | "app" | "site" | "initiative" | "template" | "organization";
-export declare type HubFamily = "people" | "team" | "event" | "dataset" | "document" | "feedback" | "map" | "app" | "site" | "initiative" | "template" | "content";
-/**
- * Visibility levels of a Hub resource
- */
-export declare type Visibility = "private" | "org" | "public";
-/**
- * User's access level to a Hub resource
- */
-export declare type AccessControl = "view" | "edit" | "admin";
-/**
- * Location of a Hub resource
- *
- * @export
- * @interface IHubGeography
- */
-export interface IHubGeography {
-    center?: [number, number];
-    geometry?: IGeometry;
-}
-export declare type SearchableType = IItem | IGroup | IUser;
-export declare type SearchFunction = (...args: any[]) => Promise<ISearchResult<SearchableType>>;
-/**
- * Properties that are common to Hub content, community, members, etc
- *
- * @export
- * @interface IHubResource
- */
-export interface IHubResource {
-    /** Generic term for the primary label (title, fullname, username, etc.) */
-    name: string;
-    /** Content snippet or other summary */
-    summary?: string;
-    /** Type of Hub resource */
-    hubType: HubType;
-    /** Date the item was created */
-    createdDate: Date;
-    /**
-     * description of what was used for this attribute
-     * the item key, e.g. `item.created` or `item.metadata.created_date`
-     */
-    createdDateSource?: string;
-    /** Date the item was last updated */
-    updatedDate: Date;
-    /**
-     * description of what was used for this attribute
-     * the item key, e.g. `item.modified` or `item.metadata.modified_date`
-     */
-    updatedDateSource?: string;
-    /** URL of the resource's page in the Portal Home application */
-    portalHomeUrl?: string;
-    /** URL of the Portal API endpoint for the resource */
-    portalApiUrl?: string;
-    /** Fully qualified URL for the item's thumbnail, including current user's token if authenticated and required */
-    thumbnailUrl?: 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;
-    /**
-     * Additional metadata from a metadata document using a formal or custom schema.
-     * For example, [item metadata in ArcGIS Online](https://doc.arcgis.com/en/arcgis-online/manage-data/metadata.htm)
-     * Metadata stored in XML format is parsed into JSON.
-     */
-    metadata?: any;
-}
-/**
- * Information about an error that occurred while indexing or composing content
- */
-export interface IEnrichmentErrorInfo {
-    type: "HTTP" | "AGO" | "Other";
-    statusCode?: number;
-    message?: string;
-}
-/**
- * Properties that are common to all Hub content types (dataset, map, document, etc)
- *
- * @export
- * @interface IHubContent
- * @extends {IHubResource,IItem}
- */
-export interface IHubContent extends IHubResource, IItem {
-    /**
-     * The content's ID for use with the Hub API
-     * For most content this will be the item's id
-     * For layers this will be `<itemId>_<layerId>`
-     * This will be undefined for private items and in enterprise
-     * because only public online items are included in the Hub API
-     */
-    hubId?: string;
-    /**
-     * Content visibility and access control, including groups
-     */
-    permissions: {
-        /** Visibility of the content */
-        visibility: Visibility;
-        /** Current user's control over the content */
-        control?: AccessControl;
-        /** The groups that have access to the item (as far as you know) */
-        groups?: IGroup[];
-    };
-    family?: HubFamily;
-    /**
-     * Item categories are the original, non-flattened item
-     * category strings.
-     */
-    itemCategories?: string[];
-    /**
-     * The normalized item type (we run normalizeItemType on
-     * the item in order to compute this prop)
-     */
-    normalizedType?: string;
-    /**
-     * Date the content was published (formal metadata),
-     * defaults to the date the content was created
-     */
-    publishedDate: Date;
-    /** Description of the source of the published date */
-    publishedDateSource?: string;
-    updateFrequency?: string;
-    /** Optional links to show in the Hub application for this content */
-    actionLinks?: IActionLink[];
-    /** Configure which Hub application actions (i.e. create web map) are available for this content */
-    hubActions?: object;
-    metrics?: {
-        /** Visibility of the metrics for this content in the Hub application */
-        visibility: Visibility | "updateGroups";
-    };
-    /** The content's unique URL slug in the Hub app */
-    slug?: string;
-    /** URL of the Portal API data endpoint for the resource */
-    portalDataUrl?: string;
-    /** The ids of any groups that the item belongs to */
-    groupIds?: string[];
-    /**
-     * Any errors encountered when indexing or composing the content
-     * see https://github.com/ArcGIS/hub-indexer/blob/master/docs/errors.md#response-formatting-for-errors
-     */
-    errors?: IEnrichmentErrorInfo[];
-    /**
-     * The item data associated w/ most types of content
-     * the format of the data depends on the item type
-     */
-    data?: {
-        [propName: string]: any;
-    };
-    /** service information (currentVersion, capabilities, maxRecordCount etc) */
-    server?: Partial<IFeatureServiceDefinition>;
-    /** layer information (geometryType, fields, etc) for related layers in the service */
-    layers?: Array<Partial<ILayerDefinition>>;
-    /** layer information (geometryType, fields, etc) */
-    layer?: Partial<ILayerDefinition>;
-    recordCount?: number;
-    /** The owner's organization id */
-    orgId?: string;
-    /**
-     * The owner's organization (portal) details (id, name, extent, etc)
-     */
-    org?: Partial<IPortal>;
-    /** Whether the content is downloadable in the Hub app */
-    isDownloadable: boolean;
-    /** The content's structured license info */
-    structuredLicense?: IStructuredLicense;
-}
-interface IActionLink {
-    /** Link title */
-    title: string;
-    /** Link URL */
-    url: string;
-}
-/**
- * IOperation
- * Represents some operation within the system.
- *
- * Used as a means to track the calls, inputs and outputs
- * during complex processes
- *
- * @export
- * @interface IOperation
- */
-export interface IOperation {
-    /**
-     * Unique identifier:
-     * i.e `getItem-3fc`, `convertToTemplate-bc7`
-     */
-    id: string;
-    /**
-     * What type of operation is this
-     * i.e. getItem, convertToTemplate
-     */
-    type: string;
-    /**
-     * Inputs to the operation
-     */
-    inputs: Record<string, unknown>;
-    state?: string;
-    startedAt?: number;
-    duration?: number;
-    output?: Record<string, unknown>;
-}
-/**
- * Serialized Operation Stack
- *
- * @export
- * @interface SerializedOperationStack
- */
-export interface ISerializedOperationStack {
-    operations: IOperation[];
-}
-/**
- * IUpdateSiteOptions
- *
- * Options for site updates
- *
- * @export
- * @interface UpdateSiteOptions
- */
-export interface IUpdateSiteOptions extends IUpdatePageOptions {
-    updateVersions?: boolean;
-}
-/**
- * IUpdatePageOptions
- *
- * Options for page updates
- *
- * @export
- * @interface UpdatePageOptions
- */
-export interface IUpdatePageOptions extends IHubUserRequestOptions {
-    allowList?: string[];
-}
-export interface IDomainEntry {
-    clientKey: string;
-    createdAt?: string;
-    hostname: string;
-    id: string;
-    orgId: string;
-    orgKey: string;
-    orgTitle: string;
-    permanentRedirect: boolean;
-    siteId: string;
-    siteTitle: string;
-    sslOnly: boolean;
-    updatedAt?: string;
-}
-/**
- * The catalog object found on Hub Site Application items.
- * It defines a selection of content to show up in the site's
- * search context.
- */
-export interface ISiteCatalog {
-    /**
-     * A list of groups containing searchable content.
-     */
-    groups: string[];
-    /**
-     * An org to limit searching to.
-     */
-    orgId: string;
-}
-export interface IHubTeam extends IGroup {
-    properties: {
-        [key: string]: any;
-    };
-}
-/**
- * Defines a generic search response interface with parameterized result type
- * for different types of searches
- *
- * total - total number of results
- * results - potentially paginated list of results
- * hasNext - boolean flag for if there are any more pages ofresults
- * next - invokable function for obtaining next page of results
- */
-export interface ISearchResponse<T> {
-    total: number;
-    results: T[];
-    hasNext: boolean;
-    next: (params?: any) => Promise<ISearchResponse<T>>;
-    facets?: IFacet[];
-}
-export {};

package/dist/types/urls/_get-http-and-https-uris.d.ts

@@ -1,7 +0,0 @@
-/**
- * Given a url without a protocol or with either http or https, return an array
- * that contains both the http and https version
- * @param {string} uri Url with either http or https, or no protocol
- * @private
- */
-export declare function _getHttpAndHttpsUris(uri: string): string[];

package/dist/types/urls/_get-hub-url-from-portal-hostname.d.ts

@@ -1,9 +0,0 @@
-/**
- * Parse the portal url, and if it matches one of the AGO
- * Url patterns, return the correct Hub Url
- * If portalUrl does not match an AGO pattern, this will
- * return `undefined`
- * @param portalUrl
- * @private
- */
-export declare function _getHubUrlFromPortalHostname(portalUrl: string): string;

package/dist/types/urls/_get-location.d.ts

@@ -1,5 +0,0 @@
-/**
- * Wrapper over window.location
- * @private
- */
-export declare function _getLocation(): Location;

package/dist/types/urls/build-url.d.ts

@@ -1,12 +0,0 @@
-interface IQueryParams {
-    [key: string]: string;
-}
-/**
- * @private
- */
-export declare function buildUrl(params: {
-    host: string;
-    path: string;
-    query?: IQueryParams;
-}): string;
-export {};

package/dist/types/urls/get-hub-api-url-from-portal.d.ts

@@ -1,6 +0,0 @@
-import { IPortal } from "@esri/arcgis-rest-portal";
-/**
- * Return the Portal url based on the portal self
- * @param {Object} portal Portal Self
- */
-export declare function getHubApiUrlFromPortal(portal: IPortal): string;

package/dist/types/urls/get-hub-locale-asset-url.d.ts

@@ -1,7 +0,0 @@
-import { IPortal } from "@esri/arcgis-rest-portal";
-/**
- * Given a Portal object, return the full Hub locale asset url
- * Used for fetching translations
- * @param {Object} portal Portal Self
- */
-export declare function getHubLocaleAssetUrl(portal: IPortal): string;

package/dist/types/urls/get-hub-url-from-portal.d.ts

@@ -1,6 +0,0 @@
-import { IPortal } from "@esri/arcgis-rest-portal";
-/**
- * Return the Hub Url based on the portal self
- * @param portal
- */
-export declare function getHubUrlFromPortal(portal: IPortal): string;

package/dist/types/urls/get-item-api-url.d.ts

@@ -1,11 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem, IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
-/**
- * Get the fully qualified URL to the REST end point for an item.
- * @param item w/ id and access
- * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
- * @param token token for the current user's session; will only be appended as a query parameter if the item's access is **not** `public`
- * @returns URL to the item's REST end point, defaults to `https://www.arcgis.com/sharing/rest/content/items/{item.id}?f=json`
- */
-export declare const getItemApiUrl: (item: IItem, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions, token?: string) => string;

package/dist/types/urls/get-item-data-url.d.ts

@@ -1,11 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem, IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
-/**
- * Get the fully qualified URL to the data REST end point for an item
- * @param item w/ id and access
- * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
- * @param token token for the current user's session; will only be appended as a query parameter if the item's access is **not** `public`
- * @returns URL to the item's data REST end point, defaults to `https://www.arcgis.com/sharing/rest/content/items/{item.id}/data`
- */
-export declare const getItemDataUrl: (item: IItem, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions, token?: string) => string;

package/dist/types/urls/get-item-home-url.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
-/**
- * Return the URL of the item's page in the Portal Home application
- * @param itemId The item's ID
- * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
- * @returns URL to the item's data REST end point, defaults to `https://www.arcgis.com/home/item.html?id={item.id}`
- */
-export declare function getItemHomeUrl(itemId: string, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

package/dist/types/urls/get-portal-api-url.d.ts

@@ -1,26 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
-/**
- * ```js
- * import { getPortalApiUrl } from "@esri/hub-common";
- * // from a portal base URL
- * let portalApiUrl = getPortalApiUrl("https://org.maps.arcgis.com"); // https://org.maps.arcgis.com/sharing/rest
- * // from an enterprise portal self response (IPortal)
- * let portalSelf = { isPortal: true, portalHostname: "server.example.org" };
- * portalApiUrl = getPortalApiUrl(portalSelf); // https://server.example.org/sharing/rest
- * // from an online portal self response (IPortal)
- * portalSelf = { isPortal: false, urlKey: "org", customBaseUrl: "maps.arcgis.com" };
- * portalApiUrl = getPortalApiUrl(portalSelf); // https://org.maps.arcgis.com/sharing/rest
- * // from hub request options (IHubRequestOptions) with a portal self (IPortal)
- * let requestOptions = { isPortal: false, portalSelf };
- * portalApiUrl = getPortalApiUrl(requestOptions); // https://org.maps.arcgis.com/sharing/rest
- * // from request options (IRequestOptions) with a portal (string)
- * requestOptions = { portal: "https://org.maps.arcgis.com/sharing/rest" };
- * portalApiUrl = getPortalApiUrl(requestOptions); // https://org.maps.arcgis.com/sharing/rest
- * ```
- * Derive a portal's API URL from the portal's base URL, a portal object, or request options
- * @param urlOrObject a portal base URL, a portal object, or request options containing either of those
- * @returns The portal API URL, defaults to `https://www.arcgis.com/sharing/rest`
- */
-export declare function getPortalApiUrl(urlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

package/dist/types/urls/get-portal-url.d.ts

@@ -1,26 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
-/**
- * ```js
- * import { getPortalUrl } from "@esri/hub-common";
- * // from a portal API URL
- * let portalUrl = getPortalUrl("https://org.maps.arcgis.com/sharing/rest"); // https://org.maps.arcgis.com
- * // from an enterprise portal self response (IPortal)
- * let portalSelf = { isPortal: true, portalHostname: "server.example.org" };
- * portalUrl = getPortalUrl(portalSelf); // https://server.example.org
- * // from an online portal self response (IPortal)
- * portalSelf = { isPortal: false, urlKey: "org", customBaseUrl: "maps.arcgis.com" };
- * portalUrl = getPortalUrl(portalSelf); // https://org.maps.arcgis.com
- * // from hub request options (IHubRequestOptions) with a portal self (IPortal)
- * let requestOptions = { isPortal: false, portalSelf };
- * portalUrl = getPortalUrl(requestOptions); // https://org.maps.arcgis.com
- * // from request options (IRequestOptions) with a portal (string)
- * requestOptions = { portal: "https://org.maps.arcgis.com/sharing/rest" };
- * portalUrl = getPortalUrl(requestOptions); // https://org.maps.arcgis.com
- * ```
- * Derive a portal's base URL from the portal's API URL, a portal object, or request options
- * @param urlOrObject a portal API URL, a portal object, or request options containing either of those
- * @returns The portal base URL, defaults to `https://www.arcgis.com`
- */
-export declare function getPortalUrl(urlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

package/dist/types/urls/hub-cdn-urlmap.d.ts

@@ -1,8 +0,0 @@
-/**
- * Mapping between the AGO Env's and the Hub's asset CDNs
- */
-export declare const HUB_CDN_URLMAP: {
-    devext: string;
-    qaext: string;
-    www: string;
-};

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

@@ -1,27 +0,0 @@
-export * from "./build-url";
-export * from "./get-hub-locale-asset-url";
-export * from "./get-portal-api-url";
-export * from "./get-portal-url";
-export * from "./hub-cdn-urlmap";
-export * from "./upgrade-protocol";
-export * from "./strip-protocol";
-export * from "./_get-http-and-https-uris";
-export * from "./_get-location";
-export * from "./get-hub-api-url-from-portal";
-export * from "./get-hub-url-from-portal";
-export * from "./get-item-home-url";
-export * from "./get-item-api-url";
-export * from "./get-item-data-url";
-/**
- *
- * @param url
- * @returns true if the url is of a map or feature service
- */
-export declare const isMapOrFeatureServerUrl: (url: string) => boolean;
-/**
- * parses map or feature service type from URL
- * @param url map or feature service URL
- * @returns item type, either "Map Service" or "Feature Service"
- * or undefined for other types of URLs
- */
-export declare const getServiceTypeFromUrl: (url: string) => string;

package/dist/types/urls/strip-protocol.d.ts

@@ -1,5 +0,0 @@
-/**
- * Remove protocol if present
- * @param {string} hostname Hostname
- */
-export declare function stripProtocol(hostname: string): string;

package/dist/types/urls/upgrade-protocol.d.ts

@@ -1,5 +0,0 @@
-/**
- * Add protocol or upgrade http to https
- * @param {string} url
- */
-export declare function upgradeProtocol(url: string): string;