@esri/hub-common 15.36.1 → 15.37.1

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

@@ -1,4 +1,4 @@
-import { IDomainEntry, IHubRequestOptions } from "../../types";
+import { IDomainEntry, IHubRequestOptions } from "../../hub-types";
 /**
  * Create an entry in the domain system
  * @param {IHubDomain} domainEntry Domain hash to be stored

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions, IModel } from "../../types";
+import { IHubRequestOptions, IModel } from "../../hub-types";
 /**
  * Given a Site Model, register the domains with the Domain Service.
  *

package/dist/types/sites/domains/domain-exists-portal.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Check if an item exists with the specified domain keyword
  * @param {String} hostname to check for

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Check if a domain entry exists. Different from lookupDomain
  * in that this will return true/false, where as lookupDomain will

package/dist/types/sites/domains/ensure-unique-domain-name.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Given a subdomain, ensure that we have a unique hostname
  * incrementing if needed

package/dist/types/sites/domains/get-domains-for-site.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions, IDomainEntry } from "../../types";
+import { IHubRequestOptions, IDomainEntry } from "../../hub-types";
 /**
  * Get a list
  * @param {string} siteId Item id of the Site

package/dist/types/sites/domains/get-unique-domain-name-portal.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Ensure a unique domain name by checking for and incrementing
  * a subdomain

package/dist/types/sites/domains/get-unique-domain-name.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Ensure a unique domain name by checking for and incrementing
  * a subdomain

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

@@ -1,4 +1,4 @@
-import { IDomainEntry } from "../../types";
+import { IDomainEntry } from "../../hub-types";
 /**
  * Determine if a domain entry belongs to a legacy site.
  * This is used to allow customers to "reclaim" domains that

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-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

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Validate a custom domain
  * @param {string} hostname to validate

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions, IDomainEntry } from "../../types";
+import { IHubRequestOptions, IDomainEntry } from "../../hub-types";
 /**
  * Fetch a the information about a domain.
  * Different implementation for Portal vs AGO

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Remove a domain entry.
  * User must be a member of the org that owns the domain entry.

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Remove all domain entries by site id.
  * User must be a member of the org that owns the domain entry.

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../../types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Remove an entry from the domain service, based on a hostname
  *

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

@@ -1,5 +1,5 @@
-import { IDomainEntry } from "../../types";
-import { IHubRequestOptions } from "../../types";
+import { IDomainEntry } from "../../hub-types";
+import { IHubRequestOptions } from "../../hub-types";
 /**
  * Update an entry in the domain system
  * @param {IHubDomain} domainEntry  Doman object to be updated

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

@@ -1,4 +1,4 @@
-import { IDraft, IModel } from "../../types";
+import { IDraft, IModel } from "../../hub-types";
 /**
  * Builds a draft with a subset of the model properties
  * @param {*} model - item model

package/dist/types/sites/feed-configuration.d.ts

@@ -1,4 +1,4 @@
-import { IModel } from "../types";
+import { IModel } from "../hub-types";
 declare type FeedFormat = "dcat-us" | "dcat-ap" | "rss";
 /**
  * DEPRECATED: Use `getFeedTemplate()` instead

package/dist/types/sites/feeds/previewFeed.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { FeedFormat } from "./types";
 export interface IPreviewFeedOptions {
     format: FeedFormat;

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

@@ -1,8 +1,8 @@
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-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 fetchSiteModel(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<import("../types").IModel>;
+export declare function fetchSiteModel(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<import("../hub-types").IModel>;

package/dist/types/sites/get-catalog-from-site-model.d.ts

@@ -1,5 +1,5 @@
 import { IHubCatalog } from "../search";
-import { IModel } from "../types";
+import { IModel } from "../hub-types";
 /**
  * Gets new catalog from site model
  *

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

@@ -1,7 +1,7 @@
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * 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("../types").IModel>;
+export declare function getSiteById(id: string, hubRequestOptions: IHubRequestOptions): Promise<import("../hub-types").IModel>;

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

@@ -21,3 +21,4 @@ export * from "./feeds/setFeedTemplate";
 export * from "./feeds/previewFeed";
 export * from "./feeds/types";
 export * from "./get-catalog-from-site-model";
+export { defaultSiteCollectionKeys } from "./defaultSiteCollectionKeys";

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions, IModel } from "../types";
+import { IHubRequestOptions, IModel } from "../hub-types";
 /**
  * @private
  * @internal

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

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 interface IGroupReharvestInfo {
     /**
      * Catalog group being harvested

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

@@ -1,4 +1,4 @@
-import { IModel } from "../types";
+import { IModel } from "../hub-types";
 /**
  * Upgrades the schema upgrades
  * @param model IModel

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

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 import { IEditorConfig } from "../core/schemas/types";

package/dist/types/surveys/_internal/SurveyUiSchemaEdit.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
 import { IHubSurvey } from "../../core/types/IHubSurvey";
 /**

package/dist/types/surveys/_internal/SurveyUiSchemaSettings.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
 import { IUiSchema } from "../../core/schemas/types";
 /**

package/dist/types/surveys/_internal/computeProps.d.ts

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubSurvey } from "../../core/types/IHubSurvey";
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Given a model and a Survey object, set various computed properties that can't be directly mapped
  * @private

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

@@ -1,6 +1,6 @@
 import { IItem } from "@esri/arcgis-rest-types";
 import { IHubSurvey } from "../core/types/IHubSurvey";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * @private
  * Get a Survey entity by id or slug

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

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Gets the primary input Feature Service for the given
  * Form ID. This will be the Fieldworker view, if it exists,

package/dist/types/surveys/utils/get-s123-edit-url.d.ts

@@ -1,2 +1,2 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 export declare function getS123EditUrl(id: string, context: IArcGISContext): string;

package/dist/types/surveys/utils/get-s123-share-url.d.ts

@@ -1,2 +1,2 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 export declare function getS123ShareUrl(id: string, context: IArcGISContext): string;

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

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Fetches a Survey's source Feature Service from a given
  * Fieldworker View ID

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

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Fetches a Survey's Stakeholder View for a given
  * Form ID

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { IGetSurveyModelsResponse } from "../../types";
+import { IGetSurveyModelsResponse } from "../../hub-types";
 /**
  * Builds a dictionary of Survey items for the given Form model
  * @param {string} formId The Form ID of the survey

package/dist/types/templates/HubTemplate.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 import { IEditorConfig } from "../core/schemas/types";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { IHubTemplate, IHubTemplateEditor } from "../core/types/IHubTemplate";

package/dist/types/templates/_internal/TemplateUiSchemaEdit.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
 import { IUiSchema } from "../../core/schemas/types";
 /**

package/dist/types/templates/_internal/computeProps.d.ts

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 import { IHubTemplate } from "../../core/types/IHubTemplate";
 /**
  * @private

package/dist/types/templates/defaults.d.ts

@@ -1,5 +1,5 @@
 import { IHubTemplate } from "../core/types/IHubTemplate";
-import { IModel } from "../types";
+import { IModel } from "../hub-types";
 /**
  * NOTE: this file provides default values for new
  * Hub Template creation; however, we have no immediate

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubTemplate } from "../core/types/IHubTemplate";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubSearchResult } from "../search/types";
 /**

package/dist/types/types/IArcGISContext.d.ts

@@ -0,0 +1,258 @@
+import { UserSession, IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IPortal } from "@esri/arcgis-rest-portal";
+import type { IRequestOptions } from "@esri/arcgis-rest-request";
+import type { IUser } from "@esri/arcgis-rest-types";
+import { HubServiceStatus, HubEntity } from "../core";
+import type { IHubHistory, IHubHistoryEntry } from "../core/hubHistory";
+import type { HubLicense, HubEnvironment, IFeatureFlags, Permission, IPermissionAccessResponse } from "../permissions";
+import type { IHubRequestOptions, IHubTrustedOrgsResponse, UserResourceApp } from "../hub-types";
+import type { IUserResourceToken } from "./IUserResourceToken";
+import type { IUserHubSettings } from "../utils/IUserHubSettings";
+/**
+ * Defines the properties of the ArcGISContext.
+ * Typically components or functions will get an instance
+ * of `ArcGISContext` from `ArcGISContetManager`.
+ *
+ * `ArcGISContext` implements this interface, and uses
+ * getters to simplify the derivation of various complex properties.
+ *
+ */
+export interface IArcGISContext {
+    /**
+     * Unique id from the ArcGISContextManager that created
+     * this instance. Primarily useful for debugging possible
+     * race-conditions that can result in multiple ArcGISContextManager
+     * instances being created.
+     */
+    id: number;
+    /**
+     * Return the UserSession if authenticated
+     */
+    session: UserSession;
+    /**
+     * Return boolean indicating if authenticatio is present
+     */
+    isAuthenticated: boolean;
+    /**
+     * Return `IUserRequestOptions`, which is used for REST-JS
+     * functions which require authentication information.
+     *
+     * If context is not authenticated, this function will return `undefined`
+     */
+    userRequestOptions: IUserRequestOptions;
+    /**
+     * Return `IRequestOptions`, which is used by REST-JS functions
+     * which *may* use authentication information if provided.
+     *
+     * If context is not authenticated, this function just returns
+     * the `portal` property, which informs REST-JS what Sharing API
+     * instance to use (i.e. AGO, Enterprise etc)
+     */
+    requestOptions: IRequestOptions;
+    /**
+     * Return a `IHubRequestOptions` object
+     *
+     * If context is not authenticated, this function will return `undefined`
+     */
+    hubRequestOptions: IHubRequestOptions;
+    /**
+     * Return the portal url.
+     *
+     * If authenticated @ ArcGIS Online, it will return
+     * the https://org.env.arcgis.com
+     *
+     * If authenticated @ ArcGIS Enterprise, it will return
+     * https://{portalHostname}/{webadaptor}
+     */
+    portalUrl: string;
+    /**
+     * Returns the url to the sharing api composed from portalUrl
+     * i.e. https://myorg.maps.arcgis.com/sharing/rest
+     */
+    sharingApiUrl: string;
+    /**
+     * Returns the Hub url, based on the portalUrl
+     *
+     * For ArcGIS Enterprise this will return `undefined`
+     */
+    hubUrl: string;
+    /**
+     * Url for the Hub OGC API
+     */
+    ogcApiUrl: string;
+    /**
+     * Returns the current user's hub-home url. If not authenticated,
+     * returns the Hub Url. If portal, returns undefined
+     */
+    hubHomeUrl: string;
+    /**
+     * Returns boolean indicating if the backing system
+     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+     */
+    isPortal: boolean;
+    /**
+     * Returns the discussions API URL
+     */
+    discussionsServiceUrl: string;
+    /**
+     * Returns the Hub Search API URL
+     */
+    hubSearchServiceUrl: string;
+    /**
+     * Returns Hub Domain Service URL
+     */
+    domainServiceUrl: string;
+    /**
+     * Returns the Events configuration object from portal/self
+     *
+     * `{serviceId: '3ef..', publicViewId: 'bc3...'}`
+     */
+    eventsConfig: any;
+    /**
+     * Returns boolean indicating if the current user
+     * belongs to an organization that has licensed
+     * ArcGIS Hub
+     */
+    hubEnabled: boolean;
+    /**
+     * Return Hub Community Org Id, if defined
+     */
+    communityOrgId: string;
+    /**
+     * If we are in a community org with an associated e-org Return the Hub Enterprise Org Id, if defined
+     */
+    enterpriseOrgId: string;
+    /**
+     * Returns the Community Org Hostname, if defined
+     */
+    communityOrgHostname: string;
+    /**
+     * Returns the Hub Community Org url
+     *
+     * i.e. https://c-org.maps.arcgis.com
+     */
+    communityOrgUrl: string;
+    /**
+     * Returns the hash of helper services from portal self
+     */
+    helperServices: any;
+    /**
+     * Returns the current user
+     */
+    currentUser: IUser;
+    /**
+     * Returns the portal object
+     */
+    portal: IPortal;
+    /**
+     * What is the current user's hub license level?
+     */
+    hubLicense: HubLicense;
+    /**
+     * Additional app-specific context
+     */
+    properties: Record<string, any>;
+    /**
+     * Hub Service Status
+     */
+    serviceStatus: HubServiceStatus;
+    /**
+     * Is this user in a Hub Alpha org?
+     * Derived from properties.alphaOrgs
+     */
+    isAlphaOrg: boolean;
+    /**
+     * Is this user in a Hub Beta org?
+     * Derived from properties.betaOrgs
+     */
+    isBetaOrg: boolean;
+    /**
+     * What environment is this running in?
+     */
+    environment: HubEnvironment;
+    /**
+     * Hash of feature flags
+     */
+    featureFlags: IFeatureFlags;
+    /**
+     * Array of Trusted Org Ids
+     */
+    trustedOrgIds: string[];
+    /**
+     * Trusted orgs xhr response
+     */
+    trustedOrgs: IHubTrustedOrgsResponse[];
+    /**
+     * Array of exchanged tokens for use
+     * with user-app-resources
+     */
+    userResourceTokens?: IUserResourceToken[];
+    /**
+     * Hash of user hub settings. These are stored as
+     * user-app-resources, associated with the `hubforarcgis` clientId
+     */
+    userHubSettings?: IUserHubSettings;
+    /**
+     * Return the user's history
+     * @returns
+     */
+    history: IHubHistory;
+    /**
+     * Return the portal thumbnail url
+     */
+    orgThumbnailUrl: string;
+    /**
+     * Return the Survey123 url
+     */
+    survey123Url: string;
+    /**
+     * Is the current users org type a community org?
+     */
+    isCommunityOrg: boolean;
+    /**
+     * Is the current user an org admin and not in a custom role?
+     */
+    isOrgAdmin: boolean;
+    /**
+     * Groups that contain Hub Resources (linkable documents etc)
+     * that are tagged to appear in different areas of the appliation.
+     * Default platform groups are defined per-environment in the
+     * "HUB_RESOURE_GROUPS" const..
+     */
+    resourceGroupIDs: string[];
+    /**
+     * Return the token for a given app, if defined
+     * @param app
+     */
+    tokenFor(app: UserResourceApp): string;
+    /**
+     * Refresh the current user, including their groups
+     */
+    refreshUser(): Promise<void>;
+    /**
+     * Add an entry to the user's history
+     * If not authenticated, this function will no-op
+     * @param entry
+     */
+    addToHistory(entry: IHubHistoryEntry): Promise<void>;
+    /**
+     * Remove a specific entry from the user's history
+     * @param entry
+     */
+    removeFromHistory(entry: IHubHistoryEntry): Promise<void>;
+    /**
+     * Simple clear of the all of the user's history
+     */
+    clearHistory(): Promise<void>;
+    /**
+     * Check specific permission for the current user, and optionally an entity
+     * @param permission
+     * @param entity
+     */
+    checkPermission(permission: Permission, entity?: HubEntity): IPermissionAccessResponse;
+    /**
+     * Update the user's hub settings directly from the Context
+     * @param settings
+     */
+    updateUserHubSettings(settings: IUserHubSettings): Promise<void>;
+}