Skip to content

fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LekoArts merged 4 commits into from
Nov 1, 2023
Merged

fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae8b879
fix(*): Use isTruthy helper
LekoArts Nov 1, 2023
728e422
Create fifty-rats-rhyme.md
LekoArts Nov 1, 2023
809cbb7
chore(shared): Add test
LekoArts Nov 1, 2023
a55122d
Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function
LekoArts Nov 1, 2023
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
8 changes: 8 additions & 0 deletions .changeset/fifty-rats-rhyme.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.
3 changes: 2 additions & 1 deletion packages/nextjs/src/server/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
* @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';
5 changes: 3 additions & 2 deletions packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down
7 changes: 5 additions & 2 deletions packages/remix/src/ssr/authenticateRequest.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

const isSatellite =
handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
false;

const requestURL = buildRequestUrl(request);
Expand Down
4 changes: 2 additions & 2 deletions packages/sdk-node/src/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
domain: process.env.CLERK_DOMAIN || '',
proxyUrl: process.env.CLERK_PROXY_URL || '',
signInUrl: process.env.CLERK_SIGN_IN_URL || '',
isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
jwtKey: process.env.CLERK_JWT_KEY || '',
};
};
28 changes: 27 additions & 1 deletion packages/shared/src/__tests__/underscore.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
expect(anotherSampleObject).not.toHaveProperty('oneKey');
});
});

describe(`isTruthy`, () => {
it(`handles booleans`, () => {
expect(isTruthy(true)).toBe(true);
expect(isTruthy(false)).toBe(false);
});
it(`handles true or false strings `, () => {
expect(isTruthy(`true`)).toBe(true);
expect(isTruthy(`false`)).toBe(false);
expect(isTruthy(`TRUE`)).toBe(true);
expect(isTruthy(`FALSE`)).toBe(false);
expect(isTruthy(`TruE`)).toBe(true);
expect(isTruthy(`FalsE`)).toBe(false);
});
it(`handles numbers`, () => {
expect(isTruthy(`1`)).toBe(true);
expect(isTruthy(`0`)).toBe(false);
expect(isTruthy(`-1`)).toBe(false);
expect(isTruthy(1)).toBe(true);
expect(isTruthy(0)).toBe(false);
expect(isTruthy(-1)).toBe(false);
});
it(`defaults to false`, () => {
expect(isTruthy(`foobar`)).toBe(false);
});
});
26 changes: 26 additions & 0 deletions packages/shared/src/underscore.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
* camelCased keys are removed.
*/
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
* Returns true for `true`, true, positive numbers.
* Returns false for `false`, false, 0, negative integers and anything else.
*/
export function isTruthy(value: unknown): boolean {
// Return if Boolean
if (typeof value === `boolean`) return value;

// Return false if null or undefined
if (value === undefined || value === null) return false;

// If the String is true or false
if (typeof value === `string`) {
if (value.toLowerCase() === `true`) return true;
if (value.toLowerCase() === `false`) return false;
}

// Now check if it's a number
const number = parseInt(value as string, 10);
if (isNaN(number)) return false;
if (number > 0) return true;

// Default to false
return false;
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper by LekoArts · Pull Request #2002 · clerk/javascript · GitHub
Skip to content
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper by LekoArts · Pull Request #2002 · clerk/javascript · GitHub
Skip to content
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper by LekoArts · Pull Request #2002 · clerk/javascript · GitHub
Skip to content
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper by LekoArts · Pull Request #2002 · clerk/javascript · GitHub
Skip to content
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper by LekoArts · Pull Request #2002 · clerk/javascript · GitHub
Skip to content
fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper#2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LekoArts
merged 4 commits into

from

Nov 1, 2023
 Merged


fix(nextjs,remix,clerk-sdk-node,shared): Use isTruthy helper
#2002
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
ae8b879

fix(*): Use isTruthy helper


LekoArts Nov 1, 2023
728e422

Create fifty-rats-rhyme.md


LekoArts Nov 1, 2023
809cbb7

chore(shared): Add test


LekoArts Nov 1, 2023
a55122d

Merge branch 'main' into lekoarts/sdk-755-add-istruthy-helper-function


LekoArts Nov 1, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/fifty-rats-rhyme.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
"@clerk/nextjs": patch
"@clerk/remix": patch
"@clerk/clerk-sdk-node": patch
"@clerk/shared": patch
---

Introduce `isTruthy` helper to better cast environment variables to a boolean. Previously only the string `"true"` was checked, now `true`, `"true"`, `"1"`, and `1` will work.

3 changes: 2 additions & 1 deletion
packages/nextjs/src/server/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';

/**
 * @deprecated Use `CLERK_JS_VERSION` instead.
Expand DownExpand Up@@ -29,6 +30,6 @@ if (FRONTEND_API) {
export const PUBLISHABLE_KEY = process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '';
export const DOMAIN = process.env.NEXT_PUBLIC_CLERK_DOMAIN || '';
export const PROXY_URL = process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '';
export const IS_SATELLITE = process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true' || false;
export const IS_SATELLITE = isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) || false;
export const SIGN_IN_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '';
export const SIGN_UP_URL = process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '';

5 changes: 3 additions & 2 deletions
packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { isTruthy } from '@clerk/shared/underscore';

import type { NextClerkProviderProps } from '../types';

export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, 'children'>) => {
Expand All@@ -10,7 +11,7 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
 clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
 proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
 domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
 isSatellite: props.isSatellite || process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE === 'true',
 isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
 signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
 signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
 afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
Expand Down

7 changes: 5 additions & 2 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { RequestState } from '@clerk/backend';
import { buildRequestUrl, Clerk } from '@clerk/backend';
import { deprecated, handleValueOrFn, isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared';
import { deprecated } from '@clerk/shared/deprecated';
import { handleValueOrFn } from '@clerk/shared/handleValueOrFn';
import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
import { isTruthy } from '@clerk/shared/underscore';

import {
 noSecretKeyOrApiKeyError,
Expand DownExpand Up@@ -60,7 +63,7 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
isTruthy(getEnvVariable('CLERK_IS_SATELLITE', context)) ||
 false;

 const requestURL = buildRequestUrl(request);
Expand Down

4 changes: 2 additions & 2 deletions
packages/sdk-node/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
/* eslint-disable turbo/no-undeclared-env-vars */
import { deprecated } from '@clerk/shared/deprecated';
import { isTruthy } from '@clerk/shared/underscore';
import type { IncomingMessage, ServerResponse } from 'http';

// https://nextjs.org/docs/api-routes/api-middlewares#connectexpress-middleware-support
Expand DownExpand Up@@ -41,7 +41,7 @@ export const loadApiEnv = () => {
 domain: process.env.CLERK_DOMAIN || '',
 proxyUrl: process.env.CLERK_PROXY_URL || '',
 signInUrl: process.env.CLERK_SIGN_IN_URL || '',
 isSatellite: process.env.CLERK_IS_SATELLITE === 'true',
 isSatellite: isTruthy(process.env.CLERK_IS_SATELLITE),
 jwtKey: process.env.CLERK_JWT_KEY || '',
 };
};

28 changes: 27 additions & 1 deletion
packages/shared/src/__tests__/underscore.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, titleize, toSentence } from '../underscore';
import { deepCamelToSnake, deepSnakeToCamel, isIPV4Address, isTruthy, titleize, toSentence } from '../underscore';

describe('toSentence', () => {
 it('returns a single item as-is', () => {
Expand DownExpand Up@@ -178,3 +178,29 @@ describe('camelToSnakeKeys', () => {
 expect(anotherSampleObject).not.toHaveProperty('oneKey');
 });
});

describe(`isTruthy`, () => {
 it(`handles booleans`, () => {
 expect(isTruthy(true)).toBe(true);
 expect(isTruthy(false)).toBe(false);
 });
 it(`handles true or false strings `, () => {
 expect(isTruthy(`true`)).toBe(true);
 expect(isTruthy(`false`)).toBe(false);
 expect(isTruthy(`TRUE`)).toBe(true);
 expect(isTruthy(`FALSE`)).toBe(false);
 expect(isTruthy(`TruE`)).toBe(true);
 expect(isTruthy(`FalsE`)).toBe(false);
 });
 it(`handles numbers`, () => {
 expect(isTruthy(`1`)).toBe(true);
 expect(isTruthy(`0`)).toBe(false);
 expect(isTruthy(`-1`)).toBe(false);
 expect(isTruthy(1)).toBe(true);
 expect(isTruthy(0)).toBe(false);
 expect(isTruthy(-1)).toBe(false);
 });
 it(`defaults to false`, () => {
 expect(isTruthy(`foobar`)).toBe(false);
 });
});

26 changes: 26 additions & 0 deletions
packages/shared/src/underscore.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,3 +82,29 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
 * camelCased keys are removed.
 */
export const deepSnakeToCamel = createDeepObjectTransformer(snakeToCamel);

/**
 * Returns true for `true`, true, positive numbers.
 * Returns false for `false`, false, 0, negative integers and anything else.
 */
export function isTruthy(value: unknown): boolean {
 // Return if Boolean
 if (typeof value === `boolean`) return value;

 // Return false if null or undefined
 if (value === undefined || value === null) return false;

 // If the String is true or false
 if (typeof value === `string`) {
 if (value.toLowerCase() === `true`) return true;
 if (value.toLowerCase() === `false`) return false;
 }

 // Now check if it's a number
 const number = parseInt(value as string, 10);
 if (isNaN(number)) return false;
 if (number > 0) return true;

 // Default to false
 return false;
}