@esri/hub-common 9.14.0 → 9.17.0

package/dist/node/utils/dasherize.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dasherize = void 0;
+/**
+ *   Dasherize a string
+ *
+ *  ```javascript
+ *  import { dasherize } from '@esri/hub-common';
+ *  dasherize('innerHTML');                // 'inner-html'
+ *  dasherize('action_name');              // 'action-name'
+ *  dasherize('css-class-name');           // 'css-class-name'
+ *  dasherize('my favorite items');        // 'my-favorite-items'
+ *  dasherize('privateDocs/ownerInvoice';  // 'private-docs/owner-invoice'
+ *  ```
+ *
+ *  Extracted and modified from Ember.js source code - MIT license
+ *  @param value
+ *  @returns
+ */
+function dasherize(value) {
+    const DECAMELIZE_REGEXP = /([a-z\d])([A-Z])/g;
+    const DASHERIZE_REGEXP = /[ _]/g;
+    return value
+        .replace(DECAMELIZE_REGEXP, "$1_$2")
+        .toLowerCase()
+        .replace(DASHERIZE_REGEXP, "-");
+}
+exports.dasherize = dasherize;
+//# sourceMappingURL=dasherize.js.map

package/dist/node/utils/dasherize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dasherize.js","sourceRoot":"","sources":["../../../src/utils/dasherize.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;IAC9C,MAAM,gBAAgB,GAAG,OAAO,CAAC;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,WAAW,EAAE;SACb,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAPD,8BAOC"}

package/dist/node/utils/index.js

@@ -19,4 +19,5 @@ tslib_1.__exportStar(require("./logger"), exports);
 tslib_1.__exportStar(require("./is-update-group"), exports);
 tslib_1.__exportStar(require("./revertable-tasks"), exports);
 tslib_1.__exportStar(require("./sessionLocalStorage"), exports);
+tslib_1.__exportStar(require("./dasherize"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC;AACtC,sDAA4B"}

package/dist/types/ArcGISContext.d.ts

@@ -12,58 +12,198 @@ 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;
+    /**
+     * Additional app-specific context
+     */
+    properties: Record<string, any>;
 }
 /**
- * @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;
-    hubUrl: 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>;
 }
 /**
- * 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;
+    private _properties;
+    /**
+     * Create a new instance of `ArcGISContext`.
+     *
+     * @param opts
+     */
     constructor(opts: IArcGISContextOptions);
     /**
      * Return the UserSession if authenticated
@@ -94,29 +234,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 +284,37 @@ 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;
+    /**
+     * Return the properties hash that was passed in.
+     * Useful for app-specific context such as the active
+     * Site for ArcGIS Hub
+     */
+    get properties(): Record<string, any>;
 }

package/dist/types/ArcGISContextManager.d.ts

@@ -32,6 +32,14 @@ export interface IArcGISContextManagerOptions {
      * 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
@@ -40,8 +48,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 +58,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 {
@@ -65,6 +71,7 @@ export declare class ArcGISContextManager {
     private _context;
     private _authentication;
     private _portalUrl;
+    private _properties;
     private _hubUrl;
     private _portalSelf;
     private _currentUser;
@@ -76,7 +83,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
      */
@@ -88,6 +100,11 @@ export declare class ArcGISContextManager {
      * @param auth
      */
     setAuthentication(auth: UserSession): Promise<void>;
+    /**
+     * Set the properties hash and re-create the context
+     * @param properties
+     */
+    setProperties(properties: Record<string, any>): void;
     /**
      * Clear the Authentication (UserSession). This should be
      * called when a user signs out of an application, but

package/dist/types/Hub.d.ts

@@ -0,0 +1,72 @@
+import { ArcGISContextManager, IArcGISContextManagerOptions } from "./ArcGISContextManager";
+import { HubProjectManager } from "./projects/HubProjectManager";
+/**
+ * Options for instantiating a Hub instance
+ */
+export interface IHubOptions {
+    contextManager?: ArcGISContextManager;
+    managerOptions?: IArcGISContextManagerOptions;
+    authOptions?: {
+        usename: string;
+        password: string;
+        portalUrl?: string;
+    };
+}
+/**
+ * Hub class can be used as an entry point to managing
+ * content, teams, sites, projects etc, in an organization's Hub.
+ *
+ * ```js
+ * import {Hub} from '@esri/hub-common';
+ * // create a Hub instance, authenticating as a specific user
+ * // working against arcgis online
+ * const myHub = await Hub.create({authOptions: {username: "casey", password: "jones"}});
+ *
+ * myHub.context.currentUser //=> {username: "casey", ...} as IUser
+ *
+ * const projectStore = await myHub.getProjectStore();
+ *
+ * const pavingProject = await projectStore.create({name: "12th Street Paving"});
+ * pavingProject.summary = "This is the 2024 planned paving of 12th Street, between 8th and 11th Ave";
+ * await projectStore.update(pavingProject);
+ * ```
+ *
+ * This is a convenience class. Hub Stores can be created
+ * directly, or the underlying functions can be imported an used
+ * as need for scenarios where these class structures introduce
+ * unwanted complexity
+ */
+export declare class Hub {
+    /**
+     * Hold a context manager, which should be a single instance for
+     * an application. When authentication changes, the .context
+     * property on the context manager will be replaced. As long as
+     * all the fns in this class leverage properties on .context
+     * everything be kept in sync.
+     */
+    private _contextManager;
+    private _projectManager;
+    /**
+     * Private so we can employ a factory function should we need
+     * async work during creation
+     * @param contextManager
+     */
+    private constructor();
+    /**
+     * Factory function to construct a new HubProjectStore instance.
+     *
+     * Note: Used so that we could do async actions in the ctor.
+     * @param contextManager
+     * @returns
+     */
+    static create(options: IHubOptions): Promise<Hub>;
+    /**
+     * Getter to abstract the context manager
+     */
+    get context(): import("./ArcGISContext").IArcGISContext;
+    /**
+     * Create a Project Store connected to the current Hub
+     * @returns
+     */
+    get projects(): HubProjectManager;
+}

package/dist/types/HubError.d.ts

@@ -0,0 +1,17 @@
+import { OperationError } from ".";
+/**
+ * Generic Hub Error with an Error stack as well
+ * as an optional serialized OperationStack.
+ *
+ * Also accepts a `rootCause` Error object
+ */
+export default class HubError extends OperationError {
+    /**
+     * Creates an instance of HubError.
+     * @param {string} operation
+     * @param {string} [message]
+     * @param {Error} [rootCause]
+     * @memberof HubError
+     */
+    constructor(operation: string, message?: string, rootCause?: Error);
+}

package/dist/types/collections.d.ts

@@ -1,3 +1,15 @@
+/**
+ * ```js
+ * import { getCollection } from "@esri/hub-common";
+ * //
+ * getCollection('Feature Layer')
+ * > 'dataset'
+ * ```
+ * Get the Hub collection for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the Hub collection of a given item type.
+ */
+export declare const getCollection: (type?: string) => string;
 export declare const collections: {
     [key: string]: string[];
 };

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

@@ -8,7 +8,8 @@
  * It's probably a good pattern to add functions here first and then
  * move them to index.ts only when they are needed by a consumer.
  */
-import { BBox, IHubContent, IHubGeography, GeographyProvenance } from "../types";
+import { IItem } from "@esri/arcgis-rest-types/dist/types/item";
+import { BBox, IHubContent, IHubGeography, GeographyProvenance, IHubRequestOptions } from "..";
 /**
  * Create a new content with updated boundary properties
  * @param content original content
@@ -17,70 +18,89 @@ import { BBox, IHubContent, IHubGeography, GeographyProvenance } from "../types"
  */
 export declare const setContentBoundary: (content: IHubContent, boundary: GeographyProvenance) => {
     boundary: IHubGeography;
-    item: any;
+    item: {
+        properties: any;
+        id: string;
+        owner: string;
+        tags: string[];
+        created: number;
+        modified: number;
+        numViews: number;
+        size: number;
+        protected?: boolean;
+        title: string;
+        type: string;
+        typeKeywords?: string[];
+        description?: string;
+        snippet?: string;
+        documentation?: string;
+        extent?: number[][];
+        categories?: string[];
+        spatialReference?: import("@esri/arcgis-rest-types").ISpatialReference;
+        culture?: string;
+        url?: string;
+    };
+    slug?: string;
     hubId?: string;
+    identifier: string;
     permissions: {
         visibility: "private" | "public" | "org";
-        control?: import("../types").AccessControl;
+        control?: import("..").AccessControl;
         groups?: import("@esri/arcgis-rest-types").IGroup[];
     };
-    family?: import("../types").HubFamily;
-    itemCategories?: string[];
-    normalizedType?: string;
+    family?: import("..").HubFamily;
+    categories?: string[];
+    isDownloadable: boolean;
+    structuredLicense?: import("..").IStructuredLicense;
     publishedDate: Date;
     publishedDateSource?: string;
     updateFrequency?: string;
-    actionLinks?: import("../types").IActionLink[];
-    hubActions?: object;
-    metrics?: {
-        visibility: "private" | "public" | "org" | "updateGroups";
-    };
-    slug?: string;
+    portalHomeUrl?: string;
+    portalApiUrl?: string;
     portalDataUrl?: string;
-    groupIds?: string[];
-    errors?: import("../types").IEnrichmentErrorInfo[];
-    data?: {
-        [propName: string]: any;
-    };
-    server?: Partial<import("@esri/arcgis-rest-types").IFeatureServiceDefinition>;
-    layers?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>[];
+    actionLinks?: import("..").IActionLink[];
+    hubActions?: object;
     layer?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>;
-    recordCount?: number;
+    itemCategories?: string[];
+    normalizedType?: string;
     orgId?: string;
-    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
-    isDownloadable: boolean;
-    structuredLicense?: import("..").IStructuredLicense;
+    thumbnailUrl?: string;
+    owner: string;
+    description?: string;
+    culture?: string;
+    tags: string[];
+    typeKeywords?: string[];
+    url?: string;
+    id: string;
     name: string;
     summary?: string;
-    hubType: import("../types").HubType;
     createdDate: Date;
-    createdDateSource?: string;
+    createdDateSource: string;
     updatedDate: Date;
-    updatedDateSource?: string;
-    portalHomeUrl?: string;
-    portalApiUrl?: string;
-    thumbnailUrl?: string;
+    updatedDateSource: string;
+    type: string;
+    server?: Partial<import("@esri/arcgis-rest-types").IFeatureServiceDefinition>;
+    layers?: Partial<import("@esri/arcgis-rest-types").ILayerDefinition>[];
+    recordCount?: number;
+    data?: {
+        [propName: string]: any;
+    };
     metadata?: any;
-    id: string;
-    owner: string;
-    tags: string[];
+    groupIds?: string[];
+    ownerUser?: import("@esri/arcgis-rest-types").IUser;
+    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
+    errors?: import("..").IEnrichmentErrorInfo[];
     created: number;
     modified: number;
     numViews: number;
     size: number;
     protected?: boolean;
     title: string;
-    type: string;
-    typeKeywords?: string[];
-    description?: string;
     snippet?: string;
     documentation?: string;
     extent?: number[][];
-    categories?: string[];
     spatialReference?: import("@esri/arcgis-rest-types").ISpatialReference;
-    culture?: string;
     properties?: any;
-    url?: string;
 };
 /**
  * Create a new content with updated extent and derived properties like boundary
@@ -89,3 +109,11 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
  * @returns a new content with the updated extent and boundary
  */
 export declare const setContentExtent: (content: IHubContent, extent: BBox) => IHubContent;
+/**
+ * Returns whether or not an item is a proxied csv
+ *
+ * @param item
+ * @param requestOptions Hub Request Options (including whether we're in portal)
+ * @returns
+ */
+export declare const isProxiedCSV: (item: IItem, requestOptions: IHubRequestOptions) => boolean;