zapier-platform-core 15.13.0 → 15.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "15.13.0",
+  "version": "15.14.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -53,7 +53,7 @@
     "node-fetch": "2.6.7",
     "oauth-sign": "0.9.0",
     "semver": "7.5.2",
-    "zapier-platform-schema": "15.13.0"
+    "zapier-platform-schema": "15.14.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/tools/create-cache.js

@@ -7,7 +7,13 @@ const ensureJSONEncodable = require('./ensure-json-encodable');
 
 const createCache = (input) => {
   const rpc = _.get(input, '_zapier.rpc');
-  const runValidationChecks = (rpc, key, value = null, ttl = null) => {
+  const runValidationChecks = (
+    rpc,
+    key,
+    value = null,
+    ttl = null,
+    scope = null
+  ) => {
     if (!rpc) {
       throw new Error('rpc is not available');
     }
@@ -20,25 +26,35 @@ const createCache = (input) => {
       throw new TypeError('ttl must be an integer');
     }
 
+    if (
+      scope !== null &&
+      (!Array.isArray(scope) ||
+        !scope.every((v) => v === 'user' || v === 'auth'))
+    ) {
+      throw new TypeError(
+        'scope must be an array of strings with values "user" or "auth"'
+      );
+    }
+
     ensureJSONEncodable(value);
   };
 
   return {
-    get: async (key) => {
-      runValidationChecks(rpc, key);
+    get: async (key, scope = null) => {
+      runValidationChecks(rpc, key, scope);
 
-      const result = await rpc('zcache_get', key);
+      const result = await rpc('zcache_get', key, scope);
       return result ? JSON.parse(result) : null;
     },
-    set: async (key, value, ttl = null) => {
-      runValidationChecks(rpc, key, value, ttl);
+    set: async (key, value, ttl = null, scope = null) => {
+      runValidationChecks(rpc, key, value, ttl, scope);
 
-      return await rpc('zcache_set', key, JSON.stringify(value), ttl);
+      return await rpc('zcache_set', key, JSON.stringify(value), ttl, scope);
     },
-    delete: async (key) => {
-      runValidationChecks(rpc, key);
+    delete: async (key, scope = null) => {
+      runValidationChecks(rpc, key, scope);
 
-      return await rpc('zcache_delete', key);
+      return await rpc('zcache_delete', key, scope);
     },
   };
 };

package/types/index.test-d.ts

@@ -2,7 +2,6 @@ import type {
   AfterResponseMiddleware,
   BeforeRequestMiddleware,
   Bundle,
-  PerformFunction,
   ZObject,
 } from './zapier.custom';
 import type {
@@ -101,7 +100,10 @@ expectType<Trigger>(hookTrigger);
 
 const searchOperation: BasicActionOperation = {
   inputFields: [{ key: 'some-input-key-1', type: 'file', required: true }],
-  perform: async (z: ZObject, b: Bundle) => [{ data: true }],
+  perform: async (z: ZObject, b: Bundle) => {
+    z.request('https://example.com', { middlewareData: { resumable: true } });
+    return [{ data: true }];
+  },
 };
 expectType<BasicActionOperation>(searchOperation);
 
@@ -124,7 +126,12 @@ const addBearerHeader: BeforeRequestMiddleware = (request, z, bundle) => {
 };
 expectType<BeforeRequestMiddleware>(addBearerHeader);
 
-const asyncBeforeRequest: BeforeRequestMiddleware = async (request) => request;
+const asyncBeforeRequest: BeforeRequestMiddleware = async (request) => {
+  if (request.middlewareData?.resumable) {
+    // do something async etc.
+  }
+  return request;
+};
 expectType<BeforeRequestMiddleware>(asyncBeforeRequest);
 
 const checkPermissionsError: AfterResponseMiddleware = (response, z) => {

package/types/zapier.custom.d.ts

@@ -95,6 +95,14 @@ export interface HttpRequestOptions {
   timeout?: number;
   url?: string;
   skipThrowForStatus?: boolean;
+
+  /**
+   * This is a special field that can be used to pass data to
+   * middleware. It is not sent with the request, but is available in
+   * the `response` object that middleware receives. This is useful for
+   * things like `prefixErrorMessage` fields etc.
+   */
+  middlewareData?: Record<string, any>;
 }
 
 interface BaseHttpResponse {

package/types/zapier.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: 15.13.0
+ * zapier-platform-schema version: 15.14.0
  *  schema-to-ts compiler version: 0.1.0
  */