feat(clerk-js): Support different CAPTCHA widget types#3154

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
anagstef merged 5 commits into from
Apr 11, 2024
Merged

feat(clerk-js): Support different CAPTCHA widget types #3154

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
4e8571c
feat(clerk-js): Bot Protection Upgrade Phase 1 PoC
Apr 4, 2024
a36f646
feat(clerk-js): Add support for different CAPTCHA widget types
Apr 9, 2024
d187452
fix(clerk-js): Show the CAPTCHA even if the form is not shown
Apr 9, 2024
b87c910
fix(clerk-js): Add `appearance: always` property for `always_visible`…
Apr 10, 2024
59fe612
Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…
anagstef Apr 11, 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
6 changes: 6 additions & 0 deletions .changeset/eighty-pens-mix.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types
10 changes: 9 additions & 1 deletion packages/clerk-js/src/core/resources/DisplayConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
CaptchaWidgetType,
DisplayConfigJSON,
DisplayConfigResource,
DisplayThemeJSON,
PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
backendHost!: string;
branded!: boolean;
captchaPublicKey: string | null = null;
captchaWidgetType: CaptchaWidgetType = null;
homeUrl!: string;
instanceEnvironmentType!: string;
faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
this.afterSwitchSessionUrl = data.after_switch_session_url;
this.branded = data.branded;
this.captchaPublicKey = data.captcha_public_key;
this.captchaWidgetType = data.captcha_widget_type;
this.supportEmail = data.support_email || '';
this.clerkJSVersion = data.clerk_js_version;
this.organizationProfileUrl = data.organization_profile_url;
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
const paramsWithCaptcha: Record<string, unknown> = params;
const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

if (canUseCaptcha && captchaSiteKey && captchaURL) {
try {
paramsWithCaptcha.captchaToken = await getCaptchaToken({
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
scriptUrl: captchaURL,
});
} catch (e) {
Expand Down
12 changes: 8 additions & 4 deletions packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
</Form.ControlRow>
)}
</Col>
<Form.SubmitButton
hasArrow
localizationKey={localizationKeys('formButtonPrimary')}
/>
<Col center>
<CaptchaElement />
<Form.SubmitButton
hasArrow
localizationKey={localizationKeys('formButtonPrimary')}
/>
</Col>
</Form.Root>
);
};
2 changes: 2 additions & 0 deletions packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
SocialButtonsReversibleContainerWithDivider,
withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
/>
)}
</SocialButtonsReversibleContainerWithDivider>
{!shouldShowForm && <CaptchaElement />}
</Flex>
</Card.Content>

Expand Down
9 changes: 9 additions & 0 deletions packages/clerk-js/src/ui/elements/CaptchaElement.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
<Box
id={CAPTCHA_ELEMENT_ID}
sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
/>
);
52 changes: 43 additions & 9 deletions packages/clerk-js/src/utils/captcha.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
* @param errorCode string
*/
'error-callback'?: (errorCode: string) => void;
/**
* Appearance controls when the widget is visible.
* It can be always (default), execute, or interaction-only.
* Refer to Appearance Modes for more information:
* https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
* @default 'always'
*/
appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
}
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
siteKey: string;
scriptUrl: string;
widgetType: CaptchaWidgetType;
}) => {
const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
let captchaToken = '',
id = '';
const invisibleWidget = !widgetType || widgetType === 'invisible';

let widgetDiv: HTMLElement | null = null;

const div = document.createElement('div');
div.classList.add(WIDGET_CLASSNAME);
document.body.appendChild(div);
if (invisibleWidget) {
const div = document.createElement('div');
div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
document.body.appendChild(div);
widgetDiv = div;
} else {
const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
if (visibleDiv) {
visibleDiv.style.display = 'block';
widgetDiv = visibleDiv;
} else {
throw {
captchaError: 'Element to render the captcha not found',
};
}
}

const captcha = await loadCaptcha(scriptUrl);
let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
return new Promise((resolve, reject) => {
try {
const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
sitekey,
appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
retry: 'never',
'refresh-expired': 'auto',
callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
captchaError: e,
};
} finally {
// After challenge has run remove node element attached
document.body.removeChild(div);
if (invisibleWidget) {
document.body.removeChild(widgetDiv);
} else {
widgetDiv.style.display = 'none';
}
}

return captchaToken;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/utils/retrieveCaptchaInfo.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const fapiClient = createFapiClient(clerk);
return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
canUseCaptcha: _environment
? _environment.userSettings.signUp.captcha_enabled &&
clerk.isStandardBrowser &&
Expand Down
3 changes: 3 additions & 0 deletions packages/types/src/displayConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
application_name: string;
branded: boolean;
captcha_public_key: string | null;
captcha_widget_type: CaptchaWidgetType;
home_url: string;
instance_environment_type: string;
logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
backendHost: string;
branded: boolean;
captchaPublicKey: string | null;
captchaWidgetType: CaptchaWidgetType;
homeUrl: string;
instanceEnvironmentType: string;
logoImageUrl: string;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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 > 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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
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
feat(clerk-js): Support different CAPTCHA widget types#3154

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

anagstef
merged 5 commits into

from

Apr 11, 2024
 Merged


feat(clerk-js): Support different CAPTCHA widget types
#3154
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
4e8571c

feat(clerk-js): Bot Protection Upgrade Phase 1 PoC

Apr 4, 2024
a36f646

feat(clerk-js): Add support for different CAPTCHA widget types

Apr 9, 2024
d187452

fix(clerk-js): Show the CAPTCHA even if the form is not shown

Apr 9, 2024
b87c910

fix(clerk-js): Add `appearance: always` property for `always_visible`…

Apr 10, 2024
59fe612

Merge branch 'main' into stefanos/core-1988-poc-with-interactive-turn…


anagstef Apr 11, 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


6 changes: 6 additions & 0 deletions
.changeset/eighty-pens-mix.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for different CAPTCHA widget types

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';
import type {
 CaptchaWidgetType,
 DisplayConfigJSON,
 DisplayConfigResource,
 DisplayThemeJSON,
 PreferredSignInStrategy,
} from '@clerk/types';

import { BaseResource } from './internal';

Expand All@@ -14,6 +20,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 backendHost!: string;
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -59,6 +66,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.afterSwitchSessionUrl = data.after_switch_session_url;
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

3 changes: 2 additions & 1 deletion
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,12 +68,13 @@ export class SignUp extends BaseResource implements SignUpResource {

 create = async (params: SignUpCreateParams): Promise<SignUpResource> => {
 const paramsWithCaptcha: Record<string, unknown> = params;
 const { captchaSiteKey, canUseCaptcha, captchaURL } = retrieveCaptchaInfo(SignUp.clerk);
 const { captchaSiteKey, canUseCaptcha, captchaURL, captchaWidgetType } = retrieveCaptchaInfo(SignUp.clerk);

 if (canUseCaptcha && captchaSiteKey && captchaURL) {
 try {
 paramsWithCaptcha.captchaToken = await getCaptchaToken({
 siteKey: captchaSiteKey,
 widgetType: captchaWidgetType,
 scriptUrl: captchaURL,
 });
 } catch (e) {
Expand Down

12 changes: 8 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import React from 'react';

import { Col, localizationKeys, useAppearance } from '../../customizables';
import { Form } from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { mqu } from '../../styledSystem';
import type { FormControlState } from '../../utils';
import type { ActiveIdentifier, Fields } from './signUpFormHelpers';
Expand DownExpand Up@@ -101,10 +102,13 @@ export const SignUpForm = (props: SignUpFormProps) => {
 </Form.ControlRow>
 )}
 </Col>
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 <Col center>
 <CaptchaElement />
 <Form.SubmitButton
 hasArrow
 localizationKey={localizationKeys('formButtonPrimary')}
 />
 </Col>
 </Form.Root>
 );
};

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpStart.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import {
 SocialButtonsReversibleContainerWithDivider,
 withCardStateProvider,
} from '../../elements';
import { CaptchaElement } from '../../elements/CaptchaElement';
import { useCardState } from '../../elements/contexts';
import { useLoadingStatus } from '../../hooks';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -277,6 +278,7 @@ function _SignUpStart(): JSX.Element {
 />
 )}
 </SocialButtonsReversibleContainerWithDivider>
 {!shouldShowForm && <CaptchaElement />}
 </Flex>
 </Card.Content>

Expand Down

9 changes: 9 additions & 0 deletions
packages/clerk-js/src/ui/elements/CaptchaElement.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import { CAPTCHA_ELEMENT_ID } from '../../utils';
import { Box } from '../customizables';

export const CaptchaElement = () => (
 <Box
 id={CAPTCHA_ELEMENT_ID}
 sx={t => ({ display: 'none', marginBottom: t.space.$6 })}
 />
);

52 changes: 43 additions & 9 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { loadScript } from '@clerk/shared/loadScript';
import type { CaptchaWidgetType } from '@clerk/types';

import { clerkFailedToLoadThirdPartyScript } from '../core/errors';

Expand DownExpand Up@@ -35,6 +36,14 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
 * Refer to Appearance Modes for more information:
 * https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes
 * @default 'always'
 */
 appearance?: 'always' | 'execute' | 'interaction-only';
}

interface Turnstile {
Expand All@@ -50,7 +59,8 @@ declare global {
 }
}

const WIDGET_CLASSNAME = 'clerk-captcha';
export const CAPTCHA_ELEMENT_ID = 'clerk-captcha';
export const CAPTCHA_INVISIBLE_CLASSNAME = 'clerk-invisible-captcha';

export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
 const codesWithRetries = ['crashed', 'undefined_error', '102', '103', '104', '106', '110600', '300', '600'];
Expand All@@ -70,14 +80,34 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptUrl: string }) => {
 const { siteKey: sitekey, scriptUrl } = captchaOptions;
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';

 let widgetDiv: HTMLElement | null = null;

 const div = document.createElement('div');
 div.classList.add(WIDGET_CLASSNAME);
 document.body.appendChild(div);
 if (invisibleWidget) {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 } else {
 const visibleDiv = document.getElementById(CAPTCHA_ELEMENT_ID);
 if (visibleDiv) {
 visibleDiv.style.display = 'block';
 widgetDiv = visibleDiv;
 } else {
 throw {
 captchaError: 'Element to render the captcha not found',
 };
 }
 }

 const captcha = await loadCaptcha(scriptUrl);
 let retries = 0;
Expand All@@ -86,8 +116,9 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 const handleCaptchaTokenGeneration = (): Promise<[string, string]> => {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(`.${WIDGET_CLASSNAME}`, {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand DownExpand Up@@ -133,8 +164,11 @@ export const getCaptchaToken = async (captchaOptions: { siteKey: string; scriptU
 captchaError: e,
 };
 } finally {
 // After challenge has run remove node element attached
 document.body.removeChild(div);
 if (invisibleWidget) {
 document.body.removeChild(widgetDiv);
 } else {
 widgetDiv.style.display = 'none';
 }
 }

 return captchaToken;
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/retrieveCaptchaInfo.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 const fapiClient = createFapiClient(clerk);
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

3 changes: 3 additions & 0 deletions
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { DisplayThemeJSON } from './json';
import type { ClerkResource } from './resource';

export type PreferredSignInStrategy = 'password' | 'otp';
export type CaptchaWidgetType = 'smart' | 'always_visible' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -14,6 +15,7 @@ export interface DisplayConfigJSON {
 application_name: string;
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -42,6 +44,7 @@ export interface DisplayConfigResource extends ClerkResource {
 backendHost: string;
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
Expand Down