zapier-platform-cli 15.18.1 → 16.0.0

package/src/utils/auth-files-codegen.js

@@ -43,7 +43,7 @@ const authFileExport = (
     connectionLabel = strLiteral('{{json.username}}'),
     test = objProperty('test'),
     authFields = [],
-  } = {}
+  } = {},
 ) => {
   return exportStatement(
     obj(
@@ -54,49 +54,49 @@ const authFileExport = (
           objProperty('type', strLiteral(authType)),
           ...extraConfigProps,
           comment(
-            "Define any input app's auth requires here. The user will be prompted to enter this info when they connect their account."
+            "Define any input app's auth requires here. The user will be prompted to enter this info when they connect their account.",
           ),
           objProperty('fields', arr(...authFields)),
           comment(
-            "The test method allows Zapier to verify that the credentials a user provides are valid. We'll execute this method whenever a user connects their account for the first time."
+            "The test method allows Zapier to verify that the credentials a user provides are valid. We'll execute this method whenever a user connects their account for the first time.",
           ),
           test,
           comment(
             `This template string can access all the data returned from the auth test. If you return the test object, you'll access the returned data with a label like \`{{json.X}}\`. If you return \`response.data\` from your test, then your label can be \`{{X}}\`. This can also be a function that returns a label. That function has the standard args \`(${standardArgs.join(
-              ', '
-            )})\` and data returned from the test can be accessed in \`bundle.inputData.X\`.`
+              ', ',
+            )})\` and data returned from the test can be accessed in \`bundle.inputData.X\`.`,
           ),
-          objProperty('connectionLabel', connectionLabel)
-        )
+          objProperty('connectionLabel', connectionLabel),
+        ),
       ),
       objProperty('befores', arr(...beforeFuncNames)),
-      objProperty('afters', arr(...afterFuncNames))
-    )
+      objProperty('afters', arr(...afterFuncNames)),
+    ),
   );
 };
 
 const authTestFunc = (testUrl = strLiteral(authJsonUrl('me'))) =>
   block(
     comment(
-      'You want to make a request to an endpoint that is either specifically designed to test auth, or one that every user will have access to. eg: `/me`.'
+      'You want to make a request to an endpoint that is either specifically designed to test auth, or one that every user will have access to. eg: `/me`.',
     ),
     comment(
-      'By returning the entire request object, you have access to the request and response data for testing purposes. Your connection label can access any data from the returned response using the `json.` prefix. eg: `{{json.username}}`.'
+      'By returning the entire request object, you have access to the request and response data for testing purposes. Your connection label can access any data from the returned response using the `json.` prefix. eg: `{{json.username}}`.',
     ),
-    fatArrowReturnFunctionDeclaration('test', standardArgs, zRequest(testUrl))
+    fatArrowReturnFunctionDeclaration('test', standardArgs, zRequest(testUrl)),
   );
 
 const handleBadResponsesFunc = (
   funcName,
-  invalidInfo = 'username and/or password'
+  invalidInfo = 'username and/or password',
 ) =>
   afterMiddlewareFunc(
     funcName,
     ifStatement(
       'response.status === 401',
-      zResponseErr(strLiteral(`The ${invalidInfo} you supplied is incorrect`))
+      zResponseErr(strLiteral(`The ${invalidInfo} you supplied is incorrect`)),
     ),
-    returnStatement(RESPONSE_VAR)
+    returnStatement(RESPONSE_VAR),
   );
 
 const basicAuthFile = () => {
@@ -107,8 +107,8 @@ const basicAuthFile = () => {
     authFileExport(
       'basic',
       '"basic" auth automatically creates "username" and "password" input fields. It also registers default middleware to create the authentication header.',
-      { afterFuncNames: [badFuncName] }
-    )
+      { afterFuncNames: [badFuncName] },
+    ),
   );
 };
 
@@ -118,7 +118,7 @@ const basicAuthFile = () => {
 const beforeMiddlewareFunc = (funcName, ...statements) =>
   block(
     comment(
-      "This function runs before every outbound request. You can have as many as you need. They'll need to each be registered in your index.js file."
+      "This function runs before every outbound request. You can have as many as you need. They'll need to each be registered in your index.js file.",
     ),
     functionDeclaration(
       funcName,
@@ -127,16 +127,16 @@ const beforeMiddlewareFunc = (funcName, ...statements) =>
       // auto include the return if it's not here already
       statements[statements.length - 1].includes('return')
         ? ''
-        : returnStatement('request')
-    )
+        : returnStatement('request'),
+    ),
   );
 
 const afterMiddlewareFunc = (funcName, ...statements) =>
   block(
     comment(
-      "This function runs after every outbound request. You can use it to check for errors or modify the response. You can have as many as you need. They'll need to each be registered in your index.js file."
+      "This function runs after every outbound request. You can use it to check for errors or modify the response. You can have as many as you need. They'll need to each be registered in your index.js file.",
     ),
-    functionDeclaration(funcName, { args: afterMiddlewareArgs }, ...statements)
+    functionDeclaration(funcName, { args: afterMiddlewareArgs }, ...statements),
   );
 
 const includeBearerFunc = (funcName) =>
@@ -147,9 +147,9 @@ const includeBearerFunc = (funcName) =>
       assignmentStatement(
         'request.headers.Authorization',
         // eslint-disable-next-line no-template-curly-in-string
-        interpLiteral('Bearer ${bundle.authData.access_token}')
-      )
-    )
+        interpLiteral('Bearer ${bundle.authData.access_token}'),
+      ),
+    ),
   );
 
 const tokenExchangeFunc = (
@@ -157,7 +157,7 @@ const tokenExchangeFunc = (
   requestUrl,
   bodyProps,
   returnProps,
-  { requestProps = [], returnComments = [] } = {}
+  { requestProps = [], returnComments = [] } = {},
 ) =>
   functionDeclaration(
     funcName,
@@ -169,21 +169,21 @@ const tokenExchangeFunc = (
           strLiteral(requestUrl),
           objProperty('method', strLiteral('POST')),
           objProperty('body', obj(...bodyProps)),
-          ...requestProps
-        )
-      )
+          ...requestProps,
+        ),
+      ),
     ),
     comment(
       "If you're using core v9.x or older, you should call response.throwForStatus() or verify response.status === 200 before you continue.",
-      1
+      1,
     ),
     ...returnComments,
-    returnStatement(obj(...returnProps))
+    returnStatement(obj(...returnProps)),
   );
 
 const oauth2TokenExchangeFunc = (
   funcName,
-  { path, grantType, bodyProps = [], returnComments = [] }
+  { path, grantType, bodyProps = [], returnComments = [] },
 ) => {
   return tokenExchangeFunc(
     funcName,
@@ -209,12 +209,12 @@ const oauth2TokenExchangeFunc = (
           obj(
             objProperty(
               'content-type',
-              strLiteral('application/x-www-form-urlencoded')
-            )
-          )
+              strLiteral('application/x-www-form-urlencoded'),
+            ),
+          ),
         ),
       ],
-    }
+    },
   );
 };
 
@@ -226,14 +226,14 @@ const getAccessTokenFunc = () => {
       comment(
         `Extra data can be pulled from the querystring. For instance:\n${objProperty(
           'accountDomain',
-          'bundle.cleanedRequest.querystring.accountDomain'
-        )}`
+          'bundle.cleanedRequest.querystring.accountDomain',
+        )}`,
       ),
     ],
     grantType: 'authorization_code',
     returnComments: [
       comment(
-        'If your app does an app refresh, then `refresh_token` should be returned here as well'
+        'If your app does an app refresh, then `refresh_token` should be returned here as well',
       ),
     ],
   });
@@ -247,7 +247,7 @@ const refreshTokenFunc = () => {
     returnComments: [
       comment('If the refresh token stays constant, no need to return it.'),
       comment(
-        'If the refresh token does change, return it here to update the stored value in Zapier'
+        'If the refresh token does change, return it here to update the stored value in Zapier',
       ),
     ],
   });
@@ -276,36 +276,36 @@ const oauth2AuthFile = () => {
                 obj(
                   objProperty(
                     'url',
-                    strLiteral(authJsonUrl('oauth/authorize'))
+                    strLiteral(authJsonUrl('oauth/authorize')),
                   ),
                   objProperty(
                     'params',
                     obj(
                       objProperty(
                         'client_id',
-                        strLiteral('{{process.env.CLIENT_ID}}')
+                        strLiteral('{{process.env.CLIENT_ID}}'),
                       ),
                       objProperty(
                         'state',
-                        strLiteral('{{bundle.inputData.state}}')
+                        strLiteral('{{bundle.inputData.state}}'),
                       ),
                       objProperty(
                         'redirect_uri',
-                        strLiteral('{{bundle.inputData.redirect_uri}}')
+                        strLiteral('{{bundle.inputData.redirect_uri}}'),
                       ),
-                      objProperty('response_type', strLiteral('code'))
-                    )
-                  )
-                )
+                      objProperty('response_type', strLiteral('code')),
+                    ),
+                  ),
+                ),
               ),
               objProperty(getOauthAccessTokenFuncName),
               objProperty(refreshOath2AccessTokenFuncName),
-              objProperty('autoRefresh', 'true')
-            )
+              objProperty('autoRefresh', 'true'),
+            ),
           ),
         ],
-      }
-    )
+      },
+    ),
   );
 };
 const customAuthFile = () => {
@@ -323,10 +323,10 @@ const customAuthFile = () => {
         assignmentStatement('request.params.api_key', 'bundle.authData.apiKey'),
         comment(
           'If you want to include the API key in the header instead, uncomment this:',
-          1
+          1,
         ),
-        comment('request.headers.Authorization = bundle.authData.apiKey;')
-      )
+        comment('request.headers.Authorization = bundle.authData.apiKey;'),
+      ),
     ),
     authFileExport(
       'custom',
@@ -338,11 +338,11 @@ const customAuthFile = () => {
           obj(
             objProperty('key', strLiteral('apiKey')),
             objProperty('label', strLiteral('API Key')),
-            objProperty('required', 'true')
+            objProperty('required', 'true'),
           ),
         ],
-      }
-    )
+      },
+    ),
   );
 };
 
@@ -352,15 +352,15 @@ const digestAuthFile = () => {
     // special digest auth
     authTestFunc(
       strLiteral(
-        'https://httpbin.zapier-tooling.com/digest-auth/auth/myuser/mypass'
-      )
+        'https://httpbin.zapier-tooling.com/digest-auth/auth/myuser/mypass',
+      ),
     ),
     handleBadResponsesFunc(badFuncName),
     authFileExport(
       'digest',
       '"digest" auth automatically creates "username" and "password" input fields. It also registers default middleware to create the authentication header.',
-      { afterFuncNames: [badFuncName] }
-    )
+      { afterFuncNames: [badFuncName] },
+    ),
   );
 };
 
@@ -378,10 +378,10 @@ const sessionAuthFile = () => {
       ],
       [
         comment(
-          'FIXME: The `|| "secret"` below is just for demo purposes, you should remove it.'
+          'FIXME: The `|| "secret"` below is just for demo purposes, you should remove it.',
         ),
         objProperty('sessionKey', 'response.data.sessionKey || "secret"'),
-      ]
+      ],
     ),
     beforeMiddlewareFunc(
       includeSessionKeyName,
@@ -390,9 +390,9 @@ const sessionAuthFile = () => {
         assignmentStatement('request.headers', 'request.headers || {}'),
         assignmentStatement(
           "request.headers['X-API-Key']",
-          'bundle.authData.sessionKey'
-        )
-      )
+          'bundle.authData.sessionKey',
+        ),
+      ),
     ),
     authFileExport(
       'session',
@@ -404,24 +404,24 @@ const sessionAuthFile = () => {
           obj(
             objProperty('key', strLiteral('username')),
             objProperty('label', strLiteral('Username')),
-            objProperty('required', 'true')
+            objProperty('required', 'true'),
           ),
           obj(
             objProperty('key', strLiteral('password')),
             objProperty('label', strLiteral('Password')),
             objProperty('required', 'true'),
             comment('this lets the user enter masked data'),
-            objProperty('type', strLiteral('password'))
+            objProperty('type', strLiteral('password')),
           ),
         ],
         extraConfigProps: [
           objProperty(
             'sessionConfig',
-            obj(objProperty('perform', getSessionKeyName))
+            obj(objProperty('perform', getSessionKeyName)),
           ),
         ],
-      }
-    )
+      },
+    ),
   );
 };
 // just different enough from oauth2 that it gets its own function
@@ -440,13 +440,13 @@ const oauth1TokenExchangeFunc = (funcName, url, ...authProperties) => {
             obj(
               objProperty('oauth_consumer_key', 'process.env.CLIENT_ID'),
               objProperty('oauth_consumer_secret', 'process.env.CLIENT_SECRET'),
-              ...authProperties
-            )
-          )
-        )
-      )
+              ...authProperties,
+            ),
+          ),
+        ),
+      ),
     ),
-    returnStatement(`querystring.parse(${RESPONSE_VAR}.content)`)
+    returnStatement(`querystring.parse(${RESPONSE_VAR}.content)`),
   );
 };
 const oauth1AuthFile = () => {
@@ -460,37 +460,37 @@ const oauth1AuthFile = () => {
     block(
       variableAssignmentDeclaration(
         requestTokenVarName,
-        strLiteral('https://trello.com/1/OAuthGetRequestToken')
+        strLiteral('https://trello.com/1/OAuthGetRequestToken'),
       ),
       variableAssignmentDeclaration(
         accessTokenVarName,
-        strLiteral('https://trello.com/1/OAuthGetAccessToken')
+        strLiteral('https://trello.com/1/OAuthGetAccessToken'),
       ),
       variableAssignmentDeclaration(
         authorizeUrlVarName,
-        strLiteral('https://trello.com/1/OAuthAuthorizeToken')
-      )
+        strLiteral('https://trello.com/1/OAuthAuthorizeToken'),
+      ),
     ),
     oauth1TokenExchangeFunc(
       getRequestTokenFuncName,
       requestTokenVarName,
       objProperty('oauth_signature_method', strLiteral('HMAC-SHA1')),
       objProperty('oauth_callback', 'bundle.inputData.redirect_uri'),
-      comment("oauth_version: '1.0' // sometimes required")
+      comment("oauth_version: '1.0' // sometimes required"),
     ),
     oauth1TokenExchangeFunc(
       getOauthAccessTokenFuncName,
       accessTokenVarName,
       objProperty('oauth_token', 'bundle.inputData.oauth_token'),
       objProperty('oauth_token_secret', 'bundle.inputData.oauth_token_secret'),
-      objProperty('oauth_verifier', 'bundle.inputData.oauth_verifier')
+      objProperty('oauth_verifier', 'bundle.inputData.oauth_verifier'),
     ),
     beforeMiddlewareFunc(
       includeAccessTokenFuncName,
       ifStatement(
         'bundle.authData && bundle.authData.oauth_token && bundle.authData.oauth_token_secret',
         comment(
-          'Put your OAuth1 credentials in `req.auth`, Zapier will sign the request for you.'
+          'Put your OAuth1 credentials in `req.auth`, Zapier will sign the request for you.',
         ),
         assignmentStatement(
           'request.auth',
@@ -500,13 +500,13 @@ const oauth1AuthFile = () => {
             objProperty('oauth_token', 'bundle.authData.oauth_token'),
             objProperty(
               'oauth_token_secret',
-              'bundle.authData.oauth_token_secret'
+              'bundle.authData.oauth_token_secret',
             ),
             comment("oauth_version: '1.0', // sometimes required"),
-            objProperty('...(request.auth || {})')
-          )
-        )
-      )
+            objProperty('...(request.auth || {})'),
+          ),
+        ),
+      ),
     ),
     authTestFunc(strLiteral('https://api.trello.com/1/members/me/')),
     authFileExport('oauth1', 'OAuth1 is an older form of OAuth', {
@@ -516,7 +516,7 @@ const oauth1AuthFile = () => {
           'oauth1Config',
           obj(
             comment(
-              "We have to define getRequestToken and getAccessToken functions to explicitly parse the response like it has a form body here, since Trello responds 'text/plain' for the Content-Type header"
+              "We have to define getRequestToken and getAccessToken functions to explicitly parse the response like it has a form body here, since Trello responds 'text/plain' for the Content-Type header",
             ),
             objProperty(getRequestTokenFuncName),
             objProperty(getOauthAccessTokenFuncName),
@@ -529,18 +529,21 @@ const oauth1AuthFile = () => {
                   obj(
                     objProperty(
                       'oauth_token',
-                      strLiteral('{{bundle.inputData.oauth_token}}')
+                      strLiteral('{{bundle.inputData.oauth_token}}'),
+                    ),
+                    objProperty(
+                      'name',
+                      strLiteral('Zapier/Trello OAuth1 Test'),
                     ),
-                    objProperty('name', strLiteral('Zapier/Trello OAuth1 Test'))
-                  )
-                )
-              )
-            )
-          )
+                  ),
+                ),
+              ),
+            ),
+          ),
         ),
       ],
       connectionLabel: strLiteral('{{username}}'),
-    })
+    }),
   );
 };
 

package/src/utils/build.js

@@ -99,7 +99,7 @@ const requiredFiles = (cwd, entryPoints) => {
         .on('end', () => {
           paths.sort();
           resolve(paths);
-        })
+        }),
     );
     b.bundle();
   });
@@ -152,10 +152,10 @@ const forceIncludeDumbPath = (appConfig, filePath) => {
     filePath.endsWith(path.join('bin', 'linux-x64-node-14', 'deasync.node')) ||
     filePath.endsWith(
       // Special, for zapier-platform-legacy-scripting-runner
-      path.join('bin', `linux-x64-node-${nodeMajorVersion}`, 'deasync.node')
+      path.join('bin', `linux-x64-node-${nodeMajorVersion}`, 'deasync.node'),
     ) ||
     filePath.match(
-      path.sep === '\\' ? /aws-sdk\\apis\\.*\.json/ : /aws-sdk\/apis\/.*\.json/
+      path.sep === '\\' ? /aws-sdk\\apis\\.*\.json/ : /aws-sdk\/apis\/.*\.json/,
     ) ||
     matchesConfigInclude
   );
@@ -211,7 +211,7 @@ const makeZip = async (dir, zipPath, disableDependencyDetection) => {
     paths = dumbPaths;
   } else {
     let finalPaths = smartPaths.concat(
-      dumbPaths.filter(forceIncludeDumbPath.bind(null, appConfig))
+      dumbPaths.filter(forceIncludeDumbPath.bind(null, appConfig)),
     );
     finalPaths = _.uniq(finalPaths);
     finalPaths.sort();
@@ -257,7 +257,7 @@ const maybeNotifyAboutOutdated = () => {
   // `build` won't run if package.json isn't there, so if we get to here we're good
   const requiredVersion = _.get(
     require(path.resolve('./package.json')),
-    `dependencies.${constants.PLATFORM_PACKAGE}`
+    `dependencies.${constants.PLATFORM_PACKAGE}`,
   );
 
   if (requiredVersion) {
@@ -269,11 +269,11 @@ const maybeNotifyAboutOutdated = () => {
     if (notifier.update && notifier.update.latest !== requiredVersion) {
       notifier.notify({
         message: `There's a newer version of ${colors.cyan(
-          constants.PLATFORM_PACKAGE
+          constants.PLATFORM_PACKAGE,
         )} available.\nConsider updating the dependency in your\n${colors.cyan(
-          'package.json'
+          'package.json',
         )} (${colors.grey(notifier.update.current)} → ${colors.green(
-          notifier.update.latest
+          notifier.update.latest,
         )}) and then running ${colors.red('zapier test')}.`,
       });
     }
@@ -285,10 +285,9 @@ const maybeRunBuildScript = async (options = {}) => {
 
   // Make sure we don't accidentally call the Zapier build hook inside itself
   if (process.env.npm_lifecycle_event !== ZAPIER_BUILD_KEY) {
-    const pJson = require(path.resolve(
-      options.cwd || process.cwd(),
-      'package.json'
-    ));
+    const pJson = require(
+      path.resolve(options.cwd || process.cwd(), 'package.json'),
+    );
 
     if (_.get(pJson, ['scripts', ZAPIER_BUILD_KEY])) {
       startSpinner(`Running ${ZAPIER_BUILD_KEY} script`);
@@ -314,7 +313,7 @@ const listWorkspaces = (workspaceRoot) => {
   }
 
   return (packageJson.workspaces || []).map((relpath) =>
-    path.resolve(workspaceRoot, relpath)
+    path.resolve(workspaceRoot, relpath),
   );
 };
 
@@ -332,7 +331,7 @@ const _buildFunc = async ({
   const osTmpDir = await fse.realpath(os.tmpdir());
   const tmpDir = path.join(
     osTmpDir,
-    'zapier-' + crypto.randomBytes(4).toString('hex')
+    'zapier-' + crypto.randomBytes(4).toString('hex'),
   );
   debug('Using temp directory: ', tmpDir);
 
@@ -373,7 +372,7 @@ const _buildFunc = async ({
           if (stat.isSymbolicLink()) {
             const realPath = path.resolve(
               path.dirname(src),
-              fse.readlinkSync(src)
+              fse.readlinkSync(src),
             );
             for (const workspace of workspaces) {
               // Use minimatch to do glob pattern match. If match, it means the
@@ -408,11 +407,11 @@ const _buildFunc = async ({
   const corePath = path.join(
     tmpDir,
     'node_modules',
-    constants.PLATFORM_PACKAGE
+    constants.PLATFORM_PACKAGE,
   );
   if (!fs.existsSync(corePath)) {
     throw new Error(
-      'Could not install dependencies properly. Error log:\n' + output.stderr
+      'Could not install dependencies properly. Error log:\n' + output.stderr,
     );
   }
 
@@ -428,12 +427,12 @@ const _buildFunc = async ({
       'node_modules',
       constants.PLATFORM_PACKAGE,
       'include',
-      'zapierwrapper.js'
-    )
+      'zapierwrapper.js',
+    ),
   );
   await writeFile(
     path.join(tmpDir, 'zapierwrapper.js'),
-    zapierWrapperBuf.toString()
+    zapierWrapperBuf.toString(),
   );
 
   if (printProgress) {
@@ -449,13 +448,13 @@ const _buildFunc = async ({
 
   const fileWriteError = await writeFile(
     path.join(tmpDir, 'definition.json'),
-    prettyJSONstringify(rawDefinition)
+    prettyJSONstringify(rawDefinition),
   );
 
   if (fileWriteError) {
     debug('\nFile Write Error:\n', fileWriteError, '\n');
     throw new Error(
-      `Unable to write ${tmpDir}/definition.json, please check file permissions!`
+      `Unable to write ${tmpDir}/definition.json, please check file permissions!`,
     );
   }
 
@@ -481,7 +480,7 @@ 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 validate` to see them!',
       );
     }
 
@@ -493,10 +492,10 @@ const _buildFunc = async ({
       debug(
         '\nErrors:\n',
         prettyJSONstringify(styleChecksResponse.errors.results),
-        '\n'
+        '\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 validate` to see them!',
       );
     }
     if (printProgress) {
@@ -524,7 +523,7 @@ const _buildFunc = async ({
   await makeSourceZip(
     tmpDir,
     path.join(wdir, sourceZipPath),
-    disableDependencyDetection
+    disableDependencyDetection,
   );
 
   if (printProgress) {
@@ -541,7 +540,7 @@ const _buildFunc = async ({
     await runCommand(
       'find',
       ['.', '-exec', 'touch', '-t', '201601010000', '{}', '+'],
-      { cwd: tmpDir }
+      { cwd: tmpDir },
     );
   }
 
@@ -561,7 +560,7 @@ const _buildFunc = async ({
 
 const buildAndOrUpload = async (
   { build = false, upload = false } = {},
-  buildOpts
+  buildOpts,
 ) => {
   if (!(build || upload)) {
     throw new Error('must either build or upload');

package/src/utils/changelog.js

@@ -18,7 +18,7 @@ const getChangelogFromMarkdown = (version, markdown) => {
     .split('\n');
 
   let startingLine = lines.findIndex((line) =>
-    RegExp(`^#{1,4} .*${version.split('.').join('\\.')}`).test(line)
+    RegExp(`^#{1,4} .*${version.split('.').join('\\.')}`).test(line),
   );
 
   if (startingLine === -1) {