PEP-958 - Update SDK type package references to @codat/sdk-link-types#1783
Draft
tom-binnington-codat wants to merge 1 commit intomainfrom
Draft
PEP-958 - Update SDK type package references to @codat/sdk-link-types#1783tom-binnington-codat wants to merge 1 commit intomainfrom
tom-binnington-codat wants to merge 1 commit intomainfrom
Conversation
Connections and Bank Feeds types have been consolidated into @codat/sdk-link-types as subpath exports. Update all docs to use: - @codat/sdk-link-types/connections (was @codat/sdk-connections) - @codat/sdk-link-types/bank-feeds (was @codat/sdk-bank-feeds-types) - initCodatBankFeeds (was initializeCodatBankFeeds, now deprecated) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| :::tip Install the npm package | ||
|
|
||
| Take advantage of our [npm package](https://www.npmjs.com/package/@codat/sdk-connections) so you don't have to manually import and maintain type definitions. You will benefit from it the most if you are using Typescript. | ||
| Take advantage of our [npm package](https://www.npmjs.com/package/@codat/sdk-link-types) so you don't have to manually import and maintain type definitions. You will benefit from it the most if you are using Typescript. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.
| It leverages our [Link SDK](/auth-flow/authorize-embedded-link) to allow your users to quickly and securely share access to their accounting software. It also enables them to set up the mapping between your accounts and the accounts in their software in one seamless flow. | ||
|
|
||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-bank-feeds-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. | ||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-link-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| It leverages our [Link SDK](/auth-flow/authorize-embedded-link) to allow your users to quickly and securely share access to their accounting software. It also enables them to set up the mapping between your accounts and the accounts in their software in one seamless flow. | ||
|
|
||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-bank-feeds-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. | ||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-link-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is included').
| It leverages our [Link SDK](/auth-flow/authorize-embedded-link) to allow your users to quickly and securely share access to their accounting software. It also enables them to set up the mapping between your accounts and the accounts in their software in one seamless flow. | ||
|
|
||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-bank-feeds-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. | ||
| All of this is included in a single low-code JavaScript component (available on [NPM](https://www.npmjs.com/package/@codat/sdk-link-types)). Its rich configuration properties allow your application to interact with the SDK and customize text and branding in a way that creates a trusted and compelling user experience. |
There was a problem hiding this comment.
[Google.WordList] Use 'app' instead of 'application'.
|
Link check results for preview deployment (https://codat-docs-git-PEP-958-update-sdk-type-package-references-codat.vercel.app): |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira
https://codatdocs.atlassian.net/browse/PEP-958
Changes
Connections and Bank Feeds types have been consolidated into
@codat/sdk-link-typesas subpath exports. This PR updates all docs references:@codat/sdk-connections->@codat/sdk-link-types/connections@codat/sdk-bank-feeds-types->@codat/sdk-link-types/bank-feedsinitializeCodatBankFeeds->initCodatBankFeeds(old name is deprecated)@codat/sdk-link-typesFiles changed
docs/auth-flow/optimize/connection-management.md— Connections SDK install/import referencesdocs/bank-feeds/bank-feeds-sdk.md— Bank Feeds SDK install/import referencesdocs/bank-feeds/setup.md— Bank Feeds install commandsblog/241124-bank-feeds-sdk.md— Bank Feeds launch blog postcode_utils/docker/package.json— Snippet dependency