zapier-platform-cli 18.5.1 → 19.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Zapier Platform CLI
 
-This is the `zapier` CLI, which you can use to build integrations with Zapier.
+This is the `zapier-platform` CLI, which you can use to build integrations with Zapier.
 
 For documentation:
 
@@ -10,4 +10,6 @@ For documentation:
 
 ## Development
 
+The published CLI exposes the **`zapier-platform`** command only (as of v19). The legacy **`zapier`** binary has been removed.
+
 See [CONTRIBUTING.md](https://github.com/zapier/zapier-platform/blob/main/CONTRIBUTING.md) and [ARCHITECTURE.md](https://github.com/zapier/zapier-platform/blob/main/packages/cli/ARCHITECTURE.md) of this package in particular.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "18.5.1",
+  "version": "19.0.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -72,7 +72,6 @@
     "yamljs": "0.3.0"
   },
   "bin": {
-    "zapier": "./src/bin/run",
     "zapier-platform": "./src/bin/run"
   },
   "oclif": {

package/src/bin/run

@@ -1,30 +1,6 @@
 #!/usr/bin/env node
 
-const path = require('node:path');
-
 (async () => {
   const oclif = await import('@oclif/core');
   await oclif.execute({ development: false, dir: __dirname });
-
-  // Show deprecation warning for the old "zapier" binary name
-  // Users can suppress this warning by setting ZAPIER_SUPPRESS_DEPRECATION_WARNING
-  if (!process.env.ZAPIER_SUPPRESS_DEPRECATION_WARNING) {
-    const msg =
-      'The "zapier" command is deprecated and will be removed in a future version. ' +
-      'Please use "zapier-platform" instead.\n' +
-      'To suppress this warning, set ZAPIER_SUPPRESS_DEPRECATION_WARNING in your environment.\n';
-    
-    if (process.platform === 'win32') {
-      // On Windows, we cannot reliably detect which wrapper was invoked (zapier vs zapier-platform)
-      // because both wrappers point to the same script. Show a generic deprecation notice instead of a warning..
-      console.warn('\n[DEPRECATION NOTICE] ' + msg);
-    } else {
-      // On Unix, we can detect which symlink was used
-      const scriptPath = process.argv[1] || '';
-      const binName = path.basename(scriptPath, path.extname(scriptPath));
-      if (binName === 'zapier') {
-        console.warn('\n[DEPRECATION WARNING] ' + msg);
-      }
-    }
-  }
 })();

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

@@ -98,10 +98,10 @@ This integration uses the [Star Wars API](https://swapi.dev/) to demonstrate:
 npm install
 
 # Run tests
-zapier test
+zapier-platform test
 
 # Push to Zapier
-zapier push
+zapier-platform push
 ```
 
 Find out more on the latest docs: https://docs.zapier.com/platform

package/src/generators/templates/openai/README.md

@@ -1,3 +1,3 @@
 # OpenAI
 
-This Zapier integration project is generated by the `zapier init` CLI command. This integration in particular is using the OpenAI API to generate responses to prompts from users. For this integration, there is a `constants.js` file that will allow you to swap out the base URL and version of the API to swap if you are using an OpenAI compatible API to get started.
+This Zapier integration project is generated by the `zapier-platform init` CLI command. This integration in particular is using the OpenAI API to generate responses to prompts from users. For this integration, there is a `constants.js` file that will allow you to swap out the base URL and version of the API to swap if you are using an OpenAI compatible API to get started.

package/src/oclif/commands/invoke/auth/render.js

@@ -0,0 +1,31 @@
+const { customLogger } = require('../logger');
+const { localAppCommand } = require('../../../../utils/local');
+
+/**
+ * Renders the auth template with real credentials from context.authData.
+ * @param {Object} context - The execution context with authData
+ * @returns {Promise<*>} The rendered auth template result
+ */
+const renderAuth = async (context) => {
+  try {
+    const result = await localAppCommand({
+      command: 'renderAuthTemplate',
+      bundle: {
+        authData: context.authData,
+      },
+      customLogger,
+      calledFromCliInvoke: true,
+    });
+    return result;
+  } catch (err) {
+    if (err.message && err.message.includes('Unexpected command')) {
+      throw new Error(
+        '`auth render` requires latest version of zapier-platform-core. ' +
+          'Upgrade zapier-platform-core in your dependencies.',
+      );
+    }
+    throw err;
+  }
+};
+
+module.exports = { renderAuth };

package/src/oclif/commands/invoke/auth/template.js

@@ -0,0 +1,30 @@
+const { customLogger } = require('../logger');
+const { localAppCommand } = require('../../../../utils/local');
+
+/**
+ * Gets the auth template for the current app. No credentials needed.
+ * Returns a template with {{bundle.authData.X}} placeholders.
+ * @param {Object} context - The execution context
+ * @returns {Promise<*>} The auth template result
+ */
+const templateAuth = async (context) => {
+  try {
+    const result = await localAppCommand({
+      command: 'getAuthTemplate',
+      bundle: {},
+      customLogger,
+      calledFromCliInvoke: true,
+    });
+    return result;
+  } catch (err) {
+    if (err.message && err.message.includes('Unexpected command')) {
+      throw new Error(
+        '`auth template` requires latest version of zapier-platform-core. ' +
+          'Upgrade zapier-platform-core in your dependencies.',
+      );
+    }
+    throw err;
+  }
+};
+
+module.exports = { templateAuth };

package/src/oclif/commands/invoke/index.js

@@ -17,6 +17,8 @@ const {
   appendEnv,
 } = require('./env');
 const { startAuth, testAuth, getAuthLabel, refreshAuth } = require('./auth');
+const { templateAuth } = require('./auth/template');
+const { renderAuth } = require('./auth/render');
 const { invokeAction } = require('./action');
 const { promptForAuthentication } = require('./prompts');
 
@@ -119,7 +121,14 @@ class InvokeCommand extends BaseCommand {
         throw new Error('You must specify ACTIONKEY in non-interactive mode.');
       }
       if (context.actionType === 'auth') {
-        const actionKeys = ['label', 'refresh', 'start', 'test'];
+        const actionKeys = [
+          'label',
+          'refresh',
+          'render',
+          'start',
+          'template',
+          'test',
+        ];
         context.actionKey = await this.promptWithList(
           'Which auth operation would you like to invoke?',
           actionKeys,
@@ -176,6 +185,18 @@ class InvokeCommand extends BaseCommand {
       }
     }
 
+    // Reject unsupported flags early for template/render commands
+    if (
+      context.actionType === 'auth' &&
+      (context.actionKey === 'template' || context.actionKey === 'render') &&
+      (context.remote || context.authId)
+    ) {
+      throw new Error(
+        `The \`--remote\` and \`--authentication-id\` flags are not applicable to \`auth ${context.actionKey}\`. ` +
+          'This command runs locally using auth data from the .env file.',
+      );
+    }
+
     if (context.authId && !context.remote) {
       // Fill authData with curlies if we're in relay mode
       const authFields = context.appDefinition.authentication.fields || [];
@@ -191,6 +212,31 @@ class InvokeCommand extends BaseCommand {
     // gives the developer an option to override the values in bundle.authData.
     context.authData = { ...context.authData, ...loadAuthDataFromEnv() };
 
+    // `auth render` accepts a positional JSON-encoded authData arg whose
+    // values take precedence over .env. Useful for one-off rendering
+    // without touching the .env file.
+    if (this.args.authData) {
+      if (context.actionType !== 'auth' || context.actionKey !== 'render') {
+        throw new Error(
+          'The authData positional argument is only supported by `auth render`.',
+        );
+      }
+      let parsed;
+      try {
+        parsed = JSON.parse(this.args.authData);
+      } catch (err) {
+        throw new Error(`Failed to parse authData as JSON: ${err.message}`);
+      }
+      if (
+        parsed === null ||
+        typeof parsed !== 'object' ||
+        Array.isArray(parsed)
+      ) {
+        throw new Error('authData must be a JSON object.');
+      }
+      context.authData = { ...context.authData, ...parsed };
+    }
+
     if (context.actionType === 'auth') {
       switch (context.actionKey) {
         case 'start': {
@@ -253,10 +299,20 @@ class InvokeCommand extends BaseCommand {
           }
           return;
         }
+        case 'template': {
+          const output = await templateAuth(context);
+          console.log(JSON.stringify(output, null, 2));
+          return;
+        }
+        case 'render': {
+          const output = await renderAuth(context);
+          console.log(JSON.stringify(output, null, 2));
+          return;
+        }
         default:
           throw new Error(
             `Unknown auth operation "${context.actionKey}". ` +
-              'The options are "label", "refresh", "start", and "test". \n',
+              'The options are "label", "refresh", "render", "start", "template", and "test". \n',
           );
       }
     } else {
@@ -377,6 +433,13 @@ InvokeCommand.args = {
     description:
       'The trigger/action key you want to invoke. If ACTIONTYPE is "auth", this can be "label", "refresh", "start", or "test".',
   }),
+  authData: Args.string({
+    description:
+      'Only used by `auth render`. JSON-encoded object with auth field values (e.g. `\'{"access_token":"a_token"}\'`). Values here take precedence over the .env file.',
+    // Don't auto-fill from piped stdin — that breaks `--inputData @-` usage
+    // for non-auth actions, which pipes into stdin for inputData.
+    ignoreStdin: true,
+  }),
 };
 
 InvokeCommand.examples = [
@@ -394,6 +457,7 @@ InvokeCommand.examples = [
   'zapier-platform invoke trigger new_recipe --remote',
   'zapier-platform invoke trigger new_recipe -r -a 12345',
   'zapier-platform invoke -r -v 2.0.0 -a -',
+  `zapier-platform invoke auth render '{"access_token":"a_token"}'`,
 ];
 InvokeCommand.description = `Invoke an authentication method, a trigger, or a create/search action locally or remotely.
 

package/src/oclif/hooks/getAppRegistrationFieldChoices.js

@@ -23,7 +23,7 @@ module.exports = async function (options) {
 
   this.config.enumFieldChoices = enumFieldChoices;
 
-  // This enables us to see all available options when running `zapier register --help`
+  // This enables us to see all available options when running `zapier-platform register --help`
   const cmd = options.config.findCommand('register');
   if (cmd && cmd.flags) {
     if (cmd.flags.audience) {

package/src/utils/analytics.js

@@ -37,7 +37,7 @@ const recordAnalytics = async (command, isValidCommand, args, flags) => {
   );
   const integrationID = integrationIDKey ? args[integrationIDKey] : undefined;
 
-  // Some commands ( like "zapier convert" ) won't have an app directory when called.
+  // Some commands ( like "zapier-platform 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

package/src/utils/api.js

@@ -31,7 +31,7 @@ const readCredentials = (explodeIfMissing = true) => {
     return Promise.resolve(
       readFile(
         constants.AUTH_LOCATION,
-        `Please run \`${colors.cyan('zapier login')}\`.`,
+        `Please run \`${colors.cyan('zapier-platform login')}\`.`,
       )
         .then((buf) => {
           return JSON.parse(buf.toString());
@@ -236,9 +236,9 @@ const getWritableApp = async () => {
   if (!linkedAppConfig.id) {
     throw new Error(
       `This project hasn't yet been associated with an existing Zapier integration.\n\nIf it's a brand new integration, run \`${colors.cyan(
-        'zapier register',
+        'zapier-platform register',
       )}\`.\n\nIf this project already exists in your Zapier account, run \`${colors.cyan(
-        'zapier link',
+        'zapier-platform link',
       )}\` instead.`,
     );
   }
@@ -255,7 +255,7 @@ const getWritableApp = async () => {
       throw new Error(
         `Your credentials are present, but invalid${
           process.env.ZAPIER_BASE_ENDPOINT ? ' in this environment' : ''
-        }. Please run \`${colors.cyan('zapier login')}\` to resolve.`,
+        }. Please run \`${colors.cyan('zapier-platform login')}\` to resolve.`,
       );
     } else if (errOrRejectedResponse.status === 404) {
       // if this fails, we know the issue is they can't see this app
@@ -263,12 +263,12 @@ const getWritableApp = async () => {
         linkedAppConfig.id
       } (or it doesn't exist${
         process.env.ZAPIER_BASE_ENDPOINT ? ' in this environment.' : ''
-      }). Try running \`${colors.cyan('zapier link')}\` to correct that.${
+      }). Try running \`${colors.cyan('zapier-platform link')}\` to correct that.${
         process.env.ZAPIER_BASE_ENDPOINT
           ? `\n\nFor local dev: make sure you've run  \`${colors.cyan(
-              'zapier login',
+              'zapier-platform login',
             )}\` and \`${colors.cyan(
-              'zapier register',
+              'zapier-platform register',
             )}\` while providing ZAPIER_BASE_ENDPOINT.`
           : ''
       }`;
@@ -400,9 +400,9 @@ const downloadSourceZip = async (dst) => {
   if (!linkedAppConfig.id) {
     throw new Error(
       `This project hasn't yet been associated with an existing Zapier integration.\n\nIf it's a brand new integration, run \`${colors.cyan(
-        'zapier register',
+        'zapier-platform register',
       )}\`.\n\nIf this project already exists in your Zapier account, run \`${colors.cyan(
-        'zapier link',
+        'zapier-platform link',
       )}\` instead.`,
     );
   }
@@ -439,7 +439,7 @@ const upload = async (
 
   if (!fs.existsSync(fullZipPath)) {
     throw new Error(
-      'Missing a built integration. Try running `zapier build` first.\nAlternatively, run `zapier push`, which will build and upload in one command.',
+      'Missing a built integration. Try running `zapier-platform build` first.\nAlternatively, run `zapier-platform push`, which will build and upload in one command.',
     );
   }
 

package/src/utils/build.js

@@ -492,7 +492,7 @@ const maybeNotifyAboutOutdated = async () => {
           'package.json',
         )} (${colors.grey(notifier.update.current)} → ${colors.green(
           notifier.update.latest,
-        )}) and then running ${colors.red('zapier test')}.`,
+        )}) and then running ${colors.red('zapier-platform test')}.`,
       });
     }
   }
@@ -707,12 +707,12 @@ const _buildFunc = async (
     if (validationErrors.length) {
       debug('\nErrors:\n', validationErrors, '\n');
       throw new Error(
-        'We hit some validation errors, try running `zapier validate` to see them!',
+        'We hit some validation errors, try running `zapier-platform validate` to see them!',
       );
     }
 
     // No need to mention specifically we're validating style checks as that's
-    //   implied from `zapier validate`, though it happens as a separate process
+    //   implied from `zapier-platform validate`, though it happens as a separate process
     const styleChecksResponse = await validateApp(rawDefinition);
 
     if (_.get(styleChecksResponse, ['errors', 'total_failures'])) {
@@ -722,7 +722,7 @@ const _buildFunc = async (
         '\n',
       );
       throw new Error(
-        'We hit some style validation errors, try running `zapier validate` to see them!',
+        'We hit some style validation errors, try running `zapier-platform validate` to see them!',
       );
     }
 
@@ -736,7 +736,7 @@ const _buildFunc = async (
           console.log(colors.yellow(`- ${issue.description}`));
         }
       }
-      console.log(colors.yellow('Run `zapier validate` for more details.'));
+      console.log(colors.yellow('Run `zapier-platform validate` for more details.'));
     }
   } else {
     debug('\nWarning: Skipping Validation');

package/src/utils/check-missing-app-info.js

@@ -18,7 +18,7 @@ module.exports = (app) => {
     throw new Error(
       `Your integration is missing required info (${missingRequiredFields
         .map((field) => field.cliName ?? field.apiName)
-        .join(', ')}). Please, run "zapier register" to add it.`,
+        .join(', ')}). Please, run "zapier-platform register" to add it.`,
     );
   }
 

package/src/utils/local.js

@@ -290,7 +290,7 @@ const getLocalAppHandler = async ({
         );
       } catch (err) {
         err.message =
-          'Your ESM integration requires a compiled `dist/` directory. Run `zapier build` to compile your code first.\n\n' +
+          'Your ESM integration requires a compiled `dist/` directory. Run `zapier-platform build` to compile your code first.\n\n' +
           err.message;
         throw err;
       }

package/src/version-store.js

@@ -20,4 +20,5 @@ module.exports = [
   { nodeVersion: '18', npmVersion: '>=10.7.0' }, // 16.x
   { nodeVersion: '18', npmVersion: '>=10.7.0' }, // 17.x
   { nodeVersion: '22', npmVersion: '>=10.7.0' }, // 18.x
+  { nodeVersion: '22', npmVersion: '>=10.7.0' }, // 19.x
 ];