zapier-platform-cli 16.4.0 → 16.5.0

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,7 +1513,7 @@
     "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": {
         "debug": {
           "char": "d",
@@ -1510,54 +1562,6 @@
         "versions.js"
       ]
     },
-    "cache:clear": {
-      "aliases": [],
-      "args": {
-        "majorVersion": {
-          "description": "(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.",
-          "name": "majorVersion",
-          "required": false
-        }
-      },
-      "description": "Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n",
-      "examples": [
-        "zapier cache:clear",
-        "zapier cache:clear 2"
-      ],
-      "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": "cache:clear",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "hide": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "cache",
-        "clear.js"
-      ]
-    },
     "canary:create": {
       "aliases": [],
       "args": {
@@ -1721,18 +1725,19 @@
         "list.js"
       ]
     },
-    "env:get": {
+    "cache:clear": {
       "aliases": [],
       "args": {
-        "version": {
-          "description": "The version to get the environment for.",
-          "name": "version",
-          "required": true
+        "majorVersion": {
+          "description": "(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.",
+          "name": "majorVersion",
+          "required": false
         }
       },
-      "description": "Get environment variables for a version.",
+      "description": "Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n",
       "examples": [
-        "zapier env:get 1.2.3"
+        "zapier cache:clear",
+        "zapier cache:clear 2"
       ],
       "flags": {
         "debug": {
@@ -1742,21 +1747,45 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "char": "f",
-          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "cache:clear",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "hide": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "cache",
+        "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,
@@ -1767,7 +1796,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:get",
+      "id": "delete:integration",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -1779,35 +1808,21 @@
         "src",
         "oclif",
         "commands",
-        "env",
-        "get.js"
+        "delete",
+        "integration.js"
       ]
     },
-    "env:set": {
+    "delete:version": {
       "aliases": [],
       "args": {
         "version": {
-          "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.",
+          "description": "Specify the version to delete. It must have no users or Zaps.",
           "name": "version",
           "required": true
-        },
-        "key-value pairs...": {
-          "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`",
-          "name": "key-value pairs..."
         }
       },
-      "description": "Set environment variables for a version.",
-      "examples": [
-        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
-      ],
+      "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": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1824,11 +1839,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:set",
+      "id": "delete:version",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1836,35 +1851,24 @@
         "src",
         "oclif",
         "commands",
-        "env",
-        "set.js"
+        "delete",
+        "version.js"
       ]
     },
-    "env:unset": {
+    "env:get": {
       "aliases": [],
       "args": {
         "version": {
-          "description": "The version to set the environment for.",
+          "description": "The version to get the environment for.",
           "name": "version",
           "required": true
-        },
-        "keys...": {
-          "description": "The keys to unset. Keys are case-insensitive.",
-          "name": "keys..."
         }
       },
-      "description": "Unset environment variables for a version.",
+      "description": "Get environment variables for a version.",
       "examples": [
-        "zapier env:unset 1.2.3 SECRET OTHER"
+        "zapier env:get 1.2.3"
       ],
       "flags": {
-        "force": {
-          "char": "f",
-          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1872,6 +1876,22 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "format": {
+          "char": "f",
+          "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
+        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -1881,11 +1901,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "env:unset",
+      "id": "env:get",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1894,16 +1914,34 @@
         "oclif",
         "commands",
         "env",
-        "unset.js"
+        "get.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
+    "env:set": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "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.",
+          "name": "version",
+          "required": true
+        },
+        "key-value pairs...": {
+          "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`",
+          "name": "key-value pairs..."
+        }
+      },
+      "description": "Set environment variables for a version.",
+      "examples": [
+        "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
       ],
-      "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": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1920,11 +1958,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:integration",
+      "id": "env:set",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1932,21 +1970,35 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "integration.js"
+        "env",
+        "set.js"
       ]
     },
-    "delete:version": {
+    "env:unset": {
       "aliases": [],
       "args": {
         "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "description": "The version to set the environment for.",
           "name": "version",
           "required": true
+        },
+        "keys...": {
+          "description": "The keys to unset. Keys are case-insensitive.",
+          "name": "keys..."
         }
       },
-      "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.",
+      "description": "Unset environment variables for a version.",
+      "examples": [
+        "zapier env:unset 1.2.3 SECRET OTHER"
+      ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "Force the update of environment variables regardless if the app version is production or not. Use with caution.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1963,11 +2015,11 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delete:version",
+      "id": "env:unset",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": false,
       "skipValidInstallCheck": true,
       "isESM": false,
@@ -1975,8 +2027,8 @@
         "src",
         "oclif",
         "commands",
-        "delete",
-        "version.js"
+        "env",
+        "unset.js"
       ]
     },
     "team:add": {
@@ -2358,5 +2410,5 @@
       ]
     }
   },
-  "version": "16.4.0"
+  "version": "16.5.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "16.4.0",
+  "version": "16.5.0",
   "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

@@ -5,19 +5,43 @@ const { buildFlags } = require('../buildFlags');
 
 const { listVersions } = require('../../utils/api');
 
+const deploymentToLifecycleState = (deployment) => {
+  switch (deployment) {
+    case 'non-production':
+      return 'private';
+    case 'production':
+      return 'promoted';
+    case 'demoted':
+      return 'available';
+    case 'legacy':
+      return 'legacy';
+    case 'deprecating':
+      return 'deprecating';
+    case 'deprecated':
+      return 'deprecated';
+    default:
+      return deployment;
+  }
+};
+
 class VersionCommand extends BaseCommand {
   async perform() {
     this.startSpinner('Loading versions');
     const { versions } = await listVersions();
     this.stopSpinner();
+    const rows = versions.map((v) => ({
+      ...v,
+      state: deploymentToLifecycleState(v.lifecycle.status),
+    }));
 
     this.logTable({
-      rows: versions,
+      rows,
       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'],
       ],
@@ -58,6 +82,6 @@ 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.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'),