fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix(elements): Correct TS types for verification machine#3671

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

Merged
LekoArts merged 5 commits into from
Jul 9, 2024
Merged

fix(elements): Correct TS types for verification machine #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58687a8
fix TODO comments
LekoArts Jul 8, 2024
8dc6407
fix types for build
LekoArts Jul 8, 2024
8c59fa8
fix type
LekoArts Jul 8, 2024
05bc219
add empty changeset
LekoArts Jul 8, 2024
e0e2dff
Merge branch 'main' into lekoarts/sdk-1845-correct-ts-types-for-strat…
LekoArts Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/ninety-geese-drop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
17 changes: 7 additions & 10 deletions packages/elements/src/internals/machines/sign-in/utils/starting-factors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
// These utilities are ported from: packages/clerk-js/src/ui/components/SignIn/utils.ts
// They should be functionally identical.
import { isWebAuthnSupported } from '@clerk/shared/webauthn';
import type { PreferredSignInStrategy, SignInFactor } from '@clerk/types';
import type { PreferredSignInStrategy, SignInFactor, SignInFirstFactor, SignInSecondFactor } from '@clerk/types';

const ORDER_WHEN_PASSWORD_PREFERRED = ['passkey', 'password', 'email_link', 'email_code', 'phone_code'] as const;
const ORDER_WHEN_OTP_PREFERRED = ['email_link', 'email_code', 'phone_code', 'passkey', 'password'] as const;
Expand All@@ -14,10 +14,10 @@ const findFactorForIdentifier = (i: string | null) => (f: SignInFactor) => {
// The algorithm can be found at
// https://www.notion.so/clerkdev/Implement-sign-in-alt-methods-e6e60ffb644645b3a0553b50556468ce
export function determineStartingSignInFactor(
firstFactors: SignInFactor[],
firstFactors: SignInFirstFactor[],

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

SignInFactor is SignInFirstFactor | SignInSecondFactor. The changes in this file narrow the input and return types

identifier: string | null,
preferredSignInStrategy?: PreferredSignInStrategy,
): SignInFactor | null {
) {
if (!firstFactors || firstFactors.length === 0) {
return null;
}
Expand All@@ -27,7 +27,7 @@ export function determineStartingSignInFactor(
: determineStrategyWhenOTPIsPreferred(firstFactors, identifier);
}

function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
function findPasskeyStrategy(factors: SignInFirstFactor[]) {
if (isWebAuthnSupported()) {
const passkeyFactor = factors.find(({ strategy }) => strategy === 'passkey');

Expand All@@ -38,10 +38,7 @@ function findPasskeyStrategy(factors: SignInFactor[]): SignInFactor | null {
return null;
}

function determineStrategyWhenPasswordIsPreferred(
factors: SignInFactor[],
identifier: string | null,
): SignInFactor | null {
function determineStrategyWhenPasswordIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -69,7 +66,7 @@ function determineStrategyWhenPasswordIsPreferred(
return null;
}

function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier: string | null): SignInFactor | null {
function determineStrategyWhenOTPIsPreferred(factors: SignInFirstFactor[], identifier: string | null) {
const passkeyFactor = findPasskeyStrategy(factors);
if (passkeyFactor) {
return passkeyFactor;
Expand DownExpand Up@@ -97,7 +94,7 @@ function determineStrategyWhenOTPIsPreferred(factors: SignInFactor[], identifier
}

// The priority of second factors is: TOTP -> Phone code -> any other factor
export function determineStartingSignInSecondFactor(secondFactors: SignInFactor[]): SignInFactor | null {
export function determineStartingSignInSecondFactor(secondFactors: SignInSecondFactor[]) {
if (!secondFactors || secondFactors.length === 0) {
return null;
}
Expand Down
46 changes: 16 additions & 30 deletions packages/elements/src/internals/machines/sign-in/verification.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,9 @@ import type {
PasswordAttempt,
PhoneCodeAttempt,
PrepareFirstFactorParams,
PrepareSecondFactorParams,
ResetPasswordEmailCodeAttempt,
ResetPasswordPhoneCodeAttempt,
SignInFactor,
SignInFirstFactor,
SignInResource,
SignInSecondFactor,
Expand All@@ -19,7 +19,7 @@ import { assign, fromPromise, log, sendTo, setup } from 'xstate';
import { RESENDABLE_COUNTDOWN_DEFAULT } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { WithParams } from '~/internals/machines/shared';
import type { SignInStrategyName, WithParams } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { determineStartingSignInFactor, determineStartingSignInSecondFactor } from '~/internals/machines/sign-in/utils';
import { assertActorEventError, assertIsDefined } from '~/internals/machines/utils/assert';
Expand All@@ -35,11 +35,11 @@ export type DetermineStartingFactorInput = {
parent: SignInRouterMachineActorRef;
};

export type PrepareFirstFactorInput = WithParams<SignInFirstFactor | null> & {
export type PrepareFirstFactorInput = WithParams<PrepareFirstFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
export type PrepareSecondFactorInput = WithParams<SignInSecondFactor | null> & {
export type PrepareSecondFactorInput = WithParams<PrepareSecondFactorParams> & {
parent: SignInRouterMachineActorRef;
resendable: boolean;
};
Expand DownExpand Up@@ -67,8 +67,8 @@ export const SignInVerificationMachineId = 'SignInVerification';

const SignInVerificationMachine = setup({
actors: {
determineStartingFactor: fromPromise<SignInFactor | null, DetermineStartingFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
determineStartingFactor: fromPromise<SignInFirstFactor | SignInSecondFactor | null, DetermineStartingFactorInput>(
() => Promise.reject(new ClerkElementsRuntimeError('Actor `determineStartingFactor` must be overridden')),
),
prepare: fromPromise<SignInResource, PrepareFirstFactorInput | PrepareSecondFactorInput>(() =>
Promise.reject(new ClerkElementsRuntimeError('Actor `prepare` must be overridden')),
Expand DownExpand Up@@ -96,10 +96,7 @@ const SignInVerificationMachine = setup({
// Only show these warnings in development!
if (process.env.NODE_ENV === 'development') {
if (
!clerk.client.signIn.supportedFirstFactors.every(factor =>
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedFirstFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these strategies: ${clerk.client.signIn.supportedFirstFactors
Expand All@@ -112,9 +109,7 @@ const SignInVerificationMachine = setup({

if (
clerk.client.signIn.supportedSecondFactors &&
!clerk.client.signIn.supportedSecondFactors.every(factor =>
context.registeredStrategies.has(factor.strategy as unknown as SignInFactor),
)
!clerk.client.signIn.supportedSecondFactors.every(factor => context.registeredStrategies.has(factor.strategy))
) {
console.warn(
`Clerk: Your instance is configured to support these 2FA strategies: ${clerk.client.signIn.supportedSecondFactors
Expand All@@ -125,26 +120,17 @@ const SignInVerificationMachine = setup({
);
}

// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
// This type should also probably be SignInFirstFactor['strategy'] instead of SignInFactor['strategy'] !!!
const strategiesUsedButNotActivated = Array.from(context.registeredStrategies).filter(
strategy =>
!clerk.client.signIn.supportedFirstFactors.some(
supported => (supported.strategy as unknown as SignInFactor) === strategy,
),
) as unknown as Array<SignInFactor['strategy']>;
strategy => !clerk.client.signIn.supportedFirstFactors.some(supported => supported.strategy === strategy),
);

if (strategiesUsedButNotActivated.length > 0) {
console.warn(
`Clerk: These rendered strategies are not configured for your instance: ${strategiesUsedButNotActivated.join(', ')}. If this is unexpected, make sure to enable them in your Clerk dashboard: https://dashboard.clerk.com/last-active?path=/user-authentication/email-phone-username`,
);
}

if (
context.currentFactor?.strategy &&
// TODO: These "as SignInFactor" assertions are incorrect, factor.strategy is SignInFactor['strategy']. This needs to be fixed together with SignInVerificationStrategyRegisterEvent and SignInStrategy React component
!context.registeredStrategies.has(context.currentFactor?.strategy as unknown as SignInFactor)
) {
if (context.currentFactor?.strategy && !context.registeredStrategies.has(context.currentFactor?.strategy)) {
throw new ClerkElementsRuntimeError(
`Your sign-in attempt is missing a ${context.currentFactor?.strategy} strategy. Make sure <Strategy name="${context.currentFactor?.strategy}"> is rendered in your flow. More information: https://clerk.com/docs/elements/reference/sign-in#strategy`,
);
Expand DownExpand Up@@ -195,7 +181,7 @@ const SignInVerificationMachine = setup({
formRef: input.formRef,
loadingStep: 'verifications',
parent: input.parent,
registeredStrategies: new Set<SignInFactor>(),
registeredStrategies: new Set<SignInStrategyName>(),

@LekoArtsLekoArtsJul 8, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This change stems from looking at packages/elements/src/react/sign-in/verifications.tsx and checking what is actually passed

resendable: false,
resendableAfter: RESENDABLE_COUNTDOWN_DEFAULT,
}),
Expand DownExpand Up@@ -250,7 +236,7 @@ const SignInVerificationMachine = setup({
input: ({ context }) => ({
parent: context.parent,
resendable: context.resendable,
params: context.currentFactor as SignInFirstFactor | null,
params: context.currentFactor as PrepareFirstFactorParams,
}),
onDone: {
actions: 'resendableReset',
Expand DownExpand Up@@ -348,7 +334,7 @@ const SignInVerificationMachine = setup({
src: 'attempt',
input: ({ context }) => ({
parent: context.parent,
currentFactor: context.currentFactor as SignInFirstFactor,
currentFactor: context.currentFactor as SignInFirstFactor | null,
fields: context.formRef.getSnapshot().context.fields,
}),
onDone: {
Expand DownExpand Up@@ -380,7 +366,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({
);
}),
prepare: fromPromise(async ({ input }) => {
const { params, parent, resendable } = input;
const { params, parent, resendable } = input as PrepareFirstFactorInput;
const clerk = parent.getSnapshot().context.clerk;

// If a prepare call has already been fired recently, don't re-send
Expand All@@ -393,7 +379,7 @@ export const SignInFirstFactorMachine = SignInVerificationMachine.provide({

assertIsDefined(params, 'First factor params');

return await clerk.client.signIn.prepareFirstFactor(params as PrepareFirstFactorParams);
return await clerk.client.signIn.prepareFirstFactor(params);
}),
attempt: fromPromise(async ({ input }) => {
const { currentFactor, fields, parent } = input as AttemptFirstFactorInput;
Expand Down
7 changes: 4 additions & 3 deletions packages/elements/src/internals/machines/sign-in/verification.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { SignInFactor } from '@clerk/types';
import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';
import type { SignInStrategyName } from '~/internals/machines/shared';

import type { SignInRouterMachineActorRef } from './router.types';

Expand All@@ -21,8 +22,8 @@ export type SignInVerificationTags =
export type SignInVerificationSubmitEvent = { type: 'SUBMIT' };
export type SignInVerificationFactorUpdateEvent = { type: 'STRATEGY.UPDATE'; factor: SignInFactor | undefined };
export type SignInVerificationRetryEvent = { type: 'RETRY' };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInFactor };
export type SignInVerificationStrategyRegisterEvent = { type: 'STRATEGY.REGISTER'; factor: SignInStrategyName };
export type SignInVerificationStrategyUnregisterEvent = { type: 'STRATEGY.UNREGISTER'; factor: SignInStrategyName };

export type SignInVerificationEvents =
| ErrorActorEvent
Expand All@@ -47,7 +48,7 @@ export interface SignInVerificationContext {
formRef: ActorRefFrom<typeof FormMachine>;
parent: SignInRouterMachineActorRef;
loadingStep: 'verifications';
registeredStrategies: Set<SignInFactor>;
registeredStrategies: Set<SignInStrategyName>;
resendable: boolean;
resendableAfter: number;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type { SignInFactor, SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import type { SignInStrategy as ClerkSignInStrategy } from '@clerk/types';
import { useSelector } from '@xstate/react';
import { useCallback, useEffect } from 'react';
import type { ActorRefFrom, SnapshotFrom } from 'xstate';
Expand DownExpand Up@@ -76,12 +76,12 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {

useEffect(() => {
if (factorCtx) {
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.REGISTER', factor: name });
}

return () => {
if (factorCtx?.getSnapshot().status === 'active') {
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name });
}
};
}, [factorCtx, name]);
Expand Down