@esri/hub-common 9.10.0 → 9.10.1-beta.1

package/dist/types/sites/domains/is-domain-for-legacy-site.d.ts

@@ -1,9 +0,0 @@
-import { IDomainEntry } from "../../types";
-/**
- * Determine if a domain entry belongs to a legacy site.
- * This is used to allow customers to "reclaim" domains that
- * were associated with legacy sites which can no longer be
- * edited.
- * @param {IHubDomain} domainEntry Domain Info record
- */
-export declare function isDomainForLegacySite(domainEntry: IDomainEntry): boolean;

package/dist/types/sites/domains/is-domain-used-elsewhere.d.ts

@@ -1,10 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Check to see if a domain is in use by any site other than the
- * one passed in. This is used in various validators while the
- * user is editing properties of the site.
- * @param {string} hostname to check
- * @param {string} siteId Site Id we are checking for
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function isDomainUsedElsewhere(hostname: string, siteId: string, hubRequestOptions: IHubRequestOptions): Promise<boolean>;

package/dist/types/sites/domains/is-valid-domain.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Validate a custom domain
- * @param {string} hostname to validate
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function isValidDomain(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/domains/lookup-domain.d.ts

@@ -1,11 +0,0 @@
-import { IHubRequestOptions, IDomainEntry } from "../../types";
-/**
- * Fetch a the information about a domain.
- * Different implementation for Portal vs AGO
- * @param {string} hostname of domain record to locate
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function lookupDomain(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<IDomainEntry | {
-    hostname: string;
-    siteId: string;
-}>;

package/dist/types/sites/domains/remove-domain.d.ts

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

package/dist/types/sites/domains/update-domain.d.ts

@@ -1,8 +0,0 @@
-import { IDomainEntry } from "../../types";
-import { IHubRequestOptions } from "../../types";
-/**
- * Update an entry in the domain system
- * @param {IHubDomain} domainEntry  Doman object to be updated
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function updateDomain(domainEntry: IDomainEntry, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/drafts/build-draft.d.ts

@@ -1,7 +0,0 @@
-import { IModel, IDraft } from "../..";
-/**
- * Builds a draft with a subset of the model properties
- * @param {*} model - item model
- * @param {*} includeList - list of property paths to include in draft object
- */
-export declare function buildDraft(model: IModel, includeList: string[]): IDraft;

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

@@ -1 +0,0 @@
-export * from "./build-draft";

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

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "..";
-/**
- * Get a Site Model by it's Item Id, and apply schema upgrades
- * @param {String} id Site Item Id
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function getSiteById(id: string, hubRequestOptions: IHubRequestOptions): Promise<import("..").IModel>;

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

@@ -1,14 +0,0 @@
-import { IHubRequestOptions } from "../types";
-/**
- * Returns site model given various kinds of identifier
- *
- * @param identifier - a site item ID, site hostname, enterprise site slug, or full site URL
- * @param hubRequestOptions
- */
-export declare function fetchSite(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<import("../types").IModel>;
-export * from "./domains";
-export * from "./drafts";
-export * from "./_ensure-telemetry";
-export * from "./get-site-by-id";
-export * from "./site-schema-version";
-export * from "./upgrade-site-schema";

package/dist/types/sites/site-schema-version.d.ts

@@ -1 +0,0 @@
-export declare const SITE_SCHEMA_VERSION = 1.5;

package/dist/types/sites/upgrade-site-schema.d.ts

@@ -1,6 +0,0 @@
-import { IModel } from "../types";
-/**
- * Upgrades the schema upgrades
- * @param model IModel
- */
-export declare function upgradeSiteSchema(model: IModel): IModel;

package/dist/types/surveys/get-input-feature-service-model.d.ts

@@ -1,11 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Gets the primary input Feature Service for the given
- * Form ID. This will be the Fieldworker view, if it exists,
- * otherwise the source Feature Service.
- * @param {string} formId The Form ID
- * @param requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getInputFeatureServiceModel: (formId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-source-feature-service-model-from-fieldworker.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Fetches a Survey's source Feature Service from a given
- * Fieldworker View ID
- * @param {string} fieldworkerId The Fieldworker View ID
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getSourceFeatureServiceModelFromFieldworker: (fieldworkerId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-stakeholder-model.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Fetches a Survey's Stakeholder View for a given
- * Form ID
- * @param {string} formId A Form ID
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getStakeholderModel: (formId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-survey-models.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-portal";
-import { IGetSurveyModelsResponse } from "../types";
-/**
- * Builds a dictionary of Survey items for the given Form model
- * @param {string} formId The Form ID of the survey
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IGetSurveyModelsResponse>}
- */
-export declare const getSurveyModels: (formItemOrId: string | IItem, requestOptions: IRequestOptions) => Promise<IGetSurveyModelsResponse>;

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

@@ -1,5 +0,0 @@
-export * from "./get-input-feature-service-model";
-export * from "./get-source-feature-service-model-from-fieldworker";
-export * from "./get-stakeholder-model";
-export * from "./get-survey-models";
-export * from "./is-fieldworker-view";

package/dist/types/surveys/is-fieldworker-view.d.ts

@@ -1,8 +0,0 @@
-import { IItem } from "@esri/arcgis-rest-types";
-/**
- * Determines if the provided Feature Service item is a
- * Fieldworker View
- * @param {IItem} featureServiceItem
- * @returns {boolean}
- */
-export declare function isFieldworkerView(featureServiceItem: IItem): boolean;

package/dist/types/types.d.ts

@@ -1,418 +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 BBox = number[][];
-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";
-export declare type GeographyProvenance = "item" | "none" | "automatic";
-/**
- * Location of a Hub resource
- *
- * @export
- * @interface IHubGeography
- */
-export interface IHubGeography {
-    center?: [number, number];
-    geometry?: IGeometry;
-    provenance?: GeographyProvenance;
-}
-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;
-}
-export 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;