@esri/solution-common 1.1.2 → 1.2.0

package/dist/esm/restHelpers.d.ts

@@ -14,9 +14,17 @@
  * limitations under the License.
  */
 import { IAddFolderResponse, IAddGroupResponse, IAdditionalSearchOptions, ICreateItemResponse, ICreateServiceResult, IDependency, IExtent, IFeatureServiceProperties, IFolderStatusResponse, IGroup, IGroupAdd, IItem, IItemTemplate, IItemUpdate, IPostProcessArgs, IRelatedItems, ISpatialReference, IStatusResponse, ItemRelationshipType, IUpdate, IUpdateItemResponse, UserSession } from "./interfaces";
-import { ISearchOptions, ISearchResult, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
+import { IUserSessionOptions } from "@esri/arcgis-rest-auth";
+import { IPagingParams, ISearchOptions, ISearchResult, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
 import { IParams } from "@esri/arcgis-rest-request";
 export { request as rest_request } from "@esri/arcgis-rest-request";
+/**
+ * Creates a UserSession via a function so that the global arcgisSolution variable can access authentication.
+ *
+ * @param options See https://esri.github.io/arcgis-rest-js/api/auth/IUserSessionOptions/
+ * @return UserSession
+ */
+export declare function getUserSession(options?: IUserSessionOptions): UserSession;
 /**
  * Searches for items matching a query and that the caller has access to.
  *
@@ -164,9 +172,13 @@ export declare function createUniqueFolder(title: string, templateDictionary: an
  * @param title Group title, used as-is if possible and with suffix otherwise
  * @param templateDictionary Hash of facts: org URL, adlib replacements, user
  * @param authentication Credentials for creating group
+ * @param owner Optional arg for the Tracking owner
+ *              If the tracking owner is not the one deploying the solution
+ *              tracker groups will be created under the deployment user but
+ *              will be reassigned to the tracking owner.
  * @return Information about created group
  */
-export declare function createUniqueGroup(title: string, groupItem: IGroupAdd, templateDictionary: any, authentication: UserSession): Promise<IAddGroupResponse>;
+export declare function createUniqueGroup(title: string, groupItem: IGroupAdd, templateDictionary: any, authentication: UserSession, owner?: string): Promise<IAddGroupResponse>;
 /**
  * Gets the ids of the dependencies of an AGOL feature service item.
  * Dependencies will only exist when the service is a view.
@@ -189,10 +201,22 @@ export declare function getLayers(serviceUrl: string, layerList: any[], authenti
  * Add additional options to a layers definition.
  *
  * @param args The IPostProcessArgs for the request(s)
+ * @param isPortal boolean to indicate if we are deploying to portal
+ *
  * @return An array of update instructions
  * @private
  */
 export declare function getLayerUpdates(args: IPostProcessArgs, isPortal: boolean): IUpdate[];
+/**
+ * Sorts relationships based on order of supporting layers and tables in the service definition
+ *
+ * @param layers the layers from the service
+ * @param tables the tables from the service
+ * @param relUpdates the relationships to add for the service
+ *
+ * @return An array with relationships that have been sorted
+ */
+export declare function _sortRelationships(layers: any[], tables: any[], relUpdates: any): any[];
 /**
  * Update view service when sourceSchemaChangesAllowed is true.
  *
@@ -296,6 +320,17 @@ export declare function removeItemOrGroup(itemId: string, authentication: UserSe
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
  */
 export declare function searchGroups(searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions): Promise<ISearchResult<IGroup>>;
+/**
+ * Searches for groups matching criteria recurusively.
+ *
+ * @param searchString Text for which to search, e.g., 'redlands+map', 'type:"Web Map" -type:"Web Mapping Application"'
+ * @param authentication Credentials for the request to AGO
+ * @param groups List of groups that have been found from previous requests
+ * @param inPagingParams The paging params for the recurisve searching
+ *
+ * @return A promise that will resolve with all groups that meet the search criteria
+ */
+export declare function searchAllGroups(searchString: string, authentication: UserSession, groups?: IGroup[], inPagingParams?: IPagingParams): Promise<IGroup[]>;
 /**
  * Searches for group contents matching criteria.
  *
@@ -311,16 +346,40 @@ export declare function searchGroups(searchString: string, authentication: UserS
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
  */
 export declare function searchGroupContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions, portalUrl?: string): Promise<ISearchResult<IItem>>;
+/**
+ * Reassign ownership of a group
+ *
+ * @param groupId Group to remove users from
+ * @param userName The new owner for the group
+ * @param authentication Credentials for the request to
+ *
+ * @return A promise that will resolve after the group ownership has been assigned
+ *
+ */
+export declare function reassignGroup(groupId: string, userName: string, authentication: UserSession): Promise<any>;
+/**
+ * Remove users from a group
+ *
+ * @param groupId Group to remove users from
+ * @param users List of users to remove from the group
+ * @param authentication Credentials for the request to
+ *
+ * @return A promise that will resolve after the users have been removed
+ *
+ */
+export declare function removeUsers(groupId: string, users: string[], authentication: UserSession): Promise<any>;
 /**
  * Shares an item to the defined group
  *
  * @param groupId Group to share with
  * @param id the item id to share with the group
  * @param destinationAuthentication Credentials for the request to AGO
+ * @param owner owner of the group when sharing tracking items (can be different from the deploying user)
+ *
  * @return A promise that will resolve after the item has been shared
  *
  */
-export declare function shareItem(groupId: string, id: string, destinationAuthentication: UserSession): Promise<void>;
+export declare function shareItem(groupId: string, id: string, destinationAuthentication: UserSession, owner?: string): Promise<void>;
 /**
  * Updates an item.
  *
@@ -342,7 +401,7 @@ export declare function updateItem(itemInfo: IItemUpdate, authentication: UserSe
  * @param access "public" or "org"
  * @return
  */
-export declare function updateItemExtended(itemInfo: IItemUpdate, data: any, authentication: UserSession, thumbnail?: File, access?: string | undefined): Promise<IUpdateItemResponse>;
+export declare function updateItemExtended(itemInfo: IItemUpdate, data: any, authentication: UserSession, thumbnail?: File, access?: string | undefined, templateDictionary?: any): Promise<IUpdateItemResponse>;
 /**
  * Update an item's base and data using a dictionary.
  *
@@ -444,12 +503,13 @@ export declare function _reportVariablesInItem(itemId: string, itemType: string,
  * Updates a feature service item.
  *
  * @param item Item to update
+ * @param itemTemplate item template for the new item
  * @param serviceInfo Service information
  * @param params arcgis-rest-js params to update
  * @param isPortal Is the service hosted in a portal?
  * @return Updated item
  */
-export declare function _setItemProperties(item: any, serviceInfo: any, params: IParams, isPortal: boolean): any;
+export declare function _setItemProperties(item: any, itemTemplate: IItemTemplate, serviceInfo: any, params: IParams, isPortal: boolean): any;
 /**
  * Set isUnique as true for indexes that reference origin relationship keyFields.
  *