@esri/hub-common 9.13.0 → 9.14.1

package/dist/types/ArcGISContextManager.d.ts

@@ -0,0 +1,116 @@
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IUser, UserSession } from "@esri/arcgis-rest-auth";
+import { IArcGISContext } from "./ArcGISContext";
+import { Level } from ".";
+/**
+ * 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;
+    /**
+     * Logging level
+     * off > error > warn > info > debug > all
+     * defaults to 'error'
+     */
+    logLevel?: Level;
+}
+/**
+ * The manager exposes context (`IArcGISContext`), which combines a `UserSession` with
+ * the `portal/self` and `user/self` responses to provide a central lookup for platform
+ * information, api urls, and other useful properties for developers such as IRequestOptions
+ * IUserRequestOptions, IHubRequestOptions etc.
+ *
+ * The context is exposed on gthe `.context` property, and as the authentication changes
+ * the `.context` is re-created. This is done to allow web frameworks to watch for
+ * changes on that single property, instead of having to leverage observers or events
+ * for change detection.
+ *
+ * Please see the [ArcGISContext Guide](/hub.js/guides/context) for additional information.
+ *
+ */
+export declare class ArcGISContextManager {
+    /**
+     * Random identifier useful for debugging issues
+     * where race-conditions can result in multiple
+     * contexts getting created
+     */
+    id: number;
+    private _context;
+    private _authentication;
+    private _portalUrl;
+    private _hubUrl;
+    private _portalSelf;
+    private _currentUser;
+    private _logLevel;
+    /**
+     * Private constructor. Use `ArcGISContextManager.create(...)` to
+     * instantiate an instance
+     * @param opts
+     */
+    private constructor();
+    /**
+     * Used to create a new instance of the ArcGISContext class.
+     *
+     * ```js
+     * const ctxMgr = await ArcGISContextManager.create();
+     * ```
+     *
+     * @param opts
+     * @returns
+     */
+    static create(opts?: IArcGISContextManagerOptions): Promise<ArcGISContextManager>;
+    /**
+     * Set the Authentication (UserSession) for the context.
+     * This should be called when a user signs into a running
+     * application.
+     * @param auth
+     */
+    setAuthentication(auth: UserSession): Promise<void>;
+    /**
+     * Clear the Authentication (UserSession). This should be
+     * called when a user signs out of an application, but
+     * the application continues running
+     */
+    clearAuthentication(): void;
+    /**
+     * Return a reference to the current state.
+     * When `.setAuthentication()` or `.clearAuthenentication()` are
+     * called, the state will be re-created. This is done so frameworks
+     * like React or Ember can detect changes.
+     */
+    get context(): IArcGISContext;
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * store that along with current user
+     */
+    private initialize;
+    /**
+     * Getter to streamline the creation of updated Context instances
+     */
+    private get contextOpts();
+}

package/dist/types/index.d.ts

@@ -18,6 +18,7 @@ export * from "./utils";
 export * from "./i18n";
 export * from "./request";
 export * from "./surveys";
+export * from "./ArcGISContextManager";
 export * from "./ArcGISContext";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";

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

@@ -104,7 +104,7 @@ export declare function getNextFunction<T>(request: ISearchOptions, nextStart: n
  * Construct a the full url to a group thumbnail
  *
  * - If the group has a thumbnail, construct the full url
- * - If the group is not public, append on the token
+ * - If the group is not public, append on the token (if passed in)
  * @param portalUrl
  * @param group
  * @param token

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

@@ -0,0 +1,8 @@
+/**
+ * Cross-walk from a portalUrl to the corresponding Hub API Url
+ *
+ * If the passed url is not recognized, then this will return `undefined`
+ * @param portalUrl
+ * @returns
+ */
+export declare function getHubApiFromPortalUrl(portalUrl: string): string;

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

@@ -0,0 +1,9 @@
+/**
+ * Given an org url, get the portal base url
+ *
+ * i.e. https://myorg.maps.arcgis.com will return https://www.arcgis.com
+ *
+ * @param orgUrl
+ * @returns
+ */
+export declare function getPortalBaseFromOrgUrl(orgUrl: string): string;

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

@@ -13,6 +13,8 @@ export * from "./get-item-home-url";
 export * from "./get-item-api-url";
 export * from "./get-item-data-url";
 export * from "./convert-urls-to-anchor-tags";
+export * from "./getHubApiFromPortalUrl";
+export * from "./getPortalBaseFromOrgUrl";
 /**
  *
  * @param url