feat: add @auth/astro framework library #9856

TheOtterlord · 2024-01-30T13:55:02Z

☕️ Reasoning

This PR is the next iteration of #6463

Introduces an Astro framework package. The package exposes an integration, along with helper methods for both server & client uses.

🧢 Checklist

Documentation (Note: The auth-astro.vercel.app autogenerated link doesn't have a deployed site. I'm assuming any deployed example will be hosted by this org)
Tests
Ready to be merged

🎫 Affected issues

📌 Resources

vercel · 2024-01-30T13:55:06Z

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

Name	Status	Preview	Comments	Updated (UTC)
auth-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 30, 2024 2:29pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
next-auth-docs	⬜️ Ignored (Inspect)	Visit Preview		Oct 30, 2024 2:29pm

apps/dev/astro/auth.config.ts

packages/frameworks-astro/src/config.ts

…c stuff

balazsorban44

Thanks! Added some comments!

Besides those, have a look at https://github.com/nextauthjs/next-auth/blob/main/packages/utils/scripts/providers.js

Used eg. here:

next-auth/packages/next-auth/package.json

Lines 61 to 65 in f33a0ac

    
           "build": "pnpm clean && pnpm providers && tsc", 
        
           "clean": "rm -rf *.js *.d.ts* lib providers", 
        
           "dev": "pnpm providers && tsc -w", 
        
           "test": "vitest -c ../utils/vitest.config.ts", 
        
           "providers": "node ../utils/scripts/providers"

This way, users can import providers from @auth/astro/providers/* instead of having to install @auth/core!

Further, for other integrations support automatic environment variable inference by using the setEnvDefaults method like so

next-auth/packages/frameworks-express/src/index.ts

Line 160 in f33a0ac

setEnvDefaults(process.env, config)

there is also createActionURL, a method from core that helps you create the url for the Request of Auth in a much less hacky way!

And lastly, the default basePath value is expected to be /auth, not /api/auth. (NextAuth.js is the only exception, since historically that was the default basePath there and we did not want to make this a breaking change in v5)

Could you incorporate these changes, and then make sure that the dev app and example app is also correctly updated? 🙏 Thanks!

packages/frameworks-astro/module.d.ts

packages/frameworks-astro/package.json

balazsorban44 · 2024-01-31T00:49:09Z

packages/frameworks-astro/package.json

+    ".": "./src/index.ts",
+    "./config": "./src/config.ts",
+    "./client": "./src/client.ts",
+    "./server": "./src/server.ts",
+    "./middleware": "./middleware.ts"


Suggested change

".": "./src/index.ts",

"./config": "./src/config.ts",

"./client": "./src/client.ts",

"./server": "./src/server.ts",

"./middleware": "./middleware.ts"

".": {

"types": "./index.d.ts",

"import": "./index.js"

},

"./config": {

"types": "./config.d.ts",

"import": "./config.js"

},

"./client": {

"types": "./client.d.ts",

"import": "./client.js"

},

"./server": {

"types": "./server.d.ts",

"import": "./server.js"

},

"./middleware": {

"types": "./middleware.d.ts",

"import": "./middleware.js"

},

"./adapters": {

"types": "./adapters.d.ts"

},

"./providers/*": {

"types": "./providers/*.d.ts",

"import": "./providers/*.js"

}

The Astro package doesn't require bundling, as all Astro projects (regardless of config) support TypeScript files. Is there still a reason to specify both types and import if they both lead to the same file?

packages/frameworks-astro/package.json

packages/frameworks-astro/tsconfig.json

packages/frameworks-astro/src/server.ts

Co-authored-by: Balázs Orbán <info@balazsorban.com>

…nto auth-astro

…, clean up file structure

NuroDev · 2024-03-10T10:03:51Z

Is there any further things blocking this from getting merged? I'd love to start using it

ndom91 · 2024-03-11T16:21:18Z

There seem to be some merge conflicts. Otherwise it should be close. Needs another last going over, testing, etc.

TheOtterlord · 2024-03-12T18:59:17Z

@ndom91 happy to resolve the conflict, seems to just be the pnpm-lock, so I'll try to do this tonight. Also, I have some notes from the last review in Discord that might be relevant when going over for another round of reviewing.

I also know there's been work on the framework guidelines? I've not been able to keep up as much as I wanted, so let me know if I'm missing anything important from those!

ndom91 · 2024-03-13T21:04:12Z

@ndom91 happy to resolve the conflict, seems to just be the pnpm-lock, so I'll try to do this tonight. Also, I have some notes from the last review in Discord that might be relevant when going over for another round of reviewing.

I also know there's been work on the framework guidelines? I've not been able to keep up as much as I wanted, so let me know if I'm missing anything important from those!

Awesome, thanks! Yeah no I don't think there were any changes there. There's just this creating a framework pkg guidelines 👍

vercel · 2024-03-13T21:51:38Z

@TheOtterlord is attempting to deploy a commit to the authjs Team on Vercel.

A member of the Team first needs to authorize it.

podbasico · 2024-10-08T17:17:03Z

I have moved away from authjs because I don't think this PR is ever going to be merged (there used to be a different one before this one)

Can you recommend good alternatives?

I could, but don't think this is the right place 😉

ruohki · 2024-10-09T18:36:46Z

I have moved away from authjs because I don't think this PR is ever going to be merged (there used to be a different one before this one)

Can you recommend good alternatives?

https://github.com/lucia-auth/lucia try this one its the other recommended framework for astro

andokai · 2024-10-09T18:44:36Z

I have moved away from authjs because I don't think this PR is ever going to be merged (there used to be a different one before this one)

Can you recommend good alternatives?

https://github.com/lucia-auth/lucia try this one its the other recommended framework for astro

Probably better that you don't do that.

lucia-auth/lucia#1707

NuroDev · 2024-10-10T11:09:23Z

I would prefer to use Auth.js since I am familar with it but since this PR is clearly not going to get merged, at least any time soon, I've switched to better-auth since it offers out the box support for Astro.

jonaspm · 2024-10-18T16:00:19Z

I also hope this does get merged!

dos41gw · 2024-10-29T17:12:32Z

Has anyone been able to run the fork with the installed PR? I'm stuck because the middleware isn't attaching due to an error in vite-plugin-astro-server/request.js: 'Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. Received protocol 'auth:'.'

jonaspm · 2024-10-29T19:29:17Z

Has anyone been able to run the fork with the installed PR? I'm stuck because the middleware isn't attaching due to an error in vite-plugin-astro-server/request.js: 'Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. Received protocol 'auth:'.'

I have not, but seems that there is still some work being done by @TheOtterlord & @ndom91

socket-security · 2024-10-30T14:22:51Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@astrojs/check@0.4.1	Transitive: environment, eval, filesystem, network, shell, unsafe	`+80`	35.9 MB	fredkschott
npm/@astrojs/node@8.3.4	Transitive: environment, eval, filesystem, network, unsafe	`+18`	326 kB	matthewp
npm/astro@4.16.7	Transitive: environment, eval, filesystem, network, shell	`+353`	514 MB	fredkschott

🚮 Removed packages: npm/@actions/core@1.10.1, npm/@ariakit/react@0.4.13, npm/@aws-sdk/client-dynamodb@3.499.0, npm/@aws-sdk/lib-dynamodb@3.499.0, npm/@azure/data-tables@13.2.2, npm/@balazsorban/monorepo-release@0.5.1, npm/@builder.io/qwik-city@1.5.5, npm/@builder.io/qwik@1.7.3, npm/@cloudflare/workers-types@4.20240117.0, npm/@simplewebauthn/server@9.0.3, npm/@types/react-dom@18.3.1, npm/@types/react@18.3.12, npm/@vercel/kv@1.0.1, npm/autoprefixer@10.4.20, npm/class-variance-authority@0.7.0, npm/lucide-react@0.274.0, npm/next-auth@5.0.0-beta.25, npm/next@15.0.2, npm/react-dom@18.3.1, npm/react@18.3.1, npm/tailwind-merge@1.14.0, npm/tailwindcss-animate@1.0.7, npm/unstorage@1.12.0

View full report↗︎

RyzeKit · 2024-11-10T06:17:38Z

I have moved away from authjs because I don't think this PR is ever going to be merged (there used to be a different one before this one)

Can you recommend good alternatives?

https://github.com/lucia-auth/lucia try this one its the other recommended framework for astro

Probably better that you don't do that.

lucia-auth/lucia#1707

I just finished converting my Astro starter kit to Lucia v4 (the latest version), and although it took some time, I would say it's a pretty good alternative. There are some examples that you can follow for guidance: https://github.com/orgs/lucia-auth/repositories?q=astro

Implement new version of @auth/astro

d559a15

TheOtterlord requested review from ThangHuuVu, ndom91 and balazsorban44 as code owners January 30, 2024 13:55

github-actions bot added frameworks examples labels Jan 30, 2024

TheOtterlord mentioned this pull request Jan 30, 2024

feat: add @auth/astro framework library with example & docs #6463

Closed

3 tasks

vercel bot deployed to Preview – auth-docs January 30, 2024 14:00 View deployment

Add missed additions

1da57c0

vercel bot deployed to Preview – auth-docs January 30, 2024 14:21 View deployment

NuroDev reviewed Jan 30, 2024

View reviewed changes

apps/dev/astro/auth.config.ts Outdated Show resolved Hide resolved

packages/frameworks-astro/src/config.ts Outdated Show resolved Hide resolved

Reimplement auth config with overrides, clean up types, fix other mis…

d57bf7b

…c stuff

vercel bot deployed to Preview – auth-docs January 30, 2024 23:23 View deployment

balazsorban44 requested changes Jan 31, 2024

View reviewed changes

Update packages/frameworks-astro/package.json

2ba14c9

Co-authored-by: Balázs Orbán <info@balazsorban.com>

vercel bot deployed to Preview – auth-docs January 31, 2024 11:35 View deployment

TheOtterlord and others added 3 commits January 31, 2024 11:47

Update packages/frameworks-astro/src/server.ts

d957b9b

Co-authored-by: Balázs Orbán <info@balazsorban.com>

Update types

ba3fd40

Merge branch 'auth-astro' of https://github.com/TheOtterlord/authjs i…

653ea4f

…nto auth-astro

vercel bot deployed to Preview – auth-docs January 31, 2024 11:49 View deployment

Change baseURL to /auth, add framework redirect, add providers script…

b74d6a8

…, clean up file structure

vercel bot had a problem deploying to Preview – auth-docs January 31, 2024 13:09 Failure

Docs changes

bc0019d

vercel bot had a problem deploying to Preview – auth-docs March 13, 2024 21:52 Failure

ThangHuuVu added 3 commits October 9, 2024 00:01

fix: reference types

e98a0eb

chore: rename getSession to auth

015ffca

chore: update config type

0a493fe

vercel bot had a problem deploying to Preview – auth-docs October 8, 2024 17:14 Failure

ThangHuuVu added 2 commits October 13, 2024 11:53

Merge branch 'main' into auth-astro

822c64e

Update pnpm-lock.yaml

444ec86

vercel bot had a problem deploying to Preview – auth-docs October 13, 2024 04:57 Failure

chore: update deps

33a83f1

vercel bot had a problem deploying to Preview – auth-docs October 13, 2024 05:17 Failure

feat: relocate /api dir

099feeb

vercel bot had a problem deploying to Preview – auth-docs October 13, 2024 15:26 Failure

ndom91 added 2 commits October 19, 2024 19:56

fix: add astro typedoc config

11ef712

fix: add astro sidebar name

32913ae

vercel bot deployed to Preview – auth-docs October 19, 2024 18:12 View deployment

TheOtterlord added 2 commits October 19, 2024 19:21

Remove middleware.ts

f88e2fc

Remove Astro 3 compatibility

5e4cfa3

vercel bot deployed to Preview – auth-docs October 19, 2024 18:30 View deployment

Merge upstream/main into theotterlord/authjs

b8fb83a

vercel bot deployed to Preview – auth-docs October 19, 2024 18:45 View deployment

Merge upstream/main into theotterlord/authjs

cd3b8f5

vercel bot deployed to Preview – auth-docs October 30, 2024 14:29 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add @auth/astro framework library #9856

feat: add @auth/astro framework library #9856

TheOtterlord commented Jan 30, 2024 •

edited

Loading

vercel bot commented Jan 30, 2024 •

edited

Loading

balazsorban44 left a comment

balazsorban44 Jan 31, 2024

TheOtterlord Jan 31, 2024

NuroDev commented Mar 10, 2024

ndom91 commented Mar 11, 2024

TheOtterlord commented Mar 12, 2024

ndom91 commented Mar 13, 2024

vercel bot commented Mar 13, 2024

podbasico commented Oct 8, 2024

ruohki commented Oct 9, 2024

andokai commented Oct 9, 2024

NuroDev commented Oct 10, 2024

jonaspm commented Oct 18, 2024

dos41gw commented Oct 29, 2024

jonaspm commented Oct 29, 2024 •

edited

Loading

socket-security bot commented Oct 30, 2024

RyzeKit commented Nov 10, 2024

	"build": "pnpm clean && pnpm providers && tsc",
	"clean": "rm -rf .js .d.ts* lib providers",
	"dev": "pnpm providers && tsc -w",
	"test": "vitest -c ../utils/vitest.config.ts",
	"providers": "node ../utils/scripts/providers"

-    ".": "./src/index.ts",
-    "./config": "./src/config.ts",
-    "./client": "./src/client.ts",
-    "./server": "./src/server.ts",
-    "./middleware": "./middleware.ts"
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./config": {
+      "types": "./config.d.ts",
+      "import": "./config.js"
+    },
+    "./client": {
+      "types": "./client.d.ts",
+      "import": "./client.js"
+    },
+    "./server": {
+      "types": "./server.d.ts",
+      "import": "./server.js"
+    },
+    "./middleware": {
+      "types": "./middleware.d.ts",
+      "import": "./middleware.js"
+    },
+    "./adapters": {
+        "types": "./adapters.d.ts"
+      },
+    "./providers/*": {
+      "types": "./providers/*.d.ts",
+      "import": "./providers/*.js"
+    }

feat: add @auth/astro framework library #9856

Are you sure you want to change the base?

feat: add @auth/astro framework library #9856

Conversation

TheOtterlord commented Jan 30, 2024 • edited Loading

☕️ Reasoning

🧢 Checklist

🎫 Affected issues

📌 Resources

vercel bot commented Jan 30, 2024 • edited Loading

balazsorban44 left a comment

Choose a reason for hiding this comment

balazsorban44 Jan 31, 2024

Choose a reason for hiding this comment

TheOtterlord Jan 31, 2024

Choose a reason for hiding this comment

NuroDev commented Mar 10, 2024

ndom91 commented Mar 11, 2024

TheOtterlord commented Mar 12, 2024

ndom91 commented Mar 13, 2024

vercel bot commented Mar 13, 2024

podbasico commented Oct 8, 2024

ruohki commented Oct 9, 2024

andokai commented Oct 9, 2024

NuroDev commented Oct 10, 2024

jonaspm commented Oct 18, 2024

dos41gw commented Oct 29, 2024

jonaspm commented Oct 29, 2024 • edited Loading

socket-security bot commented Oct 30, 2024

RyzeKit commented Nov 10, 2024

TheOtterlord commented Jan 30, 2024 •

edited

Loading

vercel bot commented Jan 30, 2024 •

edited

Loading

jonaspm commented Oct 29, 2024 •

edited

Loading