@esri/hub-common 15.36.1 → 15.37.1

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

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

@@ -1,44 +1,6 @@
-import { IArcGISContext } from "../ArcGISContext";
-import { IHubHistory } from "../core/hubHistory";
-/**
- * Site Level Settings
- */
-export interface IUserSiteSettings {
-    schemaVersion: number;
-    username?: string;
-    updated?: number;
-}
-/**
- * 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;
-}
+import type { IArcGISContext } from "../types/IArcGISContext";
+import { IUserSiteSettings } from "./IUserSiteSettings";
+import { IUserHubSettings } from "./IUserHubSettings";
 /**
  * Store User settings in the Site App's cache
  * @param settings

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

@@ -28,3 +28,5 @@ export * from "./getObjectSize";
 export * from "./date";
 export * from "./isComboboxItemSelected";
 export * from "./wait";
+export * from "./IUserHubSettings";
+export * from "./IUserSiteSettings";

package/dist/types/utils/internal/clearUserHubSettings.d.ts

@@ -1,5 +1,5 @@
-import { IArcGISContext } from "../../ArcGISContext";
-import { UserResourceApp } from "../../ArcGISContextManager";
+import type { IArcGISContext } from "../../types/IArcGISContext";
+import type { UserResourceApp } from "../../hub-types";
 export declare const USER_HUB_SETTINGS_APP: UserResourceApp;
 export declare const USER_HUB_SETTINGS_KEY = "hub-settings.json";
 /**

package/dist/types/utils/internal/clearUserSiteSettings.d.ts

@@ -1,5 +1,5 @@
-import { IArcGISContext } from "../../ArcGISContext";
-import { UserResourceApp } from "../../ArcGISContextManager";
+import type { IArcGISContext } from "../../types/IArcGISContext";
+import type { UserResourceApp } from "../../hub-types";
 export declare const USER_SITE_SETTINGS_APP: UserResourceApp;
 export declare const USER_SITE_SETTINGS_KEY = "hub-site-settings.json";
 /**

package/dist/types/utils/internal/fetchAndMigrateUserHubSettings.d.ts

@@ -1,4 +1,4 @@
-import { IUserHubSettings } from "../hubUserAppResources";
+import { IUserHubSettings } from "../IUserHubSettings";
 /**
  * @private
  * Fetch the User Hub Settings and apply migrations

package/dist/types/utils/internal/resolveDynamicValue.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { DynamicValueDefinition, DynamicValueResult } from "../../core/types/DynamicValues";
 /**
  * @internal

package/dist/types/utils/internal/resolveDynamicValues.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { DynamicValueDefinition, DynamicValueResult } from "../../core/types/DynamicValues";
 /**
  * @internal

package/dist/types/utils/internal/resolveItemQueryValues.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { DynamicValues, IDynamicItemQueryDefinition } from "../../core/types/DynamicValues";
 /**
  * @internal

package/dist/types/utils/internal/resolvePortalValues.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { DynamicValues, IDynamicPortalSelfDefinition } from "../../core/types/DynamicValues";
 /**
  * @internal

package/dist/types/utils/internal/resolveServiceQueryValues.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { DynamicValues, IDynamicServiceQueryDefinition } from "../../core/types/DynamicValues";
 /**
  * @internal

package/dist/types/utils/internal/setEntityStatusKeyword.d.ts

@@ -1,4 +1,4 @@
-import { HubEntityStatus } from "../../types";
+import { HubEntityStatus } from "../../hub-types";
 /**
  * adds/updates the entity status typekeyword and returns
  * a new array of typekeywords

package/dist/types/utils/internal/siteSettingsMigrations.d.ts

@@ -1,4 +1,5 @@
-import { IUserHubSettings, IUserSiteSettings } from "../hubUserAppResources";
+import { IUserHubSettings } from "../IUserHubSettings";
+import { IUserSiteSettings } from "../IUserSiteSettings";
 /**
  * Apply migrations for Site Settings
  * @param settings

package/dist/types/utils/internal/updateCommunityOrgSettings.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IHubUserOrgSettings } from "../../core/types/IHubUser";
 /**
  * Function to update a user's community org settings. Expects the user to be an org admin in the current community org.

package/dist/types/utils/internal/updatePortalOrgSettings.d.ts

@@ -1,4 +1,4 @@
-import { IArcGISContext } from "../../ArcGISContext";
+import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IHubUserOrgSettings } from "../../core/types/IHubUser";
 /**
  * Function to update a user's org settings. Expects the user to be an org admin in the current org.

package/dist/types/utils/revertable-tasks.d.ts

@@ -1,4 +1,4 @@
-import { IRevertableTaskResult } from "../types";
+import { IRevertableTaskResult } from "../hub-types";
 /**
  * Runs the given task and returns a IRevertableTaskResult
  * @param {Function} task A task method to run

package/dist/types/versioning/_internal/getIncludeListFromItemType.d.ts

@@ -1,4 +1,4 @@
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Gets the include list for the model type
  * @param model

package/dist/types/versioning/_internal/getVersionData.d.ts

@@ -1,4 +1,4 @@
-import { IModel } from "../../types";
+import { IModel } from "../../hub-types";
 /**
  * Returns the version data (ie the part of the model that gets versioned) from the model
  * @param model

package/dist/types/versioning/createVersion.d.ts

@@ -1,6 +1,6 @@
-import { IHubUserRequestOptions } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
 import { ICreateVersionOptions, IVersion } from "./types";
-import { IModel } from "../types";
+import { IModel } from "../hub-types";
 /**
  * Creates and returns a new version of the entity
  * @param entity

package/dist/types/versioning/deleteVersion.d.ts

@@ -1,4 +1,4 @@
-import { IHubUserRequestOptions } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
 /**
  * Deletes the version specified by the entity id and versionId
  * @param id

package/dist/types/versioning/getVersion.d.ts

@@ -1,4 +1,4 @@
-import { IHubUserRequestOptions } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
 import { IVersion } from "./types";
 /**
  * Returns an IVersion object for the specified entity id and versionId

package/dist/types/versioning/searchVersions.d.ts

@@ -1,4 +1,4 @@
-import { IHubUserRequestOptions } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
 import { IVersionMetadata } from "./types";
 /**
  * Returns an array containing the versions of the specified item

package/dist/types/versioning/updateVersion.d.ts

@@ -1,5 +1,5 @@
-import { IHubUserRequestOptions } from "../types";
-import { IModel } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
+import { IModel } from "../hub-types";
 import { IVersion } from "./types";
 /**
  * Updates the specified version with with the state of the supplied model

package/dist/types/versioning/updateVersionMetadata.d.ts

@@ -1,4 +1,4 @@
-import { IHubUserRequestOptions } from "../types";
+import { IHubUserRequestOptions } from "../hub-types";
 import { IVersionMetadata } from "./types";
 /**
  * Updates the specified version's metadata

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

@@ -1,4 +1,4 @@
-import { IHubUserRequestOptions, IModel } from "../types";
+import { IHubUserRequestOptions, IModel } from "../hub-types";
 import { IVersion } from "./types/IVersion";
 /**
  * Applies the versioned data to the model

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "15.36.1",
+  "version": "15.37.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",