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.

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

Consider renaming the @prisma/sdk package to reduce confusion #10725

Closed
nikolasburk opened this issue Dec 16, 2021 · 5 comments
Closed

Consider renaming the @prisma/sdk package to reduce confusion #10725

nikolasburk opened this issue Dec 16, 2021 · 5 comments
Assignees
Labels
kind/tech A technical change. team/client Issue for team Client. team/schema Issue for team Schema. topic: breaking change topic: prisma4 topic: sdk topic: tech debt Initiatives to improve the experience of working with the code base
Milestone

Comments

@nikolasburk
Copy link
Member

The name @prisma/sdk is a bit confusing since it's not really an SDK, so we might consider renaming it. Based on this internal Slack convo:

image

@YassinEldeeb
Copy link
Contributor

YassinEldeeb commented Dec 16, 2021

Yeah it should be renamed to be like "common" or "helpers" cause a lot of people think that it's an API for external usage from its name, but it's a really good point that this is a breaking change cause there are a lot of repositories depending on @prisma/sdk rn.

@janpio janpio added kind/tech A technical change. team/client Issue for team Client. topic: sdk labels Dec 22, 2021
@Jolg42
Copy link
Member

Jolg42 commented Jan 10, 2022

Thanks @YassinEldeeb for your feedback!

Note: We are considering adding a deprecation message soon and rename it for future major Prisma version (date undefined yet)

@Jolg42 Jolg42 added process/candidate team/schema Issue for team Schema. topic: tech debt Initiatives to improve the experience of working with the code base labels Mar 3, 2022
@Jolg42
Copy link
Member

Jolg42 commented Mar 3, 2022

[Internal]

Me, Pierre and Alexey created a draft of a plan the renaming
https://www.notion.so/prismaio/Renaming-prisma-sdk-and-cleaning-up-internal-packages-f217f9ba96aa40fd91f47995b9266dc3
Work in progress, nothing planned yet, but this would be the general direction we want to go for.

@Jolg42 Jolg42 added this to the 3.12.0 milestone Mar 16, 2022
@Jolg42 Jolg42 self-assigned this Jun 10, 2022
@Jolg42 Jolg42 modified the milestones: 3.12.0, 4.0.x Jun 10, 2022
Jolg42 added a commit that referenced this issue Jun 17, 2022
Jolg42 added a commit that referenced this issue Jun 17, 2022
* ci(sdk): start publishing `@prisma/internals`

To unblock #13868

Related #10725

* fix: add `--access public`

Tells the registry that the published package should be public

(cherry picked from commit e3d0098)

* fix script

* fix script 2

(cherry picked from commit a0265b6)
@jkomyno
Copy link
Contributor

jkomyno commented Jun 27, 2022

Can we move this issue to "done"?

@Jolg42
Copy link
Member

Jolg42 commented Jun 27, 2022

The internal package @prisma/sdk will be available under the new, more explicit name @prisma/internals from Prisma version 4.0.0.

@prisma/sdk will be published for Prisma 4.0.0 and marked as deprecated on npm, it will be the last version published in its current shape.
The upgrade path would be to rename the usage @prisma/sdk to @prisma/internals.

⚠️ Note that functionality of this internal package can be changed or even removed any time and our SemVer guarantees (no breaking changes without major version increase) are not valid here.

Making the intended use of that package explicit (internal only) is important as it helps to manage expectations with users.

This is technically not a breaking change as usage of the sdk package was not documented nor supported.

If you are using this package, it would be helpful if you could help us gain an understanding of where, how and why you are using it. Your feedback will be valuable to us to define a better API. Please share this information at #13877 - Thanks!

npm packages
https://www.npmjs.com/package/@prisma/sdk
https://www.npmjs.com/package/@prisma/internals

@Jolg42 Jolg42 closed this as completed Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/tech A technical change. team/client Issue for team Client. team/schema Issue for team Schema. topic: breaking change topic: prisma4 topic: sdk topic: tech debt Initiatives to improve the experience of working with the code base
Projects
None yet
Development

No branches or pull requests

7 participants