zapier-platform-core 17.3.1 → 17.5.0

package/index.js

@@ -1,4 +1,5 @@
 const zapier = require('./src');
 zapier.version = require('./package.json').version;
 zapier.tools = require('./src/tools/exported');
+zapier.errors = require('./src/errors');
 module.exports = zapier;

package/index.mjs

@@ -1,8 +1,10 @@
 import zapier from './src/index.js';
 import packageJson from './package.json' with { type: 'json' };
 import _tools from './src/tools/exported.js';
+import _errors from './src/errors.js';
 zapier.version = packageJson.version;
 zapier.tools = _tools;
+zapier.errors = _errors;
 // Allows `import { ... } from 'zapier-platform-core'`
 export const {
   createAppHandler,
@@ -16,6 +18,7 @@ export const {
   integrationTestHandler,
   tools,
   version,
+  errors,
 } = zapier;
 // Allows `import zapier from 'zapier-platform-core'`
 export default zapier;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "17.3.1",
+  "version": "17.5.0",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -9,9 +9,9 @@
   "types": "types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./types/index.d.ts",
       "require": "./index.js",
-      "import": "./index.mjs",
-      "types": "./types/index.d.ts"
+      "import": "./index.mjs"
     },
     "./src/*": {
       "require": "./src/*.js"
@@ -56,14 +56,14 @@
     "content-disposition": "0.5.4",
     "dotenv": "16.5.0",
     "fernet": "^0.3.3",
-    "form-data": "4.0.1",
+    "form-data": "4.0.4",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "node-abort-controller": "3.1.1",
     "node-fetch": "2.7.0",
     "oauth-sign": "0.9.0",
     "semver": "7.7.1",
-    "zapier-platform-schema": "17.3.1"
+    "zapier-platform-schema": "17.5.0"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/tools/bundle-encryption.js

@@ -2,7 +2,7 @@
 
 const crypto = require('crypto');
 const fernet = require('fernet');
-
+const zlib = require('zlib');
 /**
  * Decrypt a bundle using secret key
  *
@@ -10,10 +10,12 @@ const fernet = require('fernet');
  * 1. Hash the secret with SHA256 to get 32 bytes
  * 2. Base64url encode those bytes to make Fernet-compatible key
  * 3. Use Fernet library to decrypt (handles all token parsing internally)
+ * 4. Base64 decode the decrypted string to get compressed binary data
+ * 5. Decompress the data using gzip
  *
  * @param {string} bundle - The bundle represented as an encrypted token
  * @param {string} secret - The secret key for decryption
- * @returns {Object} The decrypted bundle object
+ * @returns {Object} The decrypted and decompressed bundle object
  */
 const decryptBundleWithSecret = (bundle, secret) => {
   try {
@@ -26,24 +28,54 @@ const decryptBundleWithSecret = (bundle, secret) => {
       throw new Error('Invalid secret - must be a non-empty string');
     }
 
-    // Create the same key as backend
+    // Step 1: Create the same key as backend
     // Hash the secret and take first 32 bytes, then base64url encode for Fernet
     const keyHash = crypto.createHash('sha256').update(secret).digest();
     const keyBytes = keyHash.subarray(0, 32); // Take first 32 bytes
     const fernetKey = keyBytes.toString('base64url'); // Use built-in base64url encoding
-
     // Use Fernet library to decrypt (handles all the token parsing)
+    const secretObj = new fernet.Secret(fernetKey);
     const token = new fernet.Token({
-      secret: new fernet.Secret(fernetKey),
+      secret: secretObj,
       token: bundle,
       ttl: 0,
     });
 
-    const decrypted = token.decode();
+    // Step 2: Decrypt the token - this should now be a valid UTF-8 string (base64 encoded)
+    let decryptedString;
+    try {
+      decryptedString = token.decode();
+    } catch (fernetError) {
+      throw new Error(`Fernet decryption failed: ${fernetError.message}`);
+    }
 
-    // Parse JSON
+    // Step 3: The decrypted data should be a base64 encoded string
+    // Base64 decode it to get the compressed binary data
+    let compressedBytes;
     try {
-      return JSON.parse(decrypted);
+      compressedBytes = Buffer.from(decryptedString, 'base64');
+    } catch (base64Error) {
+      throw new Error(`Base64 decoding failed: ${base64Error.message}`);
+    }
+
+    // Step 4: The data is compressed, so we need to decompress it
+    let decompressed;
+    try {
+      // Try to decompress first (for new format with compression)
+      decompressed = zlib.gunzipSync(compressedBytes).toString('utf8');
+    } catch (decompressionError) {
+      // If decompression fails, assume it's the old format without compression
+      // This provides backward compatibility
+      console.warn(
+        'Bundle decompression failed, falling back to uncompressed format:',
+        decompressionError.message,
+      );
+      decompressed = decryptedString;
+    }
+
+    // Step 5: Parse JSON
+    try {
+      return JSON.parse(decompressed);
     } catch (error) {
       throw new Error('Invalid JSON in decrypted bundle');
     }
@@ -51,7 +83,6 @@ const decryptBundleWithSecret = (bundle, secret) => {
     throw new Error(`Bundle decryption failed: ${error.message}`);
   }
 };
-
 module.exports = {
   decryptBundleWithSecret,
 };

package/types/custom.d.ts

@@ -10,7 +10,12 @@ import { Headers } from 'node-fetch';
 
 // The EXPORTED OBJECT
 export const version: string;
-export const tools: { env: { inject: (filename?: string) => void } };
+export const tools: { 
+  env: { inject: (filename?: string) => void };
+};
+export const errors: ErrorsModule;
+
+
 
 // see: https://github.com/zapier/zapier-platform-cli/issues/339#issue-336888249
 export const createAppTester: (
@@ -138,19 +143,30 @@ export interface Bundle<
   targetUrl?: string;
 }
 
-declare class AppError extends Error {
-  constructor(message: string, code?: string, status?: number);
-}
-declare class HaltedError extends Error {}
-declare class ExpiredAuthError extends Error {}
-declare class RefreshAuthError extends Error {}
-declare class ThrottledError extends Error {
-  constructor(message: string, delay?: number);
-}
-declare class ResponseError extends Error {
-  constructor(response: HttpResponse);
+// Error class types that match the runtime structure from src/errors.js
+type ErrorConstructor = new (message?: string) => Error;
+type AppErrorConstructor = new (message: string, code?: string, status?: number) => Error;
+type ThrottledErrorConstructor = new (message: string, delay?: number) => Error;
+type ResponseErrorConstructor = new (response: HttpResponse) => Error;
+
+interface ErrorsModule {
+  Error: AppErrorConstructor;
+  HaltedError: ErrorConstructor;
+  ExpiredAuthError: ErrorConstructor;
+  RefreshAuthError: ErrorConstructor;
+  ThrottledError: ThrottledErrorConstructor;
+  ResponseError: ResponseErrorConstructor;
+  CheckError: ErrorConstructor;
+  DehydrateError: ErrorConstructor;
+  MethodDoesNotExist: ErrorConstructor;
+  NotImplementedError: ErrorConstructor;
+  RequireModuleError: ErrorConstructor;
+  StashedBundleError: ErrorConstructor;
+  StopRequestError: ErrorConstructor;
+  handleError: (...args: any[]) => never;
 }
 
+
 // copied http stuff from external typings
 export interface HttpRequestOptions {
   agent?: Agent;
@@ -286,14 +302,7 @@ export interface ZObject {
     input_encoding?: string,
   ) => string;
 
-  errors: {
-    Error: typeof AppError;
-    HaltedError: typeof HaltedError;
-    ExpiredAuthError: typeof ExpiredAuthError;
-    RefreshAuthError: typeof RefreshAuthError;
-    ThrottledError: typeof ThrottledError;
-    ResponseError: typeof ResponseError;
-  };
+  errors: ErrorsModule;
 
   cache: {
     get: (key: string) => Promise<any>;

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.3.1
+ * zapier-platform-schema version: 17.4.0
  *  schema-to-ts compiler version: 0.1.0
  */
 import type {
@@ -704,7 +704,15 @@ export interface AuthField {
   label?: string;
 
   /** The type of this value used to be. */
-  type?: 'string' | 'number' | 'boolean' | 'datetime' | 'copy' | 'password';
+  type?:
+    | 'string'
+    | 'number'
+    | 'boolean'
+    | 'datetime'
+    | 'copy'
+    | 'password'
+    | 'integer'
+    | 'text';
 
   /** If this value is required or not. This defaults to `true`. */
   required?: boolean;