@esri/solution-common 1.1.3 → 1.3.0

package/dist/umd/generalHelpers.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ICreateItemFromTemplateResponse, IDatasourceInfo, IItemTemplate } from "./interfaces";
+import { ICreateItemFromTemplateResponse, IDatasourceInfo, IItemTemplate, IStringValuePair } from "./interfaces";
 import { Sanitizer } from "./libConnectors";
 /**
  * Returns a URL with a query parameter appended
@@ -222,6 +222,17 @@ export declare function getProp(obj: {
  * @return Array of the values plucked from the object; only defined values are returned
  */
 export declare function getProps(obj: any, props: string[]): any;
+/**
+ * Get a property out of a deeply nested object
+ * Does not handle anything but nested object graph
+ *
+ * @param obj Object to retrieve value from
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
+ *             in obj
+ * @param defaultV Optional value to use if any part of path--including final value--is undefined
+ * @return Value at end of path
+ */
+export declare function getPropWithDefault(obj: IStringValuePair, path: string, defaultV?: any): any;
 /**
  * Updates a list of the items dependencies if more are found in the
  * provided value.

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,17 +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 { 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";
 /**
- * Searches for items matching a query and that the caller has access to.
+ * Creates a UserSession via a function so that the global arcgisSolution variable can access authentication.
  *
- * @param search Search string (e.g., "q=redlands+map")
- * @return Promise resolving with search results
- * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
+ * @param options See https://esri.github.io/arcgis-rest-js/api/auth/IUserSessionOptions/
+ * @return UserSession
  */
-export declare function searchItems(search: string | ISearchOptions | SearchQueryBuilder): Promise<ISearchResult<IItem>>;
+export declare function getUserSession(options?: IUserSessionOptions): UserSession;
 /**
  * Adds a forward relationship between two items.
  *
@@ -76,6 +76,13 @@ export declare function addToServiceDefinition(url: string, options: any, skipRe
  * @return A promise that will resolve when the request has completed
  */
 export declare function checkRequestStatus(result: any, authentication: any): Promise<void>;
+/**
+ * Converts a general search into an ISearchOptions structure.
+ *
+ * @param search Search specified in one of three ways
+ * @return Recast search
+ */
+export declare function convertToISearchOptions(search: string | ISearchOptions | SearchQueryBuilder): ISearchOptions;
 /**
  * Simple validate function to ensure all coordinates are numbers
  * In some cases orgs can have null or undefined coordinate values associated with the org extent
@@ -300,6 +307,23 @@ export declare function removeItem(itemId: string, authentication: UserSession):
  * @return A promise that will resolve with the result of the request
  */
 export declare function removeItemOrGroup(itemId: string, authentication: UserSession): Promise<IStatusResponse>;
+/**
+ * Searches for items matching a query and that the caller has access to.
+ *
+ * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
+ * @return Promise resolving with search results
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
+ */
+export declare function searchItems(search: string | ISearchOptions | SearchQueryBuilder): Promise<ISearchResult<IItem>>;
+/**
+ * Searches for items matching a query and that the caller has access to, continuing recursively until done.
+ *
+ * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
+ * @param accumulatedResponse Response built from previous requests
+ * @return Promise resolving with search results
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
+ */
+export declare function searchAllItems(search: string | ISearchOptions | SearchQueryBuilder, accumulatedResponse?: ISearchResult<IItem>): Promise<ISearchResult<IItem>>;
 /**
  * Searches for groups matching criteria.
  *
@@ -323,6 +347,22 @@ export declare function searchGroups(searchString: string, authentication: UserS
  * @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 recursively.
+ *
+ * @param groupId Group whose contents are to be searched
+ * @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 additionalSearchOptions Adjustments to search, such as tranche size and categories of interest; categories
+ * are supplied as an array: each array element consists of one or more categories to be ORed; array elements are ANDed
+ * @param portalUrl Rest Url of the portal to perform the search
+ * @param accumulatedResponse Response built from previous requests
+ * @return A promise that will resolve with a structure with a tranche of results and
+ * describing how many items are available
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/group-content-search.htm
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
+ */
+export declare function searchGroupAllContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions, portalUrl?: string, accumulatedResponse?: ISearchResult<IItem>): Promise<ISearchResult<IItem>>;
 /**
  * Searches for group contents matching criteria.
  *
@@ -383,6 +423,19 @@ export declare function shareItem(groupId: string, id: string, destinationAuthen
  * @return
  */
 export declare function updateItem(itemInfo: IItemUpdate, authentication: UserSession, folderId?: string, additionalParams?: any): Promise<IUpdateItemResponse>;
+/**
+ * Updates a group.
+ *
+ * @param groupInfo The base info of a group; note that this content will be serialized, which doesn't work
+ * for binary content
+ * @param authentication Credentials for request
+ * @param additionalParams Updates that are put under the `params` property, which is not serialized
+ * @return A Promise that will resolve with the success/failure status of the request
+ */
+export declare function updateGroup(groupInfo: IGroup, authentication: UserSession, additionalParams?: any): Promise<{
+    success: boolean;
+    groupId: string;
+}>;
 /**
  * Updates an item.
  *

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.3",
+  "version": "1.3.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.4.1",
-    "@esri/arcgis-rest-feature-layer": "3.4.1",
-    "@esri/arcgis-rest-portal": "3.4.1",
-    "@esri/arcgis-rest-request": "3.4.1",
-    "@esri/arcgis-rest-service-admin": "3.4.1",
-    "@esri/hub-common": "9.1.4",
-    "@esri/hub-initiatives": "9.1.4",
-    "@esri/hub-sites": "9.1.4",
-    "@esri/hub-teams": "9.1.4",
+    "@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.15.0",
+    "@esri/hub-initiatives": "9.15.0",
+    "@esri/hub-sites": "9.15.0",
+    "@esri/hub-teams": "9.15.0",
     "@types/adlib": "^3.0.1",
-    "rollup": "^1.22.0"
+    "rollup": "^2.60.0"
   },
   "peerDependencies": {
-    "@esri/arcgis-rest-auth": "3.4.1",
-    "@esri/arcgis-rest-feature-layer": "3.4.1",
-    "@esri/arcgis-rest-portal": "3.4.1",
-    "@esri/arcgis-rest-request": "3.4.1",
-    "@esri/arcgis-rest-service-admin": "3.4.1",
-    "@esri/hub-common": "9.1.4",
-    "@esri/hub-initiatives": "9.1.4",
-    "@esri/hub-sites": "9.1.4",
-    "@esri/hub-teams": "9.1.4"
+    "@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.15.0",
+    "@esri/hub-initiatives": "9.15.0",
+    "@esri/hub-sites": "9.15.0",
+    "@esri/hub-teams": "9.15.0"
   },
   "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": "49a1d019f09a153de90c23d4fff1be1af7d554c0"
+  "gitHead": "b8f04e56c71adb7aadaa0293f8708800cdaa9c81"
 }