zapier-platform-cli 17.0.4 → 17.2.0

package/oclif.manifest.json

@@ -111,11 +111,6 @@
     "convert": {
       "aliases": [],
       "args": {
-        "integrationId": {
-          "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.",
-          "name": "integrationId",
-          "required": true
-        },
         "path": {
           "description": "Relative to your current path - IE: `.` for current directory.",
           "name": "path",
@@ -124,11 +119,64 @@
       },
       "description": "Convert a Visual Builder integration to a CLI integration.\n\nThe resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!\n\nIf you re-run this command on an existing directory it will leave existing files alone and not clobber them.\n\nYou'll need to do a `zapier push` before the new version is visible in the editor, but otherwise you're good to go.",
       "flags": {
+        "integrationId": {
+          "char": "i",
+          "dependsOn": [
+            "version"
+          ],
+          "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.",
+          "exclusive": [
+            "definition"
+          ],
+          "name": "integrationId",
+          "required": false,
+          "hasDynamicHelp": false,
+          "type": "option"
+        },
         "version": {
           "char": "v",
+          "dependsOn": [
+            "integrationId"
+          ],
           "description": "Convert a specific version. Required when converting a Visual Builder integration.",
           "name": "version",
-          "required": true,
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "json": {
+          "char": "j",
+          "description": "The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.",
+          "exclusive": [
+            "integrationId"
+          ],
+          "name": "json",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "title": {
+          "char": "t",
+          "dependsOn": [
+            "json"
+          ],
+          "description": "The integration title, which will be snake-cased for the package.json name.",
+          "name": "title",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "description": {
+          "char": "d",
+          "dependsOn": [
+            "json"
+          ],
+          "description": "The integration description, which will be used for the package.json description.",
+          "name": "description",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -178,9 +226,11 @@
           "required": true
         }
       },
-      "description": "Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nZapier will immediately send emails warning users of the deprecation if a date less than 30 days in the future is set, otherwise the emails will be sent exactly 30 days before the configured deprecation date.\n\nThere are other side effects: they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nDo not use deprecation if you only have non-breaking changes, such as:\n- Fixing help text\n- Adding new triggers/actions\n- Improving existing functionality\n- other bug fixes that don't break existing automations.",
+      "description": "Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nWhen deprecating a version, you must provide a reason for the deprecation. You can either specify the reason using the --reason flag or you will be prompted to select from the following options:\n- API endpoint deprecated\n- Security vulnerability\n- Critical bug\n- Legal requirement\n- Other\n\nZapier will immediately send emails warning users of the deprecation if a date less than 30 days in the future is set, otherwise the emails will be sent exactly 30 days before the configured deprecation date.\n\nThere are other side effects: they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nDo not use deprecation if you only have non-breaking changes, such as:\n- Fixing help text\n- Adding new triggers/actions\n- Improving existing functionality\n- other bug fixes that don't break existing automations.",
       "examples": [
-        "zapier deprecate 1.2.3 2011-10-01"
+        "zapier deprecate 1.2.3 2011-10-01",
+        "zapier deprecate 1.2.3 2011-10-01 --reason=security_vulnerability",
+        "zapier deprecate 1.2.3 2011-10-01 -r critical_bug"
       ],
       "flags": {
         "force": {
@@ -190,6 +240,21 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "reason": {
+          "char": "r",
+          "description": "Reason for deprecation.",
+          "name": "reason",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "api endpoint deprecated",
+            "security vulnerability",
+            "critical bug",
+            "legal requirement",
+            "other"
+          ],
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1630,6 +1695,88 @@
         "clear.js"
       ]
     },
+    "delete:integration": {
+      "aliases": [
+        "delete:app"
+      ],
+      "args": {},
+      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:integration",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "integration.js"
+      ]
+    },
+    "delete:version": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:version",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "version.js"
+      ]
+    },
     "canary:create": {
       "aliases": [],
       "args": {
@@ -1793,88 +1940,6 @@
         "list.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
-      ],
-      "args": {},
-      "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:integration",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "integration.js"
-      ]
-    },
-    "delete:version": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:version",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "version.js"
-      ]
-    },
     "env:get": {
       "aliases": [],
       "args": {
@@ -2430,5 +2495,5 @@
       ]
     }
   },
-  "version": "17.0.4"
+  "version": "17.2.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.0.4",
+  "version": "17.2.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/src/oclif/commands/convert.js

@@ -1,3 +1,5 @@
+const fs = require('node:fs/promises');
+
 const { Args, Flags } = require('@oclif/core');
 
 const BaseCommand = require('../ZapierBaseCommand');
@@ -8,9 +10,40 @@ const { convertApp } = require('../../utils/convert');
 const { isExistingEmptyDir } = require('../../utils/files');
 const { initApp } = require('../../utils/init');
 
+const readStream = async (stream) => {
+  const chunks = [];
+  for await (const chunk of stream) {
+    chunks.push(chunk);
+  }
+  return chunks.join('');
+};
+
 class ConvertCommand extends BaseCommand {
-  generateCreateFunc(appId, version) {
+  generateCreateFunc(appId, version, json, title, description) {
     return async (tempAppDir) => {
+      if (json) {
+        const appInfo = {
+          title,
+          description,
+        };
+
+        let parsedDefinition = json;
+        if (parsedDefinition.startsWith('@')) {
+          const filePath = parsedDefinition.substr(1);
+          let definitionStream;
+          if (filePath === '-') {
+            definitionStream = process.stdin;
+          } else {
+            const fd = await fs.open(filePath);
+            definitionStream = fd.createReadStream({ encoding: 'utf8' });
+          }
+          parsedDefinition = await readStream(definitionStream);
+        }
+        parsedDefinition = JSON.parse(parsedDefinition);
+
+        return convertApp(appInfo, parsedDefinition, tempAppDir);
+      }
+
       // has info about the app, such as title
       // has a CLI version of the actual app implementation
       this.throwForInvalidVersion(version);
@@ -41,13 +74,14 @@ class ConvertCommand extends BaseCommand {
   }
 
   async perform() {
-    const { integrationId: appId, path } = this.args;
-    const { version } = this.flags;
-    if (!appId) {
-      this.error(
-        'You must provide an integrationId. See zapier convert --help for more info.',
-      );
-    }
+    const { path } = this.args;
+    const {
+      integrationId: appId,
+      version,
+      json,
+      title,
+      description,
+    } = this.flags;
 
     if (
       (await isExistingEmptyDir(path)) &&
@@ -56,16 +90,18 @@ class ConvertCommand extends BaseCommand {
       this.exit();
     }
 
-    await initApp(path, this.generateCreateFunc(appId, version));
+    if (!appId && !json) {
+      this.error('You must provide either an integrationId or json.');
+    }
+
+    await initApp(
+      path,
+      this.generateCreateFunc(appId, version, json, title, description),
+    );
   }
 }
 
 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.`,
-    required: true,
-    parse: (input) => Number(input),
-  }),
   path: Args.string({
     description:
       'Relative to your current path - IE: `.` for current directory.',
@@ -75,11 +111,41 @@ ConvertCommand.args = {
 
 ConvertCommand.flags = buildFlags({
   commandFlags: {
+    integrationId: Args.string({
+      char: 'i',
+      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.`,
+      required: false,
+      dependsOn: ['version'],
+      exclusive: ['definition'],
+      parse: (input) => Number(input),
+    }),
     version: Flags.string({
       char: 'v',
       description:
         'Convert a specific version. Required when converting a Visual Builder integration.',
-      required: true,
+      required: false,
+      dependsOn: ['integrationId'],
+    }),
+    json: Flags.string({
+      char: 'j',
+      description:
+        'The JSON definition to use, as alternative for reading from a Visual Builder integration. Must be a JSON-encoded object. The data can be passed from the command directly like \'{"key": "value"}\', read from a file like @file.json, or read from stdin like @-.',
+      required: false,
+      exclusive: ['integrationId'],
+    }),
+    title: Flags.string({
+      char: 't',
+      description:
+        'The integration title, which will be snake-cased for the package.json name.',
+      required: false,
+      dependsOn: ['json'],
+    }),
+    description: Flags.string({
+      char: 'd',
+      description:
+        'The integration description, which will be used for the package.json description.',
+      required: false,
+      dependsOn: ['json'],
     }),
   },
 });

package/src/oclif/commands/deprecate.js

@@ -5,6 +5,14 @@ const colors = require('colors/safe');
 
 const { callAPI, getSpecificVersionInfo } = require('../../utils/api');
 
+const DEPRECATION_REASONS = [
+  { name: 'API endpoint deprecated', value: 'api endpoint deprecated' },
+  { name: 'Security vulnerability', value: 'security vulnerability' },
+  { name: 'Critical bug', value: 'critical bug' },
+  { name: 'Legal requirement', value: 'legal requirement' },
+  { name: 'Other', value: 'other' },
+];
+
 class DeprecateCommand extends BaseCommand {
   async perform() {
     const app = await this.getWritableApp();
@@ -18,6 +26,40 @@ class DeprecateCommand extends BaseCommand {
         `${colors.yellow('If all your changes are non-breaking, use `zapier migrate` instead to move users over to a newer version.')}\n`,
     );
 
+    // Get deprecation reason - either from flag or prompt user
+    let deprecationReason = this.flags.reason;
+
+    if (!deprecationReason) {
+      deprecationReason = await this.promptWithList(
+        'Please select a reason for deprecating this version:',
+        DEPRECATION_REASONS,
+        {
+          useStderr: true,
+        },
+      );
+    } else {
+      // Validate the provided reason
+      const validReasons = DEPRECATION_REASONS.map((r) => r.value);
+      if (!validReasons.includes(deprecationReason)) {
+        this.error(
+          `Invalid deprecation reason: ${deprecationReason}. Valid options are: ${validReasons.join(', ')}`,
+        );
+      }
+    }
+
+    let customReason = null;
+    if (deprecationReason === 'other') {
+      customReason = await this.prompt(
+        'Please provide a brief user-facing reason (50 characters max):',
+        {
+          required: true,
+          charLimit: 50,
+          useStderr: true,
+        },
+      );
+      customReason = 'other: ' + customReason;
+    }
+
     if (
       !this.flags.force &&
       !(await this.confirm(
@@ -32,14 +74,16 @@ class DeprecateCommand extends BaseCommand {
     }
 
     this.log(
-      `\nPreparing to deprecate version ${version} your app "${app.title}".\n`,
+      `\nPreparing to deprecate version ${version} your app "${app.title}" due to: ${customReason || DEPRECATION_REASONS.find((r) => r.value === deprecationReason)?.name}.\n`,
     );
+
     const url = `/apps/${app.id}/versions/${version}/deprecate`;
     this.startSpinner(`Deprecating ${version}`);
     await callAPI(url, {
       method: 'PUT',
       body: {
         deprecation_date: date,
+        deprecation_reason: customReason || deprecationReason,
       },
     });
     this.stopSpinner();
@@ -55,6 +99,11 @@ DeprecateCommand.flags = buildFlags({
       char: 'f',
       description: 'Skip confirmation prompt. Use with caution.',
     }),
+    reason: Flags.string({
+      char: 'r',
+      description: 'Reason for deprecation.',
+      options: DEPRECATION_REASONS.map((r) => r.value),
+    }),
   },
 });
 DeprecateCommand.args = {
@@ -68,11 +117,18 @@ DeprecateCommand.args = {
     required: true,
   }),
 };
-DeprecateCommand.examples = ['zapier deprecate 1.2.3 2011-10-01'];
+DeprecateCommand.examples = [
+  'zapier deprecate 1.2.3 2011-10-01',
+  'zapier deprecate 1.2.3 2011-10-01 --reason=security_vulnerability',
+  'zapier deprecate 1.2.3 2011-10-01 -r critical_bug',
+];
 DeprecateCommand.description = `Mark a non-production version of your integration as deprecated, with removal by a certain date.
 
 Use this when an integration version will not be supported or start breaking at a known date.
 
+When deprecating a version, you must provide a reason for the deprecation. You can either specify the reason using the --reason flag or you will be prompted to select from the following options:
+${DEPRECATION_REASONS.map((r) => `- ${r.name}`).join('\n')}
+
 Zapier will immediately send emails warning users of the deprecation if a date less than 30 days in the future is set, otherwise the emails will be sent exactly 30 days before the configured deprecation date.
 
 There are other side effects: they'll start seeing it as "Deprecated" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.

package/src/utils/convert.js

@@ -101,7 +101,7 @@ const getAuthFieldKeys = (appDefinition) => {
 
 const renderPackageJson = async (appInfo, appDefinition) => {
   const name = _.kebabCase(
-    appInfo.title || _.get(appInfo, ['general', 'title']),
+    appInfo.title || _.get(appInfo, ['general', 'title']) || '',
   );
 
   // Not using escapeSpecialChars because we don't want to escape single quotes (not
@@ -366,10 +366,10 @@ const writeGitIgnore = async (newAppDir) => {
 };
 
 const writeZapierAppRc = async (appInfo, appDefinition, newAppDir) => {
-  const json = {};
-  if (appInfo.id) {
-    json.id = appInfo.id;
+  if (!appInfo.id) {
+    return;
   }
+  const json = { id: appInfo.id };
   if (appInfo.key) {
     json.key = appInfo.key;
   }