@esri/hub-common 15.37.0 → 15.37.1

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

package/dist/types/types/IArcGISContextManagerOptions.d.ts

@@ -0,0 +1,86 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IUser } from "@esri/arcgis-rest-types";
+import { IUserResourceToken } from "./IUserResourceToken";
+import { IUserResourceConfig } from "./IUserResourceConfig";
+import { HubServiceStatus } from "../core/types/ISystemStatus";
+import { IFeatureFlags } from "../permissions";
+import { IHubTrustedOrgsResponse } from "../hub-types";
+import { Level } from "../utils";
+import { IUserHubSettings } from "../utils/IUserHubSettings";
+/**
+ * Options that can be passed into `ArcGISContextManager.create`
+ */
+export interface IArcGISContextManagerOptions {
+    /**
+     * Existing user session, which may be created from Identity Manager
+     * `const session = UserSession.fromCredential(idMgr.getCredential());`
+     */
+    authentication?: UserSession;
+    /**
+     * ArcGIS Online or ArcGIS Enterprise portal url.
+     * Do not include  `/sharing/rest`
+     * Defaults to `https://www.arcgis.com`
+     * For ArcGIS Enterprise, you must include the webadaptor name.
+     * i.e. https://gis.mytown.gov/portal
+     *
+     * When Authentication is present, the UserSession.portal value is
+     * used instead of this property.
+     */
+    portalUrl?: string;
+    /**
+     * Portal self for the authenticated user. If not passed into `.create`
+     * with the UserSession, it will be fetched
+     */
+    portal?: IPortal;
+    /**
+     * Current user as `IUser`. If not passed into `.create` with the UserSession
+     * it will be fetched.
+     */
+    currentUser?: IUser;
+    /**
+     * Any additional properties to expose on the context. This allows
+     * an application to send additional context into the system.
+     * For example, in ArcGIS Hub, many times we want to pass in the
+     * active "Hub Site" as additional context, so we will send that in
+     * as a node on a properties object.
+     */
+    properties?: Record<string, any>;
+    /**
+     * Logging level
+     * off > error > warn > info > debug > all
+     * defaults to 'error'
+     */
+    logLevel?: Level;
+    /**
+     * Option to pass in service status vs fetching it
+     */
+    serviceStatus?: HubServiceStatus;
+    /**
+     * Optional hash of feature flags
+     */
+    featureFlags?: IFeatureFlags;
+    /**
+     * Array of Trusted Org Ids
+     */
+    trustedOrgIds?: string[];
+    /**
+     * Trusted orgs xhr response
+     */
+    trustedOrgs?: IHubTrustedOrgsResponse[];
+    /**
+     * Array of app, clientId's that Context Manager should
+     * exchange tokens for
+     */
+    resourceConfigs?: IUserResourceConfig[];
+    /**
+     * Array of app, clientId, token objects which Context
+     * Manager has exchanged tokens for
+     */
+    resourceTokens?: IUserResourceToken[];
+    /**
+     * Hash of user hub settings. These are stored as
+     * user-app-resources, associated with the `hubforarcgis` clientId
+     */
+    userHubSettings?: IUserHubSettings;
+}

package/dist/types/types/IArcGISContextOptions.d.ts

@@ -0,0 +1,78 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+import type { IPortal } from "@esri/arcgis-rest-portal";
+import type { IUser } from "@esri/arcgis-rest-types";
+import type { IUserResourceToken } from "./IUserResourceToken";
+import type { HubServiceStatus } from "../core/types/ISystemStatus";
+import type { IFeatureFlags } from "../permissions";
+import type { IHubTrustedOrgsResponse } from "../hub-types";
+import type { IUserHubSettings } from "../utils/IUserHubSettings";
+/**
+ * Options for the ArcGISContext constructor
+ */
+export interface IArcGISContextOptions {
+    /**
+     * 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;
+    /**
+     * Portal base url
+     * For ArcGIS Online - https://org.env.arcgis.com
+     * For ArcGIS Enterprise - https://{portalHostname}/{webadaptor}
+     */
+    portalUrl: string;
+    /**
+     * Hub Url that corresponds to the portal url is appropritate
+     */
+    hubUrl?: string;
+    /**
+     * The current UserSession
+     */
+    authentication?: UserSession;
+    /**
+     * If the user is authenticated, the portal should be passed in
+     * so various getters can work as expected.
+     *
+     * ArcGISContextManager handles this internally
+     */
+    portalSelf?: IPortal;
+    /**
+     * If the user is authenticated, the user should be passed in
+     * so various getters can work as expected.
+     *
+     * ArcGISContextManager handles this internally
+     */
+    currentUser?: IUser;
+    /**
+     * Optional hash of additional context
+     */
+    properties?: Record<string, any>;
+    /**
+     * Option to pass in service status vs fetching it
+     */
+    serviceStatus?: HubServiceStatus;
+    /**
+     * 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;
+}

package/dist/types/types/IUserResourceConfig.d.ts

@@ -0,0 +1,5 @@
+import type { UserResourceApp } from "../hub-types";
+export interface IUserResourceConfig {
+    app: UserResourceApp;
+    clientId: string;
+}

package/dist/types/types/IUserResourceToken.d.ts

@@ -0,0 +1,4 @@
+import type { IUserResourceConfig } from "./IUserResourceConfig";
+export interface IUserResourceToken extends IUserResourceConfig {
+    token: string;
+}

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

@@ -1 +1,6 @@
+export * from "./IArcGISContext";
+export * from "./IArcGISContextManagerOptions";
+export * from "./IArcGISContextOptions";
 export * from "./IMessage";
+export * from "./IUserResourceConfig";
+export * from "./IUserResourceToken";

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

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 import { IPortal } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 interface IBuildHubCampaignUrl {

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem, IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Get the fully qualified URL to the REST end point for an item.
  * @param item w/ id and access

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem, IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Get the fully qualified URL to the data REST end point for an item
  * @param item w/ id and access

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Return the URL of the item's page in the Portal Home application
  * @param itemId The item's ID

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * ```js
  * import { getPortalApiUrl } from "@esri/hub-common";

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * ```js
  * import { getPortalUrl } from "@esri/hub-common";

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

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 import { HubEntity } from "../core/types/HubEntity";
 import { CardModelTarget } from "../core/types/IHubCardViewModel";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";

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

@@ -1,5 +1,5 @@
 import { IPortal } from "@esri/arcgis-rest-portal/dist/esm/util/get-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 import { IRequestOptions } from "@esri/arcgis-rest-request/dist/esm/utils/IRequestOptions";
 /**
  * Computes a URL to the "Content" tab in the AGO Home app for a given portal URL string, IPortal, IHubRequestOptions or IRequestOptions object

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Return the URL of the group's page in the Portal Home application
  * @param groupId The group's ID

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Return the URL of the user's page in the Portal Home application
  * @param username The username

package/dist/types/urls/is-safe-redirect-url.d.ts

@@ -1,4 +1,4 @@
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 interface IIsSafeRedirectUrlOptions extends IHubRequestOptions {
     url: string;
 }

package/dist/types/users/HubUser.d.ts

@@ -1,5 +1,5 @@
 import { IEntityEditorContext, IHubUser } from "../core/types";
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 import { IEditorConfig } from "../core/schemas/types";
 import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 import { UserEditorType } from "./_internal/UserSchema";

package/dist/types/users/HubUsers.d.ts

@@ -1,8 +1,8 @@
 import { IUser } from "@esri/arcgis-rest-types";
 import { IHubUser } from "../core/types/IHubUser";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";
-import { IArcGISContext } from "../ArcGISContext";
+import type { IArcGISContext } from "../types/IArcGISContext";
 /**
  * Converts a IUser object into an IHubUser.
  *

package/dist/types/users/_internal/UserUiSchemaSettings.d.ts

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

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

@@ -1,5 +1,5 @@
 import { IUser } from "@esri/arcgis-rest-types";
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IHubUser } from "../../core/types";
 /**
  * Given a model and a user, sets various computed properties that can't be directly mapped.

package/dist/types/users/_internal/enrichments.d.ts

@@ -1,5 +1,5 @@
 import { IUser, IPortal } from "@esri/arcgis-rest-portal";
-import { IEnrichmentErrorInfo, IHubRequestOptions } from "../../types";
+import { IEnrichmentErrorInfo, IHubRequestOptions } from "../../hub-types";
 /**
  * Possible additional properties available through enrichments
  */

package/dist/types/utils/IUserHubSettings.d.ts

@@ -0,0 +1,32 @@
+import { IHubHistory } from "../core/hubHistory";
+/**
+ * Hub Level Settings
+ */
+export interface IUserHubSettings {
+    schemaVersion: number;
+    username?: string;
+    updated?: number;
+    /**
+     * Track notices the user has dismissed
+     * stored as an object so we can add more types in the future
+     */
+    notices?: {
+        /**
+         * Ids of notices the user has dismissed
+         */
+        dismissed?: string[];
+    };
+    /**
+     * Features that are enabled for the user in preview mode
+     */
+    preview?: {
+        /**
+         * Enable the workspace feature
+         */
+        workspace: boolean;
+    };
+    /**
+     * Optional history of sites/content the user has visited
+     */
+    history?: IHubHistory;
+}

package/dist/types/utils/IUserSiteSettings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Site Level Settings
+ */
+export interface IUserSiteSettings {
+    schemaVersion: number;
+    username?: string;
+    updated?: number;
+}

package/dist/types/utils/batch.d.ts

@@ -1,4 +1,4 @@
-import { IBatch, IBatchTransform } from "../types";
+import { IBatch, IBatchTransform } from "../hub-types";
 /**
  * Helper to split a large number of calls into
  * smaller batches of concurrent calls.

package/dist/types/utils/create-operation-pipeline.d.ts

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import OperationStack from "../OperationStack";
-import { IHubRequestOptions } from "../types";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Container type for Piping in Hub
  */

package/dist/types/utils/fail-safe.d.ts

@@ -1,4 +1,4 @@
-import { GenericAsyncFunc } from "../types";
+import { GenericAsyncFunc } from "../hub-types";
 /**
  * Wrap an async function such that it will never reject
  * @param {Function} fn Async Function that we want to never fail