zapier-platform-core 17.9.0 → 18.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "17.9.0",
+  "version": "18.0.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -54,16 +54,16 @@
   "dependencies": {
     "@zapier/secret-scrubber": "^1.1.2",
     "content-disposition": "0.5.4",
-    "dotenv": "16.5.0",
+    "dotenv": "17.2.1",
     "fernet": "^0.3.3",
     "form-data": "4.0.4",
     "lodash": "4.17.21",
-    "mime-types": "2.1.35",
+    "mime-types": "3.0.1",
     "node-abort-controller": "3.1.1",
     "node-fetch": "2.7.0",
     "oauth-sign": "0.9.0",
-    "semver": "7.7.1",
-    "zapier-platform-schema": "17.9.0"
+    "semver": "7.7.2",
+    "zapier-platform-schema": "18.0.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/http-middlewares/after/throw-for-throttling.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const { ThrottledError } = require('../../errors');
+
+/**
+ * Raise a ThrottledError for 429 responses _before_ dev's afterResponse middleware,
+ * unless throwForThrottlingEarly is set to true on the request.
+ * Behaves similarly to throwForStaleAuth but for throttling.
+ */
+const throwForThrottling = (resp) => {
+  // throwForThrottlingEarly has to be explicitly set to false to disable this
+  // middleware. By default, when it's undefined or null, we want this
+  // middleware to run.
+  if (resp.request?.throwForThrottlingEarly === false) {
+    return resp;
+  }
+
+  if (resp.status === 429) {
+    const retryAfter = resp.headers.get('retry-after');
+    let delay = retryAfter ? parseInt(retryAfter, 10) : null;
+    if (Number.isNaN(delay)) {
+      delay = null;
+    }
+    throw new ThrottledError(
+      'The server returned 429 (Too Many Requests)',
+      delay,
+    );
+  }
+
+  return resp;
+};
+
+module.exports = throwForThrottling;

package/src/http-middlewares/before/prepare-request.js

@@ -145,6 +145,11 @@ const prepareRequest = function (req) {
       ['_zapier', 'app', 'flags', 'skipThrowForStatus'],
       false,
     ),
+    throwForThrottlingEarly: _.get(
+      input,
+      ['_zapier', 'app', 'flags', 'throwForThrottlingEarly'],
+      true,
+    ),
   });
 
   req = sugarBody(req);

package/src/tools/create-app-request-client.js

@@ -20,6 +20,7 @@ const sanitizeHeaders = require('../http-middlewares/before/sanatize-headers');
 const { logResponse } = require('../http-middlewares/after/log-response');
 const prepareResponse = require('../http-middlewares/after/prepare-response');
 const throwForStaleAuth = require('../http-middlewares/after/throw-for-stale-auth');
+const throwForThrottling = require('../http-middlewares/after/throw-for-throttling');
 const throwForStatusMiddleware = require('../http-middlewares/after/throw-for-status');
 const throwForDisallowedHostnameAfterRedirect = require('../http-middlewares/after/throw-for-disallowed-hostname-after-redirect');
 
@@ -69,6 +70,7 @@ const createAppRequestClient = (input, options) => {
     throwForDisallowedHostnameAfterRedirect,
     logResponse,
     ...(includeAutoRefresh ? [throwForStaleAuth] : []),
+    throwForThrottling,
     ...ensureArray(app.afterResponse),
     throwForStatusMiddleware,
   ];

package/src/tools/create-rpc-client.js

@@ -111,6 +111,10 @@ const createRpcClient = (event) => {
         if (res.status >= 500) {
           throw new Error('Unable to reach the RPC server');
         }
+        if (res.status === 413) {
+          throw new Error('The request is too large to be processed');
+        }
+
         if (res.content) {
           // check if the ids match
           if (res.content.id !== id) {

package/src/tools/environment.js

@@ -46,10 +46,13 @@ const injectEnvironmentFile = (filename) => {
     filename = localFilepath(filename);
   }
   // reads ".env" if filename is falsy, needs full path otherwise
-  let result = dotenv.config({ path: filename });
+  let result = dotenv.config({ path: filename, quiet: true });
   if (result.error) {
     // backwards compatibility
-    result = dotenv.config({ path: localFilepath('.environment') });
+    result = dotenv.config({
+      path: localFilepath('.environment'),
+      quiet: true,
+    });
     if (result.parsed && !IS_TESTING) {
       console.log(
         [

package/types/schemas.generated.d.ts

@@ -4,7 +4,7 @@
  * files, and/or the schema-to-ts tool and run its CLI to regenerate
  * these typings.
  *
- * zapier-platform-schema version: 17.8.0
+ * zapier-platform-schema version: 17.9.1
  *  schema-to-ts compiler version: 0.1.0
  */
 import type {
@@ -292,6 +292,27 @@ export interface AppFlags {
    * ignore this flag if they set `skipThrowForStatus` directly
    */
   skipThrowForStatus?: boolean;
+
+  /**
+   * Starting in `core` version `18.0.0`, 429 (throttling) responses
+   * throw a `ThrottledError` before `afterResponse` middleware runs
+   * by default. Set this flag to `true` to preserve the old behavior
+   * where `afterResponse` middleware can see and handle 429
+   * responses. This flag can be overridden per-request by setting
+   * `throwForThrottlingEarly` directly on the request options.
+   */
+  throwForThrottlingEarly?: boolean;
+
+  /**
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. This is a global flag that affects all the triggers and
+   * actions in your integration. The `cleanInputData` flag in
+   * `operation` takes precedence over this one.
+   */
+  cleanInputData?: boolean;
 }
 
 /**
@@ -941,10 +962,14 @@ export interface BasicPollingOperation<
   throttle?: ThrottleObject;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 }
 
 /**
@@ -1036,10 +1061,14 @@ export interface BasicHookOperation<
   sample?: Record<string, unknown>;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 }
 
 /**
@@ -1102,10 +1131,14 @@ export interface BasicHookToPollOperation<
   sample?: Record<string, unknown>;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 
   /**
    * The maximum amount of time to wait between polling requests in
@@ -1180,10 +1213,14 @@ export interface BasicActionOperation {
   throttle?: ThrottleObject;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 }
 
 /** Represents the fundamental mechanics of a search. */
@@ -1256,10 +1293,14 @@ export interface BasicSearchOperation<
   throttle?: ThrottleObject;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 }
 
 /** Represents the fundamental mechanics of a create. */
@@ -1331,10 +1372,14 @@ export interface BasicCreateOperation<
   throttle?: ThrottleObject;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 
   /**
    * Currently an **internal-only** feature. Zapier uses this
@@ -1421,10 +1466,14 @@ export interface BasicOperation {
   throttle?: ThrottleObject;
 
   /**
-   * (Experimental) Should empty strings, `null`, `undefined`, and
-   * empty Arrays or objects be removed from `inputData`?
+   * If true, Zapier removes empty strings, `null`, `undefined`, and
+   * empty Arrays or objects from `bundle.inputData` recursively
+   * before passing it to your `perform*` function. If you want to
+   * handle empty values yourself in your code, explicitly set this to
+   * false. There is also a global flag with the same name in
+   * `App.flags`. This one takes precedence over the global one.
    */
-  skipCleanArrayInputData?: boolean;
+  cleanInputData?: boolean;
 }
 
 /**