zapier-platform-cli 16.0.0 → 16.1.1

package/oclif.manifest.json

@@ -1771,6 +1771,168 @@
         "list.js"
       ]
     },
+    "env:get": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "The version to get the environment for.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "description": "Get environment variables for a version.",
+      "examples": [
+        "zapier env:get 1.2.3"
+      ],
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "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": "env:get",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "get.js"
+      ]
+    },
+    "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"
+      ],
+      "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": "env:set",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "set.js"
+      ]
+    },
+    "env:unset": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "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": "Unset environment variables for a version.",
+      "examples": [
+        "zapier env:unset 1.2.3 SECRET OTHER"
+      ],
+      "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": "env:unset",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "env",
+        "unset.js"
+      ]
+    },
     "team:add": {
       "aliases": [
         "team:invite"
@@ -2148,169 +2310,7 @@
         "users",
         "remove.js"
       ]
-    },
-    "env:get": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "The version to get the environment for.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "description": "Get environment variables for a version.",
-      "examples": [
-        "zapier env:get 1.2.3"
-      ],
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "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": "env:get",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "get.js"
-      ]
-    },
-    "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"
-      ],
-      "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": "env:set",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": false,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "set.js"
-      ]
-    },
-    "env:unset": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "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": "Unset environment variables for a version.",
-      "examples": [
-        "zapier env:unset 1.2.3 SECRET OTHER"
-      ],
-      "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": "env:unset",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": false,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "env",
-        "unset.js"
-      ]
     }
   },
-  "version": "16.0.0"
+  "version": "16.1.1"
 }

package/package.json

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

package/src/constants.js

@@ -26,7 +26,7 @@ const BLOCKLISTED_PATHS = [
 ];
 const NODE_VERSION = versionStore[versionStore.length - 1].nodeVersion;
 const LAMBDA_VERSION = `v${NODE_VERSION}`;
-const NODE_VERSION_CLI_REQUIRES = '>=16'; // should be the oldest non-ETL version
+const NODE_VERSION_CLI_REQUIRES = '>=18'; // should be the oldest non-ETL version
 const AUTH_KEY = 'deployKey';
 const ANALYTICS_KEY = 'analyticsMode';
 const ANALYTICS_MODES = {
@@ -42,7 +42,7 @@ const PACKAGE_VERSION = packageJson.version;
 const UPDATE_NOTIFICATION_INTERVAL = 1000 * 60 * 60 * 24 * 7; // one week
 
 const CHECK_REF_DOC_LINK =
-  'https://platform.zapier.com/docs/integration-checks-reference';
+  'https://docs.zapier.com/platform/publish/integration-checks-reference';
 
 const ISSUES_URL =
   'https://github.com/zapier/zapier-platform/issues/new/choose';

package/src/generators/templates/dynamic-dropdown/README.md

@@ -1,5 +1,5 @@
 # The "dynamic-dropdown" Template
 
-This example integration uses the [Star Wars API](https://swapi.dev/) to provide a dynamic listing of choices for an `inputField` in a trigger.
+This example integration uses the [Star Wars API](https://swapi.info/) to provide a dynamic listing of choices for an `inputField` in a trigger.
 
 ![](https://cdn.zappy.app/d985065c5098089795d9b60c77791e12.png)

package/src/generators/templates/dynamic-dropdown/triggers/people.js

@@ -5,8 +5,8 @@ const perform = async (z, bundle) => {
   // Ideally, we should poll through all the pages of results, but in this
   // example we're going to omit that part. Thus, this trigger only "see" the
   // people in their first page of results.
-  const response = await z.request({ url: 'https://swapi.dev/api/people/' });
-  let peopleArray = response.data.results;
+  const response = await z.request({ url: 'https://swapi.info/api/people/' });
+  let peopleArray = response.data;
 
   if (bundle.inputData.species_id) {
     // The Zap's setup has requested a specific species of person. Since the

package/src/generators/templates/dynamic-dropdown/triggers/species.js

@@ -3,7 +3,7 @@ const { extractID } = require('../utils');
 // Fetches a list of records from the endpoint
 const perform = async (z, bundle) => {
   const request = {
-    url: 'https://swapi.dev/api/species/',
+    url: 'https://swapi.info/api/species/',
     params: {},
   };
 
@@ -13,7 +13,7 @@ const perform = async (z, bundle) => {
   }
 
   const response = await z.request(request);
-  const speciesArray = response.data.results;
+  const speciesArray = response.data;
   return speciesArray.map((species) => {
     species.id = extractID(species.url);
     return species;

package/src/oclif/ZapierBaseCommand.js

@@ -346,7 +346,7 @@ class ZapierBaseCommand extends Command {
     if (!this.args) {
       throw new Error('unable to record analytics until args are parsed');
     }
-    return recordAnalytics(this.id, true, Object.keys(this.args), this.flags);
+    return recordAnalytics(this.id, true, this.args, this.flags);
   }
 }
 

package/src/oclif/commands/history.js

@@ -15,6 +15,7 @@ class HistoryCommand extends BaseCommand {
         ['What', 'action'],
         ['Message', 'message'],
         ['Who', 'customuser'],
+        ['Version', 'version'],
         ['Timestamp', 'date'],
       ],
       emptyMessage: 'No historical actions found',

package/src/oclif/hooks/renderMarkdownHelp.js

@@ -1,22 +1,22 @@
 const chalk = require('chalk');
 const { marked } = require('marked');
-const TerminalRenderer = require('marked-terminal');
+const { markedTerminal } = require('marked-terminal');
 
-marked.setOptions({
-  renderer: new TerminalRenderer({
+marked.use(
+  markedTerminal({
     tab: 2,
     width: process.stdout.getWindowSize()[0] - 2,
     reflowText: true,
     codespan: chalk.underline.bold,
   }),
-});
+);
 
 module.exports = (options) => {
   const cmdId = options.id === 'help' ? options.argv[0] : options.id;
   const cmd = options.config.findCommand(cmdId);
   if (cmd) {
     if (cmd.description) {
-      cmd.description = marked(cmd.description).trim();
+      cmd.description = marked.parse(cmd.description).trim();
     }
     // TODO: Do the same for flag descriptions?
   }

package/src/utils/analytics.js

@@ -2,6 +2,7 @@ const { callAPI } = require('./api');
 // const { readFile } = require('./files');
 const debug = require('debug')('zapier:analytics');
 const pkg = require('../../package.json');
+const { getLinkedAppConfig } = require('../utils/api');
 const { ANALYTICS_KEY, ANALYTICS_MODES, IS_TESTING } = require('../constants');
 const { readUserConfig, writeUserConfig } = require('./userConfig');
 
@@ -20,25 +21,37 @@ const shouldSkipAnalytics = (mode) =>
   process.env.DISABLE_ZAPIER_ANALYTICS ||
   mode === ANALYTICS_MODES.disabled;
 
-const recordAnalytics = async (command, isValidCommand, argNames, flags) => {
+const recordAnalytics = async (command, isValidCommand, args, flags) => {
   const analyticsMode = await currentAnalyticsMode();
 
   if (shouldSkipAnalytics(analyticsMode)) {
     debug('skipping analytics');
     return;
   }
-
+  const argKeys = Object.keys(args);
+  const flagKeys = Object.keys(flags);
   const shouldRecordAnonymously = analyticsMode === ANALYTICS_MODES.anonymous;
 
+  const integrationIDKey = argKeys.find(
+    (key) => key.toLowerCase() === 'integrationid',
+  );
+  const integrationID = integrationIDKey ? args[integrationIDKey] : undefined;
+
+  // Some commands ( like "zapier convert" ) won't have an app directory when called.
+  // Instead, having the app ID in the arguments.
+  // In this case, we fallback to using "integrationid" in arguments ( if it's there )
+  // and don't want to "explode" if appID is missing
+  const linkedAppId =
+    (await getLinkedAppConfig(undefined, false))?.id || integrationID;
+
   // to make this more testable, we should split this out into its own function
   const analyticsBody = {
     command,
     isValidCommand,
-    numArgs: argNames.length,
-    flags: {
-      ...flags,
-      ...(command === 'help' ? { helpCommand: argNames[0] } : {}), // include the beginning of args so we know what they want help on
-    },
+    numArgs: argKeys.length,
+    appId: linkedAppId,
+    argsKeys: argKeys,
+    flagKeys: flagKeys,
     cliVersion: pkg.version,
     os: shouldRecordAnonymously ? undefined : process.platform,
   };

package/src/utils/api.js

@@ -95,7 +95,7 @@ const callAPI = async (
     }
   }
 
-  debug(`>> ${requestOptions.method} ${requestOptions.url}`);
+  debug(`>> ${requestOptions.method} ${requestOptions.url || res.url}`);
 
   if (requestOptions.body) {
     const replacementStr = 'raw zip removed in logs';

package/src/version-store.js

@@ -17,4 +17,5 @@ module.exports = [
   { nodeVersion: '14', npmVersion: '>=5.6.0' }, // 12.x
   { nodeVersion: '16', npmVersion: '>=5.6.0' }, // 13.x
   { nodeVersion: '18', npmVersion: '>=5.6.0' }, // 15.x
+  { nodeVersion: '18', npmVersion: '>=10.7.0' }, // 16.x
 ];