Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: replace vdp-sdk/organization with instill-sdk #1564

Merged
merged 2 commits into from
Oct 28, 2024
Merged

feat: replace vdp-sdk/organization with instill-sdk #1564

merged 2 commits into from
Oct 28, 2024

Conversation

EiffelFly
Copy link
Member

Because

  • vdp-sdk is serverly out-of-date, we want to replace it with our new instill-sdk

This commit

  • replace vdp-sdk with instill-sdk

@linear Linear
Copy link

linear bot commented Oct 25, 2024

INS-6711 Retire the toolkit/vdp-sdk/organization

@github-actions GitHub Actions
Copy link

📦 Next.js Bundle Analysis for instillai-console

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@EiffelFly EiffelFly force-pushed the pochunchiu/ins-6711-retire-the-toolkitvdp-sdkorganization branch from a6f0444 to 739c2a0 Compare October 25, 2024 08:14
@github-actions GitHub Actions
Copy link

📦 Next.js Bundle Analysis for instillai-console

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

orangecoloured
orangecoloured reviewed Oct 25, 2024
View reviewed changes
packages/sdk/src/helper/UndefinedToNull.ts
@@ -0,0 +1,7 @@
export type UnionUndefinedToNull<T> = T extends undefined ? null : T;

export type UndefinedToNull<T> = {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this type do?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will convert all the undefined to null, leave it for future usage

orangecoloured
orangecoloured reviewed Oct 25, 2024
View reviewed changes
packages/toolkit/src/lib/react-query-service/organization/use-organizations/client.ts

const queryKey = getUseOrganizationsQueryKey();

return useQuery({
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it return the orgs based on the access token?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, under the hood BE will use the accessToken to parse the correct user_id

orangecoloured
orangecoloured reviewed Oct 25, 2024
View reviewed changes
packages/toolkit/src/lib/react-query-service/organization/use-organizations/server.ts Outdated
}

export function getUseOrganizationsQueryKey() {
return ["organization"];
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to use plural?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh no... I need to change it

orangecoloured
orangecoloured previously approved these changes Oct 25, 2024
View reviewed changes
Copy link
Collaborator

@orangecoloured orangecoloured left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks like the org endpoints got an updated. Otherwise pure code style stuff.

@EiffelFly EiffelFly changed the title feat: replace vdp-sdk with instill-sdk feat: replace vdp-sdk/organization with instill-sdk Oct 28, 2024
@github-actions GitHub Actions
Copy link

📦 Next.js Bundle Analysis for instillai-console

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@EiffelFly EiffelFly merged commit 2742cc7 into main Oct 28, 2024
8 checks passed
@EiffelFly EiffelFly deleted the pochunchiu/ins-6711-retire-the-toolkitvdp-sdkorganization branch October 28, 2024 07:11
@droplet-bot droplet-bot mentioned this pull request Oct 28, 2024
Merged
EiffelFly pushed a commit that referenced this pull request Nov 5, 2024
@droplet-bot
chore: release main (#1563)
ae051d1 
🤖 I have created a release *beep* *boop*
---


<details><summary>0.62.0-beta</summary>

##
[0.62.0-beta](v0.61.0-beta...v0.62.0-beta)
(2024-11-05)


### Features

* **catalog:** migrate API calls to sdk CatalogClient
([#1572](#1572))
([a305c98](a305c98))
* **integration:** add google-drive integration
([#1569](#1569))
([09eee30](09eee30))
* make the sdk e2e test mark every queryParam as required
([#1577](#1577))
([99c16a2](99c16a2))
* replace vdp-sdk/model with instill-sdk
([#1566](#1566))
([014f3ae](014f3ae))
* retire name parameter in the pipeline related endpoint
([#1575](#1575))
([533e757](533e757))


### Bug Fixes

* fix and adapt new dashboard endpoint
([#1594](#1594))
([e043500](e043500))


### Miscellaneous

* **component:** rename restapi component to http component
([#1579](#1579))
([be56f33](be56f33))
</details>

<details><summary>@instill-ai/design-system: 0.83.0</summary>

##
[0.83.0](https://github.com/instill-ai/console/compare/@instill-ai/design-system-v0.82.1...@instill-ai/design-system-v0.83.0)
(2024-11-05)


### Features

* **design-system:** feat add slider
([#1571](#1571))
([8e3e655](8e3e655))
</details>

<details><summary>@instill-ai/toolkit: 0.110.0</summary>

##
[0.110.0](https://github.com/instill-ai/console/compare/@instill-ai/toolkit-v0.109.0...@instill-ai/toolkit-v0.110.0)
(2024-11-05)


### Features

* **catalog:** add notification while file is being deleted
([#1584](#1584))
([43d1d2e](43d1d2e))
* **catalog:** add Requester UID to example code in Ask and Retrieve
pages ([#1574](#1574))
([4f7b837](4f7b837))
* **catalog:** migrate API calls to sdk CatalogClient
([#1572](#1572))
([a305c98](a305c98))
* **integration:** add google-drive integration
([#1569](#1569))
([09eee30](09eee30))
* make the sdk e2e test mark every queryParam as required
([#1577](#1577))
([99c16a2](99c16a2))
* remove vdp-sdk and rename it to sdk-helper
([#1568](#1568))
([cfcd5ae](cfcd5ae))
* replace vdp-sdk/model with instill-sdk
([#1566](#1566))
([014f3ae](014f3ae))
* replace vdp-sdk/organization with instill-sdk
([#1564](#1564))
([2742cc7](2742cc7))
* retire name parameter in the pipeline related endpoint
([#1575](#1575))
([533e757](533e757))
* retire name parameter of token related endpoints
([#1582](#1582))
([0de03b3](0de03b3))
* retire name parameter on credit related endpoint
([#1580](#1580))
([d1e29b9](d1e29b9))
* retire name parameter on integration related endpoint
([#1581](#1581))
([4b9c21a](4b9c21a))
* revamp catalog sdk and its react-query
([#1578](#1578))
([a8901bd](a8901bd))
* support document format for pipeline input and output
([#1586](#1586))
([8f5c581](8f5c581))


### Bug Fixes

* **artifact:** fix Artifact File details markdown format
([#1570](#1570))
([d67e6c0](d67e6c0))
* **catalog:** disable clone button if namespace is full
([#1592](#1592))
([e8e33b3](e8e33b3))
* **catalog:** fix remove floating tooltip from card
([#1573](#1573))
([0824467](0824467))
* **catalog:** start file upload progress tracking immediately after
uploading files
([#1587](#1587))
([0f57e88](0f57e88))
* fix and adapt new dashboard endpoint
([#1594](#1594))
([e043500](e043500))
* fix cant clone pipeline from pipeline list page
([#1567](#1567))
([d9945a9](d9945a9))
* fix list pipeline's query key is not present, and catalog fileUid
issue ([#1588](#1588))
([8cae285](8cae285))
* fix pipeline is new flag not present issue
([#1583](#1583))
([fb4ebc1](fb4ebc1))
* fix pipeline preview is wrong when reference the component in the same
iterator ([#1589](#1589))
([48cde51](48cde51))


### Miscellaneous

* deprecate the vdp-sdk/metric in toolkit
([#1559](#1559))
([8ca0ad9](8ca0ad9))
* retire vdp-sdk/operation
([#1565](#1565))
([0cc858a](0cc858a))
</details>

<details><summary>instill-sdk: 0.11.0</summary>

##
[0.11.0](instill-sdk-v0.10.0...instill-sdk-v0.11.0)
(2024-11-05)


### Features

* **catalog:** migrate API calls to sdk CatalogClient
([#1572](#1572))
([a305c98](a305c98))
* make the sdk e2e test mark every queryParam as required
([#1577](#1577))
([99c16a2](99c16a2))
* remove vdp-sdk and rename it to sdk-helper
([#1568](#1568))
([cfcd5ae](cfcd5ae))
* replace vdp-sdk/model with instill-sdk
([#1566](#1566))
([014f3ae](014f3ae))
* replace vdp-sdk/organization with instill-sdk
([#1564](#1564))
([2742cc7](2742cc7))
* retire name parameter in the pipeline related endpoint
([#1575](#1575))
([533e757](533e757))
* retire name parameter of token related endpoints
([#1582](#1582))
([0de03b3](0de03b3))
* retire name parameter on credit related endpoint
([#1580](#1580))
([d1e29b9](d1e29b9))
* retire name parameter on integration related endpoint
([#1581](#1581))
([4b9c21a](4b9c21a))
* revamp catalog sdk and its react-query
([#1578](#1578))
([a8901bd](a8901bd))


### Bug Fixes

* **artifact:** fix Artifact File details markdown format
([#1570](#1570))
([d67e6c0](d67e6c0))
* fix and adapt new dashboard endpoint
([#1594](#1594))
([e043500](e043500))
* fix cant clone pipeline from pipeline list page
([#1567](#1567))
([d9945a9](d9945a9))
* fix list pipeline's query key is not present, and catalog fileUid
issue ([#1588](#1588))
([8cae285](8cae285))
* fix pipeline preview is wrong when reference the component in the same
iterator ([#1589](#1589))
([48cde51](48cde51))
* fix sdk integration-test caused by the new revamp of instill-ai
protobuf ([#1576](#1576))
([3691050](3691050))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@orangecoloured orangecoloured orangecoloured left review comments

@pinglin pinglin Awaiting requested review from pinglin pinglin is a code owner

@xiaofei-du xiaofei-du Awaiting requested review from xiaofei-du xiaofei-du is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@EiffelFly @orangecoloured