Merge pull request #154 from line-o/feat/better-install

Ease package installation

README.md

@@ -189,10 +189,13 @@ exports.default = deployWithPermissions
 
 #### Options
 
-##### packageUri
+##### packageUri (deprecated)
 
 The unique package descriptor of the application to be installed.
 
+**NOTE:** For versions after v4.0.2 this option is ignored and will be read 
+from the XAR itself.
+
 ##### customPackageRepoUrl
 
 The application repository that will be used to resolve dependencies.
@@ -211,12 +214,10 @@ const exist = createClient({
         pass: ''
     }
 })
-// this MUST be the unique package identifier of the XAR you want to install 
-const packageUri = 'http://exist-db.org/apps/test-app'
 
 function install () {
     return src('spec/files/test-app.xar')
-        .pipe(exist.install({ packageUri }))
+        .pipe(exist.install())
 }
 ```
 

index.js

@@ -281,7 +281,7 @@ function newer (client, options) {
 
 /**
  * @typedef {Object} GulpExistInstallationOptions
- * @prop {string} packageUri
+ * @prop {string} [packageUri] deprecated
  * @prop {string} [customPackageRepoUrl]
  */
 
@@ -293,9 +293,7 @@ function newer (client, options) {
  * @return {TransformFunction} install XAR from vinyl file stream
  */
 function install (client, options) {
-  if (!options || !options.packageUri) { return new PluginError('gulp-exist', 'packageUri must be declared') }
-  const packageUri = options.packageUri
-  const customPackageRepoUrl = options.customPackageRepoUrl || null
+  const customPackageRepoUrl = options && options.customPackageRepoUrl ? options.customPackageRepoUrl : null
 
   function installPackage (file, enc, callback) {
     const xarName = file.basename
@@ -310,8 +308,8 @@ function install (client, options) {
     client.app.upload(file.contents, xarName)
       .then(response => {
         if (!response.success) { return callback(new PluginError('gulp-exist', 'XAR was not uploaded')) }
-        log(`Install ${packageUri} from ${xarName}`)
-        return client.app.install(xarName, packageUri, customPackageRepoUrl)
+        log(`Install ${xarName}`)
+        return client.app.install(xarName, customPackageRepoUrl)
       })
       .then(response => {
         if (!response.success) { return callback(new PluginError('gulp-exist', 'XAR Installation failed')) }

package.json

@@ -47,10 +47,10 @@
     "tape": "^5.0.1"
   },
   "dependencies": {
+    "@existdb/node-exist": "^4.0.0",
     "fancy-log": "^1.3.2",
     "gulp": "^4.0.2",
     "lodash.assign": "^4.2.0",
-    "@existdb/node-exist": "^3.0.1",
     "plugin-error": "^1.0.1",
     "through2": "^4.0.2",
     "vinyl": "^2.2.1"

spec/install.js

@@ -19,7 +19,7 @@ test('install XAR package', function (t) {
   }
 
   return gulp.src('test-app.xar', { cwd: 'spec/files' })
-    .pipe(testClient.install({ packageUri }))
+    .pipe(testClient.install())
     .on('data', function (d) {
       t.plan(3)
       t.true(d.success, 'succeeded')