Skip to content

feat(elements): Handle ticket-based invitation sign-up workflows #3910

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
tmilewski merged 1 commit into from
Aug 9, 2024
Merged

feat(elements): Handle ticket-based invitation sign-up workflows #3910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/pink-mails-try.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/elements": minor
---

Handle ticket-based invitation sign-up workflows
128 changes: 128 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 48 additions & 7 deletions packages/elements/src/internals/machines/form/form.machine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ export interface FormMachineContext extends MachineContext {
}

export type FormMachineEvents =
| { type: 'FIELD.ADD'; field: Pick<FieldDetails, 'name' | 'type' | 'value' | 'checked'> }
| { type: 'FIELD.ADD'; field: Pick<FieldDetails, 'name' | 'type' | 'value' | 'checked' | 'disabled'> }
| { type: 'FIELD.REMOVE'; field: Pick<FieldDetails, 'name'> }
| { type: 'FIELD.ENABLE'; field: Pick<FieldDetails, 'name'> }
| { type: 'FIELD.DISABLE'; field: Pick<FieldDetails, 'name'> }
| {
type: 'MARK_AS_PROGRESSIVE';
defaultValues: FormDefaultValues;
Expand All @@ -35,7 +37,7 @@ export type FormMachineEvents =
| { type: 'UNMARK_AS_PROGRESSIVE' }
| {
type: 'FIELD.UPDATE';
field: Pick<FieldDetails, 'name' | 'value' | 'checked'>;
field: Pick<FieldDetails, 'name' | 'value' | 'checked' | 'disabled'>;
}
| { type: 'ERRORS.SET'; error: any }
| { type: 'ERRORS.CLEAR' }
Expand Down Expand Up @@ -157,11 +159,50 @@ export const FormMachine = setup({
throw new Error('Field name is required');
}

if (context.fields.has(event.field.name)) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
context.fields.get(event.field.name)!.value = event.field.value;
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
context.fields.get(event.field.name)!.checked = event.field.checked;
const field = context.fields.get(event.field.name);

if (field) {
field.checked = event.field.checked;
field.disabled = event.field.disabled || false;
field.value = event.field.value;

context.fields.set(event.field.name, field);
}

return context.fields;
},
}),
},
'FIELD.DISABLE': {
actions: assign({
fields: ({ context, event }) => {
if (!event.field.name) {
throw new Error('Field name is required');
}

const field = context.fields.get(event.field.name);

if (field) {
field.disabled = true;
context.fields.set(event.field.name, field);
}

return context.fields;
},
}),
},
'FIELD.ENABLE': {
actions: assign({
fields: ({ context, event }) => {
if (!event.field.name) {
throw new Error('Field name is required');
}

const field = context.fields.get(event.field.name);

if (field) {
field.disabled = false;
context.fields.set(event.field.name, field);
}

return context.fields;
Expand Down
9 changes: 5 additions & 4 deletions packages/elements/src/internals/machines/form/form.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ interface FeedbackBase {
}

export interface FeedbackErrorType extends FeedbackBase {
type: Extract<FieldStates, 'error'>;
message: ClerkElementsFieldError;
type: Extract<FieldStates, 'error'>;
}

export interface FeedbackOtherType extends FeedbackBase {
type: Exclude<FieldStates, 'idle' | 'error'>;
message: string;
type: Exclude<FieldStates, 'idle' | 'error'>;
}

export interface FeedbackPasswordErrorType extends FeedbackErrorType {
Expand All @@ -28,11 +28,12 @@ export interface FeedbackPasswordInfoType extends FeedbackOtherType {
}

export type FieldDetails = {
checked?: boolean;
disabled?: boolean;
feedback?: FeedbackErrorType | FeedbackOtherType | FeedbackPasswordErrorType | FeedbackPasswordInfoType;
name?: string;
type: React.HTMLInputTypeAttribute;
value?: string | readonly string[] | number;
checked?: boolean;
feedback?: FeedbackErrorType | FeedbackOtherType | FeedbackPasswordErrorType | FeedbackPasswordInfoType;
};

export type FormFields = Map<string, FieldDetails>;
40 changes: 30 additions & 10 deletions packages/elements/src/internals/machines/sign-up/router.machine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ export const SignUpRouterMachine = setup({
},
hasClerkTransfer: ({ context }) => Boolean(context.router?.searchParams().get(SEARCH_PARAMS.transfer)),
hasResource: ({ context }) => Boolean(context.clerk.client.signUp),
hasTicket: ({ context }) => Boolean(context.ticket),

isLoggedInAndSingleSession: and(['isLoggedIn', 'isSingleSessionMode', not('isExampleMode')]),
isStatusAbandoned: needsStatus('abandoned'),
Expand Down Expand Up @@ -237,16 +238,24 @@ export const SignUpRouterMachine = setup({
Idle: {
on: {
INIT: {
actions: assign(({ event }) => ({
clerk: event.clerk,
router: event.router,
signInPath: event.signInPath || SIGN_IN_DEFAULT_BASE_PATH,
loading: {
isLoading: false,
},
exampleMode: event.exampleMode || false,
formRef: event.formRef,
})),
actions: assign(({ event }) => {
const searchParams = event.router?.searchParams();

return {
clerk: event.clerk,
router: event.router,
signInPath: event.signInPath || SIGN_IN_DEFAULT_BASE_PATH,
loading: {
isLoading: false,
},
exampleMode: event.exampleMode || false,
formRef: event.formRef,
ticket:
searchParams?.get(SEARCH_PARAMS.ticket) ||
searchParams?.get(SEARCH_PARAMS.invitationToken) ||
undefined,
};
}),
target: 'Init',
},
},
Expand Down Expand Up @@ -281,6 +290,11 @@ export const SignUpRouterMachine = setup({
guard: 'needsCallback',
target: 'Callback',
},
{
guard: 'hasTicket',
actions: { type: 'navigateInternal', params: { force: true, path: '/' } },
target: 'Start',
},
{
guard: 'needsVerification',
actions: { type: 'navigateInternal', params: { force: true, path: '/verify' } },
Expand All @@ -307,6 +321,7 @@ export const SignUpRouterMachine = setup({
basePath: context.router?.basePath,
formRef: context.formRef,
parent: self,
ticket: context.ticket,
}),
onDone: {
actions: 'raiseNext',
Expand All @@ -322,6 +337,11 @@ export const SignUpRouterMachine = setup({
guard: 'isStatusComplete',
actions: ['setActive', 'delayedReset'],
},
{
guard: and(['hasTicket', 'statusNeedsContinue']),
actions: { type: 'navigateInternal', params: { path: '/' } },
target: 'Start',
},
{
guard: 'statusNeedsVerification',
target: 'Verification',
Expand Down
1 change: 1 addition & 0 deletions packages/elements/src/internals/machines/sign-up/router.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ export interface SignUpRouterContext extends BaseRouterContext {
formRef: ActorRefFrom<TFormMachine>;
loading: SignUpRouterLoadingContext;
signInPath: string;
ticket: string | undefined;
}

// ---------------------------------- Schema ---------------------------------- //
Expand Down
Loading