zapier-platform-cli 17.2.0 → 17.3.1

package/oclif.manifest.json

@@ -58,14 +58,13 @@
       "description": "Build a pushable zip from the current directory.\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via esbuild (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier upload`.",
       "flags": {
         "disable-dependency-detection": {
-          "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
+          "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
           "name": "disable-dependency-detection",
           "allowNo": false,
           "type": "boolean"
         },
         "skip-npm-install": {
-          "description": "Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.",
-          "hidden": true,
+          "description": "Skips installing a fresh copy of npm dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.",
           "name": "skip-npm-install",
           "allowNo": false,
           "type": "boolean"
@@ -226,7 +225,7 @@
           "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\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.",
+      "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\nThe deprecation date must be at least 3 weeks days in the future. Zapier will send emails warning users of the deprecation exactly 14 days before the configured deprecation date. This gives you 1 week to migrate users to a newer version, if possible, before we notify them that they need to do so themselves.\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 --reason=security_vulnerability",
@@ -1178,14 +1177,13 @@
       "description": "Build and upload the current integration.\n\nThis command is the same as running `zapier build` and `zapier upload` in sequence. See those for more info.",
       "flags": {
         "disable-dependency-detection": {
-          "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
+          "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by your entry point (`index.js` by default). If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
           "name": "disable-dependency-detection",
           "allowNo": false,
           "type": "boolean"
         },
         "skip-npm-install": {
-          "description": "Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.",
-          "hidden": true,
+          "description": "Skips installing a fresh copy of npm dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.",
           "name": "skip-npm-install",
           "allowNo": false,
           "type": "boolean"
@@ -1695,88 +1693,6 @@
         "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": {
@@ -1940,6 +1856,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": {
@@ -2495,5 +2493,5 @@
       ]
     }
   },
-  "version": "17.2.0"
+  "version": "17.3.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.2.0",
+  "version": "17.3.1",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -19,7 +19,7 @@
     "/oclif.manifest.json"
   ],
   "engines": {
-    "node": ">=18.18"
+    "node": ">=18.20"
   },
   "scripts": {
     "docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js",
@@ -46,6 +46,7 @@
     "@oclif/plugin-not-found": "3.2.51",
     "@oclif/plugin-version": "2.2.28",
     "adm-zip": "0.5.16",
+    "decompress": "4.2.1",
     "archiver": "7.0.1",
     "chrono-node": "2.8.0",
     "cli-table3": "0.6.5",
@@ -59,12 +60,10 @@
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
     "jscodeshift": "^17.3.0",
-    "klaw": "4.1.0",
     "lodash": "4.17.21",
     "luxon": "3.6.1",
     "marked": "14.1.4",
     "marked-terminal": "7.2.1",
-    "minimatch": "9.0.3",
     "node-fetch": "2.7.0",
     "open": "10.1.2",
     "ora": "5.4.0",
@@ -85,7 +84,6 @@
     "@types/jscodeshift": "^0.12.0",
     "@types/mocha": "^10.0.9",
     "chai": "^4.3.7",
-    "decompress": "4.2.1",
     "mock-fs": "^5.5.0",
     "nock": "^14.0.4",
     "oclif": "^4.17.46",

package/src/constants.js

@@ -1,5 +1,6 @@
-const os = require('os');
-const path = require('path');
+const os = require('node:os');
+const path = require('node:path');
+
 const versionStore = require('./version-store');
 
 const BASE_ENDPOINT = process.env.ZAPIER_BASE_ENDPOINT || 'https://zapier.com';
@@ -17,13 +18,6 @@ const BUILD_DIR = 'build';
 const DEFINITION_PATH = `${BUILD_DIR}/definition.json`;
 const BUILD_PATH = `${BUILD_DIR}/build.zip`;
 const SOURCE_PATH = `${BUILD_DIR}/source.zip`;
-const BLOCKLISTED_PATHS = [
-  // Will be excluded from build.zip and source.zip
-  '.git',
-  '.env',
-  '.environment',
-  'build',
-];
 const NODE_VERSION = versionStore[versionStore.length - 1].nodeVersion;
 const LAMBDA_VERSION = `v${NODE_VERSION}`;
 const NODE_VERSION_CLI_REQUIRES = '>=18'; // should be the oldest non-ETL version
@@ -91,7 +85,6 @@ module.exports = {
   AUTH_LOCATION,
   AUTH_LOCATION_RAW,
   BASE_ENDPOINT,
-  BLOCKLISTED_PATHS,
   BUILD_DIR,
   BUILD_PATH,
   CHECK_REF_DOC_LINK,

package/src/oclif/commands/build.js

@@ -8,33 +8,41 @@ const {
 } = require('../../constants');
 
 const { buildAndOrUpload } = require('../../utils/build');
+const colors = require('colors/safe');
 
 class BuildCommand extends BaseCommand {
   async perform() {
+    const skipNpmInstall = this.flags['skip-npm-install'];
     await buildAndOrUpload(
       { build: true },
       {
-        skipNpmInstall: this.flags['skip-npm-install'],
+        skipNpmInstall,
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
       },
     );
 
     this.log(
-      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}. Try the \`zapier upload\` command now.`,
+      `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}.\n` +
+        `Now you can upload them with the ${colors.bold.underline('zapier upload')} command.`,
     );
+
+    if (!skipNpmInstall) {
+      this.log(
+        `\nTip: Try ${colors.bold.underline('zapier build --skip-npm-install')} for faster builds.`,
+      );
+    }
   }
 }
 
 BuildCommand.flags = buildFlags({
   commandFlags: {
     'disable-dependency-detection': Flags.boolean({
-      description: `Disable "smart" file inclusion. By default, Zapier only includes files that are required by \`index.js\`. If you (or your dependencies) require files dynamically (such as with \`require(someVar)\`), then you may see "Cannot find module" errors. Disabling this may make your \`build.zip\` too large. If that's the case, try using the \`includeInBuild\` option in your \`${CURRENT_APP_FILE}\`. See the docs about \`includeInBuild\` for more info.`,
+      description: `Disable "smart" file inclusion. By default, Zapier only includes files that are required by your entry point (\`index.js\` by default). If you (or your dependencies) require files dynamically (such as with \`require(someVar)\`), then you may see "Cannot find module" errors. Disabling this may make your \`build.zip\` too large. If that's the case, try using the \`includeInBuild\` option in your \`${CURRENT_APP_FILE}\`. See the docs about \`includeInBuild\` for more info.`,
     }),
     'skip-npm-install': Flags.boolean({
       description:
-        'Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.',
-      hidden: true,
+        'Skips installing a fresh copy of npm dependencies for shorter build time. Helpful for using yarn, pnpm, or local copies of dependencies.',
     }),
     'skip-validation': Flags.boolean({
       description:

package/src/oclif/commands/deprecate.js

@@ -63,9 +63,9 @@ class DeprecateCommand extends BaseCommand {
     if (
       !this.flags.force &&
       !(await this.confirm(
-        'Are you sure you want to deprecate this version? This will notify users that their Zaps or other automations will stop working after the specified date.' +
+        'Are you sure you want to deprecate this version? Only do so if it would start to fail otherwise. We will notify users that their Zaps or other automations will stop working two weeks before the specified date.' +
           (hasActiveUsers
-            ? `\n\nThis version has ${versionInfo.user_count} active user(s). Strongly consider migrating users to another version before deprecating!`
+            ? `\n\nThis version has ${versionInfo.user_count} active user(s) via Zaps. Strongly consider migrating users to another version at least two weeks before the deprecation date!`
             : ''),
       ))
     ) {
@@ -129,7 +129,7 @@ Use this when an integration version will not be supported or start breaking at
 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.
+The deprecation date must be at least 3 weeks days in the future. Zapier will send emails warning users of the deprecation exactly 14 days before the configured deprecation date. This gives you 1 week to migrate users to a newer version, if possible, before we notify them that they need to do so themselves.
 
 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/oclif/commands/push.js

@@ -1,6 +1,7 @@
 const ZapierBaseCommand = require('../ZapierBaseCommand');
 const { BUILD_PATH, SOURCE_PATH } = require('../../constants');
 const { Flags } = require('@oclif/core');
+const colors = require('colors/safe');
 
 const BuildCommand = require('./build');
 
@@ -8,10 +9,11 @@ const { buildAndOrUpload } = require('../../utils/build');
 
 class PushCommand extends ZapierBaseCommand {
   async perform() {
+    const skipNpmInstall = this.flags['skip-npm-install'];
     await buildAndOrUpload(
       { build: true, upload: true },
       {
-        skipNpmInstall: this.flags['skip-npm-install'],
+        skipNpmInstall,
         disableDependencyDetection: this.flags['disable-dependency-detection'],
         skipValidation: this.flags['skip-validation'],
         overwritePartnerChanges: this.flags['overwrite-partner-changes'],
@@ -20,6 +22,12 @@ class PushCommand extends ZapierBaseCommand {
     this.log(
       `\nPush complete! Built ${BUILD_PATH} and ${SOURCE_PATH} and uploaded them to Zapier.`,
     );
+
+    if (!skipNpmInstall) {
+      this.log(
+        `\nTip: Try ${colors.bold.underline('zapier push --skip-npm-install')} for faster builds.`,
+      );
+    }
   }
 }