fix: restore IUserRequestOptions.authentication: ArcGISIdentityManager

fix: restore IUserRequestOptions.authentication to a ArcGISIdentityMa…

Author: tomwayson

packages/arcgis-rest-portal/src/groups/helpers.ts

@@ -1,12 +1,12 @@
 /* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { IUserRequestOptions } from "@esri/arcgis-rest-request";
+import { IAuthenticatedRequestOptions } from "@esri/arcgis-rest-request";
 
 /**
  * Base options interface for making authenticated requests for groups.
  */
-export interface IUserGroupOptions extends IUserRequestOptions {
+export interface IUserGroupOptions extends IAuthenticatedRequestOptions {
   /**
    * Unique identifier of the group.
    */

packages/arcgis-rest-portal/src/groups/update-user-membership.ts

@@ -2,7 +2,10 @@
  * Apache-2.0 */
 
 import { getPortalUrl } from "../util/get-portal-url.js";
-import { request, IUserRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  request,
+  IAuthenticatedRequestOptions
+} from "@esri/arcgis-rest-request";
 
 export interface IUpdateGroupUsersResult {
   /**
@@ -11,7 +14,7 @@ export interface IUpdateGroupUsersResult {
   results: any[];
 }
 
-export interface IUpdateGroupUsersOptions extends IUserRequestOptions {
+export interface IUpdateGroupUsersOptions extends IAuthenticatedRequestOptions {
   /**
    * Group ID
    */

packages/arcgis-rest-portal/src/items/helpers.ts

@@ -3,15 +3,15 @@
 
 import {
   IRequestOptions,
-  IUserRequestOptions
+  IAuthenticatedRequestOptions
 } from "@esri/arcgis-rest-request";
 
 import type { Blob, File } from "@esri/arcgis-rest-request";
 
 /**
  * Base options interface for making authenticated requests for items.
  */
-export interface IUserItemOptions extends IUserRequestOptions {
+export interface IUserItemOptions extends IAuthenticatedRequestOptions {
   /**
    * Unique identifier of the item.
    */
@@ -22,7 +22,7 @@ export interface IUserItemOptions extends IUserRequestOptions {
   owner?: string;
 }
 
-export interface IFolderIdOptions extends IUserRequestOptions {
+export interface IFolderIdOptions extends IAuthenticatedRequestOptions {
   /**
    * Unique identifier of the folder.
    */
@@ -87,7 +87,8 @@ export interface IItemRelationshipOptions extends IRequestOptions {
   direction?: "forward" | "reverse";
 }
 
-export interface IManageItemRelationshipOptions extends IUserRequestOptions {
+export interface IManageItemRelationshipOptions
+  extends IAuthenticatedRequestOptions {
   originItemId: string;
   destinationItemId: string;
   relationshipType: ItemRelationshipType;
@@ -139,7 +140,7 @@ export interface IRemoveItemResourceOptions extends IUserItemOptions {
   deleteAll?: boolean;
 }
 
-export interface ICreateUpdateItemOptions extends IUserRequestOptions {
+export interface ICreateUpdateItemOptions extends IAuthenticatedRequestOptions {
   /**
    * The owner of the item. If this property is not present, `item.owner` will be passed, or lastly `authentication.getUsername()`.
    */

packages/arcgis-rest-portal/src/items/reassign.ts

@@ -1,10 +1,13 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
-import { request, IUserRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  request,
+  IAuthenticatedRequestOptions
+} from "@esri/arcgis-rest-request";
 import { getPortalUrl } from "../util/get-portal-url.js";
 import { isOrgAdmin } from "../sharing/helpers.js";
 
-interface IReassignItemOptions extends IUserRequestOptions {
+interface IReassignItemOptions extends IAuthenticatedRequestOptions {
   id: string;
   currentOwner: string;
   targetUsername: string;

packages/arcgis-rest-portal/src/sharing/helpers.ts

@@ -2,7 +2,7 @@
  * Apache-2.0 */
 
 import {
-  IUserRequestOptions,
+  IAuthenticatedRequestOptions,
   IGroup,
   IUser,
   GroupMembership
@@ -11,7 +11,7 @@ import { getPortalUrl } from "../util/get-portal-url.js";
 import { getGroup } from "../groups/get.js";
 import { getSelf } from "../util/get-portal.js";
 
-export interface ISharingOptions extends IUserRequestOptions {
+export interface ISharingOptions extends IAuthenticatedRequestOptions {
   /**
    * Unique identifier for the item.
    */
@@ -56,7 +56,7 @@ export function isItemOwner(
  * @returns Promise resolving in a boolean indicating if the user is an ArcGIS Organization administrator
  */
 export function isOrgAdmin(
-  requestOptions: IUserRequestOptions
+  requestOptions: IAuthenticatedRequestOptions
 ): Promise<boolean> {
   return requestOptions.authentication.getUser().then((user: IUser) => {
     return user && user.role === "org_admin" && !user.roleId;

packages/arcgis-rest-portal/src/users/get-user-properties.ts

@@ -1,7 +1,10 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { IUserRequestOptions, request } from "@esri/arcgis-rest-request";
+import {
+  IAuthenticatedRequestOptions,
+  request
+} from "@esri/arcgis-rest-request";
 import { getPortalUrl } from "../util/get-portal-url.js";
 
 export interface IUserProperties {
@@ -21,12 +24,12 @@ export interface IUserProperties {
 /**
  * Fetches the properties for a user
  * @param username The user whose properties to fetch
- * @param requestOptions An IUserRequestOptions object
+ * @param requestOptions An IAuthenticatedRequestOptions object
  * @returns a promise that resolves an IUserProperties object
  */
 export async function getUserProperties(
   username: string,
-  requestOptions: IUserRequestOptions
+  requestOptions: IAuthenticatedRequestOptions
 ): Promise<IUserProperties> {
   const url = `${getPortalUrl(
     requestOptions

packages/arcgis-rest-portal/src/users/invitation.ts

@@ -3,7 +3,7 @@
 
 import {
   request,
-  IUserRequestOptions,
+  IAuthenticatedRequestOptions,
   IGroup
 } from "@esri/arcgis-rest-request";
 
@@ -50,9 +50,9 @@ export interface IInvitationResult {
  * @returns A Promise that will resolve with the user's invitations
  */
 export async function getUserInvitations(
-  requestOptions: IUserRequestOptions
+  requestOptions: IAuthenticatedRequestOptions
 ): Promise<IInvitationResult> {
-  let options = { httpMethod: "GET" } as IUserRequestOptions;
+  let options = { httpMethod: "GET" } as IAuthenticatedRequestOptions;
   const username = await determineUsername(requestOptions);
   const portalUrl = getPortalUrl(requestOptions);
   const url = `${portalUrl}/community/users/${username}/invitations`;
@@ -62,7 +62,8 @@ export async function getUserInvitations(
   return request(url, options);
 }
 
-export interface IGetUserInvitationOptions extends IUserRequestOptions {
+export interface IGetUserInvitationOptions
+  extends IAuthenticatedRequestOptions {
   invitationId: string;
 }
 

packages/arcgis-rest-portal/src/users/notification.ts

@@ -1,7 +1,10 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IUserRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  request,
+  IAuthenticatedRequestOptions
+} from "@esri/arcgis-rest-request";
 
 import { getPortalUrl } from "../util/get-portal-url.js";
 import { determineUsername } from "../util/determine-username.js";
@@ -15,7 +18,8 @@ export interface INotification {
   data: { [key: string]: any };
 }
 
-export interface IRemoveNotificationOptions extends IUserRequestOptions {
+export interface IRemoveNotificationOptions
+  extends IAuthenticatedRequestOptions {
   /**
    * Unique identifier of the item.
    */
@@ -40,9 +44,9 @@ export interface INotificationResult {
  * @returns A Promise that will resolve with the user's notifications
  */
 export async function getUserNotifications(
-  requestOptions: IUserRequestOptions
+  requestOptions: IAuthenticatedRequestOptions
 ): Promise<INotificationResult> {
-  let options = { httpMethod: "GET" } as IUserRequestOptions;
+  let options = { httpMethod: "GET" } as IAuthenticatedRequestOptions;
 
   const username = await determineUsername(requestOptions);
   const portalUrl = getPortalUrl(requestOptions);

packages/arcgis-rest-portal/src/users/set-user-properties.ts

@@ -1,26 +1,29 @@
 /* Copyright (c) 2023 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { IUserRequestOptions, request } from "@esri/arcgis-rest-request";
+import {
+  IAuthenticatedRequestOptions,
+  request
+} from "@esri/arcgis-rest-request";
 import { getPortalUrl } from "../util/get-portal-url.js";
 import { IUserProperties } from "./get-user-properties.js";
 
 /**
  * Updates the properties for a user
  * @param username The user whose properties to update
  * @param properties IUserProperties object with properties to update
- * @param requestOptions An IUserRequestOptions object
+ * @param requestOptions An IAuthenticatedRequestOptions object
  * @returns a promise that resolves to { success: boolean }
  */
 export async function setUserProperties(
   username: string,
   properties: IUserProperties,
-  requestOptions: IUserRequestOptions
+  requestOptions: IAuthenticatedRequestOptions
 ): Promise<{ success: boolean }> {
   const url = `${getPortalUrl(
     requestOptions
   )}/community/users/${encodeURIComponent(username)}/setProperties`;
-  const options: IUserRequestOptions = {
+  const options: IAuthenticatedRequestOptions = {
     httpMethod: "POST",
     params: { properties },
     ...requestOptions

packages/arcgis-rest-portal/src/users/update.ts

@@ -1,11 +1,15 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IUserRequestOptions, IUser } from "@esri/arcgis-rest-request";
+import {
+  request,
+  IAuthenticatedRequestOptions,
+  IUser
+} from "@esri/arcgis-rest-request";
 
 import { getPortalUrl } from "../util/get-portal-url.js";
 
-export interface IUpdateUserOptions extends IUserRequestOptions {
+export interface IUpdateUserOptions extends IAuthenticatedRequestOptions {
   /**
    * The user properties to be updated.
    */