Skip to content

Conversation

whitelisab
Copy link
Contributor

@whitelisab whitelisab commented Apr 9, 2025

Summary

As a follow up to this PR (#2609) we are making the version param required for the entry patch method of the plain client.

Description

client.entry.patch expects version to be passed in, however version is currently not included in the TypeScript types. This param was made optional, and now we are making this required. This will be released as a breaking change in CMA.js v12.

Motivation and Context

Checklist (check all before merging)

  • ✅ Both unit and integration tests are passing
  • ❌ There are no breaking changes
  • ✅ Changes are reflected in the documentation

When adding a new method:

  • The new method is exported through the default and plain CMA client
  • All new public types are exported from ./lib/export-types.ts
  • Added a unit test for the new method
  • Added an integration test for the new method
  • The new method is added to the documentation

@whitelisab whitelisab requested review from a team as code owners April 9, 2025 19:47
@whitelisab whitelisab changed the base branch from master to release/v12 April 16, 2025 15:30
@whitelisab whitelisab merged commit ed442d6 into release/v12 Apr 16, 2025
6 checks passed
@whitelisab whitelisab deleted the fix/dx-34-make-version-required branch April 16, 2025 15:31
whitelisab added a commit that referenced this pull request Apr 16, 2025
* BREAKING CHANGE: full ESM support (#2472)

* fix: clean dependencies, delete unused file, migrated overlooked tests from last merge

* refactor: build process now supports TS, ESM, CJS and browser

* build: upgrade to ESM version of contentful-sdk-core

* test: reduce bundle size limits thanks to our optimizations

* build: clean up depdency changes

* chore: typos

* feat: this SDK now also includes its version number in its bundles

* test: fix output integration tests

* build: npm dedupe

* build: latest rollup dependencies

* fix: use with keyword instead of assert to mark import as json

* build: update depndencies related to this branch

* build: make npm happy to resolve our dependencies without --force

* test: ensure new failing typescript lint rules throw warnings only - still should be resolved at some point

* test: fix import paths

* build: ensure json-patch is available for typescript in projects using this api client

* ci: update node version

* fix: adjust import path

* style: ensure prettier doesnt fail on our rollup config file

* style: format code to make prettier lint happy

* style: format code to make prettier lint happy #2

* ci: update circleci config to match our new setup

* ci: cleanup

* test: slightly increase bundle size limits

* feat: introduce MIGRATION.md file

* docs: readme cleanup

* fix: move types definition to top of exports as demanded by node docs

* fix: disable linting on inject-env file

* docs: fix wrong link

---------

Co-authored-by: Lisa White <[email protected]>

* fix: replace `SysLink` & `MetaLinkProps` with `Link<T>` to improve type safety [CFISO-2344] (#2590)

* fix: replace `SysLink` & `MetaLinkProps` with `Link<T>` to improve type safety

* chore: prettier

* fix: more specific types for subject links

* fix: snapshots are created by users

* fix: webhook health is created by webhook defs

* fix: webhook call is created by webhook defs

* chore: formatting

* fix: update AiAction links

* fix: `createdBy` etc should be a union, not an object

* fix: remove unused types

* fix: remove import

* feat: narrow `sys.type` to a string literal type for better type safety (#2611)

* feat: narrow `sys.type` to a string literal type for better type safety

* fix: types for `Usage`

* chore: prettier

* feat: align taxonomy update methods with standard [NONE] (#2478)

* fix: make version param required for entry patch method of plain client [DX-34] (#2610)

---------

Co-authored-by: Benedikt Rötsch <[email protected]>
Co-authored-by: Andi Pätzold <[email protected]>
Co-authored-by: LiamStokingerContentful <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant