@esri/solution-common 1.1.2 → 1.2.0

package/dist/umd/create-hub-request-options.d.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 import { UserSession } from "./interfaces";
-import { IHubRequestOptions } from "@esri/hub-common";
+import { IHubUserRequestOptions } from "@esri/hub-common";
 /**
- * Create a IHubRequestOptions object from
+ * Create a IHubUserRequestOptions object from
  * the UserSession
  * If passed, it will use `templateDictionary`
  * values instead of making additional requests
@@ -24,6 +24,6 @@ import { IHubRequestOptions } from "@esri/hub-common";
  * @export
  * @param {UserSession} authentication
  * @param {*} templateDictionary
- * @returns {IHubRequestOptions}
+ * @returns {IHubUserRequestOptions}
  */
-export declare function createHubRequestOptions(authentication: UserSession, templateDictionary?: any): Promise<IHubRequestOptions>;
+export declare function createHubRequestOptions(authentication: UserSession, templateDictionary?: any): Promise<IHubUserRequestOptions>;

package/dist/umd/featureServiceHelpers.d.ts

@@ -749,3 +749,9 @@ export interface IPopupInfos {
     layers: INumberValuePair;
     tables: INumberValuePair;
 }
+/**
+ * Helper function to ensure same chunk size value is used in multiple locations
+ *
+ * @return a number that represents how many layers should be included per addToDef call
+ */
+export declare function _getLayerChunkSize(): number;

package/dist/umd/index.d.ts

@@ -39,5 +39,6 @@ export * from "./restHelpers";
 export * from "./restHelpersGet";
 export * from "./sharing";
 export * from "./templatization";
+export * from "./trackingHelpers";
 export * from "./velocityHelpers";
 export * from "./workforceHelpers";

package/dist/umd/interfaces.d.ts

@@ -346,6 +346,13 @@ export interface IGroupCategory {
     description?: string;
     categories?: IGroupCategory[];
 }
+/**
+ * Hierarchical arrangement of items and their dependencies.
+ */
+export interface IHierarchyElement {
+    id: string;
+    dependencies: IHierarchyElement[];
+}
 /**
  * Subset of portal.IItem containing just the properties that are stored in a template--the item's "base" section.
  */
@@ -424,7 +431,7 @@ export interface IItemTemplate {
  * Function signatures for use in a function lookup array.
  */
 export interface IItemTemplateConversions {
-    convertItemToTemplate(solutionItemId: string, itemInfo: any, authentication: UserSession, templateDictionary?: any): Promise<IItemTemplate>;
+    convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession, templateDictionary?: any): Promise<IItemTemplate>;
     createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
     postProcessDependencies?(templates: IItemTemplate[], clonedSolutionsResponse: ICreateItemFromTemplateResponse[], authentication: UserSession, templateDictionary: any): Promise<any>;
 }
@@ -432,6 +439,9 @@ export interface IItemTemplateConversions {
  * Structure for mapping from item type to module with type-specific template-handling code
  */
 export declare type moduleHandler = IItemTemplateConversions | undefined | null;
+/**
+ * Mapping from an AGO item type to the code handling that type.
+ */
 export interface IItemTypeModuleMap {
     [itemType: string]: moduleHandler;
 }
@@ -443,9 +453,15 @@ export interface IItemUpdate {
      */
     [key: string]: any;
 }
+/**
+ * Type with key access to lists of strings
+ */
 export interface IKeyedListsOfStrings {
     [key: string]: string[];
 }
+/**
+ * Type with key access to strings
+ */
 export interface IMimeTypes {
     [key: string]: string;
 }
@@ -503,10 +519,16 @@ export interface IQuickCaptureDatasource {
      */
     url: number;
 }
+/**
+ * A mapping between a relationship type and the list of item ids using that relationship.
+ */
 export interface IRelatedItems {
     relationshipType: string;
     relatedItemIds: string[];
 }
+/**
+ * Summary of a resource.
+ */
 export interface IResource {
     resource: string;
     created: number;
@@ -576,6 +598,9 @@ export interface ISolutionProgressEvent {
      */
     data?: any;
 }
+/**
+ * Information about a resource to be copied into an item.
+ */
 export interface ISourceFile {
     /**
      * The portal item id, e.g., "4efe5f693de34620934787ead6693f19", that supplies the resource
@@ -789,6 +814,9 @@ export interface ISurvey123CreateResult {
  */
 export interface IZipCopyResults extends IZipInfo, ICopyResults {
 }
+/**
+ * Information about a zipped file.
+ */
 export interface IZipInfo {
     /**
      * Zip's filename
@@ -803,3 +831,13 @@ export interface IZipInfo {
      */
     filelist: any[];
 }
+export interface IVelocityTitle {
+    /**
+     * The current label for the object
+     */
+    label: string;
+    /**
+     * Existing titles that have been used in the org
+     */
+    titles: string[];
+}

package/dist/umd/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.
  *

package/dist/umd/sharing/share-item-to-groups.d.ts

@@ -21,5 +21,6 @@ import { UserSession } from "../";
  * @param groups Array of Group Ids
  * @param itemId Item Id
  * @param authentication UserSession
+ * @param owner owner of the group when sharing tracking items (can be different from the deploying user)
  */
-export declare function shareItemToGroups(groupIds: string[], itemId: string, authentication: UserSession): Promise<any>;
+export declare function shareItemToGroups(groupIds: string[], itemId: string, authentication: UserSession, owner?: string): Promise<any>;

package/dist/umd/trackingHelpers.d.ts

@@ -0,0 +1,116 @@
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IItemTemplate, UserSession } from "./interfaces";
+import { IItemUpdate } from "@esri/arcgis-rest-types";
+import { ICreateServiceParams } from "@esri/arcgis-rest-service-admin";
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * This function will update the input templateDictionary with a boolean
+ * indicating if tracking is enabled on the org and the user is an admin.
+ *
+ * @param portalResponse portal self response
+ * @param userResponse portal user response
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param templates the list of IItemTemplates from the solution
+ *
+ * @protected
+ */
+export declare function setLocationTrackingEnabled(portalResponse: any, userResponse: any, templateDictionary: any, templates?: IItemTemplate[]): void;
+/**
+ * Used by deploy to evaluate if we have everything we need to deploy tracking views.
+ *
+ * An error is thrown to prevent additional deployment work if we have Tracking items and tracking is
+ * not enabled or the deployment user is not an admin in the organization.
+ *
+ * @param templates the list of IItemTemplates from the solution
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @protected
+ */
+export declare function _validateTrackingTemplates(templates: IItemTemplate[], templateDictionary: any): void;
+/**
+ * Used by deploy to determine the owner of the tracking service.
+ * Only one tracking service per org and all tracking views and tracking groups must be owned by the tracking service owner.
+ *
+ * This function will update the input templateDictionary with the owner as well as
+ *  the item id for the source tracking service.
+ *
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ * @param authentication Credentials for the requests
+ *
+ * @protected
+ */
+export declare function getTackingServiceOwner(templateDictionary: any, authentication: UserSession): Promise<boolean>;
+/**
+ * Check key properties to understand if we are dealing with a tracking template
+ *
+ * @param itemTemplate the template to evaluate
+ * @param itemUpdate the item update to evaluate
+ *
+ * @protected
+ */
+export declare function isTrackingViewTemplate(itemTemplate?: IItemTemplate, itemUpdate?: IItemUpdate): boolean;
+/**
+ * Check key properties to understand if we are dealing with a tracking group template
+ *
+ * @param itemTemplate the template to evaluate
+ *
+ * @protected
+ */
+export declare function isTrackingViewGroup(itemTemplate: IItemTemplate): boolean;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for feature service item
+ *
+ * @protected
+ */
+export declare function templatizeTracker(itemTemplate: IItemTemplate): void;
+/**
+ * Templatize the tracker view group id and view name for location tracking views.
+ * This function will update the itemTemplate that is passed in when it's a tracking view.
+ *
+ * @param itemTemplate Template for the tracker view
+ * @param path the path to the property that stores the current name
+ * @param groupId the id of the associated tracker group
+ * @param groupIdVar the variable to replace the existing name with
+ *
+ * @protected
+ */
+export declare function _setName(itemTemplate: IItemTemplate, path: string, groupId: string, groupIdVar: string): void;
+/**
+ * Templatize the tracker view serviceItemId
+ *
+ * This function will update the input obj with the templatized variable
+ *
+ * @param obj the object that stores the serviceItemId
+ * @param path the path to the property that stores the serviceItemId
+ *
+ * @protected
+ */
+export declare function templatizeServiceItemId(obj: any, path: string): void;
+/**
+ * Used by deploy to update the request options with key details for deploying tracker views
+ *
+ * @param itemTemplate Template for feature service item
+ * @param options the current request options to update
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
+ *
+ * @protected
+ */
+export declare function setTrackingOptions(itemTemplate: IItemTemplate, options: any, templateDictionary: any): ICreateServiceParams;

package/dist/umd/velocityHelpers.d.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 import { UserSession } from "./interfaces";
+export declare const BASE_NAMES: string[];
+export declare const PROP_NAMES: string[];
 /**
  * Get the base velocity url from the current orgs subscription info
  *

package/dist/umd/workforceHelpers.d.ts

@@ -49,6 +49,17 @@ export declare function templatizeWorkforce(data: any, keyProperties: string[],
  */
 export declare function getWorkforceDependencies(itemTemplate: IItemTemplate, dependencies: any[]): any;
 export declare function getWorkforceServiceInfo(properties: IFeatureServiceProperties, url: string, authentication: UserSession): Promise<IFeatureServiceProperties>;
+/**
+ * Wrap global id and assignmenttype values in curly braces
+ *
+ * Added for issue #734
+ *
+ * This function will update the provided workforceInfos object
+ *
+ * @param workforceInfos the object that stores the integration and type info with global ids
+ *
+ */
+export declare function _updateGlobalIdAndAssignmentType(workforceInfos: any): void;
 export declare function _getAssignmentTypeInfos(assignmentTypes: any): any[];
 export declare function _getAssignmentIntegrationInfos(assignmentIntegrations: any, authentication: UserSession): Promise<any>;
 export declare function getUrlDependencies(requests: Array<Promise<any>>, urls: string[]): Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-common",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Provides general helper functions for @esri/solution.js.",
   "main": "dist/node/index.js",
   "unpkg": "dist/umd/common.umd.min.js",
@@ -13,36 +13,36 @@
     "dist/**"
   ],
   "devDependencies": {
-    "@esri/arcgis-rest-auth": "^3.3.0",
-    "@esri/arcgis-rest-feature-layer": "^3.3.0",
-    "@esri/arcgis-rest-portal": "^3.3.0",
-    "@esri/arcgis-rest-request": "^3.3.0",
-    "@esri/arcgis-rest-service-admin": "^3.3.0",
-    "@esri/hub-common": "^8.16.0",
-    "@esri/hub-initiatives": "^8.16.0",
-    "@esri/hub-sites": "^8.16.0",
-    "@esri/hub-teams": "^8.16.0",
+    "@esri/arcgis-rest-auth": "3.4.3",
+    "@esri/arcgis-rest-feature-layer": "3.4.3",
+    "@esri/arcgis-rest-portal": "3.4.3",
+    "@esri/arcgis-rest-request": "3.4.3",
+    "@esri/arcgis-rest-service-admin": "3.4.3",
+    "@esri/hub-common": "9.7.2",
+    "@esri/hub-initiatives": "9.7.2",
+    "@esri/hub-sites": "9.7.2",
+    "@esri/hub-teams": "9.7.2",
     "@types/adlib": "^3.0.1",
-    "rollup": "^1.22.0"
+    "rollup": "^2.60.0"
   },
   "peerDependencies": {
-    "@esri/arcgis-rest-auth": "^3.3.0",
-    "@esri/arcgis-rest-feature-layer": "^3.3.0",
-    "@esri/arcgis-rest-portal": "^3.3.0",
-    "@esri/arcgis-rest-request": "^3.3.0",
-    "@esri/arcgis-rest-service-admin": "^3.3.0",
-    "@esri/hub-common": "^8.16.0",
-    "@esri/hub-initiatives": "^8.16.0",
-    "@esri/hub-sites": "^8.16.0",
-    "@esri/hub-teams": "^8.16.0"
+    "@esri/arcgis-rest-auth": "3.4.3",
+    "@esri/arcgis-rest-feature-layer": "3.4.3",
+    "@esri/arcgis-rest-portal": "3.4.3",
+    "@esri/arcgis-rest-request": "3.4.3",
+    "@esri/arcgis-rest-service-admin": "3.4.3",
+    "@esri/hub-common": "9.7.2",
+    "@esri/hub-initiatives": "9.7.2",
+    "@esri/hub-sites": "9.7.2",
+    "@esri/hub-teams": "9.7.2"
   },
   "dependencies": {
-    "@esri/arcgis-html-sanitizer": "~2.5.0",
+    "@esri/arcgis-html-sanitizer": "2.8.0",
     "@types/lodash.isplainobject": "^4.0.6",
     "adlib": "3.0.7",
-    "jszip": "3.7.0",
+    "jszip": "3.7.1",
     "lodash.isplainobject": "^4.0.6",
-    "tslib": "^1.13.0",
+    "tslib": "1.13.0",
     "xss": "^1.0.6"
   },
   "scripts": {
@@ -95,5 +95,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "c1ea3f67a733c7ee0b79cc19828347cfea9cd163"
+  "gitHead": "70f706fb28a50db0b9b13030f263f8e9e270b98d"
 }