Skip to content

Commit 2352149

Browse files
authoredApr 8, 2024··
chore(clerk-js): Remove experimental prefixes for Passkey related apis (#3134)
* chore(clerk-js): Remove experimental prefixes for Passkey related apis A few top level experimental still exist in order to ensure that we want break beta testers. Those will be removed soon. * chore(clerk-js): Add stable localization keys for passkeys * chore(clerk-js): Add changeset
1 parent 5c90b21 commit 2352149

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+583
-110
lines changed
 

‎.changeset/gorgeous-schools-drive.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
'@clerk/localizations': minor
3+
'@clerk/clerk-js': minor
4+
'@clerk/types': minor
5+
---
6+
7+
Move passkey related apis to stable:
8+
9+
- Register passkey for a user
10+
Usage: `await clerk.user.createPasskey()`
11+
- Authenticate with passkey
12+
Usage: `await clerk.client.signIn.authenticateWithPasskey()`
13+
```ts
14+
try {
15+
await clerk.client.signIn.authenticateWithPasskey(...args);
16+
}catch (e) {
17+
if (isClerkRuntimeError(e)) {
18+
if (err.code === 'passkey_operation_aborted') {
19+
...
20+
}
21+
}
22+
}
23+
```
24+
- ClerkRuntimeError codes introduced:
25+
- `passkey_not_supported`
26+
- `passkeys_pa_not_supported`
27+
- `passkey_invalid_rpID_or_domain`
28+
- `passkey_already_exists`
29+
- `passkey_operation_aborted`
30+
- `passkey_retrieval_cancelled`
31+
- `passkey_retrieval_failed`
32+
- `passkey_registration_cancelled`
33+
- `passkey_registration_failed`
34+
35+
- Get the user's passkeys
36+
`clerk.user.passkeys`
37+
- Update the name of a passkey
38+
`clerk.user.passkeys?.[0].update({name:'Company issued passkey'})`
39+
- Delete a passkey
40+
`clerk.user.passkeys?.[0].delete()`

‎packages/clerk-js/src/core/resources/Passkey.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import type {
2-
__experimental_PublicKeyCredentialWithAuthenticatorAttestationResponse,
32
DeletedObjectJSON,
43
DeletedObjectResource,
54
PasskeyJSON,
65
PasskeyResource,
76
PasskeyVerificationResource,
7+
PublicKeyCredentialWithAuthenticatorAttestationResponse,
88
UpdatePasskeyParams,
99
} from '@clerk/types';
1010

@@ -42,7 +42,7 @@ export class Passkey extends BaseResource implements PasskeyResource {
4242

4343
private static async attemptVerification(
4444
passkeyId: string,
45-
credential: __experimental_PublicKeyCredentialWithAuthenticatorAttestationResponse,
45+
credential: PublicKeyCredentialWithAuthenticatorAttestationResponse,
4646
) {
4747
const jsonPublicKeyCredential = serializePublicKeyCredential(credential);
4848
return BaseResource._fetch({

0 commit comments

Comments
 (0)
Please sign in to comment.