@esri/solution-common 4.1.2 → 5.0.0

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 (261) hide show
  1. package/dist/cjs/completeItem.d.ts +29 -29
  2. package/dist/cjs/completeItem.js +81 -81
  3. package/dist/cjs/create-hub-request-options.d.ts +29 -29
  4. package/dist/cjs/create-hub-request-options.js +63 -63
  5. package/dist/cjs/deleteHelpers/deleteEmptyGroups.d.ts +24 -24
  6. package/dist/cjs/deleteHelpers/deleteEmptyGroups.js +41 -41
  7. package/dist/cjs/deleteHelpers/deleteGroupIfEmpty.d.ts +27 -27
  8. package/dist/cjs/deleteHelpers/deleteGroupIfEmpty.js +96 -96
  9. package/dist/cjs/deleteHelpers/deleteSolutionContents.d.ts +38 -38
  10. package/dist/cjs/deleteHelpers/deleteSolutionContents.js +129 -129
  11. package/dist/cjs/deleteHelpers/deleteSolutionFolder.d.ts +29 -29
  12. package/dist/cjs/deleteHelpers/deleteSolutionFolder.js +78 -78
  13. package/dist/cjs/deleteHelpers/deleteSolutionItem.d.ts +30 -30
  14. package/dist/cjs/deleteHelpers/deleteSolutionItem.js +53 -53
  15. package/dist/cjs/deleteHelpers/index.d.ts +22 -22
  16. package/dist/cjs/deleteHelpers/index.js +25 -25
  17. package/dist/cjs/deleteHelpers/reconstructBuildOrderIds.d.ts +27 -27
  18. package/dist/cjs/deleteHelpers/reconstructBuildOrderIds.js +33 -33
  19. package/dist/cjs/deleteHelpers/removeItems.d.ts +34 -34
  20. package/dist/cjs/deleteHelpers/removeItems.js +111 -111
  21. package/dist/cjs/deleteHelpers/reportProgress.d.ts +27 -27
  22. package/dist/cjs/deleteHelpers/reportProgress.js +45 -45
  23. package/dist/cjs/deleteSolution.d.ts +55 -55
  24. package/dist/cjs/deleteSolution.js +106 -106
  25. package/dist/cjs/dependencies.d.ts +26 -26
  26. package/dist/cjs/dependencies.js +170 -170
  27. package/dist/cjs/featureServiceHelpers.d.ts +791 -791
  28. package/dist/cjs/featureServiceHelpers.js +2420 -2420
  29. package/dist/cjs/generalHelpers.d.ts +392 -385
  30. package/dist/cjs/generalHelpers.js +857 -854
  31. package/dist/cjs/generalHelpers.js.map +1 -1
  32. package/dist/cjs/get-subscription-info.d.ts +27 -27
  33. package/dist/cjs/get-subscription-info.js +38 -38
  34. package/dist/cjs/getDeletableSolutionInfo.d.ts +29 -29
  35. package/dist/cjs/getDeletableSolutionInfo.js +52 -52
  36. package/dist/cjs/getItemTypeAbbrev.d.ts +19 -19
  37. package/dist/cjs/getItemTypeAbbrev.js +184 -184
  38. package/dist/cjs/getSolutionSummary.d.ts +27 -27
  39. package/dist/cjs/getSolutionSummary.js +100 -100
  40. package/dist/cjs/index.d.ts +43 -44
  41. package/dist/cjs/index.js +46 -47
  42. package/dist/cjs/index.js.map +1 -1
  43. package/dist/cjs/interfaces.d.ts +1334 -1334
  44. package/dist/cjs/interfaces.js +74 -74
  45. package/dist/cjs/interfaces.js.map +1 -1
  46. package/dist/cjs/libConnectors.d.ts +73 -73
  47. package/dist/cjs/libConnectors.js +114 -114
  48. package/dist/cjs/migrations/apply-schema.d.ts +24 -24
  49. package/dist/cjs/migrations/apply-schema.js +35 -35
  50. package/dist/cjs/migrations/is-legacy-solution.d.ts +24 -24
  51. package/dist/cjs/migrations/is-legacy-solution.js +39 -39
  52. package/dist/cjs/migrations/upgrade-three-dot-one.d.ts +27 -27
  53. package/dist/cjs/migrations/upgrade-three-dot-one.js +48 -48
  54. package/dist/cjs/migrations/upgrade-three-dot-zero.d.ts +27 -27
  55. package/dist/cjs/migrations/upgrade-three-dot-zero.js +42 -42
  56. package/dist/cjs/migrations/upgrade-two-dot-five.d.ts +24 -24
  57. package/dist/cjs/migrations/upgrade-two-dot-five.js +72 -72
  58. package/dist/cjs/migrations/upgrade-two-dot-four.d.ts +24 -24
  59. package/dist/cjs/migrations/upgrade-two-dot-four.js +71 -71
  60. package/dist/cjs/migrations/upgrade-two-dot-one.d.ts +7 -7
  61. package/dist/cjs/migrations/upgrade-two-dot-one.js +38 -38
  62. package/dist/cjs/migrations/upgrade-two-dot-seven.d.ts +23 -23
  63. package/dist/cjs/migrations/upgrade-two-dot-seven.js +57 -57
  64. package/dist/cjs/migrations/upgrade-two-dot-six.d.ts +27 -27
  65. package/dist/cjs/migrations/upgrade-two-dot-six.js +60 -60
  66. package/dist/cjs/migrations/upgrade-two-dot-three.d.ts +23 -23
  67. package/dist/cjs/migrations/upgrade-two-dot-three.js +54 -54
  68. package/dist/cjs/migrations/upgrade-two-dot-two.d.ts +23 -23
  69. package/dist/cjs/migrations/upgrade-two-dot-two.js +57 -57
  70. package/dist/cjs/migrations/upgrade-two-dot-zero.d.ts +44 -44
  71. package/dist/cjs/migrations/upgrade-two-dot-zero.js +94 -94
  72. package/dist/cjs/migrator.d.ts +25 -25
  73. package/dist/cjs/migrator.js +76 -76
  74. package/dist/cjs/resourceHelpers.d.ts +191 -191
  75. package/dist/cjs/resourceHelpers.js +383 -390
  76. package/dist/cjs/resourceHelpers.js.map +1 -1
  77. package/dist/cjs/resources/add-resource-from-blob.d.ts +26 -26
  78. package/dist/cjs/resources/add-resource-from-blob.js +51 -51
  79. package/dist/cjs/resources/addMetadataFromBlob.d.ts +25 -25
  80. package/dist/cjs/resources/addMetadataFromBlob.js +42 -42
  81. package/dist/cjs/resources/convert-item-resource-to-storage-resource.d.ts +32 -32
  82. package/dist/cjs/resources/convert-item-resource-to-storage-resource.js +69 -69
  83. package/dist/cjs/resources/convert-storage-resource-to-item-resource.d.ts +29 -29
  84. package/dist/cjs/resources/convert-storage-resource-to-item-resource.js +69 -69
  85. package/dist/cjs/resources/copyAssociatedFiles.d.ts +67 -67
  86. package/dist/cjs/resources/copyAssociatedFiles.js +301 -301
  87. package/dist/cjs/resources/copyDataIntoItem.d.ts +33 -33
  88. package/dist/cjs/resources/copyDataIntoItem.js +61 -62
  89. package/dist/cjs/resources/copyDataIntoItem.js.map +1 -1
  90. package/dist/cjs/resources/copyMetadataIntoItem.d.ts +26 -26
  91. package/dist/cjs/resources/copyMetadataIntoItem.js +45 -45
  92. package/dist/cjs/resources/copyResourceIntoZip.d.ts +33 -33
  93. package/dist/cjs/resources/copyResourceIntoZip.js +77 -77
  94. package/dist/cjs/resources/copyZipIntoItem.d.ts +25 -25
  95. package/dist/cjs/resources/copyZipIntoItem.js +53 -53
  96. package/dist/cjs/resources/createCopyResults.d.ts +25 -25
  97. package/dist/cjs/resources/createCopyResults.js +35 -35
  98. package/dist/cjs/resources/get-blob.d.ts +26 -26
  99. package/dist/cjs/resources/get-blob.js +26 -26
  100. package/dist/cjs/resources/getItemResourcesFilesFromPaths.d.ts +24 -24
  101. package/dist/cjs/resources/getItemResourcesFilesFromPaths.js +48 -48
  102. package/dist/cjs/resources/getItemResourcesPaths.d.ts +26 -26
  103. package/dist/cjs/resources/getItemResourcesPaths.js +72 -72
  104. package/dist/cjs/resources/index.d.ts +29 -29
  105. package/dist/cjs/resources/index.js +32 -32
  106. package/dist/cjs/resources/solution-resource.d.ts +35 -35
  107. package/dist/cjs/resources/solution-resource.js +30 -30
  108. package/dist/cjs/resources/solution-resource.js.map +1 -1
  109. package/dist/cjs/resources/transform-resource-paths-to-solution-resources.d.ts +56 -56
  110. package/dist/cjs/resources/transform-resource-paths-to-solution-resources.js +145 -145
  111. package/dist/cjs/restHelpers.d.ts +586 -585
  112. package/dist/cjs/restHelpers.js +1888 -1883
  113. package/dist/cjs/restHelpers.js.map +1 -1
  114. package/dist/cjs/restHelpersGet.d.ts +288 -288
  115. package/dist/cjs/restHelpersGet.js +803 -803
  116. package/dist/cjs/sharing/index.d.ts +16 -16
  117. package/dist/cjs/sharing/index.js +19 -19
  118. package/dist/cjs/sharing/share-item-to-groups.d.ts +26 -26
  119. package/dist/cjs/sharing/share-item-to-groups.js +43 -43
  120. package/dist/cjs/templatization.d.ts +139 -139
  121. package/dist/cjs/templatization.js +313 -313
  122. package/dist/cjs/trackingHelpers.d.ts +116 -116
  123. package/dist/cjs/trackingHelpers.js +216 -216
  124. package/dist/cjs/velocityHelpers.d.ts +57 -57
  125. package/dist/cjs/velocityHelpers.js +134 -134
  126. package/dist/cjs/workforceHelpers.d.ts +115 -115
  127. package/dist/cjs/workforceHelpers.js +746 -746
  128. package/dist/cjs/workforceHelpers.js.map +1 -1
  129. package/dist/esm/completeItem.d.ts +29 -29
  130. package/dist/esm/completeItem.js +76 -76
  131. package/dist/esm/create-hub-request-options.d.ts +29 -29
  132. package/dist/esm/create-hub-request-options.js +59 -59
  133. package/dist/esm/deleteHelpers/deleteEmptyGroups.d.ts +24 -24
  134. package/dist/esm/deleteHelpers/deleteEmptyGroups.js +37 -37
  135. package/dist/esm/deleteHelpers/deleteGroupIfEmpty.d.ts +27 -27
  136. package/dist/esm/deleteHelpers/deleteGroupIfEmpty.js +91 -91
  137. package/dist/esm/deleteHelpers/deleteSolutionContents.d.ts +38 -38
  138. package/dist/esm/deleteHelpers/deleteSolutionContents.js +124 -124
  139. package/dist/esm/deleteHelpers/deleteSolutionFolder.d.ts +29 -29
  140. package/dist/esm/deleteHelpers/deleteSolutionFolder.js +73 -73
  141. package/dist/esm/deleteHelpers/deleteSolutionItem.d.ts +30 -30
  142. package/dist/esm/deleteHelpers/deleteSolutionItem.js +48 -48
  143. package/dist/esm/deleteHelpers/index.d.ts +22 -22
  144. package/dist/esm/deleteHelpers/index.js +22 -22
  145. package/dist/esm/deleteHelpers/reconstructBuildOrderIds.d.ts +27 -27
  146. package/dist/esm/deleteHelpers/reconstructBuildOrderIds.js +28 -28
  147. package/dist/esm/deleteHelpers/removeItems.d.ts +34 -34
  148. package/dist/esm/deleteHelpers/removeItems.js +106 -106
  149. package/dist/esm/deleteHelpers/reportProgress.d.ts +27 -27
  150. package/dist/esm/deleteHelpers/reportProgress.js +41 -41
  151. package/dist/esm/deleteSolution.d.ts +55 -55
  152. package/dist/esm/deleteSolution.js +100 -100
  153. package/dist/esm/dependencies.d.ts +26 -26
  154. package/dist/esm/dependencies.js +166 -166
  155. package/dist/esm/featureServiceHelpers.d.ts +791 -791
  156. package/dist/esm/featureServiceHelpers.js +2336 -2336
  157. package/dist/esm/generalHelpers.d.ts +392 -385
  158. package/dist/esm/generalHelpers.js +810 -808
  159. package/dist/esm/generalHelpers.js.map +1 -1
  160. package/dist/esm/get-subscription-info.d.ts +27 -27
  161. package/dist/esm/get-subscription-info.js +34 -34
  162. package/dist/esm/getDeletableSolutionInfo.d.ts +29 -29
  163. package/dist/esm/getDeletableSolutionInfo.js +47 -47
  164. package/dist/esm/getItemTypeAbbrev.d.ts +19 -19
  165. package/dist/esm/getItemTypeAbbrev.js +180 -180
  166. package/dist/esm/getSolutionSummary.d.ts +27 -27
  167. package/dist/esm/getSolutionSummary.js +95 -95
  168. package/dist/esm/index.d.ts +43 -44
  169. package/dist/esm/index.js +43 -44
  170. package/dist/esm/index.js.map +1 -1
  171. package/dist/esm/interfaces.d.ts +1334 -1334
  172. package/dist/esm/interfaces.js +70 -70
  173. package/dist/esm/libConnectors.d.ts +73 -73
  174. package/dist/esm/libConnectors.js +104 -104
  175. package/dist/esm/migrations/apply-schema.d.ts +24 -24
  176. package/dist/esm/migrations/apply-schema.js +31 -31
  177. package/dist/esm/migrations/is-legacy-solution.d.ts +24 -24
  178. package/dist/esm/migrations/is-legacy-solution.js +35 -35
  179. package/dist/esm/migrations/upgrade-three-dot-one.d.ts +27 -27
  180. package/dist/esm/migrations/upgrade-three-dot-one.js +44 -44
  181. package/dist/esm/migrations/upgrade-three-dot-zero.d.ts +27 -27
  182. package/dist/esm/migrations/upgrade-three-dot-zero.js +38 -38
  183. package/dist/esm/migrations/upgrade-two-dot-five.d.ts +24 -24
  184. package/dist/esm/migrations/upgrade-two-dot-five.js +68 -68
  185. package/dist/esm/migrations/upgrade-two-dot-four.d.ts +24 -24
  186. package/dist/esm/migrations/upgrade-two-dot-four.js +67 -67
  187. package/dist/esm/migrations/upgrade-two-dot-one.d.ts +7 -7
  188. package/dist/esm/migrations/upgrade-two-dot-one.js +34 -34
  189. package/dist/esm/migrations/upgrade-two-dot-seven.d.ts +23 -23
  190. package/dist/esm/migrations/upgrade-two-dot-seven.js +53 -53
  191. package/dist/esm/migrations/upgrade-two-dot-six.d.ts +27 -27
  192. package/dist/esm/migrations/upgrade-two-dot-six.js +56 -56
  193. package/dist/esm/migrations/upgrade-two-dot-three.d.ts +23 -23
  194. package/dist/esm/migrations/upgrade-two-dot-three.js +50 -50
  195. package/dist/esm/migrations/upgrade-two-dot-two.d.ts +23 -23
  196. package/dist/esm/migrations/upgrade-two-dot-two.js +53 -53
  197. package/dist/esm/migrations/upgrade-two-dot-zero.d.ts +44 -44
  198. package/dist/esm/migrations/upgrade-two-dot-zero.js +87 -87
  199. package/dist/esm/migrator.d.ts +25 -25
  200. package/dist/esm/migrator.js +72 -72
  201. package/dist/esm/resourceHelpers.d.ts +191 -191
  202. package/dist/esm/resourceHelpers.js +364 -371
  203. package/dist/esm/resourceHelpers.js.map +1 -1
  204. package/dist/esm/resources/add-resource-from-blob.d.ts +26 -26
  205. package/dist/esm/resources/add-resource-from-blob.js +47 -47
  206. package/dist/esm/resources/addMetadataFromBlob.d.ts +25 -25
  207. package/dist/esm/resources/addMetadataFromBlob.js +38 -38
  208. package/dist/esm/resources/convert-item-resource-to-storage-resource.d.ts +32 -32
  209. package/dist/esm/resources/convert-item-resource-to-storage-resource.js +65 -65
  210. package/dist/esm/resources/convert-storage-resource-to-item-resource.d.ts +29 -29
  211. package/dist/esm/resources/convert-storage-resource-to-item-resource.js +65 -65
  212. package/dist/esm/resources/copyAssociatedFiles.d.ts +67 -67
  213. package/dist/esm/resources/copyAssociatedFiles.js +293 -293
  214. package/dist/esm/resources/copyDataIntoItem.d.ts +33 -33
  215. package/dist/esm/resources/copyDataIntoItem.js +56 -57
  216. package/dist/esm/resources/copyDataIntoItem.js.map +1 -1
  217. package/dist/esm/resources/copyMetadataIntoItem.d.ts +26 -26
  218. package/dist/esm/resources/copyMetadataIntoItem.js +41 -41
  219. package/dist/esm/resources/copyResourceIntoZip.d.ts +33 -33
  220. package/dist/esm/resources/copyResourceIntoZip.js +72 -72
  221. package/dist/esm/resources/copyZipIntoItem.d.ts +25 -25
  222. package/dist/esm/resources/copyZipIntoItem.js +49 -49
  223. package/dist/esm/resources/createCopyResults.d.ts +25 -25
  224. package/dist/esm/resources/createCopyResults.js +31 -31
  225. package/dist/esm/resources/get-blob.d.ts +26 -26
  226. package/dist/esm/resources/get-blob.js +22 -22
  227. package/dist/esm/resources/getItemResourcesFilesFromPaths.d.ts +24 -24
  228. package/dist/esm/resources/getItemResourcesFilesFromPaths.js +44 -44
  229. package/dist/esm/resources/getItemResourcesPaths.d.ts +26 -26
  230. package/dist/esm/resources/getItemResourcesPaths.js +68 -68
  231. package/dist/esm/resources/index.d.ts +29 -29
  232. package/dist/esm/resources/index.js +29 -29
  233. package/dist/esm/resources/solution-resource.d.ts +35 -35
  234. package/dist/esm/resources/solution-resource.js +27 -27
  235. package/dist/esm/resources/transform-resource-paths-to-solution-resources.d.ts +56 -56
  236. package/dist/esm/resources/transform-resource-paths-to-solution-resources.js +137 -137
  237. package/dist/esm/restHelpers.d.ts +586 -585
  238. package/dist/esm/restHelpers.js +1827 -1823
  239. package/dist/esm/restHelpers.js.map +1 -1
  240. package/dist/esm/restHelpersGet.d.ts +288 -288
  241. package/dist/esm/restHelpersGet.js +763 -763
  242. package/dist/esm/sharing/index.d.ts +16 -16
  243. package/dist/esm/sharing/index.js +16 -16
  244. package/dist/esm/sharing/share-item-to-groups.d.ts +26 -26
  245. package/dist/esm/sharing/share-item-to-groups.js +39 -39
  246. package/dist/esm/templatization.d.ts +139 -139
  247. package/dist/esm/templatization.js +293 -293
  248. package/dist/esm/trackingHelpers.d.ts +116 -116
  249. package/dist/esm/trackingHelpers.js +204 -204
  250. package/dist/esm/velocityHelpers.d.ts +57 -57
  251. package/dist/esm/velocityHelpers.js +128 -128
  252. package/dist/esm/workforceHelpers.d.ts +115 -115
  253. package/dist/esm/workforceHelpers.js +717 -717
  254. package/dist/esm/workforceHelpers.js.map +1 -1
  255. package/package.json +2 -2
  256. package/dist/cjs/polyfills.d.ts +0 -40
  257. package/dist/cjs/polyfills.js +0 -98
  258. package/dist/cjs/polyfills.js.map +0 -1
  259. package/dist/esm/polyfills.d.ts +0 -40
  260. package/dist/esm/polyfills.js +0 -93
  261. package/dist/esm/polyfills.js.map +0 -1
@@ -1,57 +1,57 @@
1
- /** @license
2
- * Copyright 2021 Esri
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- import { UserSession } from "./interfaces";
17
- export declare const BASE_NAMES: string[];
18
- export declare const PROP_NAMES: string[];
19
- /**
20
- * Get the base velocity url from the current orgs subscription info
21
- *
22
- * This function will update the input templateDictionary arg with the velocity url
23
- * so we can reuse it without pinging the org again for subsequent requests to the
24
- * velocity api.
25
- *
26
- * @param authentication Credentials for the requests
27
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
28
- *
29
- * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
30
- *
31
- */
32
- export declare function getVelocityUrlBase(authentication: UserSession, templateDictionary: any): Promise<string>;
33
- /**
34
- * Update any velocity urls found in the data
35
- *
36
- * This function can be extended to support any item type specific functions such as
37
- * removing the itemId from operational layers in a webmap
38
- *
39
- * @param data The data object of the item
40
- * @param type The item type
41
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
42
- *
43
- * @returns an updated instance of the data object that was supplied.
44
- *
45
- */
46
- export declare function updateVelocityReferences(data: any, type: string, templateDictionary: any): any;
47
- /**
48
- * Helper function to update velocity urls found in the data
49
- *
50
- *
51
- * @param data The data object of the item
52
- * @param velocityUrl The velocity url from the current organization
53
- *
54
- * @returns an updated instance of the data object that was supplied.
55
- * @private
56
- */
57
- export declare function _replaceVelocityUrls(data: any, velocityUrl: string): any;
1
+ /** @license
2
+ * Copyright 2021 Esri
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { UserSession } from "./interfaces";
17
+ export declare const BASE_NAMES: string[];
18
+ export declare const PROP_NAMES: string[];
19
+ /**
20
+ * Get the base velocity url from the current orgs subscription info
21
+ *
22
+ * This function will update the input templateDictionary arg with the velocity url
23
+ * so we can reuse it without pinging the org again for subsequent requests to the
24
+ * velocity api.
25
+ *
26
+ * @param authentication Credentials for the requests
27
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
28
+ *
29
+ * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
30
+ *
31
+ */
32
+ export declare function getVelocityUrlBase(authentication: UserSession, templateDictionary: any): Promise<string>;
33
+ /**
34
+ * Update any velocity urls found in the data
35
+ *
36
+ * This function can be extended to support any item type specific functions such as
37
+ * removing the itemId from operational layers in a webmap
38
+ *
39
+ * @param data The data object of the item
40
+ * @param type The item type
41
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
42
+ *
43
+ * @returns an updated instance of the data object that was supplied.
44
+ *
45
+ */
46
+ export declare function updateVelocityReferences(data: any, type: string, templateDictionary: any): any;
47
+ /**
48
+ * Helper function to update velocity urls found in the data
49
+ *
50
+ *
51
+ * @param data The data object of the item
52
+ * @param velocityUrl The velocity url from the current organization
53
+ *
54
+ * @returns an updated instance of the data object that was supplied.
55
+ * @private
56
+ */
57
+ export declare function _replaceVelocityUrls(data: any, velocityUrl: string): any;
@@ -1,129 +1,129 @@
1
- /** @license
2
- * Copyright 2021 Esri
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- import { getSubscriptionInfo } from "./get-subscription-info";
17
- import { getProp } from "./generalHelpers";
18
- // Known base names if output, source, or feed name is missing
19
- export const BASE_NAMES = [
20
- "feat-lyr-new",
21
- "feat-lyr-existing",
22
- "stream-lyr-new"
23
- ];
24
- // Known prop paths that can contain item Ids
25
- export const PROP_NAMES = [
26
- ".portal.mapServicePortalItemID",
27
- ".portal.featureServicePortalItemID",
28
- ".portal.streamServicePortalItemID",
29
- ".portalItemId"
30
- ];
31
- /**
32
- * Get the base velocity url from the current orgs subscription info
33
- *
34
- * This function will update the input templateDictionary arg with the velocity url
35
- * so we can reuse it without pinging the org again for subsequent requests to the
36
- * velocity api.
37
- *
38
- * @param authentication Credentials for the requests
39
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
40
- *
41
- * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
42
- *
43
- */
44
- export function getVelocityUrlBase(authentication, templateDictionary) {
45
- // if we already have the base url no need to make any additional requests
46
- if (templateDictionary.hasOwnProperty("velocityUrl")) {
47
- return Promise.resolve(templateDictionary.velocityUrl);
48
- }
49
- else {
50
- // get the url from the orgs subscription info
51
- return getSubscriptionInfo({ authentication }).then((subscriptionInfo) => {
52
- let velocityUrl = "";
53
- const orgCapabilities = getProp(subscriptionInfo, "orgCapabilities");
54
- /* istanbul ignore else */
55
- if (Array.isArray(orgCapabilities)) {
56
- orgCapabilities.some(c => {
57
- /* istanbul ignore else */
58
- if (c.id === "velocity" && c.status === "active" && c.velocityUrl) {
59
- velocityUrl = c.velocityUrl;
60
- }
61
- return velocityUrl;
62
- });
63
- }
64
- // add the base url to the templateDictionary for reuse
65
- templateDictionary.velocityUrl = velocityUrl;
66
- return Promise.resolve(velocityUrl);
67
- });
68
- }
69
- }
70
- /**
71
- * Update any velocity urls found in the data
72
- *
73
- * This function can be extended to support any item type specific functions such as
74
- * removing the itemId from operational layers in a webmap
75
- *
76
- * @param data The data object of the item
77
- * @param type The item type
78
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
79
- *
80
- * @returns an updated instance of the data object that was supplied.
81
- *
82
- */
83
- export function updateVelocityReferences(data, type, templateDictionary) {
84
- const velocityUrl = templateDictionary.velocityUrl;
85
- if (data && type === "Web Map" && velocityUrl) {
86
- const layersAndTables = (data.operationalLayers || []).concat(data.tables || []);
87
- (layersAndTables).forEach((l) => {
88
- if (l.url && l.url.indexOf(velocityUrl) > -1 && l.itemId) {
89
- delete l.itemId;
90
- }
91
- });
92
- }
93
- return velocityUrl && data ? _replaceVelocityUrls(data, velocityUrl) : data;
94
- }
95
- /**
96
- * Helper function to update velocity urls found in the data
97
- *
98
- *
99
- * @param data The data object of the item
100
- * @param velocityUrl The velocity url from the current organization
101
- *
102
- * @returns an updated instance of the data object that was supplied.
103
- * @private
104
- */
105
- export function _replaceVelocityUrls(data, velocityUrl) {
106
- let dataString = JSON.stringify(data);
107
- if (dataString.indexOf(velocityUrl) > -1) {
108
- // replace any instance of the velocity base url
109
- dataString = dataString.replace(new RegExp(`${velocityUrl}`, "gi"), "{{velocityUrl}}");
110
- // add solutionItemId to any velocity service names
111
- const regex = new RegExp("{{velocityUrl}}.+?(?=/[A-Za-z]+Server)", "gi");
112
- const results = dataString.match(regex);
113
- /* istanbul ignore else */
114
- if (results) {
115
- const uniqueResults = results.filter((v, i, self) => self.indexOf(v) === i);
116
- uniqueResults.forEach(result => {
117
- // these names can contain reserved characters for regex
118
- // for example: http://something/name(something else)
119
- // TypeScript for es2015 doesn't have a definition for `replaceAll`
120
- dataString = dataString.replaceAll(result, `${result}_{{solutionItemId}}`);
121
- });
122
- }
123
- return JSON.parse(dataString);
124
- }
125
- else {
126
- return data;
127
- }
128
- }
1
+ /** @license
2
+ * Copyright 2021 Esri
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { getSubscriptionInfo } from "./get-subscription-info";
17
+ import { getProp } from "./generalHelpers";
18
+ // Known base names if output, source, or feed name is missing
19
+ export const BASE_NAMES = [
20
+ "feat-lyr-new",
21
+ "feat-lyr-existing",
22
+ "stream-lyr-new"
23
+ ];
24
+ // Known prop paths that can contain item Ids
25
+ export const PROP_NAMES = [
26
+ ".portal.mapServicePortalItemID",
27
+ ".portal.featureServicePortalItemID",
28
+ ".portal.streamServicePortalItemID",
29
+ ".portalItemId"
30
+ ];
31
+ /**
32
+ * Get the base velocity url from the current orgs subscription info
33
+ *
34
+ * This function will update the input templateDictionary arg with the velocity url
35
+ * so we can reuse it without pinging the org again for subsequent requests to the
36
+ * velocity api.
37
+ *
38
+ * @param authentication Credentials for the requests
39
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
40
+ *
41
+ * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
42
+ *
43
+ */
44
+ export function getVelocityUrlBase(authentication, templateDictionary) {
45
+ // if we already have the base url no need to make any additional requests
46
+ if (templateDictionary.hasOwnProperty("velocityUrl")) {
47
+ return Promise.resolve(templateDictionary.velocityUrl);
48
+ }
49
+ else {
50
+ // get the url from the orgs subscription info
51
+ return getSubscriptionInfo({ authentication }).then((subscriptionInfo) => {
52
+ let velocityUrl = "";
53
+ const orgCapabilities = getProp(subscriptionInfo, "orgCapabilities");
54
+ /* istanbul ignore else */
55
+ if (Array.isArray(orgCapabilities)) {
56
+ orgCapabilities.some(c => {
57
+ /* istanbul ignore else */
58
+ if (c.id === "velocity" && c.status === "active" && c.velocityUrl) {
59
+ velocityUrl = c.velocityUrl;
60
+ }
61
+ return velocityUrl;
62
+ });
63
+ }
64
+ // add the base url to the templateDictionary for reuse
65
+ templateDictionary.velocityUrl = velocityUrl;
66
+ return Promise.resolve(velocityUrl);
67
+ });
68
+ }
69
+ }
70
+ /**
71
+ * Update any velocity urls found in the data
72
+ *
73
+ * This function can be extended to support any item type specific functions such as
74
+ * removing the itemId from operational layers in a webmap
75
+ *
76
+ * @param data The data object of the item
77
+ * @param type The item type
78
+ * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
79
+ *
80
+ * @returns an updated instance of the data object that was supplied.
81
+ *
82
+ */
83
+ export function updateVelocityReferences(data, type, templateDictionary) {
84
+ const velocityUrl = templateDictionary.velocityUrl;
85
+ if (data && type === "Web Map" && velocityUrl) {
86
+ const layersAndTables = (data.operationalLayers || []).concat(data.tables || []);
87
+ (layersAndTables).forEach((l) => {
88
+ if (l.url && l.url.indexOf(velocityUrl) > -1 && l.itemId) {
89
+ delete l.itemId;
90
+ }
91
+ });
92
+ }
93
+ return velocityUrl && data ? _replaceVelocityUrls(data, velocityUrl) : data;
94
+ }
95
+ /**
96
+ * Helper function to update velocity urls found in the data
97
+ *
98
+ *
99
+ * @param data The data object of the item
100
+ * @param velocityUrl The velocity url from the current organization
101
+ *
102
+ * @returns an updated instance of the data object that was supplied.
103
+ * @private
104
+ */
105
+ export function _replaceVelocityUrls(data, velocityUrl) {
106
+ let dataString = JSON.stringify(data);
107
+ if (dataString.indexOf(velocityUrl) > -1) {
108
+ // replace any instance of the velocity base url
109
+ dataString = dataString.replace(new RegExp(`${velocityUrl}`, "gi"), "{{velocityUrl}}");
110
+ // add solutionItemId to any velocity service names
111
+ const regex = new RegExp("{{velocityUrl}}.+?(?=/[A-Za-z]+Server)", "gi");
112
+ const results = dataString.match(regex);
113
+ /* istanbul ignore else */
114
+ if (results) {
115
+ const uniqueResults = results.filter((v, i, self) => self.indexOf(v) === i);
116
+ uniqueResults.forEach(result => {
117
+ // these names can contain reserved characters for regex
118
+ // for example: http://something/name(something else)
119
+ // TypeScript for es2015 doesn't have a definition for `replaceAll`
120
+ dataString = dataString.replaceAll(result, `${result}_{{solutionItemId}}`);
121
+ });
122
+ }
123
+ return JSON.parse(dataString);
124
+ }
125
+ else {
126
+ return data;
127
+ }
128
+ }
129
129
  //# sourceMappingURL=velocityHelpers.js.map
@@ -1,115 +1,115 @@
1
- /** @license
2
- * Copyright 2020 Esri
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- import { IItemTemplate, IFeatureServiceProperties, UserSession } from "./interfaces";
17
- /**
18
- * Converts an workforce item to a template.
19
- *
20
- * @param itemTemplate template for the workforce project item
21
- * @param authentication credentials for any requests
22
- * @param templateDictionary Hash of key details used for variable replacement
23
- * @returns templatized itemTemplate
24
- */
25
- export declare function convertWorkforceItemToTemplate(itemTemplate: IItemTemplate, authentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;
26
- /**
27
- * Gets the ids of the dependencies of the workforce project.
28
- *
29
- * @param data itemTemplate data
30
- * @param keyProperties workforce project properties that contain references to dependencies
31
- * @param authentication credentials for any requests
32
- * @returns List of dependencies ids
33
- */
34
- export declare function extractWorkforceDependencies(data: any, keyProperties: string[], authentication: UserSession): Promise<any>;
35
- /**
36
- * Templatizes key item properties.
37
- *
38
- * @param data itemTemplate data
39
- * @param keyProperties workforce project properties that should be templatized
40
- * @param urlHash a key value pair of url and itemId
41
- * @param templateDictionary Hash of key details used for variable replacement
42
- * @returns an updated data object to be stored in the template
43
- */
44
- export declare function templatizeWorkforce(data: any, keyProperties: string[], urlHash: any, templateDictionary: any): any;
45
- /**
46
- * Evaluate key properties in the workforce service of additional items that are needed
47
- *
48
- * @param itemTemplate template for the workforce project item
49
- * @param dependencies list of the items dependencies
50
- * @returns an array of objects with dependency ids
51
- */
52
- export declare function getWorkforceDependencies(itemTemplate: IItemTemplate, dependencies: any[]): any;
53
- export declare function getWorkforceServiceInfo(properties: IFeatureServiceProperties, url: string, authentication: UserSession): Promise<IFeatureServiceProperties>;
54
- /**
55
- * Wrap global id and assignmenttype values in curly braces
56
- *
57
- * Added for issue #734
58
- *
59
- * This function will update the provided workforceInfos object
60
- *
61
- * @param workforceInfos the object that stores the integration and type info with global ids
62
- * @private
63
- */
64
- export declare function _updateGlobalIdAndAssignmentType(workforceInfos: any): void;
65
- export declare function _getAssignmentTypeInfos(assignmentTypes: any): any[];
66
- export declare function _getAssignmentIntegrationInfos(assignmentIntegrations: any, authentication: UserSession): Promise<any>;
67
- export declare function getUrlDependencies(requests: Array<Promise<any>>, urls: string[]): Promise<any>;
68
- /**
69
- * Templatizes values from a urlTemplate
70
- *
71
- * @param item the object that may contain a urlTemplate
72
- * @param urlHash a key value pair of url and itemId
73
- * @private
74
- */
75
- export declare function _templatizeUrlTemplate(item: any, urlHash: any): void;
76
- export declare function getLayerId(url: string): any;
77
- export declare function getReplaceValue(layerId: any, suffix: string): string;
78
- export declare function postProcessWorkforceTemplates(templates: IItemTemplate[]): IItemTemplate[];
79
- export declare function _templatizeWorkforceProject(t: IItemTemplate, groupUpdates: any): any;
80
- export declare function _templatizeWorkforceDispatcherOrWorker(t: IItemTemplate, type: string): IItemTemplate;
81
- export declare function isWorkforceProject(itemTemplate: IItemTemplate): boolean;
82
- export declare function getKeyWorkforceProperties(version: number): string[];
83
- /**
84
- * Test the provided value for any urls and submit a request to obtain the service item id for the url
85
- *
86
- * @param v a string value to test for urls
87
- * @param authentication credentials for the requests
88
- * @returns an object with any pending requests and the urls that requests were made to
89
- */
90
- export declare function urlTest(v: any, authentication: UserSession): any;
91
- export declare function _getURLs(v: string): string[];
92
- /**
93
- * Gets the current user and updates the dispatchers service
94
- *
95
- * @param newlyCreatedItem Item to be created; n.b.: this item is modified
96
- * @param destinationAuthentication The session used to create the new item(s)
97
- * @returns A promise that will resolve with \{ "success" === true || false \}
98
- */
99
- export declare function fineTuneCreatedWorkforceItem(newlyCreatedItem: IItemTemplate, destinationAuthentication: UserSession, url: string, templateDictionary: any): Promise<any>;
100
- export declare function _getFields(url: string, ids: number[], authentication: UserSession): Promise<any>;
101
- export declare function _updateUrl(url: string): string;
102
- export declare function _getAddFeatures(updateInfos: any, fields: any[]): any;
103
- export declare function _getField(name: string, fields: string[]): string;
104
- /**
105
- * Updates the dispatchers service to include the current user as a dispatcher
106
- *
107
- * @param dispatchers The dispatchers object from the workforce items data
108
- * @param name Current users name
109
- * @param fullName Current users full name
110
- * @param destinationAuthentication The session used to create the new item(s)
111
- * @returns A promise that will resolve with true || false
112
- * @private
113
- */
114
- export declare function _updateDispatchers(url: any, name: string, fullName: string, authentication: UserSession, isPortal: boolean): Promise<boolean>;
115
- export declare function _applyEdits(url: string, adds: any[], authentication: UserSession, useGlobalIds?: boolean): any;
1
+ /** @license
2
+ * Copyright 2020 Esri
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { IItemTemplate, IFeatureServiceProperties, UserSession } from "./interfaces";
17
+ /**
18
+ * Converts an workforce item to a template.
19
+ *
20
+ * @param itemTemplate template for the workforce project item
21
+ * @param authentication credentials for any requests
22
+ * @param templateDictionary Hash of key details used for variable replacement
23
+ * @returns templatized itemTemplate
24
+ */
25
+ export declare function convertWorkforceItemToTemplate(itemTemplate: IItemTemplate, authentication: UserSession, templateDictionary: any): Promise<IItemTemplate>;
26
+ /**
27
+ * Gets the ids of the dependencies of the workforce project.
28
+ *
29
+ * @param data itemTemplate data
30
+ * @param keyProperties workforce project properties that contain references to dependencies
31
+ * @param authentication credentials for any requests
32
+ * @returns List of dependencies ids
33
+ */
34
+ export declare function extractWorkforceDependencies(data: any, keyProperties: string[], authentication: UserSession): Promise<any>;
35
+ /**
36
+ * Templatizes key item properties.
37
+ *
38
+ * @param data itemTemplate data
39
+ * @param keyProperties workforce project properties that should be templatized
40
+ * @param urlHash a key value pair of url and itemId
41
+ * @param templateDictionary Hash of key details used for variable replacement
42
+ * @returns an updated data object to be stored in the template
43
+ */
44
+ export declare function templatizeWorkforce(data: any, keyProperties: string[], urlHash: any, templateDictionary: any): any;
45
+ /**
46
+ * Evaluate key properties in the workforce service of additional items that are needed
47
+ *
48
+ * @param itemTemplate template for the workforce project item
49
+ * @param dependencies list of the items dependencies
50
+ * @returns an array of objects with dependency ids
51
+ */
52
+ export declare function getWorkforceDependencies(itemTemplate: IItemTemplate, dependencies: any[]): any;
53
+ export declare function getWorkforceServiceInfo(properties: IFeatureServiceProperties, url: string, authentication: UserSession): Promise<IFeatureServiceProperties>;
54
+ /**
55
+ * Wrap global id and assignmenttype values in curly braces
56
+ *
57
+ * Added for issue #734
58
+ *
59
+ * This function will update the provided workforceInfos object
60
+ *
61
+ * @param workforceInfos the object that stores the integration and type info with global ids
62
+ * @private
63
+ */
64
+ export declare function _updateGlobalIdAndAssignmentType(workforceInfos: any): void;
65
+ export declare function _getAssignmentTypeInfos(assignmentTypes: any): any[];
66
+ export declare function _getAssignmentIntegrationInfos(assignmentIntegrations: any, authentication: UserSession): Promise<any>;
67
+ export declare function getUrlDependencies(requests: Array<Promise<any>>, urls: string[]): Promise<any>;
68
+ /**
69
+ * Templatizes values from a urlTemplate
70
+ *
71
+ * @param item the object that may contain a urlTemplate
72
+ * @param urlHash a key value pair of url and itemId
73
+ * @private
74
+ */
75
+ export declare function _templatizeUrlTemplate(item: any, urlHash: any): void;
76
+ export declare function getLayerId(url: string): any;
77
+ export declare function getReplaceValue(layerId: any, suffix: string): string;
78
+ export declare function postProcessWorkforceTemplates(templates: IItemTemplate[]): IItemTemplate[];
79
+ export declare function _templatizeWorkforceProject(t: IItemTemplate, groupUpdates: any): any;
80
+ export declare function _templatizeWorkforceDispatcherOrWorker(t: IItemTemplate, type: string): IItemTemplate;
81
+ export declare function isWorkforceProject(itemTemplate: IItemTemplate): boolean;
82
+ export declare function getKeyWorkforceProperties(version: number): string[];
83
+ /**
84
+ * Test the provided value for any urls and submit a request to obtain the service item id for the url
85
+ *
86
+ * @param v a string value to test for urls
87
+ * @param authentication credentials for the requests
88
+ * @returns an object with any pending requests and the urls that requests were made to
89
+ */
90
+ export declare function urlTest(v: any, authentication: UserSession): any;
91
+ export declare function _getURLs(v: string): string[];
92
+ /**
93
+ * Gets the current user and updates the dispatchers service
94
+ *
95
+ * @param newlyCreatedItem Item to be created; n.b.: this item is modified
96
+ * @param destinationAuthentication The session used to create the new item(s)
97
+ * @returns A promise that will resolve with \{ "success" === true || false \}
98
+ */
99
+ export declare function fineTuneCreatedWorkforceItem(newlyCreatedItem: IItemTemplate, destinationAuthentication: UserSession, url: string, templateDictionary: any): Promise<any>;
100
+ export declare function _getFields(url: string, ids: number[], authentication: UserSession): Promise<any>;
101
+ export declare function _updateUrl(url: string): string;
102
+ export declare function _getAddFeatures(updateInfos: any, fields: any[]): any;
103
+ export declare function _getField(name: string, fields: string[]): string;
104
+ /**
105
+ * Updates the dispatchers service to include the current user as a dispatcher
106
+ *
107
+ * @param dispatchers The dispatchers object from the workforce items data
108
+ * @param name Current users name
109
+ * @param fullName Current users full name
110
+ * @param destinationAuthentication The session used to create the new item(s)
111
+ * @returns A promise that will resolve with true || false
112
+ * @private
113
+ */
114
+ export declare function _updateDispatchers(url: any, name: string, fullName: string, authentication: UserSession, isPortal: boolean): Promise<boolean>;
115
+ export declare function _applyEdits(url: string, adds: any[], authentication: UserSession, useGlobalIds?: boolean): any;