zapier-platform-cli 16.4.0 → 16.5.1

package/oclif.manifest.json

@@ -649,6 +649,58 @@
         "jobs.js"
       ]
     },
+    "legacy": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "The version to mark as legacy.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Mark a non-production version of your integration as legacy.\n\nUse this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.\n\nReasons why you might want to mark a version as legacy:\n- this version may be discontinued in the future\n- this version has bugs\n- a newer version has been released and you want to encourage users to upgrade\n\n",
+      "examples": [
+        "zapier legacy 1.2.3"
+      ],
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Skip confirmation prompt. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "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": "legacy",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "legacy.js"
+      ]
+    },
     "link": {
       "aliases": [],
       "args": {},
@@ -1461,8 +1513,15 @@
     "versions": {
       "aliases": [],
       "args": {},
-      "description": "List the versions of your integration available for use in the Zapier editor.",
+      "description": "List the versions of your integration available for use in Zapier automations.",
       "flags": {
+        "all": {
+          "char": "a",
+          "description": "List all versions, including deprecated versions.",
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1721,6 +1780,88 @@
         "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": {
@@ -1897,88 +2038,6 @@
         "unset.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"
-      ]
-    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2358,5 +2417,5 @@
       ]
     }
   },
-  "version": "16.4.0"
+  "version": "16.5.1"
 }

package/package.json

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

package/src/oclif/commands/legacy.js

@@ -0,0 +1,61 @@
+const BaseCommand = require('../ZapierBaseCommand');
+const { Args, Flags } = require('@oclif/core');
+const { buildFlags } = require('../buildFlags');
+
+const { callAPI } = require('../../utils/api');
+
+class LegacyCommand extends BaseCommand {
+  async perform() {
+    const app = await this.getWritableApp();
+    const { version } = this.args;
+
+    if (
+      !this.flags.force &&
+      !(await this.confirm(
+        'Are you sure you want to mark this version as legacy? Existing Zaps and automations will continue to work, but users may not be able to create new Zaps or automations with this version.',
+      ))
+    ) {
+      this.log('\nCancelled, version is not marked as legacy.');
+      return;
+    }
+
+    this.log(
+      `\nPreparing to mark version ${version} your app "${app.title}" as legacy.\n`,
+    );
+    const url = `/apps/${app.id}/versions/${version}/legacy`;
+    this.startSpinner(`Making ${version} legacy`);
+    await callAPI(url, {
+      method: 'PUT',
+    });
+    this.stopSpinner();
+  }
+}
+
+LegacyCommand.flags = buildFlags({
+  commandFlags: {
+    force: Flags.boolean({
+      char: 'f',
+      description: 'Skip confirmation prompt. Use with caution.',
+    }),
+  },
+});
+LegacyCommand.args = {
+  version: Args.string({
+    description: 'The version to mark as legacy.',
+    required: true,
+  }),
+};
+LegacyCommand.examples = ['zapier legacy 1.2.3'];
+LegacyCommand.description = `Mark a non-production version of your integration as legacy.
+
+Use this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.
+
+Reasons why you might want to mark a version as legacy:
+- this version may be discontinued in the future
+- this version has bugs
+- a newer version has been released and you want to encourage users to upgrade
+
+`;
+LegacyCommand.skipValidInstallCheck = true;
+
+module.exports = LegacyCommand;

package/src/oclif/commands/promote.js

@@ -258,11 +258,6 @@ ${metadataPromptHelper}`);
 
     this.stopSpinner();
     this.log('  Promotion successful!');
-    if (!this.flags.invokedFromAnotherCommand) {
-      this.log(
-        'Optionally, run the `zapier migrate` command to move users to this version.',
-      );
-    }
   }
 }
 

package/src/oclif/commands/versions.js

@@ -1,5 +1,5 @@
 const colors = require('colors/safe');
-
+const { Flags } = require('@oclif/core');
 const BaseCommand = require('../ZapierBaseCommand');
 const { buildFlags } = require('../buildFlags');
 
@@ -10,14 +10,23 @@ class VersionCommand extends BaseCommand {
     this.startSpinner('Loading versions');
     const { versions } = await listVersions();
     this.stopSpinner();
+    const rows = versions.map((v) => ({
+      ...v,
+      state: v.lifecycle.status,
+    }));
+
+    const visibleVersions = this.flags.all
+      ? rows
+      : rows.filter((v) => v.state !== 'deprecated');
 
     this.logTable({
-      rows: versions,
+      rows: visibleVersions,
       headers: [
         ['Version', 'version'],
         ['Platform', 'platform_version'],
-        ['Users', 'user_count'],
-        ['Deployment', 'deployment'],
+        ['Zap Users', 'user_count'],
+        ['State', 'state'],
+        ['Legacy Date', 'legacy_date'],
         ['Deprecation Date', 'deprecation_date'],
         ['Timestamp', 'date'],
       ],
@@ -57,7 +66,15 @@ class VersionCommand extends BaseCommand {
 }
 
 VersionCommand.skipValidInstallCheck = true;
-VersionCommand.flags = buildFlags({ opts: { format: true } });
-VersionCommand.description = `List the versions of your integration available for use in the Zapier editor.`;
+VersionCommand.flags = buildFlags({
+  commandFlags: {
+    all: Flags.boolean({
+      char: 'a',
+      description: `List all versions, including deprecated versions.`,
+    }),
+  },
+  opts: { format: true },
+});
+VersionCommand.description = `List the versions of your integration available for use in Zapier automations.`;
 
 module.exports = VersionCommand;

package/src/oclif/oCommands.js

@@ -26,6 +26,7 @@ module.exports = {
   integrations: require('./commands/integrations'),
   invoke: require('./commands/invoke'),
   link: require('./commands/link'),
+  legacy: require('./commands/legacy'),
   login: require('./commands/login'),
   logs: require('./commands/logs'),
   logout: require('./commands/logout'),