@dotcms/types 26.8.7-1 → 26.8.10-1-next.2504
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,7 @@ The `@dotcms/types` package contains TypeScript type definitions for the dotCMS
|
|
|
9
9
|
|
|
10
10
|
- [Overview](#overview)
|
|
11
11
|
- [Installation](#installation)
|
|
12
|
+
- [Which SDK Version Should I Use?](#which-sdk-version-should-i-use)
|
|
12
13
|
- [Commonly Used Types](#commonly-used-types)
|
|
13
14
|
- [Type Hierarchy (Jump to Definitions)](#type-hierarchy-jump-to-definitions)
|
|
14
15
|
- [AI Search](#ai-search)
|
|
@@ -46,6 +47,34 @@ The `@dotcms/types` package contains TypeScript type definitions for the dotCMS
|
|
|
46
47
|
npm install @dotcms/types@latest --save-dev
|
|
47
48
|
```
|
|
48
49
|
|
|
50
|
+
## Which SDK Version Should I Use?
|
|
51
|
+
|
|
52
|
+
dotCMS SDKs are published in lockstep with dotCMS itself: every `@dotcms/*` package ships
|
|
53
|
+
at the **exact same version number** as the dotCMS release it was built for (e.g. dotCMS
|
|
54
|
+
`26.7.14-1` → `@dotcms/client@26.7.14-1`, `@dotcms/react@26.7.14-1`, and so on).
|
|
55
|
+
|
|
56
|
+
**Simple rule of thumb: use the SDK version that matches your dotCMS instance's version.**
|
|
57
|
+
|
|
58
|
+
You don't have to upgrade the SDK every time dotCMS releases a new version (or vice versa).
|
|
59
|
+
Most releases don't change anything the SDKs rely on, so an older SDK usually keeps working
|
|
60
|
+
fine against a newer dotCMS instance. Occasionally, though, a release does include a real
|
|
61
|
+
breaking change — and if your SDK is older than that point, it will stop working correctly.
|
|
62
|
+
|
|
63
|
+
You don't need to track this yourself: your dotCMS instance always knows the oldest SDK
|
|
64
|
+
version it still supports, and the SDK checks itself against it automatically. If you're
|
|
65
|
+
using an SDK that's too old, you'll see a clear warning in your console telling you to
|
|
66
|
+
upgrade.
|
|
67
|
+
|
|
68
|
+
**Recommendation:** pin your SDKs to the same version as your dotCMS instance, and only bump
|
|
69
|
+
them when you upgrade dotCMS — or when the console tells you to.
|
|
70
|
+
|
|
71
|
+
> **On an LTS release?** LTS releases don't currently get their own matching SDK version.
|
|
72
|
+
> Until that's addressed, use the SDK version published for the closest regular release at
|
|
73
|
+
> or before your LTS version.
|
|
74
|
+
>
|
|
75
|
+
> Want more background on how dotCMS releases and support windows work? See
|
|
76
|
+
> [Release & Support Lifecycle](https://dev.dotcms.com/docs/release-support-lifecycle).
|
|
77
|
+
|
|
49
78
|
## Commonly Used Types
|
|
50
79
|
|
|
51
80
|
```ts
|