blsmedia/bot
2
0
Fork 0
Code Activity

🧑‍💻 Improve env variables type safety and management (#718)

Browse Source 
Closes #679
This commit is contained in:
Baptiste Arnaud
2023-08-28 09:13:53 +02:00
committed by GitHub
parent a23a8c4456
commit 786e5cb582
148 changed files with 1550 additions and 1293 deletions
Download Patch File Download Diff File Expand all files Collapse all files

315
packages/env/env.ts vendored Normal file
View File

@ -0,0 +1,315 @@
import { createEnv } from '@t3-oss/env-nextjs'
import { z } from 'zod'
declare const window: {
__ENV: any
}
const getRuntimeVariable = (key: string) => {
if (typeof window === 'undefined') return process.env[key]
return window.__ENV[key]
}
const boolean = z.enum(['true', 'false']).transform((value) => value === 'true')
const baseEnv = {
server: {
NODE_ENV: z.enum(['development', 'production', 'test']).optional(),
DATABASE_URL: z
.string()
.url()
.refine((url) => url.startsWith('postgres') || url.startsWith('mysql')),
ENCRYPTION_SECRET: z.string().length(32),
NEXTAUTH_URL: z.string().url(),
DISABLE_SIGNUP: boolean.optional(),
ADMIN_EMAIL: z.string().email().optional(),
DEFAULT_WORKSPACE_PLAN: z
.enum(['FREE', 'STARTER', 'PRO', 'LIFETIME', 'UNLIMITED'])
.refine((str) =>
['FREE', 'STARTER', 'PRO', 'LIFETIME', 'UNLIMITED'].includes(str)
)
.default('FREE'),
DEBUG: boolean.optional(),
},
client: {
NEXT_PUBLIC_E2E_TEST: boolean.optional(),
NEXT_PUBLIC_VIEWER_URL: z
.string()
.min(1)
.transform((string) => string.split(',')),
NEXT_PUBLIC_VIEWER_INTERNAL_URL: z.string().url().optional(),
NEXT_PUBLIC_ONBOARDING_TYPEBOT_ID: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_E2E_TEST: getRuntimeVariable('NEXT_PUBLIC_E2E_TEST'),
NEXT_PUBLIC_VIEWER_URL: getRuntimeVariable('NEXT_PUBLIC_VIEWER_URL'),
NEXT_PUBLIC_VIEWER_INTERNAL_URL: getRuntimeVariable(
'NEXT_PUBLIC_VIEWER_INTERNAL_URL'
),
NEXT_PUBLIC_ONBOARDING_TYPEBOT_ID: getRuntimeVariable(
'NEXT_PUBLIC_ONBOARDING_TYPEBOT_ID'
),
},
}
const githubEnv = {
server: {
GITHUB_CLIENT_ID: z.string().min(1).optional(),
GITHUB_CLIENT_SECRET: z.string().min(1).optional(),
},
}
const facebookEnv = {
server: {
FACEBOOK_CLIENT_ID: z.string().min(1).optional(),
FACEBOOK_CLIENT_SECRET: z.string().min(1).optional(),
},
}
const smtpEnv = {
server: {
SMTP_USERNAME: z.string().min(1).optional(),
SMTP_PASSWORD: z.string().min(1).optional(),
SMTP_HOST: z.string().min(1).optional(),
SMTP_PORT: z.coerce.number().optional(),
SMTP_AUTH_DISABLED: boolean.optional(),
SMTP_SECURE: boolean.optional(),
},
client: {
NEXT_PUBLIC_SMTP_FROM: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_SMTP_FROM: getRuntimeVariable('NEXT_PUBLIC_SMTP_FROM'),
},
}
const gitlabEnv = {
server: {
GITLAB_CLIENT_ID: z.string().min(1).optional(),
GITLAB_CLIENT_SECRET: z.string().min(1).optional(),
GITLAB_BASE_URL: z.string().url().optional(),
GITLAB_NAME: z.string().min(1).optional(),
GITLAB_REQUIRED_GROUPS: z
.string()
.transform((string) => (string ? string.split(',') : undefined))
.optional(),
},
}
const azureEnv = {
server: {
AZURE_AD_CLIENT_ID: z.string().min(1).optional(),
AZURE_AD_CLIENT_SECRET: z.string().min(1).optional(),
AZURE_AD_TENANT_ID: z.string().min(1).optional(),
},
}
const customOAuthEnv = {
server: {
CUSTOM_OAUTH_NAME: z.string().min(1).optional(),
CUSTOM_OAUTH_SCOPE: z.string().min(1).optional(),
CUSTOM_OAUTH_CLIENT_ID: z.string().min(1).optional(),
CUSTOM_OAUTH_CLIENT_SECRET: z.string().min(1).optional(),
CUSTOM_OAUTH_WELL_KNOWN_URL: z.string().url().optional(),
CUSTOM_OAUTH_USER_ID_PATH: z.string().min(1).optional(),
CUSTOM_OAUTH_USER_EMAIL_PATH: z.string().min(1).optional(),
CUSTOM_OAUTH_USER_NAME_PATH: z.string().min(1).optional(),
CUSTOM_OAUTH_USER_IMAGE_PATH: z.string().min(1).optional(),
},
}
const googleEnv = {
server: {
GOOGLE_CLIENT_ID: z.string().min(1).optional(),
GOOGLE_CLIENT_SECRET: z.string().min(1).optional(),
},
client: {
NEXT_PUBLIC_GOOGLE_API_KEY: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_GOOGLE_API_KEY: getRuntimeVariable(
'NEXT_PUBLIC_GOOGLE_API_KEY'
),
},
}
const stripeEnv = {
server: {
STRIPE_SECRET_KEY: z.string().min(1).optional(),
STRIPE_WEBHOOK_SECRET: z.string().min(1).optional(),
STRIPE_STARTER_PRODUCT_ID: z.string().min(1).optional(),
STRIPE_STARTER_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_STARTER_YEARLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_STARTER_CHATS_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_STARTER_CHATS_YEARLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_STARTER_STORAGE_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_STARTER_STORAGE_YEARLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_PRODUCT_ID: z.string().min(1).optional(),
STRIPE_PRO_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_YEARLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_CHATS_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_CHATS_YEARLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_STORAGE_MONTHLY_PRICE_ID: z.string().min(1).optional(),
STRIPE_PRO_STORAGE_YEARLY_PRICE_ID: z.string().min(1).optional(),
},
client: {
NEXT_PUBLIC_STRIPE_PUBLIC_KEY: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_STRIPE_PUBLIC_KEY: getRuntimeVariable(
'NEXT_PUBLIC_STRIPE_PUBLIC_KEY'
),
},
}
const s3Env = {
server: {
S3_ACCESS_KEY: z.string().min(1).optional(),
S3_SECRET_KEY: z.string().min(1).optional(),
S3_BUCKET: z.string().min(1).optional(),
S3_PORT: z.coerce.number().optional(),
S3_ENDPOINT: z.string().min(1).optional(),
S3_SSL: boolean.optional(),
S3_REGION: z.string().min(1).optional(),
},
}
const giphyEnv = {
client: {
NEXT_PUBLIC_GIPHY_API_KEY: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_GIPHY_API_KEY: getRuntimeVariable('NEXT_PUBLIC_GIPHY_API_KEY'),
},
}
const vercelEnv = {
server: {
VERCEL_TOKEN: z.string().min(1).optional(),
VERCEL_TEAM_ID: z.string().min(1).optional(),
VERCEL_GIT_COMMIT_SHA: z.string().min(1).optional(),
},
client: {
NEXT_PUBLIC_VERCEL_VIEWER_PROJECT_NAME: z.string().min(1).optional(),
NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA: z.string().min(1).optional(),
NEXT_PUBLIC_VERCEL_ENV: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_VERCEL_VIEWER_PROJECT_NAME: getRuntimeVariable(
'NEXT_PUBLIC_VERCEL_VIEWER_PROJECT_NAME'
),
NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA: getRuntimeVariable(
'NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA'
),
NEXT_PUBLIC_VERCEL_ENV: getRuntimeVariable('NEXT_PUBLIC_VERCEL_ENV'),
},
}
const sleekPlanEnv = {
server: {
SLEEKPLAN_SSO_KEY: z.string().min(1).optional(),
},
}
const unsplashEnv = {
client: {
NEXT_PUBLIC_UNSPLASH_APP_NAME: z.string().min(1).optional(),
NEXT_PUBLIC_UNSPLASH_ACCESS_KEY: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_UNSPLASH_APP_NAME: getRuntimeVariable(
'NEXT_PUBLIC_UNSPLASH_APP_NAME'
),
NEXT_PUBLIC_UNSPLASH_ACCESS_KEY: getRuntimeVariable(
'NEXT_PUBLIC_UNSPLASH_ACCESS_KEY'
),
},
}
const whatsAppEnv = {
server: {
META_SYSTEM_USER_TOKEN: z.string().min(1).optional(),
WHATSAPP_PREVIEW_FROM_PHONE_NUMBER_ID: z.string().min(1).optional(),
},
}
const upstashRedis = {
server: {
UPSTASH_REDIS_REST_URL: z.string().url().optional(),
UPSTASH_REDIS_REST_TOKEN: z.string().min(1).optional(),
},
}
const sentryEnv = {
client: {
NEXT_PUBLIC_SENTRY_DSN: z.string().min(1).optional(),
},
server: {
SENTRY_AUTH_TOKEN: z.string().min(1).optional(),
SENTRY_PROJECT: z.string().min(1).optional(),
SENTRY_ORG: z.string().min(1).optional(),
},
runtimeEnv: {
NEXT_PUBLIC_SENTRY_DSN: getRuntimeVariable('NEXT_PUBLIC_SENTRY_DSN'),
},
}
const telemetryEnv = {
server: {
TELEMETRY_WEBHOOK_URL: z.string().url().optional(),
TELEMETRY_WEBHOOK_BEARER_TOKEN: z.string().min(1).optional(),
USER_CREATED_WEBHOOK_URL: z.string().url().optional(),
},
}
const posthogEnv = {
server: {
POSTHOG_API_KEY: z.string().min(1).optional(),
},
}
export const env = createEnv({
server: {
...baseEnv.server,
...githubEnv.server,
...facebookEnv.server,
...smtpEnv.server,
...googleEnv.server,
...stripeEnv.server,
...s3Env.server,
...vercelEnv.server,
...sleekPlanEnv.server,
...whatsAppEnv.server,
...upstashRedis.server,
...gitlabEnv.server,
...azureEnv.server,
...customOAuthEnv.server,
...sentryEnv.server,
...telemetryEnv.server,
...posthogEnv.server,
},
client: {
...baseEnv.client,
...smtpEnv.client,
...googleEnv.client,
...stripeEnv.client,
...giphyEnv.client,
...vercelEnv.client,
...unsplashEnv.client,
...sentryEnv.client,
},
experimental__runtimeEnv: {
...baseEnv.runtimeEnv,
...smtpEnv.runtimeEnv,
...googleEnv.runtimeEnv,
...stripeEnv.runtimeEnv,
...giphyEnv.runtimeEnv,
...vercelEnv.runtimeEnv,
...unsplashEnv.runtimeEnv,
...sentryEnv.runtimeEnv,
},
// onInvalidAccess: (variable: string) => {
// throw new Error(
// `❌ Attempted to access a server-side environment variable on the client: ${variable}`
// )
// },
})

20
packages/env/package.json vendored Normal file
View File

@ -0,0 +1,20 @@
{
"name": "@typebot.io/env",
"version": "1.0.0",
"license": "AGPL-3.0-or-later",
"private": true,
"main": "./env.ts",
"types": "./env.ts",
"dependencies": {
"@t3-oss/env-nextjs": "^0.6.0",
"zod": "3.21.4"
},
"devDependencies": {
"@typebot.io/tsconfig": "workspace:*",
"@types/node": "^20.4.9",
"esbuild": "^0.19.1"
},
"scripts": {
"build": "esbuild env.ts --packages=external --outfile=dist/env.mjs"
}
}

5
packages/env/tsconfig.json vendored Normal file
View File

@ -0,0 +1,5 @@
{
"extends": "@typebot.io/tsconfig/base.json",
"include": ["**/*.ts"],
"exclude": ["node_modules"]
}