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

.gitignore

@@ -89,6 +89,7 @@ packages/core/providers
 packages/core/src/lib/pages/styles.ts
 docs/docs/reference/03-core
 docs/docs/reference/04-sveltekit
+docs/docs/reference/04-astro
 
 
 # SvelteKit

apps/examples/astro/.gitignore

@@ -0,0 +1,20 @@
+# build output
+dist/
+.output/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

apps/examples/astro/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

apps/examples/astro/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

apps/examples/astro/README.md

@@ -0,0 +1,49 @@
+# Welcome to [Astro](https://astro.build)
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/basics)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png)
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```
+/
+├── public/
+│   └── favicon.svg
+├── src/
+│   ├── components/
+│   │   └── Card.astro
+│   ├── layouts/
+│   │   └── Layout.astro
+│   └── pages/
+│       └── index.astro
+└── package.json
+```
+
+Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+
+There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+
+Any static assets, like images, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                | Action                                             |
+| :--------------------- | :------------------------------------------------- |
+| `npm install`          | Installs dependencies                              |
+| `npm run dev`          | Starts local dev server at `localhost:3000`        |
+| `npm run build`        | Build your production site to `./dist/`            |
+| `npm run preview`      | Preview your build locally, before deploying       |
+| `npm run astro ...`    | Run CLI commands like `astro add`, `astro preview` |
+| `npm run astro --help` | Get help using the Astro CLI                       |
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

apps/examples/astro/astro.config.mjs

@@ -0,0 +1,21 @@
+import { defineConfig } from "astro/config";
+import node from "@astrojs/node";
+import auth from '@auth/astro'
+import Github from '@auth/core/providers/github'
+import { loadEnv } from 'vite'
+
+const env = loadEnv(import.meta.env.MODE, process.cwd(), "")
+
+// https://astro.build/config
+export default defineConfig({
+  output: "server",
+  adapter: node({
+    mode: 'standalone'
+  }),
+  integrations: [auth({
+    providers: [Github({
+      clientId: env.GITHUB_ID,
+      clientSecret: env.GITHUB_SECRET
+    })]
+  })]
+});

apps/examples/astro/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@example/basics",
+  "type": "module",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/node": "5.0.0",
+    "@auth/astro": "latest",
+    "@auth/core": "latest",
+    "astro": "2.1.0"
+  }
+}

apps/examples/astro/src/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="astro/client" />

apps/examples/astro/src/layouts/Layout.astro

@@ -0,0 +1,26 @@
+---
+export interface Props {
+	title: string;
+}
+
+const { title } = Astro.props;
+---
+
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width" />
+		<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+		<meta name="generator" content={Astro.generator} />
+		<title>{title}</title>
+	</head>
+	<body>
+    <slot/>
+	</body>
+</html>
+<style is:global>
+	html {
+		font-family: system-ui, sans-serif;
+	}
+</style>

apps/examples/astro/src/pages/index.astro

@@ -0,0 +1,25 @@
+---
+import Layout from '../layouts/Layout.astro';
+import type { Session } from '@auth/core/types';
+import { Auth, SignIn, SignOut } from '@auth/astro/components';
+import { getSession } from '@auth/astro/server'
+let session = await getSession(Astro.request);
+---
+
+<Layout title="Welcome to Astro Auth">
+  <Auth>
+    {(session: Session) => 
+      <main>
+        <h1>Astro + AuthJS</h1>
+        <p>
+          <a href="/protected">Protected Route</a>
+        </p>
+        <SignIn>Login</SignIn>
+        <SignOut>Logout</SignOut>
+        <p>
+          {session ? `Logged in as ${session.user?.name}` : 'Not logged in'}
+        </p>
+      </main>
+    }
+  </Auth>
+</Layout>

apps/examples/astro/src/pages/protected.astro

@@ -0,0 +1,19 @@
+---
+import { getSession } from "@auth/astro/server"
+
+let session = await getSession(Astro.request)
+
+if (!session) return Astro.redirect("/")
+---
+
+<p>
+  Only logged in users can see this page.
+</p>
+
+<p>
+  Logged in as {session?.user?.name}
+</p>
+
+<p>
+  <a href="/">Home</a>
+</p>

apps/examples/astro/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "astro/tsconfigs/strict"
+}

docs/docusaurus.config.js

@@ -235,6 +235,21 @@ const docusaurusConfig = {
         includeExtension: false,
       },
     ],
+    [
+      "docusaurus-plugin-typedoc",
+      {
+        ...typedocConfig,
+        id: "astro",
+        plugin: ["./tyepdoc"],
+        entryPoints: ["index.ts", "client.ts", "server.ts", "components.d.ts"].map(
+          (e) => `../packages/frameworks-astro/${e}`
+        ),
+        tsconfig: "../packages/frameworks-astro/tsconfig.json",
+        out: "reference/04-astro",
+        watch: process.env.TYPEDOC_WATCH,
+        includeExtension: false
+      },
+    ],
   ],
 }
 

docs/package.json

@@ -17,6 +17,7 @@
   "dependencies": {
     "@auth/core": "workspace:*",
     "@auth/sveltekit": "workspace:*",
+    "@auth/astro": "workspace:*",
     "@mdx-js/react": "1.6.22",
     "@sapphire/docusaurus-plugin-npm2yarn2pnpm": "1.1.4",
     "classnames": "^2.3.2",

docs/sidebars.js

@@ -62,6 +62,21 @@ module.exports = {
       },
       items: ["reference/solidstart/client", "reference/solidstart/protected"],
     },
+    {
+      type: "category",
+      label: "@auth/astro",
+      link: { type: "doc", id: "reference/astro/modules/main" },
+      items: [
+        { type: "autogenerated", dirName: "reference/04-astro/modules" },
+        {
+          type: "category",
+          label: "Reflections",
+          collapsed: true,
+          className: "reflection-category", // See src/index.css
+          items: [{ type: "autogenerated", dirName: "reference/04-astro" }],
+        },
+      ],
+    },
     {
       type: "category",
       label: "@auth/nextjs",

packages/frameworks-astro/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+   <br/>
+   <a href="https://authjs.dev" target="_blank"><img width="150px" src="https://authjs.dev/img/logo/logo-sm.png" /></a>
+   <h3 align="center">Astro Auth</a></h3>
+   <h4 align="center">Authentication for Astro.</h4>
+   <p align="center" style="align: center;">
+      <a href="https://npm.im/next-auth">
+        <img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
+      </a>
+      <a href="https://npm.im/@auth/astro">
+        <img alt="npm" src="https://img.shields.io/npm/v/@auth/sveltekit?color=green&label=@auth/astro&style=flat-square">
+      </a>
+      <a href="https://www.npmtrends.com/@auth/sveltekit">
+        <img src="https://img.shields.io/npm/dm/@auth/sveltekit?label=%20downloads&style=flat-square" alt="Downloads" />
+      </a>
+      <a href="https://github.com/nextauthjs/next-auth/stargazers">
+        <img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="Github Stars" />
+      </a>
+   </p>
+</p>