@esri/solution-common 1.2.0 → 1.3.2

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/resources/convert-item-resource-to-storage-resource.d.ts

@@ -13,18 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { SolutionResourceType } from "./solution-resource";
 /**
  * Generates a folder and filename for storing a copy of an item's resource in a storage item.
  *
  * @param prefix Base prefix for resource
- * @param storageVersion Version of the Solution template
  * @param sourceResourceFilename Either filename or folder/filename to resource
+ * @param storageVersion Version of the Solution template
+ * @param storageFileType Optional argument that when supplied will control the how the prefix is created
  * @return Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
  * exists plus ("_" + part of sourceResourceFilename before "/" if that separator exists);
  * file is sourceResourceFilename
  * @see convertStorageResourceToItemResource
  */
-export declare function convertItemResourceToStorageResource(prefix: string, sourceResourceFilename: string, storageVersion?: number): {
+export declare function convertItemResourceToStorageResource(prefix: string, sourceResourceFilename: string, storageVersion?: number, storageFileType?: SolutionResourceType): {
     folder: string;
     filename: string;
 };

package/dist/umd/restHelpers.d.ts

@@ -25,14 +25,6 @@ export { request as rest_request } from "@esri/arcgis-rest-request";
  * @return UserSession
  */
 export declare function getUserSession(options?: IUserSessionOptions): UserSession;
-/**
- * Searches for items matching a query and that the caller has access to.
- *
- * @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
- */
-export declare function searchItems(search: string | ISearchOptions | SearchQueryBuilder): Promise<ISearchResult<IItem>>;
 /**
  * Adds a forward relationship between two items.
  *
@@ -84,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
@@ -308,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.
  *
@@ -331,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.
  *
@@ -391,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-common",
-  "version": "1.2.0",
+  "version": "1.3.2",
   "description": "Provides general helper functions for @esri/solution.js.",
   "main": "dist/node/index.js",
   "unpkg": "dist/umd/common.umd.min.js",
@@ -18,10 +18,10 @@
     "@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",
+    "@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": "^2.60.0"
   },
@@ -31,10 +31,10 @@
     "@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"
+    "@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.8.0",
@@ -95,5 +95,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "70f706fb28a50db0b9b13030f263f8e9e270b98d"
+  "gitHead": "08334d19a46a19455c798c89c325f50b9305d8b3"
 }