feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into from
Apr 17, 2024
Merged

feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found #3191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5faa6e7
feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…
Apr 15, 2024
a758c91
fix(clerk-js): Fix error wording
Apr 15, 2024
8ed3b0a
fix(clerk-js): Add comment to explain the captcha fallback mechanism
Apr 15, 2024
c6d2c50
fix(clerk-js): Use the invisible key when DOM node is missing
Apr 16, 2024
faa87dd
Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…
anagstef Apr 17, 2024
0b7d139
Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…
anagstef Apr 17, 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/itchy-onions-rush.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM
2 changes: 2 additions & 0 deletions packages/clerk-js/src/core/resources/DisplayConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
branded!: boolean;
captchaPublicKey: string | null = null;
captchaWidgetType: CaptchaWidgetType = null;
captchaPublicKeyInvisible: string | null = null;
homeUrl!: string;
instanceEnvironmentType!: string;
faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
this.branded = data.branded;
this.captchaPublicKey = data.captcha_public_key;
this.captchaWidgetType = data.captcha_widget_type;
this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
this.supportEmail = data.support_email || '';
this.clerkJSVersion = data.clerk_js_version;
this.organizationProfileUrl = data.organization_profile_url;
Expand Down
10 changes: 7 additions & 3 deletions packages/clerk-js/src/core/resources/SignUp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,15 +68,19 @@ export class SignUp extends BaseResource implements SignUpResource {

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

if (canUseCaptcha && captchaSiteKey && captchaURL) {
if (canUseCaptcha && captchaSiteKey && captchaURL && captchaPublicKeyInvisible) {
try {
paramsWithCaptcha.captchaToken = await getCaptchaToken({
const { captchaToken, captchaWidgetTypeUsed } = await getCaptchaToken({
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
scriptUrl: captchaURL,
});
paramsWithCaptcha.captchaToken = captchaToken;
paramsWithCaptcha.captchaWidgetType = captchaWidgetTypeUsed;
} catch (e) {
if (e.captchaError) {
paramsWithCaptcha.captchaError = e.captchaError;
Expand Down
42 changes: 32 additions & 10 deletions packages/clerk-js/src/utils/captcha.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
* @param errorCode string
*/
'error-callback'?: (errorCode: string) => void;
/**
* A JavaScript callback invoked when a given client/browser is not supported by the widget.
*/
'unsupported-callback'?: () => boolean;
/**
* Appearance controls when the widget is visible.
* It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
return window.turnstile;
}

/*
* How this function works:
* The widgetType is either 'invisible' or 'smart'.
* - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
* - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getCaptchaToken = async (captchaOptions: {
siteKey: string;
scriptUrl: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
}) => {
const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
let captchaToken = '',
id = '';
const invisibleWidget = !widgetType || widgetType === 'invisible';
let invisibleWidget = !widgetType || widgetType === 'invisible';
let turnstileSiteKey = siteKey;

let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
const div = document.createElement('div');
div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
document.body.appendChild(div);
widgetDiv = div;
return div;
};

if (invisibleWidget) {
widgetDiv = createInvisibleDOMElement();
} 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',
};
console.error('Captcha DOM element not found. Using invisible captcha widget.');
widgetDiv = createInvisibleDOMElement();
invisibleWidget = true;
turnstileSiteKey = invisibleSiteKey;
}
}

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
return new Promise((resolve, reject) => {
try {
const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
sitekey,
appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
sitekey: turnstileSiteKey,
appearance: 'interaction-only',
retry: 'never',
'refresh-expired': 'auto',
callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
}
reject([errorCodes.join(','), id]);
},
'unsupported-callback': function () {
reject(['This browser is not supported by the CAPTCHA.', id]);
return true;
},
});
} catch (e) {
/**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
}
}

return captchaToken;
return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};
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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment
? _environment.userSettings.signUp.captcha_enabled &&
clerk.isStandardBrowser &&
Expand Down
4 changes: 3 additions & 1 deletion packages/types/src/displayConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.
export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
branded: boolean;
captcha_public_key: string | null;
captcha_widget_type: CaptchaWidgetType;
captcha_public_key_invisible: string | null;
home_url: string;
instance_environment_type: string;
logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
branded: boolean;
captchaPublicKey: string | null;
captchaWidgetType: CaptchaWidgetType;
captchaPublicKeyInvisible: string | null;
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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 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): Fallback to invisible CAPTCHA if the element is not found#3191

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 6 commits into

from

Apr 17, 2024
 Merged


feat(clerk-js): Fallback to invisible CAPTCHA if the element is not found
#3191
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
5faa6e7

feat(clerk-js): Fallback to invisible CAPTCHA if the element to rende…

Apr 15, 2024
a758c91

fix(clerk-js): Fix error wording

Apr 15, 2024
8ed3b0a

fix(clerk-js): Add comment to explain the captcha fallback mechanism

Apr 15, 2024
c6d2c50

fix(clerk-js): Use the invisible key when DOM node is missing

Apr 16, 2024
faa87dd

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 2024
0b7d139

Merge branch 'main' into stefanos/core-2071-implement-fallback-to-inv…


anagstef Apr 17, 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/itchy-onions-rush.md

View file


Open in desktop

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

Fallback to invisible CAPTCHA if the element to render to is not found in the DOM

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 branded!: boolean;
 captchaPublicKey: string | null = null;
 captchaWidgetType: CaptchaWidgetType = null;
 captchaPublicKeyInvisible: string | null = null;
 homeUrl!: string;
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
Expand DownExpand Up@@ -68,6 +69,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.branded = data.branded;
 this.captchaPublicKey = data.captcha_public_key;
 this.captchaWidgetType = data.captcha_widget_type;
 this.captchaPublicKeyInvisible = data.captcha_public_key_invisible;
 this.supportEmail = data.support_email || '';
 this.clerkJSVersion = data.clerk_js_version;
 this.organizationProfileUrl = data.organization_profile_url;
Expand Down

10 changes: 7 additions & 3 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

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

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

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

42 changes: 32 additions & 10 deletions
packages/clerk-js/src/utils/captcha.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,10 @@ interface RenderOptions {
 * @param errorCode string
 */
 'error-callback'?: (errorCode: string) => void;
 /**
 * A JavaScript callback invoked when a given client/browser is not supported by the widget.
 */
 'unsupported-callback'?: () => boolean;
 /**
 * Appearance controls when the widget is visible.
 * It can be always (default), execute, or interaction-only.
Expand DownExpand Up@@ -80,32 +84,46 @@ export async function loadCaptcha(url: string) {
 return window.turnstile;
}

/*
 * How this function works:
 * The widgetType is either 'invisible' or 'smart'.
 * - If the widgetType is 'invisible', the captcha widget is rendered in a hidden div at the bottom of the body.
 * - If the widgetType is 'smart', the captcha widget is rendered in a div with the id 'clerk-captcha'. If the div does
 * not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
 */
export const getCaptchaToken = async (captchaOptions: {
 siteKey: string;
 scriptUrl: string;
 widgetType: CaptchaWidgetType;
 invisibleSiteKey: string;
}) => {
 const { siteKey: sitekey, scriptUrl, widgetType } = captchaOptions;
 const { siteKey, scriptUrl, widgetType, invisibleSiteKey } = captchaOptions;
 let captchaToken = '',
 id = '';
 const invisibleWidget = !widgetType || widgetType === 'invisible';
 let invisibleWidget = !widgetType || widgetType === 'invisible';
 let turnstileSiteKey = siteKey;

 let widgetDiv: HTMLElement | null = null;

if (invisibleWidget) {
const createInvisibleDOMElement = () => {
 const div = document.createElement('div');
 div.classList.add(CAPTCHA_INVISIBLE_CLASSNAME);
 document.body.appendChild(div);
 widgetDiv = div;
 return div;
 };

 if (invisibleWidget) {
 widgetDiv = createInvisibleDOMElement();
 } 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',
 };
 console.error('Captcha DOM element not found. Using invisible captcha widget.');
 widgetDiv = createInvisibleDOMElement();
 invisibleWidget = true;
 turnstileSiteKey = invisibleSiteKey;
 }
 }

Expand All@@ -117,8 +135,8 @@ export const getCaptchaToken = async (captchaOptions: {
 return new Promise((resolve, reject) => {
 try {
 const id = captcha.render(invisibleWidget ? `.${CAPTCHA_INVISIBLE_CLASSNAME}` : `#${CAPTCHA_ELEMENT_ID}`, {
 sitekey,
 appearance: widgetType === 'always_visible' ? 'always' : 'interaction-only',
 sitekey: turnstileSiteKey,
 appearance: 'interaction-only',
 retry: 'never',
 'refresh-expired': 'auto',
 callback: function (token: string) {
Expand All@@ -139,6 +157,10 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 reject([errorCodes.join(','), id]);
 },
 'unsupported-callback': function () {
 reject(['This browser is not supported by the CAPTCHA.', id]);
 return true;
 },
 });
 } catch (e) {
 /**
Expand DownExpand Up@@ -171,5 +193,5 @@ export const getCaptchaToken = async (captchaOptions: {
 }
 }

 return captchaToken;
 return { captchaToken, captchaWidgetTypeUsed: invisibleWidget ? 'invisible' : 'smart' };
};

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@@ -7,6 +7,7 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
 return {
 captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
 captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
 captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
 canUseCaptcha: _environment
 ? _environment.userSettings.signUp.captcha_enabled &&
 clerk.isStandardBrowser &&
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/displayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +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;
Comment thread
dimkl marked this conversation as resolved.

export type CaptchaWidgetType = 'smart' | 'invisible' | null;

export interface DisplayConfigJSON {
 object: 'display_config';
Expand All@@ -16,6 +16,7 @@ export interface DisplayConfigJSON {
 branded: boolean;
 captcha_public_key: string | null;
 captcha_widget_type: CaptchaWidgetType;
 captcha_public_key_invisible: string | null;
 home_url: string;
 instance_environment_type: string;
 logo_image_url: string;
Expand DownExpand Up@@ -46,6 +47,7 @@ export interface DisplayConfigResource extends ClerkResource {
 branded: boolean;
 captchaPublicKey: string | null;
 captchaWidgetType: CaptchaWidgetType;
 captchaPublicKeyInvisible: string | null;
 homeUrl: string;
 instanceEnvironmentType: string;
 logoImageUrl: string;
Expand Down