@esri/hub-common 9.10.2 → 9.13.1

package/dist/types/ArcGISContext.d.ts

@@ -0,0 +1,98 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { IArcGISContextState } from "./ArcGISContextState";
+/**
+ * Options that can be passed into `ArcGISContext.create`
+ */
+export interface IArcGISContextOptions {
+    /**
+     * 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;
+    /**
+     * If set to `true` additional logging will be sent to the console
+     * Defaults to false.
+     */
+    debug?: boolean;
+}
+/**
+ * Application Context Object
+ *
+ * Abstraction that combines a `UserSession` with
+ * the `portal/self` and `user/self` responses to
+ * provide a central lookup of platform information.
+ *
+ * This is a work-in-progress, and will likely expand over time.
+ *
+ * `ArcGISContext` is used in conjuction with the `arcgis-app-identity`
+ * component to orchestrate oAuth.
+ */
+export declare class ArcGISContext {
+    /**
+     * Random identifier useful for debugging issues
+     * where race-conditions can result in multiple
+     * contexts getting created
+     */
+    id: number;
+    private _state;
+    private _authentication;
+    private _portalUrl;
+    private _hubUrl;
+    private _portalSelf;
+    private _currentUser;
+    private _debug;
+    /**
+     * Private constructor. Use `ArcGISContext.create(...)` to
+     * instantiate an instance
+     * @param opts
+     */
+    private constructor();
+    /**
+     * Static async Factory
+     * @param opts
+     * @returns
+     */
+    static create(opts?: IArcGISContextOptions): Promise<ArcGISContext>;
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * store that along with current user
+     */
+    initialize(): Promise<void>;
+    /**
+     * 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 state(): IArcGISContextState;
+    /**
+     * @internal
+     * Log debugging messages to the console
+     * @param message
+     */
+    private log;
+}

package/dist/types/ArcGISContextState.d.ts

@@ -0,0 +1,129 @@
+import { IUser, IUserRequestOptions, UserSession } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubRequestOptions } from ".";
+/**
+ * Defined the properties of the ArcGISContext.state
+ * object. This wll be a class instance, and when authentication
+ * changes, the instance will be replaced. This is done to allow
+ * frameworks like React or Ember to bind into the .state property
+ * and react when it changes.
+ */
+export interface IArcGISContextState {
+    id: number;
+    session: UserSession;
+    isAuthenticated: boolean;
+    userRequestOptions: IUserRequestOptions;
+    requestOptions: IRequestOptions;
+    hubRequestOptions: IHubRequestOptions;
+    portalUrl: string;
+    sharingApiUrl: string;
+    hubUrl: string;
+    isPortal: boolean;
+    discussionsServiceUrl: string;
+    hubSearchServiceUrl: string;
+    domainServiceUrl: string;
+    eventsConfig: any;
+    hubEnabled: boolean;
+    communityOrgId: string;
+    communityOrgHostname: string;
+    communityOrgUrl: string;
+    helperServices: any;
+    currentUser: IUser;
+    portal: IPortal;
+}
+/**
+ * @internal
+ */
+export interface IArcGISContextStateOptions {
+    id: number;
+    portalUrl: string;
+    hubUrl: string;
+    authentication?: UserSession;
+    portalSelf?: IPortal;
+    currentUser?: IUser;
+}
+/**
+ * @internal
+ * Thin class just used to enable getters
+ *
+ * This class should not be used by anything other than
+ * the ArcGISContext class
+ */
+export declare class ArcGISContextState implements IArcGISContextState {
+    id: number;
+    private _authentication;
+    private _portalUrl;
+    private _hubUrl;
+    private _portalSelf;
+    private _currentUser;
+    constructor(opts: IArcGISContextStateOptions);
+    /**
+     * Return the UserSession if authenticated
+     */
+    get session(): UserSession;
+    /**
+     * Return boolean indicating if authenticatio is present
+     */
+    get isAuthenticated(): boolean;
+    /**
+     * Return `IUserRequestOptions`, which is used for REST-JS
+     * functions which require authentication information.
+     *
+     * If context is not authenticated, this function will throw
+     */
+    get 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)
+     */
+    get requestOptions(): IRequestOptions;
+    /**
+     * Return a `IHubRequestOptions` object
+     */
+    get 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, which includes the web adaptor
+     */
+    get portalUrl(): string;
+    /**
+     * Returns the url to the sharing api
+     * i.e. https://myorg.maps.arcgis.com/sharing/rest
+     */
+    get sharingApiUrl(): string;
+    get hubUrl(): string;
+    /**
+     * Returns boolean indicating if the backing system
+     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+     */
+    get isPortal(): boolean;
+    get discussionsServiceUrl(): string;
+    get hubSearchServiceUrl(): string;
+    get domainServiceUrl(): string;
+    get eventsConfig(): any;
+    /**
+     * Returns boolean indicating if the current user
+     * belongs to an organization that has licensed
+     * ArcGIS Hub
+     */
+    get hubEnabled(): boolean;
+    /**
+     * Return Hub Community Org Id, if defined
+     */
+    get communityOrgId(): string;
+    get communityOrgHostname(): string;
+    get communityOrgUrl(): string;
+    get helperServices(): any;
+    get currentUser(): IUser;
+    get portal(): IPortal;
+}

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

@@ -210,6 +210,19 @@ export declare function datasetToItem(dataset: DatasetResource): IItem;
  * @returns new content
  */
 export declare const setContentType: (content: IHubContent, type: string) => IHubContent;
+/**
+ * Compute the content type icon based on the normalizedType
+ * @param normalizedType
+ * @returns content type icon
+ */
+export declare const getContentTypeIcon: (normalizedType: string) => any;
+/**
+ * Compute the content type label
+ * @param normalizedType
+ * @param isProxied
+ * @returns content type label
+ */
+export declare const getContentTypeLabel: (normalizedType: string, isProxied: boolean) => string;
 /**
  * returns a new content that has the specified hubId and updated identifier
  * @param content orignal content

package/dist/types/index.d.ts

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

package/dist/types/types.d.ts

@@ -82,7 +82,11 @@ export interface ISolutionTemplate extends IModel {
     };
 }
 export declare type GenericAsyncFunc = (...args: any) => Promise<any>;
-interface IHubRequestOptionsPortalSelf extends IPortal {
+/**
+ * @internal
+ * This just adds user to the IPortal interface
+ */
+export interface IHubRequestOptionsPortalSelf extends IPortal {
     user?: IUser;
 }
 export interface IHubRequestOptions extends IRequestOptions {
@@ -415,4 +419,3 @@ export interface ISearchResponse<T> {
     next: (params?: any) => Promise<ISearchResponse<T>>;
     facets?: IFacet[];
 }
-export {};

package/dist/types/urls/convert-urls-to-anchor-tags.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert urls in a string to hyperlinks
+ * @param {content} string
+ */
+export declare function convertUrlsToAnchorTags(content: string): string;

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

@@ -12,6 +12,7 @@ export * from "./get-hub-url-from-portal";
 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";
 /**
  *
  * @param url

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

@@ -15,3 +15,4 @@ export * from "./increment-string";
 export * from "./logger";
 export * from "./is-update-group";
 export * from "./revertable-tasks";
+export * from "./sessionLocalStorage";

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

@@ -0,0 +1,23 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+/**
+ * Remove any serialized sessions associated with the passed clientId
+ * from a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ */
+export declare function clearSession(clientId: string, win?: any): void;
+/**
+ * Re-hydrate a UserSession from a browser's local storage.
+ * If not found,
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ * @returns
+ */
+export declare function getSession(clientId: string, win?: any): UserSession | null;
+/**
+ * Serialize a UserSession into a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param session UserSession
+ * @param win optional window (used for testing)
+ */
+export declare function saveSession(clientId: string, session: UserSession, win?: any): void;