Merge pull request #1455 from Esri/add-web-tool

Add web tool

README.md

@@ -60,6 +60,7 @@ The API is divided into packages to make it easier to use just the parts that yo
 * `velocity`, which contains functions to support ArcGIS Velocity items
 * `viewer`, which contains functions to support displaying Solution items
 * `web-experience`, which contains functions for Experience Builder items
+* `web-tool`, which contains functions for Web Tool Geoprocessing Service items
 * `workflow`, which contains functions for Workflow items
 
 #### Additional information

build.bat

@@ -58,6 +58,7 @@ rmdir/s/q packages\storymap\dist 2>nul
 rmdir/s/q packages\velocity\dist 2>nul
 rmdir/s/q packages\viewer\dist 2>nul
 rmdir/s/q packages\web-experience\dist 2>nul
+rmdir/s/q packages\web-tool\dist 2>nul
 rmdir/s/q demos\copyItemInfo\dist 2>nul
 rmdir/s/q demos\copySolutions\dist 2>nul
 rmdir/s/q demos\createSolution\dist 2>nul
@@ -98,6 +99,8 @@ del/q packages\viewer\dist\cjs\package.json 2>nul
 del/q packages\viewer\dist\esm\package.json 2>nul
 del/q packages\web-experience\dist\cjs\package.json 2>nul
 del/q packages\web-experience\dist\esm\package.json 2>nul
+del/q packages\web-tool\dist\cjs\package.json 2>nul
+del/q packages\web-tool\dist\esm\package.json 2>nul
 del/q packages\workflow\dist\cjs\package.json 2>nul
 del/q packages\workflow\dist\esm\package.json 2>nul
 

buildCI.bat

@@ -30,6 +30,8 @@ rmdir/s/q packages\viewer\dist 2>nul
 rmdir/s/q packages\viewer\node_modules 2>nul
 rmdir/s/q packages\web-experience\dist 2>nul
 rmdir/s/q packages\web-experience\node_modules 2>nul
+rmdir/s/q packages\web-tool\dist 2>nul
+rmdir/s/q packages\web-tool\node_modules 2>nul
 rmdir/s/q packages\workflow\dist 2>nul
 rmdir/s/q packages\workflow\node_modules 2>nul
 
@@ -47,6 +49,7 @@ del/q packages\storymap\package-lock.json 2>nul
 del/q packages\velocity\package-lock.json 2>nul
 del/q packages\viewer\package-lock.json 2>nul
 del/q packages\web-experience\package-lock.json 2>nul
+del/q packages\web-tool\package-lock.json 2>nul
 del/q packages\workflow\package-lock.json 2>nul
 
 rmdir/q/s coverage 2>nul

check_npm_package_versions.html

@@ -81,6 +81,7 @@
         html += addPackageVersionsToTable("@esri/solution-velocity", "velocity");
         html += addPackageVersionsToTable("@esri/solution-viewer", "viewer");
         html += addPackageVersionsToTable("@esri/solution-web-experience", "web-experience");
+        html += addPackageVersionsToTable("@esri/solution-web-tool", "web-tool");
         html += addPackageVersionsToTable("@esri/solution-workflow", "workflow");
 
         html += "</table>";

demos/createSolution/package.json

@@ -32,6 +32,7 @@
     "@esri/solution-velocity": "file:../../packages/velocity/dist",
     "@esri/solution-viewer": "file:../../packages/viewer/dist",
     "@esri/solution-web-experience": "file:../../packages/web-experience/dist",
+    "@esri/solution-web-tool": "file:../../packages/web-tool/dist",
     "@esri/solution-workflow": "file:../../packages/workflow/dist",
     "css-loader": "^6.9.0",
     "html-webpack-plugin": "^5.5.1",

demos/deploySolution/package.json

@@ -32,6 +32,7 @@
     "@esri/solution-velocity": "file:../../packages/velocity/dist",
     "@esri/solution-viewer": "file:../../packages/viewer/dist",
     "@esri/solution-web-experience": "file:../../packages/web-experience/dist",
+    "@esri/solution-web-tool": "file:../../packages/web-tool/dist",
     "@esri/solution-workflow": "file:../../packages/workflow/dist",
     "css-loader": "^6.9.0",
     "html-webpack-plugin": "^5.5.1",

demos/implementedTypes/package.json

@@ -32,6 +32,7 @@
     "@esri/solution-velocity": "file:../../packages/velocity/dist",
     "@esri/solution-viewer": "file:../../packages/viewer/dist",
     "@esri/solution-web-experience": "file:../../packages/web-experience/dist",
+    "@esri/solution-web-tool": "file:../../packages/web-tool/dist",
     "@esri/solution-workflow": "file:../../packages/workflow/dist",
     "css-loader": "^6.9.0",
     "html-webpack-plugin": "^5.5.1",

guides/Package Overview.md

@@ -94,4 +94,5 @@ The library is a collection of packages that are framework agnostic and make a v
 * [`@esri/solution-velocity`](https://github.com/Esri/solution.js/tree/master/packages/velocity): Manages the creation and deployment of Velocity item types for @esri/solution.js.
 * [`@esri/solution-viewer`](https://github.com/Esri/solution.js/tree/master/packages/viewer): Simplifies access to @esri/solution.js.
 * [`@esri/solution-web-experience`](https://github.com/Esri/solution.js/tree/master/packages/web-experience): Manages the creation and deployment of Web Experience item types for @esri/solution.js.
+* [`@esri/solution-web-tool`](https://github.com/Esri/solution.js/tree/master/packages/web-tool): Manages the creation and deployment of Web Tool Geoprocessing Service item types for @esri/solution.js.
 * [`@esri/solution-workflow`](https://github.com/Esri/solution.js/tree/master/packages/workflow): Manages the creation and deployment of Workflow item types for @esri/solution.js.

guides/Publishing to npmjs.md

@@ -13,7 +13,7 @@
 * \[ \] Run `npm run release:publish-npm` in a Windows shell and enter the npm 2-factor code when requested
 * \[ \] Check that publishing worked using `check_npm_package_versions.html` in a browser
 * \[ \] Run `build.bat` to update the package-lock.json files with the latest version.
-* \[ \] Commit package.json files (publishing updates the `gitHead` property in the files) and the package-lock.json files. 
+* \[ \] Commit package.json files (publishing updates the `gitHead` property in the files) and the package-lock.json files.
 * \[ \] Push `master` branch to GitHub
 * \[ \] Merge `master` into the `develop` branch and push the latter to GitHub
 * \[ \] Create a release from the build's tag in GitHub
@@ -154,6 +154,7 @@ call npm deprecate "@esri/solution-storymap@%obsoleteVersion%" "obsolete" --otp=
 call npm deprecate "@esri/solution-velocity@%obsoleteVersion%" "obsolete" --otp=%twoFactorCode%
 call npm deprecate "@esri/solution-viewer@%obsoleteVersion%" "obsolete" --otp=%twoFactorCode%
 call npm deprecate "@esri/solution-web-experience@%obsoleteVersion%" "obsolete" --otp=%twoFactorCode%
+call npm deprecate "@esri/solution-web-tool@%obsoleteVersion%" "obsolete" --otp=%twoFactorCode%
 call npm deprecate "@esri/solution-webform@%obsoleteVersion%" "obsolete" --otp=%twoFactorCode%
 ```
 

package.json

@@ -60,6 +60,7 @@
     "packages/velocity",
     "packages/viewer",
     "packages/web-experience",
+    "packages/web-tool",
     "packages/workflow"
   ],
   "devDependencies": {

packages/common/src/getItemTypeAbbrev.ts

@@ -37,7 +37,7 @@ export function getItemTypeAbbrev(type: string): string {
       "Geocoding Service": "xxx",
       "Geodata Service": "xxx",
       "Geometry Service": "xxx",
-      "Geoprocessing Service": "xxx",
+      "Geoprocessing Service": "gs",
       "Globe Service": "xxx",
       "Image Service": "xxx",
       KML: "xxx",

packages/common/src/resourceHelpers.ts

@@ -125,6 +125,7 @@ export function convertBlobToSupportableResource(
  * @param destinationItemId Id of item to receive copy of resource/metadata
  * @param destinationAuthentication Credentials for the request to the destination
  * @param template Description of item that will receive files
+ * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  * @returns A promise which resolves to a boolean indicating if the copies were successful
  */
 export function copyFilesFromStorageItem(
@@ -134,7 +135,8 @@ export function copyFilesFromStorageItem(
   destinationFolderId: string,
   destinationItemId: string,
   destinationAuthentication: UserSession,
-  template: any = {}
+  template: any = {},
+  templateDictionary: any = {}
 ): Promise<boolean> {
   // TODO: This is only used in deployer, so move there
   // changed to allow the template to be passed in
@@ -172,7 +174,8 @@ export function copyFilesFromStorageItem(
       sourceItemId,
       destinationItemId,
       destinationAuthentication,
-      template
+      template,
+      templateDictionary
     ).then((results: IAssociatedFileCopyResults[]) => {
       const allOK: boolean = results
         // Filter out metadata