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

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts
, '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(astro): Add support for type-safe environment variables - #5104

Merged
wobsoriano merged 14 commits into
mainfrom
rob/eco-119-astro-env-support
Feb 11, 2025
Merged

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

Conversation

@wobsoriano

Copy link
Copy Markdown
Member

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot

changeset-botBot commented Feb 8, 2025

Copy link
Copy Markdown

🦋 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
NameType
@clerk/astroMinor

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

vercelBot commented Feb 8, 2025

Copy link
Copy Markdown

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

NameStatusPreviewCommentsUpdated (UTC)
clerk-js-sandbox✅ Ready (Inspect)Visit Preview💬 Add feedbackFeb 10, 2025 4:32pm

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

@wobsorianowobsorianoFeb 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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 || {};

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
wobsoriano requested review from LekoArts and panteliselef and removed request for LekoArtsFebruary 8, 2025 00:46
@wobsoriano
wobsoriano marked this pull request as ready for review February 8, 2025 00:46
@wobsoriano

Copy link
Copy Markdown
MemberAuthor

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

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

PackageVersion
@clerk/astro2.2.0-snapshot.v20250208004744
@clerk/backend1.24.0-snapshot.v20250208004744
@clerk/chrome-extension2.2.8-snapshot.v20250208004744
@clerk/clerk-js5.52.2-snapshot.v20250208004744
@clerk/elements0.22.21-snapshot.v20250208004744
@clerk/clerk-expo2.7.6-snapshot.v20250208004744
@clerk/expo-passkeys0.1.19-snapshot.v20250208004744
@clerk/express1.3.47-snapshot.v20250208004744
@clerk/fastify2.1.20-snapshot.v20250208004744
@clerk/localizations3.10.5-snapshot.v20250208004744
@clerk/nextjs6.11.2-snapshot.v20250208004744
@clerk/nuxt1.1.3-snapshot.v20250208004744
@clerk/clerk-react5.22.12-snapshot.v20250208004744
@clerk/react-router1.0.7-snapshot.v20250208004744
@clerk/remix4.4.23-snapshot.v20250208004744
@clerk/shared2.21.0-snapshot.v20250208004744
@clerk/tanstack-start0.9.5-snapshot.v20250208004744
@clerk/testing1.4.21-snapshot.v20250208004744
@clerk/themes2.2.17-snapshot.v20250208004744
@clerk/types4.45.1-snapshot.v20250208004744
@clerk/ui0.3.22-snapshot.v20250208004744
@clerk/vue1.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

Comment thread.changeset/chilly-suns-beg.md Outdated
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 || {};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment threadpackages/astro/src/integration/create-integration.ts Outdated
@wobsoriano
wobsorianoforce-pushed the rob/eco-119-astro-env-support branch from ed1dfa7 to 4e1abb5CompareFebruary 10, 2025 16:21
@wobsoriano
wobsoriano merged commit ab06832 into mainFeb 11, 2025
@wobsoriano
wobsoriano deleted the rob/eco-119-astro-env-support branch February 11, 2025 14:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@wobsoriano@clerk-cookie@LekoArts