@esri/hub-common 16.5.3 → 17.0.0

package/dist/types/hub-types.d.ts

@@ -1,8 +1,5 @@
-import type { IItem, IUser, IGroup } from "@esri/arcgis-rest-portal";
-import type { IPolygon, ISpatialReference, IGeometry } from "@esri/arcgis-rest-types";
-import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
-import type { UserSession } from "@esri/arcgis-rest-auth";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
+import type { IGroup, IItem, IPortal, ISearchResult, IUser } from "@esri/arcgis-rest-portal";
+import type { ArcGISIdentityManager, IGeometry, IPolygon, IRequestOptions, ISpatialReference } from "@esri/arcgis-rest-request";
 /**
  * App keys for User Resources used in Hub
  */
@@ -96,16 +93,20 @@ export interface IHubRequestOptionsPortalSelf extends IPortal {
     user?: IUser;
 }
 export interface IHubRequestOptions extends IRequestOptions {
-    authentication?: UserSession;
+    authentication?: ArcGISIdentityManager;
     isPortal?: boolean;
     hubApiUrl?: string;
     portalSelf?: IHubRequestOptionsPortalSelf;
+    /**
+     * The implementation of `fetch` to use. Defaults to a global `fetch`.
+     */
+    fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 }
 /**
  * Options for requests that require an authenticated user.
  */
 export interface IHubUserRequestOptions extends IHubRequestOptions {
-    authentication: UserSession;
+    authentication: ArcGISIdentityManager;
 }
 export interface IHubTrustedOrgsResponse {
     from: IHubTrustedOrgsRelationship;

package/dist/types/initiative-templates/edit.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
 /**
  * @private

package/dist/types/initiatives/HubInitiatives.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubRequestOptions, IHubInitiativeEditor } from "../index";
 import { IQuery } from "../search/types/IHubCatalog";
 import { IItem } from "@esri/arcgis-rest-portal";

package/dist/types/items/_enrichments.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-portal";
+import type { IItem } from "@esri/arcgis-rest-portal";
 import { IItemEnrichments, IServerEnrichments } from "../core";
 import { IEnrichmentErrorInfo, IHubRequestOptions } from "../hub-types";
 import { IHubSchedule } from "../core/types/IHubSchedule";

package/dist/types/items/_internal/_prepare-upload-requests.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IBatch } from "../../hub-types";
 /**
  * Takes a file, file owner, and file AGO item id along with a size limit

package/dist/types/items/_internal/_wait-for-item-ready.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Helper function which takes an itemId and checks the status
  * of the item every 2 seconds until it is either complete or failed.

package/dist/types/items/create-item-from-file.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { ICreateItemResponse } from "@esri/arcgis-rest-portal";
 import type { IItemAdd } from "@esri/arcgis-rest-portal";
 /**

package/dist/types/items/create-item-from-url-or-file.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { ICreateItemResponse, ISharingResponse } from "@esri/arcgis-rest-portal";
 import type { IGroup, IItemAdd } from "@esri/arcgis-rest-portal";
 interface ICreateItemFromUrlOrFileOptions extends IUserRequestOptions {

package/dist/types/items/create-item-from-url.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { ICreateItemResponse } from "@esri/arcgis-rest-portal";
 import type { IItemAdd } from "@esri/arcgis-rest-portal";
 /**

package/dist/types/items/deleteItemThumbnail.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Delete an item's thumbnail
  * @param id

package/dist/types/items/fail-safe-update.d.ts

@@ -1,5 +1,5 @@
 import { IModel } from "../hub-types";
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Update a model's item, wrapped in a failSafe so this will not blow up if
  * the user lacks rights somehow. This should be used in places where there is

package/dist/types/items/is-services-directory-disabled.d.ts

@@ -1,4 +1,4 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import type { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Checks if a server's services directory is disabled. Consider hoisting this to RESTJS
@@ -6,4 +6,4 @@ import type { IItem } from "@esri/arcgis-rest-portal";
  * @param requestOptions Request options
  * @returns Promise that resolves boolean
  */
-export declare const isServicesDirectoryDisabled: (idOrItem: string | IItem, requestOptions: IRequestOptions) => Promise<boolean>;
+export declare const isServicesDirectoryDisabled: (idOrItem: string | IItem, requestOptions: IUserRequestOptions) => Promise<boolean>;

package/dist/types/items/setItemThumbnail.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Upload a file to be used as the thumbnail for an item
  * @param id

package/dist/types/items/uploadImageResource.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Given an item, and owner, add a image resource to the item and returns its url
  * @param id

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

@@ -1,5 +1,5 @@
 export * from "./serializeModel";
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IModel } from "../hub-types";

package/dist/types/org/fetchOrgLimits.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 export declare type OrgLimitType = "ScheduleTask" | "Collaboration" | "Community" | "Groups" | "Content";
 /**
  * Definiton of the org limits response.

package/dist/types/pages/HubPages.d.ts

@@ -3,7 +3,7 @@ import { IHubRequestOptions, IModel } from "../hub-types";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubPage } from "../core";
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IFetchItemOptions } from "../items/fetch";
 /**
  * @private

package/dist/types/projects/edit.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
 import { IHubProject, IHubProjectEditor } from "../core/types";
 /**

package/dist/types/resources/_internal/_validate-url-helpers.d.ts

@@ -1,4 +1,4 @@
-import type { IExtent, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
+import type { IExtent, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-service";
 import { ItemType } from "../../hub-types";
 /**
  * Feature service / Doc Links Should not have data urls. Let"s exclude them from that.

package/dist/types/resources/doesResourceExist.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Given an item ID, and a resource name, check if the resource exists
  *

package/dist/types/resources/fetch-and-upload-resource.d.ts

@@ -1,5 +1,5 @@
 import { IItemResourceResponse } from "@esri/arcgis-rest-portal";
-import type { UserSession } from "@esri/arcgis-rest-auth";
+import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 /**
  * Fetch image from a url, and upload as a resource
  * @param {Object} options {id, owner, fileName, url, authentication}
@@ -9,5 +9,5 @@ export declare function fetchAndUploadResource(options: {
     owner: string;
     fileName: string;
     url: string;
-    authentication: UserSession;
+    authentication: ArcGISIdentityManager;
 }): Promise<IItemResourceResponse>;

package/dist/types/resources/fetch-and-upload-thumbnail.d.ts

@@ -1,4 +1,4 @@
-import type { UserSession } from "@esri/arcgis-rest-auth";
+import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 /**
  * Fetch image from a url, then upload to an item as it's thumbnail
  * @param {object} options
@@ -8,5 +8,5 @@ export declare function fetchAndUploadThumbnail(options: {
     owner: string;
     fileName: string;
     url: string;
-    authentication: UserSession;
+    authentication: ArcGISIdentityManager;
 }): Promise<any>;

package/dist/types/resources/removeResource.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Removes a resource associated with an item
  *

package/dist/types/resources/upsertResource.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 /**
  * Given an item, and owner, Search for if the resource exists
  * and if does, update it, otherwise add it. Returns a url for the item.

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

@@ -1,4 +1,4 @@
-import type { UserSession } from "@esri/arcgis-rest-auth";
+import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 import { IHubRequestOptions } from "../../hub-types";
 import { EntityType } from "./IHubCatalog";
 import { NamedApis, IApiDefinition } from "./types";
@@ -58,7 +58,7 @@ export interface IHubSearchOptions extends IPagingOptions, ISortOptions {
     /**
      * DEPRECATE in favor of requestOptions
      */
-    authentication?: UserSession;
+    authentication?: ArcGISIdentityManager;
     /**
      * While hubSearch requires requestOptions, it is not marked
      * required because that is a breaking change to this

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

@@ -1,4 +1,4 @@
-import { IUser, UserSession } from "@esri/arcgis-rest-auth";
+import { IUser, ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 import { IGroup, ISearchGroupUsersOptions, ISearchOptions, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
 import { IHubSite } from "../core";
 import { ISearchResponse } from "../hub-types";
@@ -50,7 +50,7 @@ export declare function relativeDateToDateRange(relative: IRelativeDate): IDateR
  * @param fn
  * @returns
  */
-export declare function getNextFunction<T>(request: ISearchOptions | ISearchGroupUsersOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;
+export declare function getNextFunction<T>(request: ISearchOptions | ISearchGroupUsersOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: ArcGISIdentityManager) => Promise<ISearchResponse<T>>;
 /**
  * Construct a the full url to a group thumbnail
  *

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

@@ -2,11 +2,17 @@ import type { IUser } from "@esri/arcgis-rest-portal";
 import { HubFamily } from "../hub-types";
 import { EntityType, IFilter, IHubCatalog, IHubCollection } from "./types";
 import type { IArcGISContext } from "../types/IArcGISContext";
-/**
- * This is used to determine what IHubCatalog definition JSON object
- * can be created
- */
-export declare type WellKnownCatalog = "myContent" | "favorites" | "organization" | "world" | "editGroups" | "viewGroups" | "allGroups" | "partners" | "community" | "livingAtlas";
+/** well-known item catalogs */
+export declare const WELL_KNOWN_ITEM_CATALOGS: readonly ["myContent", "favorites", "organization", "world", "partners", "community", "livingAtlas"];
+export declare type WellKnownItemCatalog = (typeof WELL_KNOWN_ITEM_CATALOGS)[number];
+/** well-known group catalogs */
+export declare const WELL_KNOWN_GROUP_CATALOGS: readonly ["editGroups", "viewGroups", "allGroups", "myGroups", "orgGroups", "communityGroups", "publicGroups"];
+export declare type WellKnownGroupCatalog = (typeof WELL_KNOWN_GROUP_CATALOGS)[number];
+/** well-known event catalogs */
+export declare const WELL_KNOWN_EVENT_CATALOGS: readonly ["myEvents", "orgEvents", "worldEvents"];
+export declare type WellKnownEventCatalog = (typeof WELL_KNOWN_EVENT_CATALOGS)[number];
+/** well known catalogs */
+export declare type WellKnownCatalog = WellKnownItemCatalog | WellKnownGroupCatalog | WellKnownEventCatalog;
 /**
  * This is used to determine what IHubCollection definition JSON object
  * can be created. We use HubFamily here to define most of the collections
@@ -38,6 +44,18 @@ export interface IGetWellKnownCatalogOptions {
  * @returns i18nScope with a "." at the end if it is defined
  */
 export declare function dotifyString(i18nScope: string): string;
+/**
+ * Helper function to build an array of well-known Catalogs
+ * note: requested well-known Catalogs must be for the same
+ * targetEntity type
+ *
+ * @param i18nScope Translation scope to be interpolated into the catalog
+ * @param targetEntity The type of entity to query for
+ * @param catalogNames Names of the catalogs requested
+ * @param context contextual portal & auth information
+ * @param opts optional IGetWellKnownCatalogOptions args
+ */
+export declare function getWellKnownCatalogs(i18nScope: string, targetEntity: EntityType, catalogNames: WellKnownCatalog[], context: IArcGISContext, opts?: Exclude<IGetWellKnownCatalogOptions, "context" | "user">): IHubCatalog[];
 /** Get a single catalog based on the catalog name, entity type and optional requests
  * @param i18nScope Translation scope to be interpolated into the catalog
  * @param name Name of the catalog requested

package/dist/types/surveys/edit.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubSurvey } from "../core/types/IHubSurvey";
 /**
  * @private

package/dist/types/templates/edit.d.ts

@@ -1,4 +1,4 @@
-import type { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubTemplate, IHubTemplateEditor } from "../core/types/IHubTemplate";
 import { IPortal } from "@esri/arcgis-rest-portal";
 /**

package/dist/types/types/IArcGISContext.d.ts

@@ -1,4 +1,4 @@
-import { UserSession, IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { ArcGISIdentityManager, IUserRequestOptions } from "@esri/arcgis-rest-request";
 import type { IPortal } from "@esri/arcgis-rest-portal";
 import type { IRequestOptions } from "@esri/arcgis-rest-request";
 import type { IUser } from "@esri/arcgis-rest-portal";
@@ -26,9 +26,9 @@ export interface IArcGISContext {
      */
     id: number;
     /**
-     * Return the UserSession if authenticated
+     * Return the ArcGISIdentityManager if authenticated
      */
-    session: UserSession;
+    session: ArcGISIdentityManager;
     /**
      * Return boolean indicating if authenticatio is present
      */

package/dist/types/types/IArcGISContextManagerOptions.d.ts

@@ -1,4 +1,4 @@
-import type { UserSession } from "@esri/arcgis-rest-auth";
+import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 import { IPortal } from "@esri/arcgis-rest-portal";
 import type { IUser } from "@esri/arcgis-rest-portal";
 import { IUserResourceToken } from "./IUserResourceToken";
@@ -13,9 +13,9 @@ import { IUserHubSettings } from "../utils/IUserHubSettings";
 export interface IArcGISContextManagerOptions {
     /**
      * Existing user session, which may be created from Identity Manager
-     * `const session = UserSession.fromCredential(idMgr.getCredential());`
+     * `const session = ArcGISIdentityManager.fromCredential(idMgr.getCredential());`
      */
-    authentication?: UserSession;
+    authentication?: ArcGISIdentityManager;
     /**
      * ArcGIS Online or ArcGIS Enterprise portal url.
      * Do not include  `/sharing/rest`
@@ -23,17 +23,17 @@ export interface IArcGISContextManagerOptions {
      * 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
+     * When Authentication is present, the ArcGISIdentityManager.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
+     * with the ArcGISIdentityManager, it will be fetched
      */
     portal?: IPortal;
     /**
-     * Current user as `IUser`. If not passed into `.create` with the UserSession
+     * Current user as `IUser`. If not passed into `.create` with the ArcGISIdentityManager
      * it will be fetched.
      */
     currentUser?: IUser;

package/dist/types/types/IArcGISContextOptions.d.ts

@@ -1,4 +1,4 @@
-import type { UserSession } from "@esri/arcgis-rest-auth";
+import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 import type { IPortal } from "@esri/arcgis-rest-portal";
 import type { IUser } from "@esri/arcgis-rest-portal";
 import type { IUserResourceToken } from "./IUserResourceToken";
@@ -28,9 +28,9 @@ export interface IArcGISContextOptions {
      */
     hubUrl?: string;
     /**
-     * The current UserSession
+     * The current ArcGISIdentityManager
      */
-    authentication?: UserSession;
+    authentication?: ArcGISIdentityManager;
     /**
      * If the user is authenticated, the portal should be passed in
      * so various getters can work as expected.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "16.5.3",
+  "version": "17.0.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -22,12 +22,9 @@
     "tslib": "^1.13.0"
   },
   "peerDependencies": {
-    "@esri/arcgis-rest-auth": "^2.14.0 || 3",
-    "@esri/arcgis-rest-feature-layer": "^3.2.0",
-    "@esri/arcgis-rest-portal": "^2.18.0 || 3",
-    "@esri/arcgis-rest-request": "^2.14.0 || 3",
-    "@esri/arcgis-rest-service-admin": "^3.6.0",
-    "@esri/arcgis-rest-types": "^2.15.0 || 3"
+    "@esri/arcgis-rest-feature-service": "~4.0.5",
+    "@esri/arcgis-rest-portal": "~4.4.0",
+    "@esri/arcgis-rest-request": "~4.2.3"
   },
   "devDependencies": {
     "@types/adlib": "^3.0.1",