zapier-platform-cli 15.18.1 → 16.0.0

package/src/oclif/commands/convert.js

@@ -1,3 +1,5 @@
+const { Args, Flags } = require('@oclif/core');
+
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
@@ -6,8 +8,6 @@ const { convertApp } = require('../../utils/convert');
 const { isExistingEmptyDir } = require('../../utils/files');
 const { initApp } = require('../../utils/init');
 
-const { flags } = require('@oclif/command');
-
 class ConvertCommand extends BaseCommand {
   generateCreateFunc(appId, version) {
     return async (tempAppDir) => {
@@ -23,7 +23,7 @@ class ConvertCommand extends BaseCommand {
 
         if (!versionInfo.definition_override) {
           this.error(
-            `Integration ${appId} @ ${version} is already a CLI integration and can't be converted. Instead, pick a version that was created using the Visual Builder.`
+            `Integration ${appId} @ ${version} is already a CLI integration and can't be converted. Instead, pick a version that was created using the Visual Builder.`,
           );
         }
         this.stopSpinner();
@@ -32,7 +32,7 @@ class ConvertCommand extends BaseCommand {
       } catch (e) {
         if (e.status === 404) {
           this.error(
-            `Visual Builder integration ${appId} @ ${version} not found. Double check the integration id and version.`
+            `Visual Builder integration ${appId} @ ${version} not found. Double check the integration id and version.`,
           );
         }
         this.error(e.json.errors[0]);
@@ -45,7 +45,7 @@ class ConvertCommand extends BaseCommand {
     const { version } = this.flags;
     if (!appId) {
       this.error(
-        'You must provide an integrationId. See zapier convert --help for more info.'
+        'You must provide an integrationId. See zapier convert --help for more info.',
       );
     }
 
@@ -60,23 +60,22 @@ class ConvertCommand extends BaseCommand {
   }
 }
 
-ConvertCommand.args = [
-  {
-    name: 'integrationId',
-    required: true,
+ConvertCommand.args = {
+  integrationId: Args.string({
     description: `To get the integration/app ID, go to "https://developer.zapier.com", click on an integration, and copy the number directly after "/app/" in the URL.`,
-    parse: (input) => Number(input),
-  },
-  {
-    name: 'path',
     required: true,
+    parse: (input) => Number(input),
+  }),
+  path: Args.string({
     description:
       'Relative to your current path - IE: `.` for current directory.',
-  },
-];
+    required: true,
+  }),
+};
+
 ConvertCommand.flags = buildFlags({
   commandFlags: {
-    version: flags.string({
+    version: Flags.string({
       char: 'v',
       description:
         'Convert a specific version. Required when converting a Visual Builder integration.',
@@ -84,6 +83,7 @@ ConvertCommand.flags = buildFlags({
     }),
   },
 });
+
 ConvertCommand.description = `Convert a Visual Builder integration to a CLI integration.
 
 The resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!

package/src/oclif/commands/delete/version.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { callAPI } = require('../../../utils/api');
 
@@ -17,13 +18,12 @@ class DeleteVersionCommand extends BaseCommand {
   }
 }
 
-DeleteVersionCommand.args = [
-  {
-    name: 'version',
-    required: true,
+DeleteVersionCommand.args = {
+  version: Args.string({
     description: `Specify the version to delete. It must have no users or Zaps.`,
-  },
-];
+    required: true,
+  }),
+};
 DeleteVersionCommand.flags = buildFlags();
 DeleteVersionCommand.skipValidInstallCheck = true;
 DeleteVersionCommand.description = `Delete a specific version of your integration.

package/src/oclif/commands/deprecate.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../buildFlags');
 
 const { callAPI } = require('../../utils/api');
@@ -8,7 +9,7 @@ class DeprecateCommand extends BaseCommand {
     const app = await this.getWritableApp();
     const { version, date } = this.args;
     this.log(
-      `Preparing to deprecate version ${version} your app "${app.title}".\n`
+      `Preparing to deprecate version ${version} your app "${app.title}".\n`,
     );
     const url = `/apps/${app.id}/versions/${version}/deprecate`;
     this.startSpinner(`Deprecating ${version}`);
@@ -20,25 +21,23 @@ class DeprecateCommand extends BaseCommand {
     });
     this.stopSpinner();
     this.log(
-      `\nWe'll let users know that this version is no longer recommended and will cease to work on ${date}.`
+      `\nWe'll let users know that this version is no longer recommended and will cease to work on ${date}.`,
     );
   }
 }
 
 DeprecateCommand.flags = buildFlags();
-DeprecateCommand.args = [
-  {
-    name: 'version',
+DeprecateCommand.args = {
+  version: Args.string({
     description: 'The version to deprecate.',
     required: true,
-  },
-  {
-    name: 'date',
-    required: true,
+  }),
+  date: Args.string({
     description:
       'The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.',
-  },
-];
+    required: true,
+  }),
+};
 DeprecateCommand.examples = ['zapier deprecate 1.2.3 2011-10-01'];
 DeprecateCommand.description = `Mark a non-production version of your integration as deprecated, with removal by a certain date.
 

package/src/oclif/commands/describe.js

@@ -95,7 +95,7 @@ class DescribeCommand extends BaseCommand {
           authentication.redirect_uri = version.oauth_redirect_uri;
         } else {
           authentication.redirect_uri = grey(
-            'Run `zapier push` to see the redirect_uri.'
+            'Run `zapier push` to see the redirect_uri.',
           );
         }
       }
@@ -134,7 +134,7 @@ class DescribeCommand extends BaseCommand {
           .map((method) => method({ key: resource.key }))
           .filter((path) => _.has(definition, path))
           .join('\n'),
-      })
+      }),
     );
     this.logTitle('Resources');
     this.logTable({
@@ -153,7 +153,7 @@ class DescribeCommand extends BaseCommand {
       const rows = _.values(definition[type]).map((row) => {
         // add possible action paths
         let paths = actionTemplates.map((method) =>
-          method({ type, key: row.key })
+          method({ type, key: row.key }),
         );
 
         // add possible resource paths
@@ -161,7 +161,7 @@ class DescribeCommand extends BaseCommand {
           const key = row.operation.resource.split('.')[0];
           const resourceTemplates = makeResourceTemplates(typeMap[type]);
           paths = paths.concat(
-            resourceTemplates.map((method) => method({ key }))
+            resourceTemplates.map((method) => method({ key })),
           );
         }
 
@@ -182,7 +182,7 @@ class DescribeCommand extends BaseCommand {
           ['Available Methods', 'paths', grey('n/a')],
         ],
         emptyMessage: grey(
-          `Nothing found for ${type}. Use the \`zapier scaffold\` command to add one.`
+          `Nothing found for ${type}. Use the \`zapier scaffold\` command to add one.`,
         ),
       });
 

package/src/oclif/commands/env/get.js

@@ -1,4 +1,5 @@
 const BaseCommand = require('../../ZapierBaseCommand');
+const { Args } = require('@oclif/core');
 const { buildFlags } = require('../../buildFlags');
 const { listEnv } = require('../../../utils/api');
 
@@ -22,13 +23,12 @@ class GetEnvCommand extends BaseCommand {
   }
 }
 
-GetEnvCommand.args = [
-  {
-    name: 'version',
+GetEnvCommand.args = {
+  version: Args.string({
     description: 'The version to get the environment for.',
     required: true,
-  },
-];
+  }),
+};
 GetEnvCommand.flags = buildFlags({ opts: { format: true } });
 GetEnvCommand.description = `Get environment variables for a version.`;
 GetEnvCommand.examples = [`zapier env:get 1.2.3`];

package/src/oclif/commands/env/set.js

@@ -1,3 +1,4 @@
+const { Args } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 const { omit } = require('lodash');
 
@@ -7,7 +8,7 @@ const { callAPI } = require('../../../utils/api');
 
 const successMessage = (version) =>
   `Successfully wrote the following to the environment of version ${cyan(
-    version
+    version,
   )}:`;
 
 class SetEnvCommand extends BaseCommand {
@@ -19,7 +20,7 @@ class SetEnvCommand extends BaseCommand {
 
     if (!valuesToSet.length) {
       this.error(
-        'Must specify at least one key-value pair to set (like `SOME_KEY=1234`)'
+        'Must specify at least one key-value pair to set (like `SOME_KEY=1234`)',
       );
     }
 
@@ -39,7 +40,7 @@ class SetEnvCommand extends BaseCommand {
     const app = await this.getWritableApp();
     if (!app.all_versions.includes(version)) {
       this.error(
-        `Version ${version} doesn't exist on integration "${app.title}"`
+        `Version ${version} doesn't exist on integration "${app.title}"`,
       );
     }
 
@@ -53,7 +54,7 @@ class SetEnvCommand extends BaseCommand {
           body: payload,
           method: 'POST',
         },
-        true
+        true,
       );
 
       this.log(successMessage(version));
@@ -73,19 +74,17 @@ class SetEnvCommand extends BaseCommand {
   }
 }
 
-SetEnvCommand.args = [
-  {
-    name: 'version',
+SetEnvCommand.args = {
+  version: Args.string({
     description:
       'The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.',
     required: true,
-  },
-  {
-    name: 'key-value pairs...',
+  }),
+  'key-value pairs...': Args.string({
     description:
       'The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`',
-  },
-];
+  }),
+};
 SetEnvCommand.flags = buildFlags();
 SetEnvCommand.description = `Set environment variables for a version.`;
 SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`];

package/src/oclif/commands/env/unset.js

@@ -1,3 +1,4 @@
+const { Args } = require('@oclif/core');
 const { cyan } = require('colors/safe');
 
 const BaseCommand = require('../../ZapierBaseCommand');
@@ -6,7 +7,7 @@ const { callAPI } = require('../../../utils/api');
 
 const successMessage = (version) =>
   `Successfully unset the following keys in the environment of version ${cyan(
-    version
+    version,
   )} (if they existed):`;
 
 class UnsetEnvCommand extends BaseCommand {
@@ -36,7 +37,7 @@ class UnsetEnvCommand extends BaseCommand {
     const app = await this.getWritableApp();
     if (!app.all_versions.includes(version)) {
       this.error(
-        `Version ${version} doesn't exist on integration "${app.title}"`
+        `Version ${version} doesn't exist on integration "${app.title}"`,
       );
     }
 
@@ -54,17 +55,15 @@ class UnsetEnvCommand extends BaseCommand {
   }
 }
 
-UnsetEnvCommand.args = [
-  {
-    name: 'version',
+UnsetEnvCommand.args = {
+  version: Args.string({
     description: 'The version to set the environment for.',
     required: true,
-  },
-  {
-    name: 'keys...',
+  }),
+  'keys...': Args.string({
     description: 'The keys to unset. Keys are case-insensitive.',
-  },
-];
+  }),
+};
 UnsetEnvCommand.flags = buildFlags();
 UnsetEnvCommand.description = `Unset environment variables for a version.`;
 UnsetEnvCommand.examples = [`zapier env:unset 1.2.3 SECRET OTHER`];

package/src/oclif/commands/init.js

@@ -1,6 +1,6 @@
 const { join } = require('path');
 
-const { flags } = require('@oclif/command');
+const { Args, Flags } = require('@oclif/core');
 const yeoman = require('yeoman-environment');
 
 const BaseCommand = require('../ZapierBaseCommand');
@@ -15,31 +15,30 @@ class InitCommand extends BaseCommand {
     const env = yeoman.createEnv();
     env.registerStub(ProjectGenerator, 'zapier:integration');
 
-    env.run('zapier:integration', { path, template }, () => {
-      this.log();
-      this.log(`A new integration has been created in directory "${path}".`);
-      this.log(`Read all about it in "${join(path, 'README.md')}".`);
-    });
+    await env.run('zapier:integration', { path, template });
+
+    this.log();
+    this.log(`A new integration has been created in directory "${path}".`);
+    this.log(`Read all about it in "${join(path, 'README.md')}".`);
   }
 }
 
 InitCommand.flags = buildFlags({
   commandFlags: {
-    template: flags.string({
+    template: Flags.string({
       char: 't',
       description: 'The template to start your integration with.',
       options: TEMPLATE_CHOICES,
     }),
   },
 });
-InitCommand.args = [
-  {
-    name: 'path',
-    required: true,
+InitCommand.args = {
+  path: Args.string({
     description:
       "Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation",
-  },
-];
+    required: true,
+  }),
+};
 InitCommand.examples = [
   'zapier init myapp',
   'zapier init ./path/myapp --template oauth2',