@esri/solution-common 1.3.10 → 1.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (223) hide show
  1. package/dist/esm/completeItem.d.ts +1 -1
  2. package/dist/esm/completeItem.js +1 -1
  3. package/dist/esm/deleteHelpers/deleteEmptyGroups.d.ts +1 -1
  4. package/dist/esm/deleteHelpers/deleteEmptyGroups.js +1 -1
  5. package/dist/esm/deleteHelpers/deleteGroupIfEmpty.d.ts +1 -1
  6. package/dist/esm/deleteHelpers/deleteGroupIfEmpty.js +1 -1
  7. package/dist/esm/deleteHelpers/deleteSolutionContents.d.ts +1 -1
  8. package/dist/esm/deleteHelpers/deleteSolutionContents.js +1 -1
  9. package/dist/esm/deleteHelpers/deleteSolutionFolder.d.ts +1 -1
  10. package/dist/esm/deleteHelpers/deleteSolutionFolder.js +1 -1
  11. package/dist/esm/deleteHelpers/deleteSolutionItem.d.ts +1 -1
  12. package/dist/esm/deleteHelpers/deleteSolutionItem.js +1 -1
  13. package/dist/esm/deleteHelpers/reconstructBuildOrderIds.d.ts +1 -1
  14. package/dist/esm/deleteHelpers/reconstructBuildOrderIds.js +1 -1
  15. package/dist/esm/deleteHelpers/removeItems.d.ts +1 -1
  16. package/dist/esm/deleteHelpers/removeItems.js +1 -1
  17. package/dist/esm/deleteSolution.d.ts +2 -2
  18. package/dist/esm/deleteSolution.js +2 -2
  19. package/dist/esm/dependencies.d.ts +1 -1
  20. package/dist/esm/dependencies.js +2 -2
  21. package/dist/esm/featureServiceHelpers.d.ts +99 -60
  22. package/dist/esm/featureServiceHelpers.js +99 -60
  23. package/dist/esm/featureServiceHelpers.js.map +1 -1
  24. package/dist/esm/generalHelpers.d.ts +34 -34
  25. package/dist/esm/generalHelpers.js +36 -36
  26. package/dist/esm/getDeletableSolutionInfo.d.ts +1 -1
  27. package/dist/esm/getDeletableSolutionInfo.js +1 -1
  28. package/dist/esm/getSolutionSummary.d.ts +1 -1
  29. package/dist/esm/getSolutionSummary.js +1 -1
  30. package/dist/esm/interfaces.d.ts +438 -10
  31. package/dist/esm/interfaces.js +7 -1
  32. package/dist/esm/interfaces.js.map +1 -1
  33. package/dist/esm/libConnectors.d.ts +5 -5
  34. package/dist/esm/libConnectors.js +5 -5
  35. package/dist/esm/migrations/apply-schema.d.ts +1 -0
  36. package/dist/esm/migrations/apply-schema.js +1 -0
  37. package/dist/esm/migrations/apply-schema.js.map +1 -1
  38. package/dist/esm/migrations/upgrade-three-dot-one.d.ts +1 -0
  39. package/dist/esm/migrations/upgrade-three-dot-one.js +1 -0
  40. package/dist/esm/migrations/upgrade-three-dot-one.js.map +1 -1
  41. package/dist/esm/migrations/upgrade-two-dot-seven.d.ts +7 -0
  42. package/dist/esm/migrations/upgrade-two-dot-seven.js +7 -0
  43. package/dist/esm/migrations/upgrade-two-dot-seven.js.map +1 -1
  44. package/dist/esm/polyfills.d.ts +2 -2
  45. package/dist/esm/polyfills.js +2 -2
  46. package/dist/esm/resourceHelpers.d.ts +11 -11
  47. package/dist/esm/resourceHelpers.js +11 -11
  48. package/dist/esm/resources/addMetadataFromBlob.d.ts +1 -1
  49. package/dist/esm/resources/addMetadataFromBlob.js +1 -1
  50. package/dist/esm/resources/convert-item-resource-to-storage-resource.d.ts +1 -1
  51. package/dist/esm/resources/convert-item-resource-to-storage-resource.js +1 -1
  52. package/dist/esm/resources/convert-storage-resource-to-item-resource.d.ts +1 -1
  53. package/dist/esm/resources/convert-storage-resource-to-item-resource.js +1 -1
  54. package/dist/esm/resources/copyAssociatedFiles.d.ts +4 -3
  55. package/dist/esm/resources/copyAssociatedFiles.js +5 -4
  56. package/dist/esm/resources/copyAssociatedFiles.js.map +1 -1
  57. package/dist/esm/resources/copyDataIntoItem.d.ts +2 -2
  58. package/dist/esm/resources/copyDataIntoItem.js +2 -2
  59. package/dist/esm/resources/copyMetadataIntoItem.d.ts +1 -1
  60. package/dist/esm/resources/copyMetadataIntoItem.js +1 -1
  61. package/dist/esm/resources/copyResourceIntoZip.d.ts +2 -2
  62. package/dist/esm/resources/copyResourceIntoZip.js +2 -2
  63. package/dist/esm/resources/copyZipIntoItem.d.ts +1 -1
  64. package/dist/esm/resources/copyZipIntoItem.js +1 -1
  65. package/dist/esm/resources/createCopyResults.d.ts +1 -1
  66. package/dist/esm/resources/createCopyResults.js +1 -1
  67. package/dist/esm/resources/get-blob.d.ts +1 -1
  68. package/dist/esm/resources/get-blob.js +1 -1
  69. package/dist/esm/resources/getItemResourcesFilesFromPaths.d.ts +1 -1
  70. package/dist/esm/resources/getItemResourcesFilesFromPaths.js +1 -1
  71. package/dist/esm/resources/getItemResourcesPaths.d.ts +1 -1
  72. package/dist/esm/resources/getItemResourcesPaths.js +1 -1
  73. package/dist/esm/resources/transform-resource-paths-to-solution-resources.d.ts +1 -0
  74. package/dist/esm/resources/transform-resource-paths-to-solution-resources.js +1 -0
  75. package/dist/esm/resources/transform-resource-paths-to-solution-resources.js.map +1 -1
  76. package/dist/esm/restHelpers.d.ts +59 -54
  77. package/dist/esm/restHelpers.js +55 -50
  78. package/dist/esm/restHelpers.js.map +1 -1
  79. package/dist/esm/restHelpersGet.d.ts +30 -30
  80. package/dist/esm/restHelpersGet.js +30 -30
  81. package/dist/esm/templatization.d.ts +15 -15
  82. package/dist/esm/templatization.js +15 -15
  83. package/dist/esm/trackingHelpers.d.ts +9 -9
  84. package/dist/esm/trackingHelpers.js +9 -9
  85. package/dist/esm/velocityHelpers.d.ts +4 -4
  86. package/dist/esm/velocityHelpers.js +4 -4
  87. package/dist/esm/workforceHelpers.d.ts +8 -7
  88. package/dist/esm/workforceHelpers.js +18 -7
  89. package/dist/esm/workforceHelpers.js.map +1 -1
  90. package/dist/node/completeItem.d.ts +1 -1
  91. package/dist/node/completeItem.js +1 -1
  92. package/dist/node/deleteHelpers/deleteEmptyGroups.d.ts +1 -1
  93. package/dist/node/deleteHelpers/deleteEmptyGroups.js +1 -1
  94. package/dist/node/deleteHelpers/deleteGroupIfEmpty.d.ts +1 -1
  95. package/dist/node/deleteHelpers/deleteGroupIfEmpty.js +1 -1
  96. package/dist/node/deleteHelpers/deleteSolutionContents.d.ts +1 -1
  97. package/dist/node/deleteHelpers/deleteSolutionContents.js +1 -1
  98. package/dist/node/deleteHelpers/deleteSolutionFolder.d.ts +1 -1
  99. package/dist/node/deleteHelpers/deleteSolutionFolder.js +1 -1
  100. package/dist/node/deleteHelpers/deleteSolutionItem.d.ts +1 -1
  101. package/dist/node/deleteHelpers/deleteSolutionItem.js +1 -1
  102. package/dist/node/deleteHelpers/reconstructBuildOrderIds.d.ts +1 -1
  103. package/dist/node/deleteHelpers/reconstructBuildOrderIds.js +1 -1
  104. package/dist/node/deleteHelpers/removeItems.d.ts +1 -1
  105. package/dist/node/deleteHelpers/removeItems.js +1 -1
  106. package/dist/node/deleteSolution.d.ts +2 -2
  107. package/dist/node/deleteSolution.js +2 -2
  108. package/dist/node/dependencies.d.ts +1 -1
  109. package/dist/node/dependencies.js +2 -2
  110. package/dist/node/featureServiceHelpers.d.ts +99 -60
  111. package/dist/node/featureServiceHelpers.js +99 -60
  112. package/dist/node/featureServiceHelpers.js.map +1 -1
  113. package/dist/node/generalHelpers.d.ts +34 -34
  114. package/dist/node/generalHelpers.js +36 -36
  115. package/dist/node/getDeletableSolutionInfo.d.ts +1 -1
  116. package/dist/node/getDeletableSolutionInfo.js +1 -1
  117. package/dist/node/getSolutionSummary.d.ts +1 -1
  118. package/dist/node/getSolutionSummary.js +1 -1
  119. package/dist/node/interfaces.d.ts +438 -10
  120. package/dist/node/interfaces.js +7 -1
  121. package/dist/node/interfaces.js.map +1 -1
  122. package/dist/node/libConnectors.d.ts +5 -5
  123. package/dist/node/libConnectors.js +5 -5
  124. package/dist/node/migrations/apply-schema.d.ts +1 -0
  125. package/dist/node/migrations/apply-schema.js +1 -0
  126. package/dist/node/migrations/apply-schema.js.map +1 -1
  127. package/dist/node/migrations/upgrade-three-dot-one.d.ts +1 -0
  128. package/dist/node/migrations/upgrade-three-dot-one.js +1 -0
  129. package/dist/node/migrations/upgrade-three-dot-one.js.map +1 -1
  130. package/dist/node/migrations/upgrade-two-dot-seven.d.ts +7 -0
  131. package/dist/node/migrations/upgrade-two-dot-seven.js +7 -0
  132. package/dist/node/migrations/upgrade-two-dot-seven.js.map +1 -1
  133. package/dist/node/polyfills.d.ts +2 -2
  134. package/dist/node/polyfills.js +2 -2
  135. package/dist/node/resourceHelpers.d.ts +11 -11
  136. package/dist/node/resourceHelpers.js +11 -11
  137. package/dist/node/resources/addMetadataFromBlob.d.ts +1 -1
  138. package/dist/node/resources/addMetadataFromBlob.js +1 -1
  139. package/dist/node/resources/convert-item-resource-to-storage-resource.d.ts +1 -1
  140. package/dist/node/resources/convert-item-resource-to-storage-resource.js +1 -1
  141. package/dist/node/resources/convert-storage-resource-to-item-resource.d.ts +1 -1
  142. package/dist/node/resources/convert-storage-resource-to-item-resource.js +1 -1
  143. package/dist/node/resources/copyAssociatedFiles.d.ts +4 -3
  144. package/dist/node/resources/copyAssociatedFiles.js +5 -4
  145. package/dist/node/resources/copyAssociatedFiles.js.map +1 -1
  146. package/dist/node/resources/copyDataIntoItem.d.ts +2 -2
  147. package/dist/node/resources/copyDataIntoItem.js +2 -2
  148. package/dist/node/resources/copyMetadataIntoItem.d.ts +1 -1
  149. package/dist/node/resources/copyMetadataIntoItem.js +1 -1
  150. package/dist/node/resources/copyResourceIntoZip.d.ts +2 -2
  151. package/dist/node/resources/copyResourceIntoZip.js +2 -2
  152. package/dist/node/resources/copyZipIntoItem.d.ts +1 -1
  153. package/dist/node/resources/copyZipIntoItem.js +1 -1
  154. package/dist/node/resources/createCopyResults.d.ts +1 -1
  155. package/dist/node/resources/createCopyResults.js +1 -1
  156. package/dist/node/resources/get-blob.d.ts +1 -1
  157. package/dist/node/resources/get-blob.js +1 -1
  158. package/dist/node/resources/getItemResourcesFilesFromPaths.d.ts +1 -1
  159. package/dist/node/resources/getItemResourcesFilesFromPaths.js +1 -1
  160. package/dist/node/resources/getItemResourcesPaths.d.ts +1 -1
  161. package/dist/node/resources/getItemResourcesPaths.js +1 -1
  162. package/dist/node/resources/transform-resource-paths-to-solution-resources.d.ts +1 -0
  163. package/dist/node/resources/transform-resource-paths-to-solution-resources.js +1 -0
  164. package/dist/node/resources/transform-resource-paths-to-solution-resources.js.map +1 -1
  165. package/dist/node/restHelpers.d.ts +59 -54
  166. package/dist/node/restHelpers.js +55 -50
  167. package/dist/node/restHelpers.js.map +1 -1
  168. package/dist/node/restHelpersGet.d.ts +30 -30
  169. package/dist/node/restHelpersGet.js +30 -30
  170. package/dist/node/templatization.d.ts +15 -15
  171. package/dist/node/templatization.js +15 -15
  172. package/dist/node/trackingHelpers.d.ts +9 -9
  173. package/dist/node/trackingHelpers.js +9 -9
  174. package/dist/node/velocityHelpers.d.ts +4 -4
  175. package/dist/node/velocityHelpers.js +4 -4
  176. package/dist/node/workforceHelpers.d.ts +8 -7
  177. package/dist/node/workforceHelpers.js +18 -7
  178. package/dist/node/workforceHelpers.js.map +1 -1
  179. package/dist/umd/common.umd.js +399 -313
  180. package/dist/umd/common.umd.js.map +1 -1
  181. package/dist/umd/common.umd.min.js +3 -3
  182. package/dist/umd/common.umd.min.js.map +1 -1
  183. package/dist/umd/completeItem.d.ts +1 -1
  184. package/dist/umd/deleteHelpers/deleteEmptyGroups.d.ts +1 -1
  185. package/dist/umd/deleteHelpers/deleteGroupIfEmpty.d.ts +1 -1
  186. package/dist/umd/deleteHelpers/deleteSolutionContents.d.ts +1 -1
  187. package/dist/umd/deleteHelpers/deleteSolutionFolder.d.ts +1 -1
  188. package/dist/umd/deleteHelpers/deleteSolutionItem.d.ts +1 -1
  189. package/dist/umd/deleteHelpers/reconstructBuildOrderIds.d.ts +1 -1
  190. package/dist/umd/deleteHelpers/removeItems.d.ts +1 -1
  191. package/dist/umd/deleteSolution.d.ts +2 -2
  192. package/dist/umd/dependencies.d.ts +1 -1
  193. package/dist/umd/featureServiceHelpers.d.ts +99 -60
  194. package/dist/umd/generalHelpers.d.ts +34 -34
  195. package/dist/umd/getDeletableSolutionInfo.d.ts +1 -1
  196. package/dist/umd/getSolutionSummary.d.ts +1 -1
  197. package/dist/umd/interfaces.d.ts +438 -10
  198. package/dist/umd/libConnectors.d.ts +5 -5
  199. package/dist/umd/migrations/apply-schema.d.ts +1 -0
  200. package/dist/umd/migrations/upgrade-three-dot-one.d.ts +1 -0
  201. package/dist/umd/migrations/upgrade-two-dot-seven.d.ts +7 -0
  202. package/dist/umd/polyfills.d.ts +2 -2
  203. package/dist/umd/resourceHelpers.d.ts +11 -11
  204. package/dist/umd/resources/addMetadataFromBlob.d.ts +1 -1
  205. package/dist/umd/resources/convert-item-resource-to-storage-resource.d.ts +1 -1
  206. package/dist/umd/resources/convert-storage-resource-to-item-resource.d.ts +1 -1
  207. package/dist/umd/resources/copyAssociatedFiles.d.ts +4 -3
  208. package/dist/umd/resources/copyDataIntoItem.d.ts +2 -2
  209. package/dist/umd/resources/copyMetadataIntoItem.d.ts +1 -1
  210. package/dist/umd/resources/copyResourceIntoZip.d.ts +2 -2
  211. package/dist/umd/resources/copyZipIntoItem.d.ts +1 -1
  212. package/dist/umd/resources/createCopyResults.d.ts +1 -1
  213. package/dist/umd/resources/get-blob.d.ts +1 -1
  214. package/dist/umd/resources/getItemResourcesFilesFromPaths.d.ts +1 -1
  215. package/dist/umd/resources/getItemResourcesPaths.d.ts +1 -1
  216. package/dist/umd/resources/transform-resource-paths-to-solution-resources.d.ts +1 -0
  217. package/dist/umd/restHelpers.d.ts +59 -54
  218. package/dist/umd/restHelpersGet.d.ts +30 -30
  219. package/dist/umd/templatization.d.ts +15 -15
  220. package/dist/umd/trackingHelpers.d.ts +9 -9
  221. package/dist/umd/velocityHelpers.d.ts +4 -4
  222. package/dist/umd/workforceHelpers.d.ts +8 -7
  223. package/package.json +18 -17
@@ -13,7 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- 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";
16
+ import { IAddFolderResponse, IAddGroupResponse, IAdditionalGroupSearchOptions, ICreateItemResponse, ICreateServiceResult, IDependency, IExtent, IFeatureServiceProperties, IFolderStatusResponse, IGroup, IGroupAdd, IItem, IItemTemplate, IItemUpdate, IPostProcessArgs, IRelatedItems, ISpatialReference, IStatusResponse, ItemRelationshipType, IUpdate, IUpdateItemResponse, UserSession } from "./interfaces";
17
17
  import { IUserSessionOptions } from "@esri/arcgis-rest-auth";
18
18
  import { IPagingParams, ISearchOptions, ISearchResult, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
19
19
  import { IParams } from "@esri/arcgis-rest-request";
@@ -22,7 +22,7 @@ export { request as rest_request } from "@esri/arcgis-rest-request";
22
22
  * Creates a UserSession via a function so that the global arcgisSolution variable can access authentication.
23
23
  *
24
24
  * @param options See https://esri.github.io/arcgis-rest-js/api/auth/IUserSessionOptions/
25
- * @return UserSession
25
+ * @returns UserSession
26
26
  */
27
27
  export declare function getUserSession(options?: IUserSessionOptions): UserSession;
28
28
  /**
@@ -32,7 +32,7 @@ export declare function getUserSession(options?: IUserSessionOptions): UserSessi
32
32
  * @param destinationItemId Destination of relationship
33
33
  * @param relationshipType Type of relationship
34
34
  * @param authentication Credentials for the request
35
- * @return A Promise to add item resources.
35
+ * @returns A Promise to add item resources.
36
36
  */
37
37
  export declare function addForwardItemRelationship(originItemId: string, destinationItemId: string, relationshipType: ItemRelationshipType, authentication: UserSession): Promise<IStatusResponse>;
38
38
  /**
@@ -41,7 +41,7 @@ export declare function addForwardItemRelationship(originItemId: string, destina
41
41
  * @param originItemId Origin of relationship
42
42
  * @param destinationRelationships Destinations
43
43
  * @param authentication Credentials for the request
44
- * @return A Promise to add item resources.
44
+ * @returns A Promise to add item resources.
45
45
  */
46
46
  export declare function addForwardItemRelationships(originItemId: string, destinationRelationships: IRelatedItems[], authentication: UserSession): Promise<IStatusResponse[]>;
47
47
  /**
@@ -49,7 +49,7 @@ export declare function addForwardItemRelationships(originItemId: string, destin
49
49
  *
50
50
  * @param url URL to use as base
51
51
  * @param authentication Credentials to be used to generate token for URL
52
- * @return A promise that will resolve with the supplied URL with `token=&lt;token&gt;` added to its query params
52
+ * @returns A promise that will resolve with the supplied URL with `token=&lt;token&gt;` added to its query params
53
53
  * unless either the URL doesn't exist or the token can't be generated
54
54
  */
55
55
  export declare function addTokenToUrl(url: string, authentication: UserSession): Promise<string>;
@@ -64,7 +64,7 @@ export declare function addTokenToUrl(url: string, authentication: UserSession):
64
64
  * @param options the info to add to the services definition
65
65
  * @param skipRetry a boolean to control if retry logic will be used. Defaults to false.
66
66
  * @param useAsync a boolean to control if we will use an async request
67
- * @return A promise that will resolve when the request has completed
67
+ * @returns A promise that will resolve when the request has completed
68
68
  */
69
69
  export declare function addToServiceDefinition(url: string, options: any, skipRetry?: boolean, useAsync?: boolean): Promise<void>;
70
70
  /**
@@ -73,14 +73,14 @@ export declare function addToServiceDefinition(url: string, options: any, skipRe
73
73
  * @param result the result returned from the addToDefinition request.
74
74
  * This will contain a status url or the standard sync result.
75
75
  * @param authentication Credentials to be used to generate token for URL
76
- * @return A promise that will resolve when the request has completed
76
+ * @returns A promise that will resolve when the request has completed
77
77
  */
78
78
  export declare function checkRequestStatus(result: any, authentication: any): Promise<void>;
79
79
  /**
80
80
  * Converts a general search into an ISearchOptions structure.
81
81
  *
82
82
  * @param search Search specified in one of three ways
83
- * @return Recast search
83
+ * @returns Recast search
84
84
  */
85
85
  export declare function convertToISearchOptions(search: string | ISearchOptions | SearchQueryBuilder): ISearchOptions;
86
86
  /**
@@ -88,7 +88,7 @@ export declare function convertToISearchOptions(search: string | ISearchOptions
88
88
  * In some cases orgs can have null or undefined coordinate values associated with the org extent
89
89
  *
90
90
  * @param extent the extent to validate
91
- * @return the provided extent or a default global extent if some coordinates are not numbers
91
+ * @returns the provided extent or a default global extent if some coordinates are not numbers
92
92
  * @private
93
93
  */
94
94
  export declare function _validateExtent(extent: IExtent): IExtent;
@@ -102,7 +102,7 @@ export declare function _validateExtent(extent: IExtent): IExtent;
102
102
  * @param outSR the spatial reference to project to
103
103
  * @param geometryServiceUrl the service url for the geometry service to use
104
104
  * @param authentication the credentials for the requests
105
- * @return the extent projected to the provided spatial reference
105
+ * @returns the extent projected to the provided spatial reference
106
106
  * or the world extent projected to the provided spatial reference
107
107
  * @private
108
108
  */
@@ -114,7 +114,7 @@ export declare function convertExtentWithFallback(extent: IExtent, fallbackExten
114
114
  * @param outSR Desired spatial reference
115
115
  * @param geometryServiceUrl Path to geometry service providing `findTransformations` and `project` services
116
116
  * @param authentication Credentials for the request
117
- * @return Original extent if it's already using outSR or the extents projected into the outSR
117
+ * @returns Original extent if it's already using outSR or the extents projected into the outSR
118
118
  */
119
119
  export declare function convertExtent(extent: IExtent, outSR: ISpatialReference, geometryServiceUrl: string, authentication: UserSession): Promise<any>;
120
120
  /**
@@ -123,7 +123,7 @@ export declare function convertExtent(extent: IExtent, outSR: ISpatialReference,
123
123
  * @param newItemTemplate Template of item to be created
124
124
  * @param authentication Credentials for the request
125
125
  * @param templateDictionary Hash of facts: org URL, adlib replacements, user; .user.folders property contains a list
126
- * @return A promise that will resolve with an object reporting success and the Solution id
126
+ * @returns A promise that will resolve with an object reporting success and the Solution id
127
127
  */
128
128
  export declare function createFeatureService(newItemTemplate: IItemTemplate, authentication: UserSession, templateDictionary: any): Promise<ICreateServiceResult>;
129
129
  /**
@@ -139,7 +139,7 @@ export declare function createFeatureService(newItemTemplate: IItemTemplate, aut
139
139
  * @param metadataFile Item's metadata file
140
140
  * @param resourcesFiles Item's resources
141
141
  * @param access Access to set for item: "public", "org", "private"
142
- * @return A promise that will resolve with an object reporting success or failure and the Solution id
142
+ * @returns A promise that will resolve with an object reporting success or failure and the Solution id
143
143
  */
144
144
  export declare function createFullItem(itemInfo: any, folderId: string | undefined, destinationAuthentication: UserSession, itemThumbnailUrl?: string, itemThumbnailAuthentication?: UserSession, dataFile?: File, metadataFile?: File, resourcesFiles?: File[], access?: string): Promise<ICreateItemResponse>;
145
145
  /**
@@ -151,7 +151,7 @@ export declare function createFullItem(itemInfo: any, folderId: string | undefin
151
151
  * @param folderId Id of folder to receive item; null indicates that the item goes into the root
152
152
  * folder; ignored for Group item type
153
153
  * @param access Access to set for item: "public", "org", "private"
154
- * @return A promise that will resolve with an object reporting success and the Solution id
154
+ * @returns A promise that will resolve with an object reporting success and the Solution id
155
155
  */
156
156
  export declare function createItemWithData(itemInfo: any, dataInfo: any, authentication: UserSession, folderId: string | undefined, access?: string): Promise<ICreateItemResponse>;
157
157
  /**
@@ -162,7 +162,7 @@ export declare function createItemWithData(itemInfo: any, dataInfo: any, authent
162
162
  * of known folder names; function updates list with existing names not yet known, and creates .user.folders if it
163
163
  * doesn't exist in the dictionary
164
164
  * @param authentication Credentials for creating folder
165
- * @return Id of created folder
165
+ * @returns Id of created folder
166
166
  */
167
167
  export declare function createUniqueFolder(title: string, templateDictionary: any, authentication: UserSession): Promise<IAddFolderResponse>;
168
168
  /**
@@ -175,7 +175,7 @@ export declare function createUniqueFolder(title: string, templateDictionary: an
175
175
  * If the tracking owner is not the one deploying the solution
176
176
  * tracker groups will be created under the deployment user but
177
177
  * will be reassigned to the tracking owner.
178
- * @return Information about created group
178
+ * @returns Information about created group
179
179
  */
180
180
  export declare function createUniqueGroup(title: string, groupItem: IGroupAdd, templateDictionary: any, authentication: UserSession, owner?: string): Promise<IAddGroupResponse>;
181
181
  /**
@@ -184,7 +184,7 @@ export declare function createUniqueGroup(title: string, groupItem: IGroupAdd, t
184
184
  *
185
185
  * @param itemTemplate Template of item to be created
186
186
  * @param authentication Credentials for the request
187
- * @return A promise that will resolve a list of dependencies
187
+ * @returns A promise that will resolve a list of dependencies
188
188
  */
189
189
  export declare function extractDependencies(itemTemplate: IItemTemplate, authentication?: UserSession): Promise<IDependency[]>;
190
190
  /**
@@ -193,7 +193,7 @@ export declare function extractDependencies(itemTemplate: IItemTemplate, authent
193
193
  * @param serviceUrl the url for the service
194
194
  * @param layerList list of base layer info
195
195
  * @param authentication Credentials for the request
196
- * @return A promise that will resolve a list of dependencies
196
+ * @returns A promise that will resolve a list of dependencies
197
197
  */
198
198
  export declare function getLayers(serviceUrl: string, layerList: any[], authentication: UserSession): Promise<any[]>;
199
199
  /**
@@ -202,7 +202,7 @@ export declare function getLayers(serviceUrl: string, layerList: any[], authenti
202
202
  * @param args The IPostProcessArgs for the request(s)
203
203
  * @param isPortal boolean to indicate if we are deploying to portal
204
204
  *
205
- * @return An array of update instructions
205
+ * @returns An array of update instructions
206
206
  * @private
207
207
  */
208
208
  export declare function getLayerUpdates(args: IPostProcessArgs, isPortal: boolean): IUpdate[];
@@ -213,7 +213,8 @@ export declare function getLayerUpdates(args: IPostProcessArgs, isPortal: boolea
213
213
  * @param tables the tables from the service
214
214
  * @param relUpdates the relationships to add for the service
215
215
  *
216
- * @return An array with relationships that have been sorted
216
+ * @returns An array with relationships that have been sorted
217
+ * @private
217
218
  */
218
219
  export declare function _sortRelationships(layers: any[], tables: any[], relUpdates: any): any[];
219
220
  /**
@@ -225,7 +226,7 @@ export declare function _sortRelationships(layers: any[], tables: any[], relUpda
225
226
  * @param itemTemplate Template of item being deployed
226
227
  * @param authentication Credentials for the request
227
228
  * @param updates An array of update instructions
228
- * @return An array of update instructions
229
+ * @returns An array of update instructions
229
230
  */
230
231
  export declare function getFinalServiceUpdates(itemTemplate: IItemTemplate, authentication: UserSession, updates: IUpdate[]): IUpdate[];
231
232
  /**
@@ -236,7 +237,7 @@ export declare function getFinalServiceUpdates(itemTemplate: IItemTemplate, auth
236
237
  *
237
238
  * @param Update will contain either add, update, or delete from service definition call
238
239
  * @param skipRetry defaults to false. when true the retry logic will be ignored
239
- * @return A promise that will resolve when service definition call has completed
240
+ * @returns A promise that will resolve when service definition call has completed
240
241
  * @private
241
242
  */
242
243
  export declare function getRequest(update: IUpdate, skipRetry?: boolean, useAsync?: boolean): Promise<void>;
@@ -245,7 +246,7 @@ export declare function getRequest(update: IUpdate, skipRetry?: boolean, useAsyn
245
246
  *
246
247
  * @param itemTemplate Feature service item, data, dependencies definition to be modified
247
248
  * @param authentication Credentials for the request to AGOL
248
- * @return A promise that will resolve when fullItem has been updated
249
+ * @returns A promise that will resolve when fullItem has been updated
249
250
  * @private
250
251
  */
251
252
  export declare function getServiceLayersAndTables(itemTemplate: IItemTemplate, authentication: UserSession): Promise<IItemTemplate>;
@@ -255,7 +256,7 @@ export declare function getServiceLayersAndTables(itemTemplate: IItemTemplate, a
255
256
  * @param serviceUrl the feature service url
256
257
  * @param authentication Credentials for the request to AGOL
257
258
  * @param workforceService boolean to indicate if extra workforce service steps should be handled
258
- * @return A promise that will resolve with the service properties
259
+ * @returns A promise that will resolve with the service properties
259
260
  * @private
260
261
  */
261
262
  export declare function getFeatureServiceProperties(serviceUrl: string, authentication: UserSession, workforceService?: boolean): Promise<IFeatureServiceProperties>;
@@ -264,7 +265,8 @@ export declare function getFeatureServiceProperties(serviceUrl: string, authenti
264
265
  * Layers and Tables are both returned in the layers array when we access a feature service from the admin api.
265
266
  *
266
267
  * @param adminData The data of the feature service
267
- * @return A mutated version of the provided adminData
268
+ * @returns A mutated version of the provided adminData
269
+ * @private
268
270
  */
269
271
  export declare function _parseAdminServiceData(adminData: any): any;
270
272
  /**
@@ -272,7 +274,7 @@ export declare function _parseAdminServiceData(adminData: any): any;
272
274
  * These layers should not be templatized or depolyed
273
275
  *
274
276
  * @param groupDesignations the items group designations to evaluate
275
- * @return A boolean indicating if the invalid designation is found in the item info
277
+ * @returns A boolean indicating if the invalid designation is found in the item info
276
278
  */
277
279
  export declare function hasInvalidGroupDesignations(groupDesignations: string): boolean;
278
280
  /**
@@ -280,7 +282,7 @@ export declare function hasInvalidGroupDesignations(groupDesignations: string):
280
282
  *
281
283
  * @param folderId Id of a folder to delete
282
284
  * @param authentication Credentials for the request to AGO
283
- * @return A promise that will resolve with the result of the request
285
+ * @returns A promise that will resolve with the result of the request
284
286
  */
285
287
  export declare function removeFolder(folderId: string, authentication: UserSession): Promise<IFolderStatusResponse>;
286
288
  /**
@@ -288,7 +290,7 @@ export declare function removeFolder(folderId: string, authentication: UserSessi
288
290
  *
289
291
  * @param groupId Id of a group to delete
290
292
  * @param authentication Credentials for the request to AGO
291
- * @return A promise that will resolve with the result of the request
293
+ * @returns A promise that will resolve with the result of the request
292
294
  */
293
295
  export declare function removeGroup(groupId: string, authentication: UserSession): Promise<IStatusResponse>;
294
296
  /**
@@ -296,7 +298,7 @@ export declare function removeGroup(groupId: string, authentication: UserSession
296
298
  *
297
299
  * @param itemId Id of an item to delete
298
300
  * @param authentication Credentials for the request to AGO
299
- * @return A promise that will resolve with the result of the request
301
+ * @returns A promise that will resolve with the result of the request
300
302
  */
301
303
  export declare function removeItem(itemId: string, authentication: UserSession): Promise<IStatusResponse>;
302
304
  /**
@@ -304,14 +306,14 @@ export declare function removeItem(itemId: string, authentication: UserSession):
304
306
  *
305
307
  * @param itemId Id of an item or group to delete
306
308
  * @param authentication Credentials for the request to AGO
307
- * @return A promise that will resolve with the result of the request
309
+ * @returns A promise that will resolve with the result of the request
308
310
  */
309
311
  export declare function removeItemOrGroup(itemId: string, authentication: UserSession): Promise<IStatusResponse>;
310
312
  /**
311
313
  * Searches for items matching a query and that the caller has access to.
312
314
  *
313
315
  * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
314
- * @return Promise resolving with search results
316
+ * @returns Promise resolving with search results
315
317
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
316
318
  */
317
319
  export declare function searchItems(search: string | ISearchOptions | SearchQueryBuilder): Promise<ISearchResult<IItem>>;
@@ -320,7 +322,7 @@ export declare function searchItems(search: string | ISearchOptions | SearchQuer
320
322
  *
321
323
  * @param search Search string (e.g., "q=redlands+map") or a more detailed structure that can include authentication
322
324
  * @param accumulatedResponse Response built from previous requests
323
- * @return Promise resolving with search results
325
+ * @returns Promise resolving with search results
324
326
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search.htm
325
327
  */
326
328
  export declare function searchAllItems(search: string | ISearchOptions | SearchQueryBuilder, accumulatedResponse?: ISearchResult<IItem>): Promise<ISearchResult<IItem>>;
@@ -330,12 +332,12 @@ export declare function searchAllItems(search: string | ISearchOptions | SearchQ
330
332
  * @param searchString Text for which to search, e.g., 'redlands+map', 'type:"Web Map" -type:"Web Mapping Application"'
331
333
  * @param authentication Credentials for the request to AGO
332
334
  * @param additionalSearchOptions Adjustments to search, such as tranche size
333
- * @return A promise that will resolve with a structure with a tranche of results and
335
+ * @returns A promise that will resolve with a structure with a tranche of results and
334
336
  * describing how many items are available
335
337
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-search.htm
336
338
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
337
339
  */
338
- export declare function searchGroups(searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions): Promise<ISearchResult<IGroup>>;
340
+ export declare function searchGroups(searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalGroupSearchOptions): Promise<ISearchResult<IGroup>>;
339
341
  /**
340
342
  * Searches for groups matching criteria recurusively.
341
343
  *
@@ -344,7 +346,7 @@ export declare function searchGroups(searchString: string, authentication: UserS
344
346
  * @param groups List of groups that have been found from previous requests
345
347
  * @param inPagingParams The paging params for the recurisve searching
346
348
  *
347
- * @return A promise that will resolve with all groups that meet the search criteria
349
+ * @returns A promise that will resolve with all groups that meet the search criteria
348
350
  */
349
351
  export declare function searchAllGroups(searchString: string, authentication: UserSession, groups?: IGroup[], inPagingParams?: IPagingParams): Promise<IGroup[]>;
350
352
  /**
@@ -357,12 +359,12 @@ export declare function searchAllGroups(searchString: string, authentication: Us
357
359
  * are supplied as an array: each array element consists of one or more categories to be ORed; array elements are ANDed
358
360
  * @param portalUrl Rest Url of the portal to perform the search
359
361
  * @param accumulatedResponse Response built from previous requests
360
- * @return A promise that will resolve with a structure with a tranche of results and
362
+ * @returns A promise that will resolve with a structure with a tranche of results and
361
363
  * describing how many items are available
362
364
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-content-search.htm
363
365
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
364
366
  */
365
- export declare function searchGroupAllContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions, portalUrl?: string, accumulatedResponse?: ISearchResult<IItem>): Promise<ISearchResult<IItem>>;
367
+ export declare function searchGroupAllContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalGroupSearchOptions, portalUrl?: string, accumulatedResponse?: ISearchResult<IItem>): Promise<ISearchResult<IItem>>;
366
368
  /**
367
369
  * Searches for group contents matching criteria.
368
370
  *
@@ -372,12 +374,12 @@ export declare function searchGroupAllContents(groupId: string, searchString: st
372
374
  * @param additionalSearchOptions Adjustments to search, such as tranche size and categories of interest; categories
373
375
  * are supplied as an array: each array element consists of one or more categories to be ORed; array elements are ANDed
374
376
  * @param portalUrl Rest Url of the portal to perform the search
375
- * @return A promise that will resolve with a structure with a tranche of results and
377
+ * @returns A promise that will resolve with a structure with a tranche of results and
376
378
  * describing how many items are available
377
379
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-content-search.htm
378
380
  * @see https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
379
381
  */
380
- export declare function searchGroupContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalSearchOptions, portalUrl?: string): Promise<ISearchResult<IItem>>;
382
+ export declare function searchGroupContents(groupId: string, searchString: string, authentication: UserSession, additionalSearchOptions?: IAdditionalGroupSearchOptions, portalUrl?: string): Promise<ISearchResult<IItem>>;
381
383
  /**
382
384
  * Reassign ownership of a group
383
385
  *
@@ -385,7 +387,7 @@ export declare function searchGroupContents(groupId: string, searchString: strin
385
387
  * @param userName The new owner for the group
386
388
  * @param authentication Credentials for the request to
387
389
  *
388
- * @return A promise that will resolve after the group ownership has been assigned
390
+ * @returns A promise that will resolve after the group ownership has been assigned
389
391
  *
390
392
  */
391
393
  export declare function reassignGroup(groupId: string, userName: string, authentication: UserSession): Promise<any>;
@@ -396,7 +398,7 @@ export declare function reassignGroup(groupId: string, userName: string, authent
396
398
  * @param users List of users to remove from the group
397
399
  * @param authentication Credentials for the request to
398
400
  *
399
- * @return A promise that will resolve after the users have been removed
401
+ * @returns A promise that will resolve after the users have been removed
400
402
  *
401
403
  */
402
404
  export declare function removeUsers(groupId: string, users: string[], authentication: UserSession): Promise<any>;
@@ -408,7 +410,7 @@ export declare function removeUsers(groupId: string, users: string[], authentica
408
410
  * @param destinationAuthentication Credentials for the request to AGO
409
411
  * @param owner owner of the group when sharing tracking items (can be different from the deploying user)
410
412
  *
411
- * @return A promise that will resolve after the item has been shared
413
+ * @returns A promise that will resolve after the item has been shared
412
414
  *
413
415
  */
414
416
  export declare function shareItem(groupId: string, id: string, destinationAuthentication: UserSession, owner?: string): Promise<void>;
@@ -430,7 +432,7 @@ export declare function updateItem(itemInfo: IItemUpdate, authentication: UserSe
430
432
  * for binary content
431
433
  * @param authentication Credentials for request
432
434
  * @param additionalParams Updates that are put under the `params` property, which is not serialized
433
- * @return A Promise that will resolve with the success/failure status of the request
435
+ * @returns A Promise that will resolve with the success/failure status of the request
434
436
  */
435
437
  export declare function updateGroup(groupInfo: IGroup, authentication: UserSession, additionalParams?: any): Promise<{
436
438
  success: boolean;
@@ -462,7 +464,7 @@ export declare function updateItemTemplateFromDictionary(itemId: string, templat
462
464
  * @param id AGOL id of item to update
463
465
  * @param url URL to assign to item's base section
464
466
  * @param authentication Credentials for the request
465
- * @return A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
467
+ * @returns A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
466
468
  * response
467
469
  */
468
470
  export declare function updateItemURL(id: string, url: string, authentication: UserSession): Promise<string>;
@@ -472,7 +474,7 @@ export declare function updateItemURL(id: string, url: string, authentication: U
472
474
  * @param itemId Id of item to receive data file
473
475
  * @param dataFile Data to be added
474
476
  * @param authentication Credentials for the request
475
- * @return Promise reporting success or failure
477
+ * @returns Promise reporting success or failure
476
478
  * @private
477
479
  */
478
480
  export declare function _addItemDataFile(itemId: string, dataFile: File, authentication: UserSession): Promise<IUpdateItemResponse>;
@@ -482,7 +484,7 @@ export declare function _addItemDataFile(itemId: string, dataFile: File, authent
482
484
  * @param itemId Id of item to receive data file
483
485
  * @param metadataFile Metadata to be added
484
486
  * @param authentication Credentials for the request
485
- * @return Promise reporting success or failure
487
+ * @returns Promise reporting success or failure
486
488
  * @private
487
489
  */
488
490
  export declare function _addItemMetadataFile(itemId: string, metadataFile: File, authentication: UserSession): Promise<IUpdateItemResponse>;
@@ -490,7 +492,7 @@ export declare function _addItemMetadataFile(itemId: string, metadataFile: File,
490
492
  * Accumulates the number of relationships in a collection of layers.
491
493
  *
492
494
  * @param List of layers to examine
493
- * @return The number of relationships
495
+ * @returns The number of relationships
494
496
  * @private
495
497
  */
496
498
  export declare function _countRelationships(layers: any[]): number;
@@ -500,7 +502,7 @@ export declare function _countRelationships(layers: any[]): number;
500
502
  * @param serviceUrl URL to hosted service
501
503
  * @param layerList List of layers at that service...must contain id
502
504
  * @param authentication Credentials for the request
503
- * @return A promise that will resolve with a list of the layers from the admin api
505
+ * @returns A promise that will resolve with a list of the layers from the admin api
504
506
  * @private
505
507
  */
506
508
  export declare function _getCreateServiceOptions(newItemTemplate: IItemTemplate, authentication: UserSession, templateDictionary: any): Promise<any>;
@@ -513,7 +515,7 @@ export declare function _getCreateServiceOptions(newItemTemplate: IItemTemplate,
513
515
  *
514
516
  * @param serviceInfo the object that contains the spatial reference to evaluate
515
517
  * @param templateDictionary the template dictionary
516
- * @return the extent to use as the fallback
518
+ * @returns the extent to use as the fallback
517
519
  * @private
518
520
  */
519
521
  export declare function _getFallbackExtent(serviceInfo: any, templateDictionary: any): any;
@@ -521,7 +523,7 @@ export declare function _getFallbackExtent(serviceInfo: any, templateDictionary:
521
523
  * Add relationships to all layers in one call to retain fully functioning composite relationships
522
524
  *
523
525
  * @param args The IPostProcessArgs for the request(s)
524
- * @return Any relationships that should be updated for the service
526
+ * @returns Any relationships that should be updated for the service
525
527
  * @private
526
528
  */
527
529
  export declare function _getRelationshipUpdates(args: IPostProcessArgs): any;
@@ -533,7 +535,7 @@ export declare function _getRelationshipUpdates(args: IPostProcessArgs): any;
533
535
  * @param obj parameters for the request
534
536
  * @param args various arguments to help support the request
535
537
  * @param type type of update the request will handle
536
- * @return IUpdate that has the request url and arguments
538
+ * @returns IUpdate that has the request url and arguments
537
539
  * @private
538
540
  */
539
541
  export declare function _getUpdate(url: string, id: any, obj: any, args: any, type: "delete" | "update" | "add" | "refresh"): IUpdate;
@@ -542,6 +544,7 @@ export declare function _getUpdate(url: string, id: any, obj: any, args: any, ty
542
544
  *
543
545
  * @param base Item's base section
544
546
  * @param data Item's data section
547
+ * @private
545
548
  */
546
549
  export declare function _reportVariablesInItem(itemId: string, itemType: string, base: any, data: any): void;
547
550
  /**
@@ -552,14 +555,15 @@ export declare function _reportVariablesInItem(itemId: string, itemType: string,
552
555
  * @param serviceInfo Service information
553
556
  * @param params arcgis-rest-js params to update
554
557
  * @param isPortal Is the service hosted in a portal?
555
- * @return Updated item
558
+ * @returns Updated item
559
+ * @private
556
560
  */
557
561
  export declare function _setItemProperties(item: any, itemTemplate: IItemTemplate, serviceInfo: any, params: IParams, isPortal: boolean): any;
558
562
  /**
559
563
  * Set isUnique as true for indexes that reference origin relationship keyFields.
560
564
  *
561
565
  * @param serviceInfo Service information
562
- * @protected
566
+ * @private
563
567
  */
564
568
  export declare function _updateIndexesForRelationshipKeyFields(serviceInfo: any): void;
565
569
  /**
@@ -569,7 +573,8 @@ export declare function _updateIndexesForRelationshipKeyFields(serviceInfo: any)
569
573
  * @param url URL to assign to item's base section
570
574
  * @param authentication Credentials for the request
571
575
  * @param numAttempts Number of times to try to set the URL if AGO says that it updated the URL, but really didn't
572
- * @return A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
576
+ * @returns A promise that will resolve with the item id when the item has been updated or an AGO-style JSON failure
573
577
  * response
578
+ * @private
574
579
  */
575
580
  export declare function _updateItemURL(id: string, url: string, authentication: UserSession, numAttempts?: number): Promise<string>;