@esri/hub-common 9.14.0 → 9.14.1

package/dist/types/ArcGISContext.d.ts

@@ -12,58 +12,189 @@ import { IHubRequestOptions } from ".";
  *
  */
 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;
+    /**
+     * 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;
+    /**
+     * 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;
 }
 /**
- * @internal
+ * 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;
 }
 /**
- * ArcGISContext
- *
- * Abstraction that holds a UserSession, along with
+ * Abstraction that holds a `UserSession`, along with
  * getters to streamline access to various platform
- * urls, and common constructs like IRequestOptions
+ * urls, and common constructs like `IRequestOptions`,
+ * `IUserRequestOptions` etc.
  *
- * Thin class just used to enable getters
+ * Instances are intended to be immutable, but this is not directly enforced.
  *
- * This class should not be used by anything other than
- * the ArcGISContextManager class
+ * In most circumstances, this class should be created by
+ * the ArcGISContextManager class.
  */
 export declare class ArcGISContext implements 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;
     private _authentication;
     private _portalUrl;
     private _hubUrl;
     private _portalSelf;
     private _currentUser;
+    /**
+     * Create a new instance of `ArcGISContext`.
+     *
+     * @param opts
+     */
     constructor(opts: IArcGISContextOptions);
     /**
      * Return the UserSession if authenticated
@@ -94,29 +225,48 @@ export declare class ArcGISContext implements IArcGISContext {
      */
     get hubRequestOptions(): IHubRequestOptions;
     /**
-     * Return the portal url.
+     * Return the portal url i.e. https://www.arcgis.com
      *
      * 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
+     * https://{portalHostname}/{webadaptor}
      */
     get portalUrl(): string;
     /**
-     * Returns the url to the sharing api
+     * Returns the url to the sharing api composed from portalUrl
      * i.e. https://myorg.maps.arcgis.com/sharing/rest
      */
     get sharingApiUrl(): string;
+    /**
+     * Returns the Hub url, based on the portalUrl
+     *
+     * For ArcGIS Enterprise this will return `undefined`
+     */
     get hubUrl(): string;
     /**
      * Returns boolean indicating if the backing system
      * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
      */
     get isPortal(): boolean;
+    /**
+     * Returns the discussions API URL
+     */
     get discussionsServiceUrl(): string;
+    /**
+     * Returns the Hub Search API URL
+     */
     get hubSearchServiceUrl(): string;
+    /**
+     * Returns Hub Domain Service URL
+     */
     get domainServiceUrl(): string;
+    /**
+     * Returns the Events configuration object from portal/self
+     *
+     * `{serviceId: '3ef..', publicViewId: 'bc3...'}`
+     */
     get eventsConfig(): any;
     /**
      * Returns boolean indicating if the current user
@@ -125,12 +275,31 @@ export declare class ArcGISContext implements IArcGISContext {
      */
     get hubEnabled(): boolean;
     /**
-     * Return Hub Community Org Id, if defined
+     * Return the Hub Community Org Id, if defined
      */
     get communityOrgId(): string;
+    /**
+     * Returns the Hub Community Org Hostname, if defined
+     *
+     * i.e. c-org.maps.arcgis.com
+     */
     get communityOrgHostname(): string;
+    /**
+     * Returns the Hub Community Org url
+     *
+     * i.e. https://c-org.maps.arcgis.com
+     */
     get communityOrgUrl(): string;
+    /**
+     * Returns the hash of helper services from portal self
+     */
     get helperServices(): any;
+    /**
+     * Returns the current user as IUser
+     */
     get currentUser(): IUser;
+    /**
+     * Returns the portal object as IPortal
+     */
     get portal(): IPortal;
 }

package/dist/types/ArcGISContextManager.d.ts

@@ -40,8 +40,6 @@ export interface IArcGISContextManagerOptions {
     logLevel?: Level;
 }
 /**
- * ArcGIS Context Manager
- *
  * 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
@@ -52,7 +50,7 @@ export interface IArcGISContextManagerOptions {
  * changes on that single property, instead of having to leverage observers or events
  * for change detection.
  *
- * This is a work-in-progress, and will likely expand over time.
+ * Please see the [ArcGISContext Guide](/hub.js/guides/context) for additional information.
  *
  */
 export declare class ArcGISContextManager {
@@ -76,7 +74,12 @@ export declare class ArcGISContextManager {
      */
     private constructor();
     /**
-     * Static async Factory
+     * Used to create a new instance of the ArcGISContext class.
+     *
+     * ```js
+     * const ctxMgr = await ArcGISContextManager.create();
+     * ```
+     *
      * @param opts
      * @returns
      */

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.13.2 - Tue Jan 25 2022 00:14:10 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.14.0 - Mon Feb 07 2022 19:02:27 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6430,12 +6430,15 @@
             appbuilderExtension: "file",
             appbuilderWidgetPackage: "widgets-source",
             application: "web",
+            applicationConfiguration: "app-gear",
             arcgisProMap: "desktop",
             cadDrawing: "file-cad",
             cityEngineWebScene: "urban-model",
             codeAttachment: "file-code",
+            codeSample: "file-code",
             colorSet: "palette",
             contentCategorySet: "label",
+            csv: "file-csv",
             cSV: "file-csv",
             cSVCollection: "file-csv",
             dashboard: "dashboard",
@@ -6457,8 +6460,8 @@
             geoprocessingService: "file",
             globeLayer: "layers",
             globeService: "file",
-            hubInitiative: "mountain-summit-nocap",
-            hubInitiativeTemplate: "initiative-template-outlines-thick",
+            hubInitiative: "initiative",
+            hubInitiativeTemplate: "initiative-template",
             hubPage: "browser",
             hubSiteApplication: "web",
             image: "file-image",
@@ -6474,6 +6477,7 @@
             kMLCollection: "data",
             layer: "layers",
             layerPackage: "layers",
+            layerTemplate: "file",
             locatorPackage: "file",
             mapArea: "file",
             mapDocument: "map-contents",
@@ -6496,6 +6500,7 @@
             orthoMappingTemplate: "file",
             pDF: "file-pdf",
             quickCaptureProject: "mobile",
+            rasterFunctionTemplate: "file",
             rasterLayer: "map",
             realTimeAnalytic: "file",
             relationalDatabaseConnection: "file",
@@ -6504,19 +6509,23 @@
             sceneService: "urban-model",
             serviceDefinition: "file",
             shapefile: "data",
-            solution: "solutions",
+            solution: "puzzle-piece",
             sqliteGeodatabase: "file",
             statisticalDataCollection: "file",
+            storymap: "tour",
             storyMap: "tour",
+            storymapTheme: "palette",
             symbolSet: "file",
             table: "table",
             urbanModel: "urban-model",
+            vectorTilePackage: "file-shape",
             vectorTileService: "map",
             visioDocument: "conditional-rules",
             webExperience: "apps",
             webMap: "map",
             webMappingApplication: "apps",
             webScene: "urban-model",
+            wfs: "map",
             wFS: "map",
             wMS: "map",
             wMTS: "map",
@@ -10783,18 +10792,22 @@
         discussions: "/api/discussions/v1",
     };
     /**
-     * ArcGISContext
-     *
-     * Abstraction that holds a UserSession, along with
+     * Abstraction that holds a `UserSession`, along with
      * getters to streamline access to various platform
-     * urls, and common constructs like IRequestOptions
+     * urls, and common constructs like `IRequestOptions`,
+     * `IUserRequestOptions` etc.
      *
-     * Thin class just used to enable getters
+     * Instances are intended to be immutable, but this is not directly enforced.
      *
-     * This class should not be used by anything other than
-     * the ArcGISContextManager class
+     * In most circumstances, this class should be created by
+     * the ArcGISContextManager class.
      */
     var ArcGISContext = /** @class */ (function () {
+        /**
+         * Create a new instance of `ArcGISContext`.
+         *
+         * @param opts
+         */
         function ArcGISContext(opts) {
             this._portalUrl = "https://www.arcgis.com";
             this.id = opts.id;
@@ -10878,25 +10891,27 @@
              */
             get: function () {
                 // We may add more logic around what is returned in some corner cases
-                return {
-                    authentication: this.session,
-                    isPortal: this.isPortal,
-                    portalSelf: this.portal,
-                    hubApiUrl: this.hubUrl,
-                };
+                if (this.isAuthenticated) {
+                    return {
+                        authentication: this.session,
+                        isPortal: this.isPortal,
+                        portalSelf: this.portal,
+                        hubApiUrl: this.hubUrl,
+                    };
+                }
             },
             enumerable: false,
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "portalUrl", {
             /**
-             * Return the portal url.
+             * Return the portal url i.e. https://www.arcgis.com
              *
              * 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
+             * https://{portalHostname}/{webadaptor}
              */
             get: function () {
                 if (this.isAuthenticated) {
@@ -10916,7 +10931,7 @@
         });
         Object.defineProperty(ArcGISContext.prototype, "sharingApiUrl", {
             /**
-             * Returns the url to the sharing api
+             * Returns the url to the sharing api composed from portalUrl
              * i.e. https://myorg.maps.arcgis.com/sharing/rest
              */
             get: function () {
@@ -10926,6 +10941,11 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "hubUrl", {
+            /**
+             * Returns the Hub url, based on the portalUrl
+             *
+             * For ArcGIS Enterprise this will return `undefined`
+             */
             get: function () {
                 return this._hubUrl;
             },
@@ -10946,9 +10966,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "discussionsServiceUrl", {
-            // Hub APIs
-            // ----------
-            // Discussions
+            /**
+             * Returns the discussions API URL
+             */
             get: function () {
                 if (this._hubUrl) {
                     return "" + this._hubUrl + hubApiEndpoints.discussions;
@@ -10958,7 +10978,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "hubSearchServiceUrl", {
-            // Hub Search
+            /**
+             * Returns the Hub Search API URL
+             */
             get: function () {
                 if (this._hubUrl) {
                     return "" + this._hubUrl + hubApiEndpoints.search;
@@ -10968,7 +10990,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "domainServiceUrl", {
-            // Domain
+            /**
+             * Returns Hub Domain Service URL
+             */
             get: function () {
                 if (this._hubUrl) {
                     return "" + this._hubUrl + hubApiEndpoints.domains;
@@ -10978,8 +11002,11 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "eventsConfig", {
-            // Events
-            // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
+            /**
+             * Returns the Events configuration object from portal/self
+             *
+             * `{serviceId: '3ef..', publicViewId: 'bc3...'}`
+             */
             get: function () {
                 if (this._portalSelf) {
                     return getProp(this._portalSelf, "portalProperties.hub.settings.events");
@@ -11002,7 +11029,7 @@
         });
         Object.defineProperty(ArcGISContext.prototype, "communityOrgId", {
             /**
-             * Return Hub Community Org Id, if defined
+             * Return the Hub Community Org Id, if defined
              */
             get: function () {
                 if (this._portalSelf) {
@@ -11013,6 +11040,11 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "communityOrgHostname", {
+            /**
+             * Returns the Hub Community Org Hostname, if defined
+             *
+             * i.e. c-org.maps.arcgis.com
+             */
             get: function () {
                 if (this._portalSelf) {
                     return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
@@ -11022,6 +11054,11 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "communityOrgUrl", {
+            /**
+             * Returns the Hub Community Org url
+             *
+             * i.e. https://c-org.maps.arcgis.com
+             */
             get: function () {
                 if (this.communityOrgHostname) {
                     return "https://" + this.communityOrgHostname;
@@ -11031,8 +11068,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "helperServices", {
-            // Platform API service urls are all in helperServices
-            // and not consistent to expose as urls
+            /**
+             * Returns the hash of helper services from portal self
+             */
             get: function () {
                 if (this._portalSelf) {
                     return this._portalSelf.helperServices;
@@ -11042,6 +11080,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "currentUser", {
+            /**
+             * Returns the current user as IUser
+             */
             get: function () {
                 return this._currentUser;
             },
@@ -11049,6 +11090,9 @@
             configurable: true
         });
         Object.defineProperty(ArcGISContext.prototype, "portal", {
+            /**
+             * Returns the portal object as IPortal
+             */
             get: function () {
                 return this._portalSelf;
             },
@@ -11059,8 +11103,6 @@
     }());
 
     /**
-     * ArcGIS Context Manager
-     *
      * 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
@@ -11071,7 +11113,7 @@
      * changes on that single property, instead of having to leverage observers or events
      * for change detection.
      *
-     * This is a work-in-progress, and will likely expand over time.
+     * Please see the [ArcGISContext Guide](/hub.js/guides/context) for additional information.
      *
      */
     var ArcGISContextManager = /** @class */ (function () {
@@ -11110,7 +11152,12 @@
             }
         }
         /**
-         * Static async Factory
+         * Used to create a new instance of the ArcGISContext class.
+         *
+         * ```js
+         * const ctxMgr = await ArcGISContextManager.create();
+         * ```
+         *
          * @param opts
          * @returns
          */