zapier-platform-core 17.2.0 → 17.3.1

package/include/zapierwrapper.mjs

@@ -5,9 +5,14 @@ let _appRaw;
 try {
   _appRaw = await import('{REPLACE_ME_PACKAGE_NAME}');
 } catch (err) {
-  if (err.code === 'ERR_MODULE_NOT_FOUND') {
-    err.message +=
-      '\nMake sure you specify a valid entry point using `exports` in package.json.';
+  if (
+    err.code === 'ERR_MODULE_NOT_FOUND' &&
+    err.message?.includes('{REPLACE_ME_PACKAGE_NAME}')
+  ) {
+    err.message =
+      'It seems you are using ESM because your package.json has `"type": "module"`. ' +
+      'For ESM to work, make sure you specify a valid entry point using `exports` (instead of `main`) in package.json.\n\n' +
+      err.message;
   }
   throw err;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-core",
-  "version": "17.2.0",
+  "version": "17.3.1",
   "description": "The core SDK for CLI apps in the Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -55,7 +55,7 @@
     "@zapier/secret-scrubber": "^1.1.2",
     "content-disposition": "0.5.4",
     "dotenv": "16.5.0",
-    "fernet": "^0.4.0",
+    "fernet": "^0.3.3",
     "form-data": "4.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
@@ -63,7 +63,7 @@
     "node-fetch": "2.7.0",
     "oauth-sign": "0.9.0",
     "semver": "7.7.1",
-    "zapier-platform-schema": "17.2.0"
+    "zapier-platform-schema": "17.3.1"
   },
   "devDependencies": {
     "@types/node-fetch": "^2.6.11",

package/src/tools/fetch-logger.js

@@ -56,11 +56,16 @@ const isZapierUserAgent = (headers) =>
   _.get(headers, 'user-agent', []).indexOf('Zapier') !== -1;
 
 const shouldIncludeResponseContent = (contentType) => {
+  if (!contentType) {
+    return false;
+  }
+
   for (const ctype of ALLOWED_HTTP_DATA_CONTENT_TYPES) {
     if (contentType.includes(ctype)) {
       return true;
     }
   }
+
   return false;
 };
 

package/src/tools/http.js

@@ -9,7 +9,8 @@ const HTML_TYPE = 'text/html';
 const TEXT_TYPE = 'text/plain';
 const TEXT_TYPE_UTF8 = 'text/plain; charset=utf-8';
 const YAML_TYPE = 'application/yaml';
-const XML_TYPE = 'application/xml';
+const XML_TEXT_TYPE = 'text/xml';
+const XML_APPLICATION_TYPE = 'application/xml';
 const JSONAPI_TYPE = 'application/vnd.api+json';
 
 const ALLOWED_HTTP_DATA_CONTENT_TYPES = new Set([
@@ -20,7 +21,8 @@ const ALLOWED_HTTP_DATA_CONTENT_TYPES = new Set([
   TEXT_TYPE,
   TEXT_TYPE_UTF8,
   YAML_TYPE,
-  XML_TYPE,
+  XML_TEXT_TYPE,
+  XML_APPLICATION_TYPE,
   JSONAPI_TYPE,
 ]);
 
@@ -122,7 +124,8 @@ module.exports = {
   HTML_TYPE,
   TEXT_TYPE,
   YAML_TYPE,
-  XML_TYPE,
+  XML_TEXT_TYPE,
+  XML_APPLICATION_TYPE,
   JSONAPI_TYPE,
   ALLOWED_HTTP_DATA_CONTENT_TYPES,
   getContentType,

package/types/custom.d.ts

@@ -18,10 +18,15 @@ export const createAppTester: (
   options?: { customStoreKey?: string },
 ) => <T, B extends Bundle>(
   func: (z: ZObject, bundle: B) => T | Promise<T>,
-  bundle?: Partial<B>, // partial so we don't have to make a full bundle in tests
+  bundle?: DeepPartial<B>, // partial so we don't have to make a full bundle in tests
   clearZcacheBeforeUse?: boolean,
 ) => Promise<T>; // appTester always returns a promise
 
+/** Recursively make all properties of an object optional. */
+type DeepPartial<T> = T extends object
+  ? { [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P] }
+  : T;
+
 type HttpMethod =
   | 'GET'
   | 'POST'

package/types/functions.d.ts

@@ -2,9 +2,16 @@ import type { Bundle, ZObject } from './custom';
 
 type DefaultInputData = Record<string, unknown>;
 
+/**
+ * Wraps a `perform` function that is used to poll for data from an API.
+ * By default must return an array of objects with an `id` field, but
+ * when one or more output fields have `primary:true` set on them, this
+ * can be overridden by setting the second type parameter to a type with
+ * those keys.
+ */
 export type PollingTriggerPerform<
   $InputData extends DefaultInputData = DefaultInputData,
-  $Return extends { id: string } = { id: string }, // Primary key stuff later?
+  $Return extends {} = { id: string },
 > = (z: ZObject, bundle: Bundle<$InputData>) => $Return[] | Promise<$Return[]>;
 
 /**

package/types/functions.test-d.ts

@@ -0,0 +1,18 @@
+import { expectAssignable } from 'tsd';
+import type { PollingTriggerPerform } from './functions';
+
+const simplePerform = (async (z, bundle) => {
+  return [{ id: '1', name: 'test' }];
+}) satisfies PollingTriggerPerform;
+
+expectAssignable<PollingTriggerPerform<{}, { id: string; name: string }>>(
+  simplePerform,
+);
+
+const primaryKeyOverridePerform = (async (z, bundle) => {
+  return [{ itemId: 123, name: 'test' }];
+}) satisfies PollingTriggerPerform<{}, { itemId: number; name: string }>;
+
+expectAssignable<PollingTriggerPerform<{}, { itemId: number; name: string }>>(
+  primaryKeyOverridePerform,
+);

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.1.0
+ * zapier-platform-schema version: 17.3.1
  *  schema-to-ts compiler version: 0.1.0
  */
 import type {
@@ -906,6 +906,12 @@ export interface BasicPollingOperation<
   /** What should the form a user sees and configures look like? */
   inputFields?: $InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -995,6 +1001,12 @@ export interface BasicHookOperation<
   /** What should the form a user sees and configures look like? */
   inputFields?: $InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1049,6 +1061,12 @@ export interface BasicHookToPollOperation<
   /** What should the form a user sees and configures look like? */
   inputFields?: $InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1103,6 +1121,12 @@ export interface BasicActionOperation {
   /** What should the form a user sees and configures look like? */
   inputFields?: InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1164,6 +1188,12 @@ export interface BasicSearchOperation<
   /** What should the form a user sees and configures look like? */
   inputFields?: $InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1227,6 +1257,12 @@ export interface BasicCreateOperation<
   /** What should the form a user sees and configures look like? */
   inputFields?: $InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1305,6 +1341,12 @@ export interface BasicOperation {
   /** What should the form a user sees and configures look like? */
   inputFields?: InputFields;
 
+  /**
+   * Defines groups for organizing input fields in the UI. Each group
+   * can have a key, label, and emphasis styling.
+   */
+  inputFieldGroups?: InputFieldGroups;
+
   /**
    * What fields of data will this return? Will use resource
    * outputFields if missing, will also use sample if available.
@@ -1412,6 +1454,13 @@ export interface PlainOutputField {
   steadyState?: boolean;
 }
 
+/** An array or collection of input field groups. */
+export type InputFieldGroups = {
+  key: Key;
+  label: string;
+  emphasize: boolean;
+}[];
+
 /**
  * Zapier uses this configuration to ensure this action is performed
  * one at a time per scope (avoid concurrency).
@@ -1613,6 +1662,12 @@ export interface PlainInputField {
    * Supports simple key-values only (no sub-objects or arrays).
    */
   meta?: FieldMeta;
+
+  /**
+   * References a group key from the operation's inputFieldGroups to
+   * organize this field with others.
+   */
+  group?: Key;
 }
 
 /**