zapier-platform-cli 17.5.0 → 17.7.0

package/oclif.manifest.json

@@ -652,6 +652,13 @@
           "multiple": false,
           "type": "option"
         },
+        "paging-token": {
+          "description": "Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which page of items you should fetch.",
+          "name": "paging-token",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1719,10 +1726,12 @@
           "required": true
         }
       },
-      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
+      "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nTo canary traffic for a specific user, use the --user flag.\n\nTo canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.\n\nTo canary traffic for a specific user within a specific account, use both --user and --account-id flags.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
       "examples": [
-        "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
-        "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
+        "zapier canary:create 1.0.0 1.1.0 -p 10 -d 3600",
+        "zapier canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com",
+        "zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com",
+        "zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345"
       ],
       "flags": {
         "percent": {
@@ -1743,6 +1752,29 @@
           "multiple": false,
           "type": "option"
         },
+        "user": {
+          "char": "u",
+          "description": "Canary this user (email) across all accounts, unless `account-id` is specified.",
+          "name": "user",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "account-id": {
+          "char": "a",
+          "description": "The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.",
+          "name": "account-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force-include-all": {
+          "char": "f",
+          "description": "Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.",
+          "name": "force-include-all",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1868,88 +1900,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": {
@@ -2126,6 +2076,88 @@
         "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"
@@ -2505,5 +2537,5 @@
       ]
     }
   },
-  "version": "17.5.0"
+  "version": "17.7.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.5.0",
+  "version": "17.7.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -25,16 +25,16 @@
     "docs": "ZAPIER_BASE_ENDPOINT='' node scripts/docs.js",
     "preversion": "git pull && yarn validate",
     "prepack": "oclif manifest",
-    "postpack": "rm -f oclif.manifest.json",
+    "postpack": "rimraf oclif.manifest.json",
     "precommit": "yarn docs && git add docs",
     "version": "yarn docs && git add docs/*",
     "postversion": "git push && git push --tags",
     "lint": "eslint src",
     "lint:fix": "eslint --fix src",
-    "test": "cross-env NODE_ENV=test mocha -t 50s --recursive src/tests --exit",
-    "test:debug": "cross-env NODE_ENV=test node inspect ../../node_modules/.bin/mocha -t 50s --recursive src/tests --exit",
-    "smoke-test": "cross-env NODE_ENV=test mocha -t 2m --recursive src/smoke-tests --exit",
-    "smoke-test:debug": "cross-env NODE_ENV=test node inspect ../../node_modules/.bin/mocha -t 2m --recursive src/smoke-tests --exit",
+    "test": "cross-env NODE_ENV=test mocha -t 200s --recursive src/tests --exit",
+    "test:debug": "cross-env NODE_ENV=test node inspect ../../node_modules/.bin/mocha -t 200s --recursive src/tests --exit",
+    "smoke-test": "cross-env NODE_ENV=test mocha -t 6m --recursive src/smoke-tests --exit",
+    "smoke-test:debug": "cross-env NODE_ENV=test node inspect ../../node_modules/.bin/mocha -t 6m --recursive src/smoke-tests --exit",
     "validate-templates": "./scripts/validate-app-templates.js",
     "set-template-versions": "./scripts/set-app-template-versions.js",
     "validate": "yarn test && yarn smoke-test && yarn lint"
@@ -46,12 +46,12 @@
     "@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",
     "colors": "1.4.0",
     "debug": "4.4.0",
+    "decompress": "4.2.1",
     "dotenv": "16.5.0",
     "esbuild": "0.25.4",
     "fs-extra": "11.2.0",
@@ -73,7 +73,7 @@
     "semver": "7.7.1",
     "string-length": "4.0.2",
     "through2": "4.0.2",
-    "tmp": "0.2.3",
+    "tmp": "0.2.4",
     "traverse": "0.6.11",
     "update-notifier": "5.1.0",
     "yeoman-environment": "3.19.3",
@@ -87,6 +87,7 @@
     "mock-fs": "^5.5.0",
     "nock": "^14.0.4",
     "oclif": "^4.17.46",
+    "rimraf": "^5.0.10",
     "typescript": "^5.8.3",
     "yamljs": "0.3.0"
   },

package/src/oclif/commands/canary/create.js

@@ -8,6 +8,9 @@ class CanaryCreateCommand extends ZapierBaseCommand {
     const { versionFrom, versionTo } = this.args;
     const percent = this.flags.percent;
     const duration = this.flags.duration;
+    const user = this.flags.user;
+    const accountId = this.flags['account-id'];
+    const forceIncludeAll = this.flags['force-include-all'];
 
     this.validateVersions(versionFrom, versionTo);
     this.validatePercent(percent);
@@ -25,13 +28,34 @@ If you would like to stop this canary now, run \`zapier canary:delete ${existing
       return;
     }
 
-    this.startSpinner(`Creating canary deployment
+    let createCanaryMessage = `Creating canary deployment
     - From version: ${versionFrom}
     - To version: ${versionTo}
-    - Traffic amount: ${percent}%
-    - Duration: ${duration} seconds`);
+    - Percentage: ${percent}%
+    - Duration: ${duration} seconds`;
 
-    await createCanary(versionFrom, versionTo, percent, duration);
+    const body = {
+      percent,
+      duration,
+    };
+
+    if (user) {
+      body.user = user;
+      createCanaryMessage += `\n    - User: ${user}`;
+    }
+
+    if (accountId) {
+      body.account_id = parseInt(accountId);
+      createCanaryMessage += `\n    - Account ID: ${accountId}`;
+    }
+
+    if (forceIncludeAll) {
+      body.force_include_all = true;
+      createCanaryMessage += `\n    - Force Include All: true`;
+    }
+
+    this.startSpinner(createCanaryMessage);
+    await createCanary(versionFrom, versionTo, body);
 
     this.stopSpinner();
     this.log('Canary deployment created successfully.');
@@ -71,6 +95,21 @@ CanaryCreateCommand.flags = buildFlags({
       description: 'Duration of the canary in seconds',
       required: true,
     }),
+    user: Flags.string({
+      char: 'u',
+      description:
+        'Canary this user (email) across all accounts, unless `account-id` is specified.',
+    }),
+    'account-id': Flags.string({
+      char: 'a',
+      description:
+        'The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.',
+    }),
+    'force-include-all': Flags.boolean({
+      char: 'f',
+      description:
+        'Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.',
+    }),
   },
 });
 
@@ -89,13 +128,21 @@ CanaryCreateCommand.description = `Create a new canary deployment, diverting a s
 
 Only one canary can be active at the same time. You can run \`zapier canary:list\` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using \`zapier canary:delete a.b.c x.y.z\`.
 
+To canary traffic for a specific user, use the --user flag.
+
+To canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.
+
+To canary traffic for a specific user within a specific account, use both --user and --account-id flags.
+
 Note: this is similar to \`zapier migrate\` but different in that this is temporary and will "revert" the changes once the specified duration is expired.
 
 **Only use this command to canary traffic between non-breaking versions!**`;
 
 CanaryCreateCommand.examples = [
-  'zapier canary:create 1.0.0 1.1.0 -p 25 -d 720',
-  'zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300',
+  'zapier canary:create 1.0.0 1.1.0 -p 10 -d 3600',
+  'zapier canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com',
+  'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com',
+  'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345',
 ];
 CanaryCreateCommand.skipValidInstallCheck = true;
 

package/src/oclif/commands/canary/list.js

@@ -12,6 +12,8 @@ class CanaryListCommand extends ZapierBaseCommand {
       to_version: c.to_version,
       percent: c.percent,
       seconds_remaining: c.until_timestamp - Math.floor(Date.now() / 1000),
+      user: c.user,
+      account_id: c.account_id,
     }));
 
     this.log(bold('Active Canaries') + '\n');
@@ -22,6 +24,8 @@ class CanaryListCommand extends ZapierBaseCommand {
         ['To Version', 'to_version'],
         ['Traffic Amount', 'percent'],
         ['Seconds Remaining', 'seconds_remaining'],
+        ['User', 'user'],
+        ['Account ID', 'account_id'],
       ],
       emptyMessage: grey(`No active canary deployments found.`),
     });

package/src/oclif/commands/invoke.js

@@ -59,7 +59,14 @@ const loadAuthDataFromEnv = () => {
     .filter(([k, v]) => k.startsWith(AUTH_FIELD_ENV_PREFIX))
     .reduce((authData, [k, v]) => {
       const fieldKey = k.substr(AUTH_FIELD_ENV_PREFIX.length);
-      authData[fieldKey] = v;
+      // Try to parse as JSON if it looks like JSON, otherwise keep as string
+      try {
+        authData[fieldKey] =
+          v.startsWith('{') || v.startsWith('[') ? JSON.parse(v) : v;
+      } catch (e) {
+        // If JSON parsing fails, keep as string
+        authData[fieldKey] = v;
+      }
       return authData;
     }, {});
 };
@@ -237,7 +244,10 @@ const appendEnv = async (vars, prefix = '') => {
     '.env',
     Object.entries(vars)
       .filter(([k, v]) => v !== undefined)
-      .map(([k, v]) => `${prefix}${k}='${v || ''}'\n`),
+      .map(
+        ([k, v]) =>
+          `${prefix}${k}='${typeof v === 'object' && v !== null ? JSON.stringify(v) : v || ''}'\n`,
+      ),
   );
 };
 
@@ -1303,6 +1313,7 @@ class InvokeCommand extends BaseCommand {
         isPopulatingDedupe: this.flags.isPopulatingDedupe,
         limit: this.flags.limit,
         page: this.flags.page,
+        paging_token: this.flags['paging-token'],
         isTestingAuth: false, // legacy property
       };
       const output = await this.invokeAction(
@@ -1382,6 +1393,10 @@ InvokeCommand.flags = buildFlags({
       description:
         'EXPERIMENTAL: Instead of using the local .env file, use the production authentication data with the given authentication ID (aka the "app connection" on Zapier). Find them at https://zapier.com/app/assets/connections (https://zpr.io/z8SjFTdnTFZ2 for instructions) or specify \'-\' to interactively select one from your available authentications. When specified, the code will still run locally, but all outgoing requests will be proxied through Zapier with the production auth data.',
     }),
+    'paging-token': Flags.string({
+      description:
+        'Set bundle.meta.paging_token. Used for search pagination or bulk reads. When used in production, this indicates which page of items you should fetch.',
+    }),
   },
 });
 

package/src/oclif/commands/pull.js

@@ -6,10 +6,18 @@ const yeoman = require('yeoman-environment');
 const ZapierBaseCommand = require('../ZapierBaseCommand');
 const { downloadSourceZip } = require('../../utils/api');
 const { ensureDir, makeTempDir, removeDirSync } = require('../../utils/files');
-const { listFiles } = require('../../utils/build');
+const { walkDirWithPresetBlocklist } = require('../../utils/build');
 const { buildFlags } = require('../buildFlags');
 const PullGenerator = require('../../generators/pull');
 
+const listFiles = (dir) => {
+  const relPaths = [];
+  for (const entry of walkDirWithPresetBlocklist(dir)) {
+    relPaths.push(path.join(path.relative(dir, entry.parentPath), entry.name));
+  }
+  return relPaths;
+};
+
 class PullCommand extends ZapierBaseCommand {
   async perform() {
     // Fetch the source zip from API
@@ -28,7 +36,7 @@ class PullCommand extends ZapierBaseCommand {
 
       // Prompt user to confirm overwrite
       const currentDir = process.cwd();
-      const sourceFiles = await listFiles(srcDst);
+      const sourceFiles = listFiles(srcDst);
 
       const env = yeoman.createEnv();
       const namespace = 'zapier:pull';

package/src/utils/api.js

@@ -154,17 +154,14 @@ const createCredentials = (username, password, totpCode) => {
   );
 };
 
-const createCanary = async (versionFrom, versionTo, percent, duration) => {
+const createCanary = async (versionFrom, versionTo, body) => {
   const linkedAppId = (await getLinkedAppConfig(undefined, true))?.id;
 
   return callAPI(
     `/apps/${linkedAppId}/versions/${versionFrom}/canary-to/${versionTo}`,
     {
       method: 'POST',
-      body: {
-        percent,
-        duration,
-      },
+      body,
     },
   );
 };

package/src/utils/build.js

@@ -272,13 +272,28 @@ const countLeadingDoubleDots = (relPath) => {
 // Join all relPaths with workingDir and return the common ancestor directory.
 const findCommonAncestor = (workingDir, relPaths) => {
   let maxLeadingDoubleDots = 0;
-  for (const relPath of relPaths) {
-    maxLeadingDoubleDots = Math.max(
-      maxLeadingDoubleDots,
-      countLeadingDoubleDots(relPath),
-    );
-  }
 
+  if (isWindows()) {
+    for (const relPath of relPaths) {
+      if (relPath.match(/^[a-zA-Z]:/)) {
+        // On Windows, relPath can be absolute if it starts with a different
+        // drive letter than workingDir.
+        return 'C:\\';
+      } else {
+        maxLeadingDoubleDots = Math.max(
+          maxLeadingDoubleDots,
+          countLeadingDoubleDots(relPath),
+        );
+      }
+    }
+  } else {
+    for (const relPath of relPaths) {
+      maxLeadingDoubleDots = Math.max(
+        maxLeadingDoubleDots,
+        countLeadingDoubleDots(relPath),
+      );
+    }
+  }
   let commonAncestor = workingDir;
   for (let i = 0; i < maxLeadingDoubleDots; i++) {
     commonAncestor = path.dirname(commonAncestor);
@@ -286,6 +301,10 @@ const findCommonAncestor = (workingDir, relPaths) => {
   return commonAncestor;
 };
 
+const stripDriveLetterForZip = (pathStr) => {
+  return pathStr.replace(/^[cC]:\\/, '').replace(/^([a-zA-Z]):/, '$1');
+};
+
 const writeBuildZipDumbly = async (workingDir, zip) => {
   for (const entry of walkDirWithPresetBlocklist(workingDir)) {
     const absPath = path.resolve(entry.parentPath, entry.name);
@@ -350,7 +369,7 @@ const writeBuildZipSmartly = async (workingDir, zip) => {
   // Write required files to the zip
   for (const relPath of relPaths) {
     const absPath = path.resolve(workingDir, relPath);
-    const nameInZip = path.relative(zipRoot, absPath);
+    const nameInZip = stripDriveLetterForZip(path.relative(zipRoot, absPath));
     if (nameInZip === 'package.json' && zipRoot !== workingDir) {
       // Ignore workspace root's package.json
       continue;
@@ -388,10 +407,10 @@ const writeBuildZipSmartly = async (workingDir, zip) => {
         symlink.parentPath,
         symlink.name,
       );
-      const nameInZip = path.relative(zipRoot, absPath);
+      const nameInZip = stripDriveLetterForZip(path.relative(zipRoot, absPath));
       const targetInZip = path.relative(
-        symlink.parentPath,
-        fs.realpathSync(absPath),
+        stripDriveLetterForZip(symlink.parentPath),
+        stripDriveLetterForZip(fs.realpathSync(absPath)),
       );
       zip.symlink(nameInZip, targetInZip, 0o644);
     }