support static resource file save via tooling api

Author: Mohith Shrivastava

README.md

@@ -34,6 +34,7 @@ If you are Visual Studio Code user then recommend installing the extension along
 * [`sfdx deploy:vfcomponent`](#sfdx-deployvfcomponent)
 * [`sfdx deploy:aura`](#sfdx-deployaura)
 * [`sfdx deploy:lwc`](#sfdx-deploylwc)
+* [`sfdx deploy:staticresource`](#sfdx-deploystaticresource)
 
 ## `sfdx retrieve:dxsource`
 
@@ -96,7 +97,7 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the apex class you want to save to salesforce. Note you can run pwd command on terminal to obtain the path easily.
 
 EXAMPLES
-  $ sfdx deploy:apex -p pathname // Default authorized org is used for the deploy .The pathname parameter must be enclosed in double quotes. Example if your path is /Users/mohith/Desktop/ForceProjects/TestApp/force-app/main/default/classes/Constants.cls then the command to save this class will be sfdx deploy:apex -p "/Users/mohith/Desktop/ForceProjects/TestApp/force-app/main/default/classes/Constants.cls"
+  $ sfdx deploy:apex -p <pathname> // Default authorized org is used for the deploy .The pathname parameter must be enclosed in double quotes. Example if your path is /Users/mohith/Desktop/ForceProjects/TestApp/force-app/main/default/classes/Constants.cls then the command to save this class will be sfdx deploy:apex -p "/Users/mohith/Desktop/ForceProjects/TestApp/force-app/main/default/classes/Constants.cls"
 ```
 
 _See code: [src/commands/deploy/apex.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/apex.ts)_
@@ -113,7 +114,7 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the apex trigger you want to save to salesforce. Note you can run pwd command on terminal to obtain the path easily
 
 EXAMPLES
-  $ sfdx deploy:trigger -p pathname // Default authorized org is used for the deploy
+  $ sfdx deploy:trigger -p <pathname> // Default authorized org is used for the deploy
 ```
 
 _See code: [src/commands/deploy/trigger.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/trigger.ts)_
@@ -130,7 +131,7 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the vf page you want to save to salesforce . Note you can run pwd command on terminal to obtain the path.
 
 EXAMPLES
-  $ sfdx deploy:vf -p pathname // Default authorized org is used for the deploy
+  $ sfdx deploy:vf -p <pathname> // Default authorized org is used for the deploy
 ```
 
 _See code: [src/commands/deploy/vf.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/vf.ts)_
@@ -147,7 +148,7 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the vf component you want to save
 
 EXAMPLES
-  $ sfdx deploy:vfcomponent -p pathname // file path used to save the component to Salesforce.
+  $ sfdx deploy:vfcomponent -p <pathname> // file path used to save the component to Salesforce.
 ```
 
 _See code: [src/commands/deploy/vfcomponent.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/vfcomponent.ts)_
@@ -166,7 +167,7 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the aura bundle you want to save to Salesforce.
 
 EXAMPLES
-  $ sfdx deploy:aura -p pathname // Default authorized org is used for the deploy
+  $ sfdx deploy:aura -p <pathname> // Default authorized org is used for the deploy
 ```
 
 _See code: [src/commands/deploy/aura.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/aura.ts)_
@@ -185,11 +186,34 @@ OPTIONS
   --p, --pathname=pathname                   (required) the file path of the lightning web components bundle you want to save to Salesforce.
 
 EXAMPLES
-  $ sfdx deploy:lwc -p pathname // Default authorized org is used for the deploy
+  $ sfdx deploy:lwc -p <pathname> // Default authorized org is used for the deploy
 ```
 
 _See code: [src/commands/deploy/lwc.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/lwc.ts)_
 
+## `sfdx deploy:staticresource`
+
+Deploys Static Resources to the Salesforce Org using Tooling API.
+
+Supports deploying sttaic resource folder (It zips it up) as well individual files in static resource folder.
+
+```
+USAGE
+  $ sfdx deploy:staticresource
+
+OPTIONS
+  --p, --pathname=pathname                   (required) the file path of the lightning web components bundle you want to save to Salesforce.
+
+EXAMPLES
+  $ sfdx deploy:staticresource -p <pathname> // Default authorized org is used for the deploy
+  $ sfdx deploy:staticresource -p <pathname> --resourcepath <name of the folder where you have app>' // Default authorized org is used for the deploy
+  $ sfdx deploy:staticresource -p <pathname> --resourcepath <name of the folder where you have app>' --cachecontrol public //makes the cache control of static resource public
+```
+
+_See code: [src/commands/deploy/staticresource.ts](https://github.com/msrivastav13/mo-dx-plugin/blob/master/src/commands/deploy/staticresource.ts)_
+
+
+
 ### Important Note When Using these Commands With Non-Scratch Org
 
 **These commands do not maintain history and files are overriden on server .Make sure you have source control for the project setup so you do not loose anything**

messages/org.json

@@ -6,5 +6,6 @@
   "triggerDeploy": "Deploy apex triggers using tooling api",
   "lwcDeploy": "Deploy lwc wusing tooling api",
   "retrieveDxSource": "Retrieves Source is DX format from Unmanaged/Managed package",
-  "retrieveSource": "Retrieves Source from Unmanaged/Managed package in Metadata API format"
+  "retrieveSource": "Retrieves Source from Unmanaged/Managed package in Metadata API format",
+  "staticresourceDeploy" : "Deploy static resource using tooling api"
 }

package.json

@@ -1,41 +1,43 @@
 {
   "name": "mo-dx-plugin",
-  "version": "0.2.12",
+  "version": "0.2.3",
   "author": "Mohith Shrivastava",
   "bugs": "https://github.com/ForceProjects/mo-dx-plugin/issues",
   "dependencies": {
     "@oclif/command": "^1",
-    "@oclif/plugin-help": "^2",
     "@oclif/config": "^1",
     "@oclif/errors": "^1",
+    "@oclif/plugin-help": "^2",
     "@salesforce/command": "^1.4.1",
+    "@salesforce/core": "^1.3.2",
     "@salesforce/ts-types": "^1.0.1",
-    "tslib": "^1",
     "adm-zip": "^0.4.13",
+    "chalk": "^2.4.1",
     "fs-extra": "^8.1.0",
     "lodash": "^4.17.13",
-    "chalk": "^2.4.1",
-    "@salesforce/core": "^1.3.2"
+    "mime-types": "^2.1.24",
+    "tslib": "^1"
   },
   "devDependencies": {
-    "@types/adm-zip": "^0.4.31",
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-help": "^2",
     "@oclif/test": "^1",
     "@salesforce/dev-config": "1.1.4",
+    "@types/adm-zip": "^0.4.31",
     "@types/chai": "^4",
+    "@types/fs-extra": "^5.0.3",
     "@types/jsforce": "1.9.8",
+    "@types/lodash": "^4.14.13",
+    "@types/mime-types": "^2.1.0",
     "@types/mocha": "^5",
     "@types/node": "^10",
-    "@types/lodash": "^4.14.13",
     "chai": "^4",
     "globby": "8",
     "mocha": "^5",
     "nyc": "^12",
     "sinon": "5",
     "ts-node": "^7",
-    "typescript": "~3.3",
-    "@types/fs-extra": "^5.0.3"
+    "typescript": "~3.3"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -57,7 +59,7 @@
       "deploy": {
         "description": "Commands to deploy apex,vf,trigger and aura bundle."
       },
-      "retrieve":{
+      "retrieve": {
         "description": "Commands to get DX formatted code or metadata from the unmanaged package/managed package or changeset."
       }
     },

src/commands/deploy/staticresource.ts

@@ -0,0 +1,112 @@
+import {core, flags, SfdxCommand} from '@salesforce/command';
+import {AnyJson} from '@salesforce/ts-types';
+import * as AdmZip from 'adm-zip';
+import chalk from 'chalk';
+import fs = require('fs-extra');
+import * as Mime from 'mime-types';
+import {displaylog} from '../../service/displayError';
+import {getNameSpacePrefix} from '../../service/getNamespacePrefix';
+
+// Initialize Messages with the current plugin directory
+core.Messages.importMessagesDirectory(__dirname);
+
+// Load the specific messages for this file. Messages from @salesforce/command, @salesforce/core,
+// or any library that is using the messages framework can also be loaded this way.
+const messages = core.Messages.loadMessages('mo-dx-plugin', 'org');
+
+export default class StaticResourceDeploy extends SfdxCommand {
+
+  public static description = messages.getMessage('staticresourceDeploy');
+
+  public static examples = [
+  '$ sfdx deploy:staticresource -p <filepath>',
+  '$ sfdx deploy:staticresource -p <filepath> --cachecontrol public',
+  '$ sfdx deploy:staticresource -p <filepath> --cachecontrol public --resourcepath <name of the folder where you have single page app>'
+  ];
+
+  protected static flagsConfig = {
+    // flag with a value (-n, --name=VALUE)
+    filepath: flags.string({char: 'p', description: 'file path' }),
+    resourcepath : flags.string({char: 'r', description: 'resource path, This defaults to staticresources', default: 'staticresources' }),
+    cachecontrol : flags.string({char: 'c', description: 'cache control, defaults to public', default: 'private'})
+  };
+
+  // Comment this out if your command does not require an org username
+  protected static requiresUsername = true;
+
+  // Set this to true if your command requires a project workspace; 'requiresProject' is false by default
+  protected static requiresProject = true;
+
+  public async run(): Promise<AnyJson> {
+
+    this.ux.startSpinner(chalk.bold.yellowBright('Saving'));
+
+    const conn = this.org.getConnection();
+
+    const namespacePrefix = await getNameSpacePrefix(conn);
+
+    interface StaticResource {
+      Body: string;
+      Id: string;
+      ContentType: string;
+      CacheControl: string;
+      Name: string;
+    }
+
+    try {
+      // find the depth of the file from static Resource folder
+      const resourcepath = this.flags.filepath.split(this.flags.resourcepath + '/').pop();
+      const folderorfilename =  resourcepath.split('/')[0];
+      let staticResourceName: string;
+      let contentType: string | boolean;
+      let body: string;
+
+      staticResourceName = folderorfilename.split('.')[0];
+      // check if resource is bundled or individual file with extension
+      if (folderorfilename === staticResourceName) {
+        // zip the resource and get the body as archive
+        const resourcebundlepath = this.flags.filepath.slice(0, this.flags.filepath.indexOf(this.flags.resourcepath));
+        const zipper = new AdmZip();
+        zipper.addLocalFolder(resourcebundlepath + '/' +  this.flags.resourcepath + '/' + staticResourceName);
+        body = zipper.toBuffer().toString('base64');
+        contentType = 'application/zip';
+      } else {
+        body = await fs.readFile(this.flags.filepath, 'utf8');
+        const buff = Buffer.alloc(body.length, body);
+        body = buff.toString('base64');
+        contentType = Mime.lookup(folderorfilename.split('.')[1]);
+        if (contentType === false) {
+          contentType = 'application/octet-stream';
+        }
+      }
+
+      // check if static resource already exists
+      const staticResources = await conn.tooling.sobject('StaticResource').find({
+        Name: staticResourceName,
+        NameSpacePrefix : namespacePrefix
+      }) as StaticResource[];
+
+      if (staticResources.length > 0) {
+        const staticresourceToUpdate = {} as StaticResource;
+        staticresourceToUpdate.Id = staticResources[0].Id;
+        staticresourceToUpdate.Body = body;
+        await conn.tooling.sobject('StaticResource').update(staticresourceToUpdate);
+      } else {
+        // Create a new Static Resource
+        const staticresource = {} as StaticResource;
+        staticresource.Body = body;
+        staticresource.ContentType = contentType;
+        staticresource.CacheControl = this.flags.cachecontrol;
+        staticresource.Name = staticResourceName;
+        await conn.tooling.sobject('StaticResource').create(staticresource);
+      }
+      this.ux.stopSpinner(chalk.bold.greenBright('StaticResource Deployed SuccessFully ✔'));
+    } catch (e) {
+      this.ux.stopSpinner(chalk.bold.redBright('Static Resource Save Failed ✖'));
+      displaylog(e, this.ux);
+    }
+
+    return '{}';
+  }
+
+}

yarn.lock

@@ -381,6 +381,11 @@
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.136.tgz#413e85089046b865d960c9ff1d400e04c31ab60f"
   integrity sha512-0GJhzBdvsW2RUccNHOBkabI8HZVdOXmXbXhuKlDEd5Vv12P7oAVGfomGp3Ne21o5D/qu1WmthlNKFaoZJJeErA==
 
+"@types/mime-types@^2.1.0":
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/@types/mime-types/-/mime-types-2.1.0.tgz#9ca52cda363f699c69466c2a6ccdaad913ea7a73"
+  integrity sha1-nKUs2jY/aZxpRmwqbM2q2RPqenM=
+
 "@types/minimatch@*":
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
@@ -2545,7 +2550,7 @@ mime-db@1.40.0:
   resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.40.0.tgz#a65057e998db090f732a68f6c276d387d4126c32"
   integrity sha512-jYdeOMPy9vnxEqFRRo6ZvTZ8d9oPb+k18PKoYNYUe2stVEBPPwsln/qWzdbmaIvnhZ9v2P+CuecK+fpUfsV2mA==
 
-mime-types@^2.1.12, mime-types@~2.1.19:
+mime-types@^2.1.12, mime-types@^2.1.24, mime-types@~2.1.19:
   version "2.1.24"
   resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.24.tgz#b6f8d0b3e951efb77dedeca194cff6d16f676f81"
   integrity sha512-WaFHS3MCl5fapm3oLxU4eYDw77IQM2ACcxQ9RIxfaC3ooc6PFuBMGZZsYpvoXS5D5QTWPieo1jjLdAm3TBP3cQ==