zapier-platform-cli - npm Package Versions

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

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

core

• :exclamation: Node.js v16.x is no longer supported (#890)

• :exclamation: 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.

• :exclamation: 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

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

misc

• :hammer: 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

• :nail_care: Add support for TS on the zapier scaffold command (#884)

core

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

schema

• :tada: Add meta field support for the FieldSchema (#883)

schema-to-ts

None!

misc

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

15.18.1

released 2024-11-01

cli

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

core

• :bug: Fix issue where HTTP logger can break aws-sdk v3 (and maybe other HTTP client libraries) intermittently (#905)
• :bug: HTTP logging now works with native fetch (#908)
• :test_tube: 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

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

core

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

schema

None!

schema-to-ts

• :tada: Type z.request responses and deprecate .json (#895)

misc

• :scroll: Typo fixes and link changes (#885)
• :scroll: Add docs explaining why hidden triggers for dynamic dropdowns need to declare input fields (#887)
• :scroll: Migrate docs out of this monorepo (#893)
• :scroll: 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

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

core

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

schema

None!

misc

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

15.16.1

released 2024-10-04

cli

None!

core

• :nail_care: Return a descriptive error when a filename cannot be uploaded (#874)

schema

None!

misc

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

15.16.0

released 2024-09-24

cli

• :tada: Introduce zapier canary command (#861)

core

None!

schema

None!

misc

• :hammer: Bump vite from 5.3.3 to 5.4.7 in /schema-to-ts (#868)
• :hammer: 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

• :test_tube: Add checks to support Buffered Create Actions (#832)

schema

• :test_tube: Add performBuffer and buffer to operation schema to support Buffered Create Actions (#832)

15.14.2

released 2024-09-17

cli

None!

core

• :bug: Ensure censoring of OAuth1 tokens in HTTP logs (#864)

schema

None!

misc

None!

15.14.1

released 2024-09-12

cli

None!

core

• :nail_care: Add signal to z.request options (#857)

schema

None!

misc

• :scroll: Add documentation around inputFormat field type (#858)