reuse logic within tanstack-start

Author: wobsoriano

packages/shared/src/getEnvVariable.ts

@@ -1,10 +1,5 @@
 type CloudflareEnv = { env: Record<string, string> };
 
-interface Context {
-  [key: string]: unknown;
-  cloudflare?: CloudflareEnv;
-}
-
 const hasCloudflareProxyContext = (context: any): context is { cloudflare: CloudflareEnv } => {
   return !!context?.cloudflare?.env;
 };
@@ -19,7 +14,7 @@ const hasCloudflareContext = (context: any): context is CloudflareEnv => {
  * @param context - Optional context object that may contain environment values
  * @returns The environment variable value or empty string if not found
  */
-export const getEnvVariable = (name: string, context: Context | undefined): string => {
+export const getEnvVariable = <T = unknown>(name: string, context?: T): string => {
   // Node envs
   if (typeof process !== 'undefined' && process.env && typeof process.env[name] === 'string') {
     return process.env[name];
@@ -41,8 +36,8 @@ export const getEnvVariable = (name: string, context: Context | undefined): stri
   }
 
   // Check whether the value exists in the context object directly
-  if (context && typeof context[name] === 'string') {
-    return context[name];
+  if (context && typeof context[name as keyof typeof context] === 'string') {
+    return context[name as keyof typeof context] as string;
   }
 
   // Cloudflare workers

packages/tanstack-start/src/server/constants.ts

@@ -1,7 +1,8 @@
 import { apiUrlFromPublishableKey } from '@clerk/shared/apiUrlFromPublishableKey';
+import { getEnvVariable } from '@clerk/shared/getEnvVariable';
 import { getEvent } from 'vinxi/http';
 
-import { getEnvVariable, getPublicEnvVariables } from '../utils/env';
+import { getPublicEnvVariables } from '../utils/env';
 
 export const commonEnvs = () => {
   const event = getEvent();
@@ -21,16 +22,16 @@ export const commonEnvs = () => {
     TELEMETRY_DEBUG: publicEnvs.telemetryDebug,
 
     // Server-only environment variables
-    API_VERSION: getEnvVariable('CLERK_API_VERSION', 'v1', event),
-    SECRET_KEY: getEnvVariable('CLERK_SECRET_KEY', '', event),
-    ENCRYPTION_KEY: getEnvVariable('CLERK_ENCRYPTION_KEY', '', event),
-    CLERK_JWT_KEY: getEnvVariable('CLERK_JWT_KEY', '', event),
-    API_URL: getEnvVariable('CLERK_API_URL', '', event) || apiUrlFromPublishableKey(publicEnvs.publishableKey),
+    API_VERSION: getEnvVariable('CLERK_API_VERSION', event) || 'v1',
+    SECRET_KEY: getEnvVariable('CLERK_SECRET_KEY', event),
+    ENCRYPTION_KEY: getEnvVariable('CLERK_ENCRYPTION_KEY', event),
+    CLERK_JWT_KEY: getEnvVariable('CLERK_JWT_KEY', event),
+    API_URL: getEnvVariable('CLERK_API_URL', event) || apiUrlFromPublishableKey(publicEnvs.publishableKey),
 
     SDK_METADATA: {
       name: PACKAGE_NAME,
       version: PACKAGE_VERSION,
-      environment: getEnvVariable('NODE_ENV', '', event),
+      environment: getEnvVariable('NODE_ENV', event),
     },
   } as const;
 };

packages/tanstack-start/src/server/loadOptions.ts

@@ -1,12 +1,13 @@
 import { createClerkRequest } from '@clerk/backend/internal';
 import { apiUrlFromPublishableKey } from '@clerk/shared/apiUrlFromPublishableKey';
+import { getEnvVariable } from '@clerk/shared/getEnvVariable';
 import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
 import { isHttpOrHttps, isProxyUrlRelative } from '@clerk/shared/proxy';
 import { handleValueOrFn } from '@clerk/shared/utils';
 import { getEvent } from 'vinxi/http';
 
 import { errorThrower } from '../utils';
-import { getEnvVariable, getPublicEnvVariables } from '../utils/env';
+import { getPublicEnvVariables } from '../utils/env';
 import { commonEnvs } from './constants';
 import type { LoaderOptions } from './types';
 import { patchRequest } from './utils';
@@ -18,7 +19,7 @@ export const loadOptions = (request: Request, overrides: LoaderOptions = {}) =>
   const secretKey = overrides.secretKey || commonEnv.SECRET_KEY;
   const publishableKey = overrides.publishableKey || commonEnv.PUBLISHABLE_KEY;
   const jwtKey = overrides.jwtKey || commonEnv.CLERK_JWT_KEY;
-  const apiUrl = getEnvVariable('CLERK_API_URL', '', event) || apiUrlFromPublishableKey(publishableKey);
+  const apiUrl = getEnvVariable('CLERK_API_URL', event) || apiUrlFromPublishableKey(publishableKey);
   const domain = handleValueOrFn(overrides.domain, new URL(request.url)) || commonEnv.DOMAIN;
   const isSatellite = handleValueOrFn(overrides.isSatellite, new URL(request.url)) || commonEnv.IS_SATELLITE;
   const relativeOrAbsoluteProxyUrl = handleValueOrFn(overrides?.proxyUrl, clerkRequest.clerkUrl, commonEnv.PROXY_URL);

packages/tanstack-start/src/server/utils/index.ts

@@ -1,8 +1,8 @@
 import type { RequestState } from '@clerk/backend/internal';
 import { debugRequestState } from '@clerk/backend/internal';
+import { getEnvVariable } from '@clerk/shared/getEnvVariable';
 import { isTruthy } from '@clerk/shared/underscore';
 
-import { getEnvVariable } from '../../utils/env';
 import type { AdditionalStateOptions } from '../types';
 
 /**

packages/tanstack-start/src/utils/env.ts

@@ -1,40 +1,10 @@
+import { getEnvVariable } from '@clerk/shared/getEnvVariable';
 import { isTruthy } from '@clerk/shared/underscore';
 import type { HTTPEvent } from 'vinxi/http';
 
-/**
- *
- * Utility function to get env variables.
- *
- * @param name env variable name
- * @param defaultVaue default value to return if the env variable is not set
- * @param event - H3Event object for accessing runtime environment variables
- * @returns string
- *
- * @internal
- */
-export const getEnvVariable = (name: string, defaultValue: string = '', event?: HTTPEvent) => {
-  // Cloudflare context check
-  const cfValue = event?.context?.cloudflare?.env[name];
-  if (cfValue) {
-    return cfValue;
-  }
-
-  // Node envs
-  if (typeof process !== 'undefined' && process.env && typeof process.env[name] === 'string') {
-    return process.env[name];
-  }
-
-  // Vite specific envs
-  if (typeof import.meta !== 'undefined' && import.meta.env && typeof import.meta.env[name] === 'string') {
-    return import.meta.env[name];
-  }
-
-  return defaultValue;
-};
-
 export const getPublicEnvVariables = (event?: HTTPEvent) => {
   const getValue = (name: string): string => {
-    return getEnvVariable(`VITE_${name}`, '', event) || getEnvVariable(name, '', event);
+    return getEnvVariable(`VITE_${name}`, event) || getEnvVariable(name, event);
   };
 
   return {