|
| 1 | +--- |
| 2 | +title: "Deprecation of @codat/sdk-bank-feeds-types and @codat/sdk-connections packages" |
| 3 | +date: "2026-03-27" |
| 4 | +tags: ["Deprecation"] |
| 5 | +authors: tom-binnington-codat |
| 6 | +--- |
| 7 | + |
| 8 | +Codat is consolidating the `@codat/sdk-bank-feeds-types` and `@codat/sdk-connections` npm packages. These packages will no longer be published separately. |
| 9 | + |
| 10 | +<!--truncate--> |
| 11 | + |
| 12 | +As part of our effort to simplify our technical estate, we are merging the type definitions from `@codat/sdk-bank-feeds-types` and `@codat/sdk-connections` into `@codat/sdk-link-types` using subpath exports. This reduces the number of packages you need to manage and aligns all SDK type definitions under a single package. |
| 13 | + |
| 14 | +The existing versions of the deprecated packages will continue to work as thin re-exports, but no new versions will be published. |
| 15 | + |
| 16 | +### New import paths |
| 17 | + |
| 18 | +To use the new `@codat/sdk-link-types` package, replace your existing imports with the new subpath exports: |
| 19 | + |
| 20 | +```typescript |
| 21 | +// Before |
| 22 | +import { CodatConnectionsProps } from "@codat/sdk-connections"; |
| 23 | +import { CodatBankFeedsProps } from "@codat/sdk-bank-feeds-types"; |
| 24 | + |
| 25 | +// After |
| 26 | +import { CodatConnectionsProps } from "@codat/sdk-link-types/connections"; |
| 27 | +import { CodatBankFeedsProps } from "@codat/sdk-link-types/bank-feeds"; |
| 28 | +``` |
| 29 | + |
| 30 | +Additionally, the `initializeCodatBankFeeds` function has been renamed to `initCodatBankFeeds`. The old function name is available as a deprecated alias. |
| 31 | + |
| 32 | +## Action required |
| 33 | + |
| 34 | +If you need to bump the package version or want to move to using `@codat/sdk-link-types` to take advantage of future feature releases, follow these steps: |
| 35 | + |
| 36 | +1. Update your project to use `@codat/sdk-link-types@1.11.0` or later. |
| 37 | +2. Replace imports from `@codat/sdk-connections` with `@codat/sdk-link-types/connections`. |
| 38 | +3. Replace imports from `@codat/sdk-bank-feeds-types` with `@codat/sdk-link-types/bank-feeds`. |
| 39 | +4. If you use `initializeCodatBankFeeds`, rename it to `initCodatBankFeeds`. |
| 40 | + |
| 41 | +## Expected impact if no action is taken |
| 42 | + |
| 43 | +Your existing code will continue to work as the deprecated packages now re-export from `@codat/sdk-link-types`. However, the old packages won't receive updates and will eventually be removed. As a result, you may miss feature enhancements that will be published under `@codat/sdk-link-types`. You will also see deprecation warnings in your IDE for the old init functions. |
0 commit comments