feat(clerk-expo): Support expo passkeys #4352

AlexNti · 2024-10-17T15:24:13Z

Description

🔐 This PR introduces passkey support for Expo iOS, Android, and Web. 🚀

🛠 Usage

To enable passkeys in your Expo project, update your ClerkProvider as follows:

import { ClerkProvider } from '@clerk/clerk-expo';
import { passkeys } from '@clerk/clerk-expo/passkeys';

<ClerkProvider passkeys={passkeys}>
  {/* Your app here */}
</ClerkProvider>

🔑 Creating a Passkey

const { user } = useUser();

const handleCreatePasskey = async () => {
  if (!user) return;
  try {
    return await user.createPasskey();
  } catch (e: any) {
    // handle error
  }
};

🔓 Authenticating with a Passkey

const { signIn, setActive } = useSignIn();

const handlePasskeySignIn = async () => {
  try {
    const signInResponse = await signIn.authenticateWithPasskey();
    await setActive({ session: signInResponse.createdSessionId });
  } catch (err: any) {
    // handle error
  }
};

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

changeset-bot · 2024-10-17T15:24:18Z

🦋 Changeset detected

Latest commit: b39bce4

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

This PR includes changesets to release 19 packages

Name	Type
@clerk/clerk-js	Minor
@clerk/shared	Minor
@clerk/types	Minor
@clerk/clerk-expo	Minor
@clerk/chrome-extension	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/elements	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch
@clerk/tanstack-start	Patch
@clerk/testing	Patch
@clerk/ui	Patch
@clerk/localizations	Patch
@clerk/themes	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

AlexNti · 2024-10-18T08:49:25Z

!snapshot

clerk-cookie · 2024-10-18T08:53:24Z

Hey @AlexNti - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.3.16-snapshot.v84a6da3
@clerk/backend	1.14.1-snapshot.v84a6da3
@clerk/express	1.3.1-snapshot.v84a6da3
@clerk/fastify	2.0.3-snapshot.v84a6da3
@clerk/nextjs	5.7.5-snapshot.v84a6da3
@clerk/remix	4.2.39-snapshot.v84a6da3
@clerk/clerk-sdk-node	5.0.52-snapshot.v84a6da3
@clerk/tanstack-start	0.4.15-snapshot.v84a6da3
@clerk/testing	1.3.13-snapshot.v84a6da3

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

anagstef · 2024-10-18T09:27:20Z

!snapshot

clerk-cookie · 2024-10-18T09:31:37Z

Hey @anagstef - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.3.16-snapshot.vd00b3bb
@clerk/backend	1.14.1-snapshot.vd00b3bb
@clerk/chrome-extension	1.3.21-snapshot.vd00b3bb
@clerk/clerk-js	5.28.0-snapshot.vd00b3bb
@clerk/elements	0.16.3-snapshot.vd00b3bb
@clerk/clerk-expo	2.3.0-snapshot.vd00b3bb
@clerk/express	1.3.1-snapshot.vd00b3bb
@clerk/fastify	2.0.3-snapshot.vd00b3bb
@clerk/localizations	3.3.1-snapshot.vd00b3bb
@clerk/nextjs	5.7.5-snapshot.vd00b3bb
@clerk/clerk-react	5.12.1-snapshot.vd00b3bb
@clerk/remix	4.2.39-snapshot.vd00b3bb
@clerk/clerk-sdk-node	5.0.52-snapshot.vd00b3bb
@clerk/shared	2.9.3-snapshot.vd00b3bb
@clerk/tanstack-start	0.4.15-snapshot.vd00b3bb
@clerk/testing	1.3.13-snapshot.vd00b3bb
@clerk/themes	2.1.38-snapshot.vd00b3bb
@clerk/types	4.27.0-snapshot.vd00b3bb

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

AlexNti · 2024-10-23T16:28:40Z

!snapshot

clerk-cookie · 2024-10-23T16:33:46Z

Hey @AlexNti - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.4.1-snapshot.v1f5c4b4
@clerk/backend	1.15.1-snapshot.v1f5c4b4
@clerk/chrome-extension	1.3.22-snapshot.v1f5c4b4
@clerk/clerk-js	5.29.0-snapshot.v1f5c4b4
@clerk/elements	0.17.1-snapshot.v1f5c4b4
@clerk/clerk-expo	2.3.0-snapshot.v1f5c4b4
@clerk/express	1.3.3-snapshot.v1f5c4b4
@clerk/fastify	2.0.5-snapshot.v1f5c4b4
@clerk/localizations	3.3.2-snapshot.v1f5c4b4
@clerk/nextjs	6.0.1-snapshot.v1f5c4b4
@clerk/clerk-react	5.13.1-snapshot.v1f5c4b4
@clerk/remix	4.2.41-snapshot.v1f5c4b4
@clerk/clerk-sdk-node	5.0.54-snapshot.v1f5c4b4
@clerk/shared	2.10.1-snapshot.v1f5c4b4
@clerk/tanstack-start	0.4.17-snapshot.v1f5c4b4
@clerk/testing	1.3.15-snapshot.v1f5c4b4
@clerk/themes	2.1.39-snapshot.v1f5c4b4
@clerk/types	4.28.0-snapshot.v1f5c4b4

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

AlexNti · 2024-10-23T16:43:44Z

!snapshot

clerk-cookie · 2024-10-23T16:48:03Z

Hey @AlexNti - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.4.1-snapshot.va96a299
@clerk/backend	1.15.1-snapshot.va96a299
@clerk/chrome-extension	1.3.22-snapshot.va96a299
@clerk/clerk-js	5.29.0-snapshot.va96a299
@clerk/elements	0.17.1-snapshot.va96a299
@clerk/clerk-expo	2.3.0-snapshot.va96a299
@clerk/express	1.3.3-snapshot.va96a299
@clerk/fastify	2.0.5-snapshot.va96a299
@clerk/localizations	3.3.2-snapshot.va96a299
@clerk/nextjs	6.0.1-snapshot.va96a299
@clerk/clerk-react	5.13.1-snapshot.va96a299
@clerk/remix	4.2.41-snapshot.va96a299
@clerk/clerk-sdk-node	5.0.54-snapshot.va96a299
@clerk/shared	2.10.1-snapshot.va96a299
@clerk/tanstack-start	0.4.17-snapshot.va96a299
@clerk/testing	1.3.15-snapshot.va96a299
@clerk/themes	2.1.39-snapshot.va96a299
@clerk/types	4.28.0-snapshot.va96a299

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

AlexNti · 2024-10-23T18:52:10Z

!snapshot

AlexNti · 2024-10-23T18:59:58Z

!snapshot

clerk-cookie · 2024-10-23T19:04:24Z

Hey @AlexNti - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.4.1-snapshot.vb92f3ea
@clerk/backend	1.15.1-snapshot.vb92f3ea
@clerk/chrome-extension	1.3.22-snapshot.vb92f3ea
@clerk/clerk-js	5.29.0-snapshot.vb92f3ea
@clerk/elements	0.17.1-snapshot.vb92f3ea
@clerk/clerk-expo	2.3.0-snapshot.vb92f3ea
@clerk/express	1.3.3-snapshot.vb92f3ea
@clerk/fastify	2.0.5-snapshot.vb92f3ea
@clerk/localizations	3.3.2-snapshot.vb92f3ea
@clerk/nextjs	6.0.1-snapshot.vb92f3ea
@clerk/clerk-react	5.13.1-snapshot.vb92f3ea
@clerk/remix	4.2.41-snapshot.vb92f3ea
@clerk/clerk-sdk-node	5.0.54-snapshot.vb92f3ea
@clerk/shared	2.10.1-snapshot.vb92f3ea
@clerk/tanstack-start	0.4.17-snapshot.vb92f3ea
@clerk/testing	1.3.15-snapshot.vb92f3ea
@clerk/themes	2.1.39-snapshot.vb92f3ea
@clerk/types	4.28.0-snapshot.vb92f3ea

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

AlexNti · 2024-10-23T20:25:25Z

!snapshot

clerk-cookie · 2024-10-23T20:32:04Z

Hey @AlexNti - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	1.4.1-snapshot.vaa1630d
@clerk/backend	1.15.1-snapshot.vaa1630d
@clerk/chrome-extension	1.3.22-snapshot.vaa1630d
@clerk/clerk-js	5.29.0-snapshot.vaa1630d
@clerk/elements	0.17.1-snapshot.vaa1630d
@clerk/clerk-expo	2.3.0-snapshot.vaa1630d
@clerk/express	1.3.3-snapshot.vaa1630d
@clerk/fastify	2.0.5-snapshot.vaa1630d
@clerk/localizations	3.3.2-snapshot.vaa1630d
@clerk/nextjs	6.0.1-snapshot.vaa1630d
@clerk/clerk-react	5.13.1-snapshot.vaa1630d
@clerk/remix	4.2.41-snapshot.vaa1630d
@clerk/clerk-sdk-node	5.0.54-snapshot.vaa1630d
@clerk/shared	2.10.1-snapshot.vaa1630d
@clerk/tanstack-start	0.4.17-snapshot.vaa1630d
@clerk/testing	1.3.15-snapshot.vaa1630d
@clerk/themes	2.1.39-snapshot.vaa1630d
@clerk/types	4.28.0-snapshot.vaa1630d

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/clerk-sdk-node

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

…functions Adding __unstable__createPublicCredentials __unstable__getPublicCredentials __unstable__isWebAuthnSupported which are going to be used to override the webAuthnCreateCredential,webAuthnGetCredential and isWebAuthnSupported

…hnSupported In this commit we are overriding the above functions with __unstable__createPublicCredentials __unstable__getPublicCredentials and __unstable__isWebAuthnSupported, this will happen only if we are on an Expo application

…unctions

clerk-cookie added types clerk-js expo labels Oct 17, 2024

AlexNti force-pushed the feat/expo-passkeys branch from fb2db15 to 84a6da3 Compare October 17, 2024 15:25

AlexNti requested a review from panteliselef October 17, 2024 15:25

AlexNti force-pushed the feat/expo-passkeys branch from d00b3bb to 5c7e219 Compare October 23, 2024 09:53

AlexNti and others added 10 commits October 24, 2024 10:22

move CredentialReturn type to passskeys type

88e4297

feat(expo): Allow clerk provider to receive passkey functions as props

de617a0

consume CredentialReturn from types

33ca2b3

chore(expo): Add optional operator to passkeysFunc

e0273db

Add changeset

dde4ae5

chore: Rename passkeysFunc => passkeys

b64e26a

chore: Simplify the code by removing the if statements for injected f…

c667744

…unctions

chore: Export ClerkWebAuthnError from shared error package

022fac8

AlexNti added 3 commits October 24, 2024 10:22

chore: change type of passkeys.get function

97b8772

chore: Fix wrong type at create clerk instance

dc2c636

chore: Fix missing props at __unstable__getPublicCredentials

1b742a8

AlexNti force-pushed the feat/expo-passkeys branch from aa1630d to 1b742a8 Compare October 24, 2024 07:22

AlexNti added 2 commits October 24, 2024 10:33

chore: Add changeset

a69d808

chore: Update changesets

b39bce4

AlexNti marked this pull request as ready for review October 24, 2024 08:24

AlexNti requested review from octoper, LekoArts and anagstef October 24, 2024 08:41

AlexNti changed the title ~~Feat/expo passkeys [WIP]~~ Feat/expo passkeys Oct 24, 2024

AlexNti mentioned this pull request Oct 24, 2024

feat(clerk-expo-passkeys): Introduce Passkeys module for expo #4361

Open

9 tasks

AlexNti changed the title ~~Feat/expo passkeys~~ feat(expo): Support expo passkey Oct 24, 2024

AlexNti changed the title ~~feat(expo): Support expo passkey~~ feat(expo): Support expo passkeys Oct 24, 2024

AlexNti changed the title ~~feat(expo): Support expo passkeys~~ feat(clerk-expo): Support expo passkeys Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(clerk-expo): Support expo passkeys #4352

feat(clerk-expo): Support expo passkeys #4352

AlexNti commented Oct 17, 2024 •

edited

Loading

changeset-bot bot commented Oct 17, 2024 •

edited

Loading

AlexNti commented Oct 18, 2024

clerk-cookie commented Oct 18, 2024

anagstef commented Oct 18, 2024

clerk-cookie commented Oct 18, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

feat(clerk-expo): Support expo passkeys #4352

Are you sure you want to change the base?

feat(clerk-expo): Support expo passkeys #4352

Conversation

AlexNti commented Oct 17, 2024 • edited Loading

Description

🛠 Usage

🔑 Creating a Passkey

🔓 Authenticating with a Passkey

Checklist

Type of change

changeset-bot bot commented Oct 17, 2024 • edited Loading

🦋 Changeset detected

AlexNti commented Oct 18, 2024

clerk-cookie commented Oct 18, 2024

anagstef commented Oct 18, 2024

clerk-cookie commented Oct 18, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 23, 2024

clerk-cookie commented Oct 23, 2024

AlexNti commented Oct 17, 2024 •

edited

Loading

changeset-bot bot commented Oct 17, 2024 •

edited

Loading