chore(clerk-js,backend,shared):Apply deprecation warnings `@clerk/types` by dimkl · Pull Request #1823 · clerk/javascript

dimkl · 2023-10-03T16:58:52Z

Description

Review it per commit

Deprecations:

orgs jwt claims
apiKey
frontendApi
redirect_url
password
generateSignature
afterSwitchOrganizationUrl
profileImageUrl

Other changes:

fix typo of frontendApi

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Packages affected

changeset-bot · 2023-10-03T16:58:55Z

🦋 Changeset detected

Latest commit: 10fb826

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
@clerk/clerk-js	Patch
@clerk/backend	Patch
@clerk/shared	Patch
@clerk/clerk-react	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/fastify	Patch
gatsby-plugin-clerk	Patch
@clerk/nextjs	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

brkalow · 2023-10-05T18:45:17Z

 import type { PublicUserDataJSON } from '@clerk/types';

-export class OrganizationPublicUserData implements PublicUserData {
+export class PublicUserData implements IPublicUserData {


❓ Why are we renaming this class?

Because the publicUserData property is the same for all Resources (eg OrganizationMembership , Session), so there is no need to create a separate class for each resource.

…nal key arg

…rontendApi deprecations

…*UserData classes

ZeldOcarina · 2023-10-10T14:04:54Z

Hi I am now getting DEPRECATION WARNING: "frontendApi" is deprecated and will be removed in the next major release.
How do I fix it?

dimkl · 2023-10-10T14:07:58Z

Hello @ZeldOcarina
I think that there is another line in the deprecation warning which indicates that you should use the publishableKey instead of frontendApi. This warning may be caused by using the environment variable related to the forntendApi.

ZeldOcarina · 2023-10-10T14:43:22Z

Hi @dimkl it only says this:

DEPRECATION WARNING: "frontendApi" is deprecated and will be removed in the next major release.
Use `publishableKey` instead.

I am just using these as envs:

CLERK_PUBLISHABLE_KEY=pk_test_**********
CLERK_SECRET_KEY=sk_test_***********
CLERK_JWT_JSON_ENDPOINT=https://clerk.monarchy.io/.well-known/jwks.json

dimkl · 2023-10-10T15:00:50Z

@ZeldOcarina let me take a better look at it, and I will get back to you :)
How do you use CLERK_JWT_JSON_ENDPOINT env? This is not an environment variable used internally by Clerk.
Also what packages are you using?

ZeldOcarina · 2023-10-10T15:15:49Z

I am using :

"@clerk/clerk-sdk-node": "^4.12.12",
"@clerk/remix": "^3.0.5",

That env was in an old guide, if not needed anymore I can delete it I am not manually using it anywhere!

dimkl · 2023-10-10T16:41:26Z

@ZeldOcarina you can drop this env.
Also about the deprecation warnings, this PR should resolve your case: #1856

yns01 · 2023-11-08T09:18:41Z

Hey @dimkl, I'm still getting the warning:

Clerk - DEPRECATION WARNING: "frontendApi" is deprecated and will be removed in the next major release.
Use `publishableKey` instead.

I'm using

    "@clerk/localizations": "^1.26.8",
    "@clerk/remix": "^3.1.3",

and I have the following env defined:

CLERK_PUBLISHABLE_KEY
CLERK_SECRET_KEY

dimkl · 2023-11-08T09:29:06Z

@yns01 thanks for reporting this, i will take a look and come back.

dimkl · 2023-11-09T11:43:18Z

@yns01 Should be fixed in @clerk/remix@3.1.4

dimkl added the v5-pre-release label Oct 3, 2023

dimkl requested a review from a team as a code owner October 3, 2023 16:58

dimkl self-assigned this Oct 3, 2023

clerk-cookie added clerk-js react backend labels Oct 3, 2023

dimkl force-pushed the fix-nextjs-shared-deps branch from bffe9d9 to 63f77bd Compare October 4, 2023 14:07

dimkl force-pushed the apply-deprecation-warnings-types branch from 1e91a8d to 339eeba Compare October 4, 2023 14:08

dimkl force-pushed the fix-nextjs-shared-deps branch 2 times, most recently from 9acaa62 to 319d166 Compare October 5, 2023 12:01

Base automatically changed from fix-nextjs-shared-deps to main October 5, 2023 16:24

dimkl force-pushed the apply-deprecation-warnings-types branch 4 times, most recently from 67930d2 to d8a7164 Compare October 5, 2023 17:14

brkalow reviewed Oct 5, 2023

View reviewed changes

Comment thread packages/clerk-js/src/core/resources/Session.ts

dimkl force-pushed the apply-deprecation-warnings-types branch from d8a7164 to fbad687 Compare October 6, 2023 12:11

brkalow approved these changes Oct 6, 2023

View reviewed changes

dimkl added 10 commits October 6, 2023 23:30

fix(shared): Fix deprecatedObjectProperty key usage and support optio…

868ff6c

…nal key arg

chore(clerk-js): Warn about orgs jwt claim deprecation

0c32d41

chore(backend): Warn about orgs jwt claim deprecation

033ed90

chore(backend): Warn about apiKey deprecation

d0c669b

chore(backend): Fix typo in frontendApi deprecation warning

225e3ef

chore(clerk-react,clerk-js): Warn about PublishableKeyOrFrontendApi.f…

cb1deb3

…rontendApi deprecations

chore(clerk-js): Warn about PublicUserData.profileImageUrl deprecations

4e78724

chore(clerk-js): Warn about redirect_url deprecations

0c04f1f

chore(clerk-js): Warn about password deprecations in User.update

41d8871

chore(clerk-js): Warn about generateSignature deprecations

31f7217

dimkl added 3 commits October 6, 2023 23:30

chore(clerk-js): Warn about afterSwitchOrganizationUrl deprecation

c60c9c2

chore(clerk-js): Warn about UserData.profileImageUrl deprecations

e292115

chore(clerk-js): Use PublicUserData and UserData instead of multiple …

10fb826

…*UserData classes

dimkl force-pushed the apply-deprecation-warnings-types branch from fbad687 to 10fb826 Compare October 6, 2023 20:31

dimkl enabled auto-merge October 6, 2023 20:34

dimkl disabled auto-merge October 6, 2023 20:34

dimkl added this pull request to the merge queue Oct 6, 2023

Merged via the queue into main with commit 1e212c1 Oct 6, 2023

dimkl deleted the apply-deprecation-warnings-types branch October 6, 2023 20:49

clerk-cookie mentioned this pull request Oct 6, 2023

Version Packages #1842

Merged

This was referenced Nov 8, 2023

fix(remix): Avoid always showing frontendApi deprecation #2086

Merged

@clerk/remix - DEPRECATION WARNING: "frontendApi" #2089

Closed

Uh oh!

Conversation

dimkl commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Packages affected

Uh oh!

changeset-bot Bot commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

brkalow Oct 5, 2023

Choose a reason for hiding this comment

Uh oh!

dimkl Oct 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ZeldOcarina commented Oct 10, 2023

Uh oh!

dimkl commented Oct 10, 2023

Uh oh!

ZeldOcarina commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dimkl commented Oct 10, 2023

Uh oh!

ZeldOcarina commented Oct 10, 2023

Uh oh!

dimkl commented Oct 10, 2023

Uh oh!

yns01 commented Nov 8, 2023

Uh oh!

dimkl commented Nov 8, 2023

Uh oh!

dimkl commented Nov 9, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dimkl commented Oct 3, 2023 •

edited

Loading

changeset-bot Bot commented Oct 3, 2023 •

edited

Loading

ZeldOcarina commented Oct 10, 2023 •

edited

Loading