feat(astro): Add support for type-safe environment variables by wobsoriano · Pull Request #5104 · clerk/javascript

wobsoriano · 2025-02-08T00:32:06Z

Description

This PR adds support for type-safe env variables in Astro.

While our integration continues to use import.meta.env and process.env internally, we now provide users the option to import Clerk environment variables in a type-safe way.

When enabled, users can import our built-in variables like so:

import { PUBLIC_CLERK_PUBLISHABLE_KEY } from "astro:env/client"
import { CLERK_SECRET_KEY } from "astro:env/server"

console.log(PUBLIC_CLERK_PUBLISHABLE_KEY)
console.log(CLERK_SECRET_KEY)

Resolves ECO-119

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

changeset-bot · 2025-02-08T00:32:10Z

🦋 Changeset detected

Latest commit: 8f9508b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@clerk/astro	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-02-08T00:32:11Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 10, 2025 4:32pm

wobsoriano · 2025-02-08T00:37:33Z

    "inlineSources": false,
    "isolatedModules": true,
-    "moduleResolution": "node",
+    "moduleResolution": "Bundler",


We need to update this to properly resolve imports from packages that use export maps (like astro/config)

wobsoriano · 2025-02-08T00:43:47Z

 function createIntegration<Params extends HotloadAstroClerkIntegrationParams>() {
  return (params?: Params): AstroIntegration => {
-    const { proxyUrl, isSatellite, domain, signInUrl, signUpUrl } = params || {};
+    const { proxyUrl, isSatellite, domain, signInUrl, signUpUrl, enableEnvSchema = false } = params || {};


Since this is primarily for convenience and doesn't affect the core functionality of our integration, should we just enable it by default?

Yeah, since it's stable in Astro 5 I'd say let's enable it by default and change our docs/quickstart to use it 👍 I guess it's good to give the ability to turn it off in case someone want's to override it (assuming Astro doesn't merge the schema, dunno)

wobsoriano · 2025-02-08T00:46:57Z

!snapshot

clerk-cookie · 2025-02-08T00:49:21Z

Hey @wobsoriano - the snapshot version command generated the following package versions:

Package	Version
@clerk/astro	2.2.0-snapshot.v20250208004744
@clerk/backend	1.24.0-snapshot.v20250208004744
@clerk/chrome-extension	2.2.8-snapshot.v20250208004744
@clerk/clerk-js	5.52.2-snapshot.v20250208004744
@clerk/elements	0.22.21-snapshot.v20250208004744
@clerk/clerk-expo	2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys	0.1.19-snapshot.v20250208004744
@clerk/express	1.3.47-snapshot.v20250208004744
@clerk/fastify	2.1.20-snapshot.v20250208004744
@clerk/localizations	3.10.5-snapshot.v20250208004744
@clerk/nextjs	6.11.2-snapshot.v20250208004744
@clerk/nuxt	1.1.3-snapshot.v20250208004744
@clerk/clerk-react	5.22.12-snapshot.v20250208004744
@clerk/react-router	1.0.7-snapshot.v20250208004744
@clerk/remix	4.4.23-snapshot.v20250208004744
@clerk/shared	2.21.0-snapshot.v20250208004744
@clerk/tanstack-start	0.9.5-snapshot.v20250208004744
@clerk/testing	1.4.21-snapshot.v20250208004744
@clerk/themes	2.2.17-snapshot.v20250208004744
@clerk/types	4.45.1-snapshot.v20250208004744
@clerk/ui	0.3.22-snapshot.v20250208004744
@clerk/vue	1.1.11-snapshot.v20250208004744

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@2.2.0-snapshot.v20250208004744 --save-exact

@clerk/backend

npm i @clerk/backend@1.24.0-snapshot.v20250208004744 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.8-snapshot.v20250208004744 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.52.2-snapshot.v20250208004744 --save-exact

@clerk/elements

npm i @clerk/elements@0.22.21-snapshot.v20250208004744 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.7.6-snapshot.v20250208004744 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.19-snapshot.v20250208004744 --save-exact

@clerk/express

npm i @clerk/express@1.3.47-snapshot.v20250208004744 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.20-snapshot.v20250208004744 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.10.5-snapshot.v20250208004744 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.11.2-snapshot.v20250208004744 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.1.3-snapshot.v20250208004744 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.22.12-snapshot.v20250208004744 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.0.7-snapshot.v20250208004744 --save-exact

@clerk/remix

npm i @clerk/remix@4.4.23-snapshot.v20250208004744 --save-exact

@clerk/shared

npm i @clerk/shared@2.21.0-snapshot.v20250208004744 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.9.5-snapshot.v20250208004744 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.21-snapshot.v20250208004744 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.17-snapshot.v20250208004744 --save-exact

@clerk/types

npm i @clerk/types@4.45.1-snapshot.v20250208004744 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.22-snapshot.v20250208004744 --save-exact

@clerk/vue

npm i @clerk/vue@1.1.11-snapshot.v20250208004744 --save-exact

LekoArts · 2025-02-10T09:21:09Z

 function createIntegration<Params extends HotloadAstroClerkIntegrationParams>() {
  return (params?: Params): AstroIntegration => {
-    const { proxyUrl, isSatellite, domain, signInUrl, signUpUrl } = params || {};
+    const { proxyUrl, isSatellite, domain, signInUrl, signUpUrl, enableEnvSchema = false } = params || {};


Yeah, since it's stable in Astro 5 I'd say let's enable it by default and change our docs/quickstart to use it 👍 I guess it's good to give the ability to turn it off in case someone want's to override it (assuming Astro doesn't merge the schema, dunno)

Co-authored-by: Lennart <lekoarts@gmail.com>

clerk-cookie added the astro label Feb 8, 2025

vercel Bot had a problem deploying to Preview February 8, 2025 00:34 Failure

wobsoriano commented Feb 8, 2025

View reviewed changes

vercel Bot deployed to Preview February 8, 2025 00:41 View deployment

wobsoriano commented Feb 8, 2025

View reviewed changes

wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArts February 8, 2025 00:46

wobsoriano marked this pull request as ready for review February 8, 2025 00:46

vercel Bot deployed to Preview February 8, 2025 00:47 View deployment

LekoArts suggested changes Feb 10, 2025

View reviewed changes

vercel Bot temporarily deployed to Preview February 10, 2025 16:06 Inactive

vercel Bot deployed to Preview February 10, 2025 16:08 View deployment

vercel Bot temporarily deployed to Preview February 10, 2025 16:13 Inactive

wobsoriano and others added 11 commits February 10, 2025 08:19

feat(astro): Add type safe env vars support

e78dded

chore: update changeset

9f23211

chore: run dedupe

f5323a0

Update packages/astro/src/integration/create-integration.ts

bee9adb

Co-authored-by: Lennart <lekoarts@gmail.com>

Update .changeset/chilly-suns-beg.md

d8c10fc

Co-authored-by: Lennart <lekoarts@gmail.com>

chore(astro): Set default value to true

07c3d9d

chore(astro): Inform about validating secrets

a38993f

chore(astro): Set default env schema option value to false

c8b2b55

chore(astro): Add changeset

d54605b

chore(astro): Commit suggestion to changeset

d25235c

Co-authored-by: Lennart <lekoarts@gmail.com>

chore: Pin latest version of astro and update tsconfig

4e625e2

chore: enable feature by default

4e1abb5

wobsoriano force-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5 Compare February 10, 2025 16:21

chore: remove extra changeset

6753d44

wobsoriano requested a review from LekoArts February 10, 2025 16:23

vercel Bot deployed to Preview February 10, 2025 16:24 View deployment

chore: update changeset

8f9508b

vercel Bot deployed to Preview February 10, 2025 16:32 View deployment

LekoArts approved these changes Feb 11, 2025

View reviewed changes

wobsoriano merged commit ab06832 into main Feb 11, 2025

wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49

clerk-cookie mentioned this pull request Feb 11, 2025

ci(repo): Version packages #5127

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(astro): Add support for type-safe environment variables#5104

feat(astro): Add support for type-safe environment variables#5104
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support

wobsoriano commented Feb 8, 2025

Uh oh!

changeset-bot Bot commented Feb 8, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Feb 8, 2025 •

edited

Loading

Uh oh!

wobsoriano Feb 8, 2025 •

edited

Loading

Uh oh!

wobsoriano Feb 8, 2025

Uh oh!

LekoArts Feb 10, 2025

Uh oh!

wobsoriano commented Feb 8, 2025

Uh oh!

clerk-cookie commented Feb 8, 2025

Uh oh!

Uh oh!

LekoArts Feb 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

wobsoriano commented Feb 8, 2025

Description

Checklist

Type of change

Uh oh!

changeset-bot Bot commented Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wobsoriano Feb 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wobsoriano Feb 8, 2025

Choose a reason for hiding this comment

Uh oh!

LekoArts Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

wobsoriano commented Feb 8, 2025

Uh oh!

clerk-cookie commented Feb 8, 2025

Uh oh!

Uh oh!

LekoArts Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot Bot commented Feb 8, 2025 •

edited

Loading

vercel Bot commented Feb 8, 2025 •

edited

Loading

wobsoriano Feb 8, 2025 •

edited

Loading