16.0.0

released 2024-12-16

Version 16.0.0 is a breaking change release that contains some important housekeeping updates that put us in a better spot to support some exciting changes coming up in future versions. Here is a quick breakdown of the two main breaking changes:

1. The minimum supported version of Node.js is now v18.18. We’ve officially dropped support for Node.js v16.x, which has been designated end-of-life since September 2023.

2. Integrations using zapier-platform-core@16.0.0 and onwards will default to running on the ARM architecture in AWS Lambda. Note: If you believe your integrations have run into runtime incompatibilities due to this change, please reach out to our support team and we may be able to opt your integration out of running on ARM.

Here are the detailed release notes for this release (note that ❗ denotes a breaking change):

cli

🔨 The oclif suite of packages have been upgraded to support the latest oclif major version (v4) (#890).

core

❗ Node.js v16.x is no longer supported (#890)
❗ Integrations running on zapier-platform-core v16 and onwards will run on the ARM architecture by default. This means means they will run on AWS Graviton2 processors (previously, the AWS Lambda runtime was based on x86 architecture). For more details on what this means on a technical level, please check out: AWS Lambda on Graviton 2.
❗ Due to changes in the underlying dotenv library (see changelog) (#926), when using zapier.tools.env.inject(), we always recommend "double quoting" your environment variable values. Please make sure to consider if the following cases would apply to your .env files:
- SECRET_HASH=something-with-a-#-hash: change it to SECRET_HASH="something-with-a-#-hash"
- SECRET_BACKTICK=something-with-a-`-backtick: change it to SECRET_BACKTICK="something-with-a-`-backtick"

Add skipEncodingChars property typing for z.request object (#928)

schema

N/A

schema-to-ts

🔧 The schema-to-ts package is now part of the repository root "yarn workspaces" (#913)

misc

🔨 Dependency updates (#890, #926, #927)
- repo root
  - Add @eslint/eslintrc@^3.2.0
  - Add @eslint/js@^9.16.0
  - Add globals@^15.13.0
  - Remove eslint-plugin-standard
  - Update lerna from 6.4.1 to 8.0.2
  - Update husky from 7.0.4 to 9.1.7
  - Update mocha from 10.8.2 to 11.0.1
  - Update eslint from 8.32.0 to 9.16.0
  - Update eslint-plugin-import from 2.27.5 to 2.31.0
  - Update eslint-plugin-mocha from 9.0.0 to 10.5.0
  - Update eslint-plugin-n from 15.6.1 to 17.14.0
  - Update eslint-plugin-promise from 6.1.1 to 7.2.1
  - Update prettier from 2.8.3 to 3.4.1
- cli
  - Add oclif@^4.15.1
  - Add @oclif/core@4.0.28
  - Add @oclif/plugin-version@2.2.15
  - Remove stdout-stderr
  - Remove oclif/dev-cli
  - Remove @oclif/command
  - Remove @oclif/config
  - Update archiver 5.3.1 to 7.0.1
  - Update gulp-prettier from 4.0.0 to 5.0.0
  - Update marked 4.2.12 to 14.1.4
  - Update marked-terminal from 5.2.0 to 7.2.1
  - Update read from 2.1.0 to 4.0.0
  - Update fs-extra from 11.1.1 to 11.2.0
  - Update yeoman-environment from 3.3.0 to 3.19.3
  - Update semver from 7.5.2 to 7.6.3
  - Update node-fetch from 2.6.7 to 2.7.0
  - Update adm-zip from 0.5.10 to 0.5.16
  - Update browserify from 17.0.0 to 17.0.1
  - Update cli-table3 from 0.6.3 to 0.6.5
  - Update tmp from 0.2.1 to 0.2.3
  - Update traverse from 0.6.7 to 0.6.10
  - Update prettier from 2.8.9 to 3.4.1
- core
  - Update dotenv from 12.0.4 to 16.4.5
  - Update semver from 7.5.2 to 7.6.3
  - Update node-fetch from 2.6.7 to 2.7.0
  - Update form-data from 4.0.0 to 4.0.1
- schema-to-ts
  - Update prettier from 3.2.5 to 3.4.1

15.19.0

released 2024-11-25

For optimal performance, an optional argument has been added to z.dehydrate to allow devs to control the cache duration on hydrators. The default cache duration for hydrators is unchanged (5 minutes).

Also, with the new optional meta field object added to the FieldSchema object, devs now have a supported mechanism for storing field-specific context which may be obtained when constructing dynamic needs, and then making that context available during actual action execution in the perform method.

Lastly, the zapier scaffold now supports TypeScript (TS) applications. It automatically detects TS and JS projects if the --entry flag isn't provided, so that it can generate and edit the right files in the right places, given TS projects tend to keep their files in ./src.

cli

💅 Add support for TS on the zapier scaffold command (#884)

core

🎉 Add support for providing the cache expiration for hydrators (#918)
📜 Add timezone and withSearch fields to the bundle.meta object (#922)
📜 Update the BeforeRequestMiddleware typings to require url in the request object (#924)

schema

🎉 Add meta field support for the FieldSchema (#883)

schema-to-ts

None!

misc

🔨 Bump elliptic from 6.5.7 to 6.6.0 (#911)
🔨 Bump cross-spawn from 7.0.3 to 7.0.6 in /schema-to-ts (#919)

15.18.1

released 2024-11-01

cli

🐛 Fix issue where zapier invoke --debug doesn't print HTTP logs for requests that aren't sent by z.request() (#907)

core

🐛 Fix issue where HTTP logger can break aws-sdk v3 (and maybe other HTTP client libraries) intermittently (#905)
🐛 HTTP logging now works with native fetch (#908)
🧪 Allow to not wait for event loop to be empty to fix a hanging issue (#904)

schema

None!

15.18.0

released 2024-10-24

cli

💅 Fix a failing smoke test based on CLI package size (now that many docs are deleted) (#899)
🎉 Add OAuth2 to TypeScript init output (#894)

core

🎉 Adds nx argument to z.cache.set() (#900)
🐛 Force a process.exit(1) on catching an EMFILE error inside checkMemory() (#901)

schema

None!

schema-to-ts

🎉 Type z.request responses and deprecate .json (#895)

misc

📜 Typo fixes and link changes (#885)
📜 Add docs explaining why hidden triggers for dynamic dropdowns need to declare input fields (#887)
📜 Migrate docs out of this monorepo (#893)
📜 Updating doc links in CHANGELOG (#898)

15.17.0

released 2024-10-11

Introducing three major updates, with the first two aimed at improving your development experience:

The zapier invoke command: This powerful new command enables you to emulate Zapier's production environment locally. Test triggers, actions, and authentication flows right from your terminal without deploying to Zapier. This is especially valuable for debugging, development, and quick testing iterations. Learn more about the command in the README or by typing zapier invoke --help in your terminal.
Refreshed "typescript" project template: We've updated the "typescript" project template with the latest type definitions. Enjoy enhanced type safety, improved autocompletion, and a smoother coding experience overall.
Although we've removed Node.js 16 from zapier-platform-cli's CI testing, it still works on Node.js 16, except for the zapier invoke auth start command. But using Node.js 18 or later is recommended, as we'll be dropping support for Node.js 16 in an upcoming major release.

As usual, all other improvements and bug fixes are listed below.

cli

🎉 Introduce zapier invoke command (#856, #872, #878)
💅 Update "typescript" project template and example with latest type definitions (#845)
🐛 Fix zapier convert command not writing bulkReads to separate files (#881)

core

💅 Retry on 5xx errors when calling RPC (#875)
💅 Add ResponseError type (#877)
🔧 Bump mock-fs from 5.2.0 to 5.3.0 (#872)

schema

None!

misc

🔧 Drop Node.js 16 and add Node.js 20 from/to CI (#872)

15.16.1

released 2024-10-04

cli

None!

core

💅 Return a descriptive error when a filename cannot be uploaded (#874)

schema

None!

misc

📜 Add canary command to docs (#870)
📜 Add instructions for installing the Zapier Platform development version to docs (#873)

15.16.0

released 2024-09-24

cli

🎉 Introduce zapier canary command (#861)

core

None!

schema

None!

misc

🔨 Bump vite from 5.3.3 to 5.4.7 in /schema-to-ts (#868)
🔨 Bump rollup from 4.18.1 to 4.22.4 in /schema-to-ts (#867)

15.15.0

released 2024-09-18

This release introduces "Buffered Create Actions", currently only available for internal use. A Buffered Create allows you to create objects in bulk with a single or fewer API request(s). This is useful when you want to reduce the number of requests made to your server. When enabled, Zapier holds the data until the buffer reaches a size limit or a certain time has passed, then sends the buffered data using the performBuffer function you define.

cli

None!

core

🧪 Add checks to support Buffered Create Actions (#832)

schema

🧪 Add performBuffer and buffer to operation schema to support Buffered Create Actions (#832)

schema

💅 Add configurable poll delay for HookToPoll (#844)

misc

🔨 Bump elliptic from 6.5.4 to 6.5.7 (#842)
🔨 Bump axios from 1.6.1 to 1.7.4 (#843)

15.12.0

released 2024-08-16

cli

💅 Introduce zapier pull command (#838)
💅 Handle subheadings when interpreting the changelog (#827)

core

🐛 Properly type HTTP Options, replacing generic object types (#840)
🐛 Allow Async Middleware Functions Types (#826)

schema

🐛 Correct casing on bulk reads action type (#831)
🐛 Display the bulk_reads functional constraint (#829)

schema-to-ts

🐛 Simplify and correct Array types in Schema to TS conversion (#835)

misc

📜 Improve documentation accuracy regarding primary: true limitations (#836)
📜 Document limitations regarding primary in outputFields (#834)
📜 Document bundle.meta.withSearch (#823)

15.11.1

released 2024-07-19

core

🐛 Add base64 encoding before autostashing large payloads (#824)

core

💅 Throw error for HTTP redirect made to disallowed domains (#803)

schema

🧪 Add support for retry and filter at the root-level of the throttle configuration (#796)
🐛 Update createsSchema to disallow additional properties (#798)

misc

🔨 Bump jquery from 2.1.4 to 3.5.0 in the legacy-scripting-runner (#790)
🔨 Bump marked from 0.3.19 to 4.2.12 (#793)
🔨 Bump braces from 3.0.2 to 3.0.3 (#805)

15.7.3

released 2024-05-27

cli

🐛 Address CVE-2024-27980 changes in Node.js by always passing shell: true as an option for spawn() in Windows OS environments (thanks to @jaydamani for the report!) (#788).

15.7.2

released 2024-05-08

cli

📜 Correct docs about zapier migrate --user (#779)

core

🐛 Censor set-cookie response header in logs (#780)

misc

🔧 Dependency updates
- Bump semver from 5.7.1 to 7.5.2 (#776)
- Bump ejs from 3.1.7 to 3.1.10 (#777)
- Bump debug from 4.1.1 to 4.3.4 (#778)

15.7.1

released 2024-05-01

cli

📜 Add instruction to close resolved issues after promotion in the docs (#770)
📜 Remove the note on redirect_uri change after publish in the docs (#774)

core

🐛 Fix null response content breaking the search for sensitive values (#772)

schema

None!

misc

🐛 Fix the legacy-scripting-runner's ErrorException invalid JSON data (#773)
🔨 Bump tar from 6.1.0 to 6.2.1 (#771)

15.7.0

released 2024-04-09

cli

📜 Added missing 'to' in CLI docs (#767)

core

💅 Raised max file size for upload streaming to 1GB (#768)

schema

🧪 Add support for retry in the overrides object of the throttle configuration (#761)

misc

🔧 Fix failing tests in dependabot's PRs (#762)

15.6.0

released 2024-03-26

cli

📜 Document allowGetBody option in z.request() (#752)
📜 Update document on the throttle configuration to include key and overrides attributes, and action scope (#760)

core

🔧 Change trigger output check logic for the newly-added primary property in outputFields (#754)

schema

🎉 Allow to set primary in outputFields to define the unique key for deduplication (#754)
🧪 Add support for overrides in the throttle configuration (#755)
🧪 Add support for key in the throttle configuration and action scope (#757)

15.5.3

released 2024-02-08

cli

🐛 Fixed bug in zapier validate where zapier-platform-core was failing to import on version 15.5.2 (#746)

15.5.2

released 2024-02-06

cli

🐛 Fixed bug in zapier convert that crashes due to syntax error in user's code and should not replace source in sample (#730)
🐛 Improved handling of broken symlinks while copying files to temp directory during the build process (#737)
🐛 Fixed bug in zapier build where it failed to run in npm workspaces (#738, #742)
🐛 Fixed converting triggers breaking when trigger key starts with a number (#741)
🔧 Upgraded @oclif/plugin-help dependency, addressing security issue with sub-dependency (#739)
🔧 Updated the "custom-auth" sample to avoid a warning when running zapier validate (#724)

core

🐛 Updated TypeScript method types in RawHttpResponse (#735)
🐛 Use node-fetch TypeScript types in BaseHttpResponse (#736)

misc

📜 Updated rest hook tutorial to include content for expiring webhooks (#731)
📜 Documenting 5 min cache behavior of hydration and how to workaround (#740)

15.5.1

released 2023-11-21

cli

📜 Update zapier logs documentation to mention default user target (#721)

core

💅 Allow server to decide when to truncate log fields (#725)

schema

None!

misc

🔨 Bump axios from 1.2.3 to 1.6.1 (#726)

15.5.0

released 2023-11-08

cli

None!

core

None!

schema

💅 Add steadyState property on the FieldSchema for steady state deduplication on trigger polls (#721)

misc

🔨 Bump browserify-sign from 4.0.4 to 4.2.2 (#719)

15.4.2

released 2023-11-01

cli

📜 Update z.cursor documentation for handling end of the result set (#703)

core

🔨 Bump secret-scrubber-js to v1.0.8 (#717)

schema

📜 Correct the 'value' and 'sample' description in the 'FieldChoicesWithLabel' schema (#716)

misc

🔨 Bump @babel/traverse from 7.14.0 to 7.23.2 (#715)
📜 Fix broken link in README-source.md (#714)
📜 Fix broken link in readme.md (#713)

schema

🎉 Added support for throttle configuration (#709)

misc

🐛 Fixed building of boilerplate having lingering old files from previous builds (#708)
🔨 Bumped get-func-name version from 2.0.0 to 2.0.2 (#707)

15.3.0

released 2023-09-19

cli

None!

core

None!

schema

💅 (Experimental) Extend Custom Auth to support OTP (#702)

misc

📜 Bring over paging cursor doc changes added in visual-builder repo (#701)
🐛 Updating example Github app unit tests (#700)
📜 Update version mismatch (#699)
🐛 Fix legacy scripting runner test (#697)

15.1.0

released 2023-09-07

cli

🐛 Removed the logic converting an empty array to undefined in changelog metadata (#690)
💅 Integration title length must be at least 2 characters (#693)

core

None!

schema

None!

legacy-scripting-runner

🐛 Fixed a flaky test for legacy scripting runner (#697)

misc

📜 Added links to relevant support documentation (#692)
📜 Fixed markdown formatting for backtick usage (#691)
📜 Added detail on encoding defaults in the API documentation (#689)
📜 Added detail on OAuth state parameter in the API documentation (#683)
📜 Minor updates to CLI documentation and rebuild (#688)
📜 Moved up template explanation in README (#682)
📜 Added detail on the 'computed' flag in the API documentation (#686)
📜 Added detail on callback URL parameter in the API documentation (#687)
📜 Updated GitHub CLI tutorial app documentation (#679)
🔨 Bumped word-wrap version from 1.2.3 to 1.2.4 (#680)
🔨 Bumped cli, core, schema from 15.0.0 to 15.0.1 (#678)

15.0.1

released 2023-07-10

cli

🐛 zapier convert now uses jest test template scaffold instead of mocha (#674)

core

None!

schema

None!

misc

📜 Documentation update related to example apps (#675, #672, #671)
📜 Documentation update related to outdated hyperlinks (#673)
📜 Documentation update to match public platform docs (#670)

15.0.0

released 2023-06-30

Version 15.0.0 is a breaking change release that contains several important upgrades and deprecations. Here is a brief breakdown of the changes (❗ denotes a breaking change):

❗ Changelog is required for promotions. Prior to v15.0.0, providing a changelog was optional for promoting an app; this is now required. You can also append changelog metadata to help categorize whether the changes are related to bug fixes or a new feature.
❗ Remove important field from the schema. The important field was deprecated in v14.0.1 (#644) and now we are removing it in this release.
❗ Apps can now use Node.js v18.x and Node.js v14.x is no longer supported. (a) Any integrations that depend on zapier-platform-core@15.0.0 will now run on Node.js 18. (b) We are dropping support for Node.js 14, which has been designated end-of-life since 2023-04-30 (see the Node.js release schedule).

cli

🐛 zapier convert now uses jest test template scaffold instead of mocha (#674)
🐛 zapier login --sso points to the correct link for fetching Deploy Keys (#666)
🐛 zapier convert should convert source fields (#660)
❗ Changelog is required for promotions (#653)

core

❗ Apps can now use Node.js v18.x and Node.js v14.x is no longer supported (#665)

schema

❗ Remove important field from the schema (#662)

misc

📜 Documentation update related to redirect caveat in public apps (#661)
📜 Documentation update related to supplement the "Output Fields" section (#654)
🔨 Dependency updates (#668, #665)

CLI
- Bump @oclif/command@1.8.21 to @oclif/command@1.8.27
- Bump @oclif/config@1.18.6 to @oclif/command@1.18.10
- Bump fs-extra@10.0.0 to @oclif/command@11.1.1
- Bump jscodeshift@0.14.0 to jscodeshift@0.15.0
- Bump marked-terminal@5.1.1 to marked-terminal@5.2.0
- Bump prettier@2.8.3 to prettier@2.8.8
- Bump read@2.0.0 to read@2.1.0
- Bump semver@7.3.8 to semvar@7.5.2
- Bump yeoman-generator@5.7.0 to yeoman-generator@5.9.0
- Bump nock@13.3.0 to nock@13.3.1
Core
- Bump node-abort-controller@3.0.1 to node-abort-controller@3.1.1
- Bump semver@7.3.5 to semvar@7.5.2
- Bump aws-sdk@2.1300.0 to aws-sdk@2.1397.0
- Bump fs-extra@10.0.0 to fs-extra@11.1.1
- Bump @types/node@18.11.18 to @types/node@20.3.1
Legacy
- Bump moment-timezone@0.5.35 to moment-timezone@0.5.43
- Bump aws-sdk@2.1300.0 to aws-sdk@2.1397.0
- Bump nock@13.3.0 to nock@13.3.1
Schema
- Bump jsonschema@1.2.2 to jsonschema@1.4.1
- Bump fs-extra@10.0.0 to fs-extra@11.1.1

14.1.1

released 2023-06-07

cli

📜 Improve docs related to expected behaviors for configuring OAuth2 with PKCE (#655)
📜 Improve docs related to hydration payload limit(#656)
🔨 Dependency updates
- Bump typescript in template generator from 4.2.4 to 4.9.4 (#657)

core

None!

schema

None!

misc

None!

14.0.1

released 2023-05-22

cli

🐛 Fix duplicate authentication field keys being generated by the zapier convert command (#639)
🐛 Fix missing key property in the .zapierapprc file after running the zapier convert command (#640)
📜 Improve docs related to expected behaviors for stale authentication (#647)

core

None!

schema

📜 Deprecate the important key of the BasicDisplaySchema. This property will be removed and hence a breaking change ❗ in the next major version release. (#644)

misc

🔨 Dependency updates
- Bump moment from 2.24.0 to 2.29.4 (#635)
- Bump minimatch from 3.0.4 to 3.0.5 (#634)

14.0.0

released 2023-03-21

Version 14.0.0 is a breaking change release that contains several important upgrades and deprecations. Here is a brief breakdown of the changes (❗ denotes a breaking change):

❗ altersDynamicFields no longer defaults to true when dynamic is set. You should now set the flag appropriately. If a dynamic dropdown (i.e. a field with dynamic set) should refresh other input fields, you must set altersDynamicFields to true on v14.
```
inputFields: [
  {
    key: 'city',
    dynamic: 'city.id.name',
    altersDynamicFields: true  // <- set this appropriately on v14
  }
]
```
❗ Before v14, the Zap editor didn't really use canPaginate. Instead, it made two requests and compared them to determine if pagination is supported. Starting from v14, canPaginate is required for the Zap editor to show the Load More button for pagination.
```
triggers: {
  contact: {
    operation: {
      canPaginate: true  // <- set this appropriately on v14
    }
  }
}
```
❗ Now you are required to provide meta information about your app, such as your intended audience and app category (if that information isn't already provided). If you are missing this information, you will be blocked from making updates to your integration (zapier promote, zapier upload, zapier push). Use zapier register with zapier-platform-core@14.0.0 or go to https://developer.zapier.com/app/{app_id}/version/{version}/settings to fill it out.
On v14, OAuth2 implementation now supports PKCE! See our documentation for details.

Read on for a detailed set of release notes. Again, ❗ are BREAKING CHANGEs.

cli

❗ Implement individual field flags for register command (#618)
❗ Block promote, upload, and push for missing required app info (#612)
💅 Use uniform field names in check-missing-app-info util (#630)
💅 Only require fields for private integrations via CLI (#628)
💅 Implement --yes flag for register command (#627)
📜 Improve documentation on throttling (#631)
📜 Add documentation for PKCE OAuth2 (#629)
📜 Add information about how to return line items (#620)
📜 Fix 'integraiton' typo in CLI docs (#613)

core

🔨 bump http-cache-semantics from 4.1.0 to 4.1.1 (#617)

schema

🎉 Add enablePkce to oauth2Config (#623)
🔨 searchAndCreates and searchOrCreates can coexist to avoid search key collision (#624)
📜 Add clarity on role of performList for testing REST Hooks (#619)

misc

📜 Small followup improvement on GitHub issue templates (#625)
📜 Replace issue templates with GitHub forms, update CODEOWNERS (#622)

Old Releases

The changelogs for older versions can be found in the changelog directory.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

16.0.0

cli

core

schema

schema-to-ts

misc

15.19.0

cli

core

schema

schema-to-ts

misc

15.18.1

cli

core

schema

15.18.0

cli

core

schema

schema-to-ts

misc

15.17.0

cli

core

schema

misc

15.16.1

cli

core

schema

misc

15.16.0

cli

core

schema

misc

15.15.0

cli

core

schema

15.14.2

cli

core

schema

misc

15.14.1

cli

core

schema

misc

15.14.0

cli

core

schema

misc

15.13.0

cli

core

schema

misc

15.12.0

cli

core

schema

schema-to-ts

misc

15.11.1

core

cli

schema

15.11.0

core

cli