npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@convocomet/auth-astro

v1.1.0

Published

This is a fork of [Auth Astro](https://github.com/nowaythatworked/auth-astro), including many fixes and new features, which was created due to a lack of maintenance in the upstream version.

Downloads

6

Readme

Auth Astro

This is a fork of Auth Astro, including many fixes and new features, which was created due to a lack of maintenance in the upstream version.

Auth Astro is the easiest way to add Authentication to your Astro Project. It wraps the core of Auth.js into an Astro integration which automatically adds the endpoints and handles everything else.

(disclaimer: Please don´t confuse this package with astro-auth)

Installation

The easiest way to get started is adding this package using the astro cli.

npm run astro add @convocomet/auth-astro

This will install the package and required peer-dependencies and add the integration to your config. You can now jump to configuration

Alternarviely you can install the required packagages on your own.

npm install @convocomet/auth-astro@latest @auth/core@latest

Next you need to add the integration to your astro config by importing it and listing it in the integrations array.

Configuration

Create your auth configuration file in the root of your project.

import GitHub from '@auth/core/providers/github'
import { defineConfig } from '@convocomet/auth-astro'

export default defineConfig({
	providers: [
		GitHub({
			clientId: env.GITHUB_CLIENT_ID,
			clientSecret: env.GITHUB_CLIENT_SECRET,
		}),
	],
})

Some OAuth Providers request a callback URL be submitted alongside requesting a Client ID, and Client Secret. The callback URL used by the providers must be set to the following, unless you override the prefix field in the configuration:

[origin]/api/auth/callback/[provider]

// example
// http://localhost:3000/api/auth/callback/github

Setup Environment Variables

Generate an auth secret by running openssl rand -hex 32 in a local terminal or by visiting generate-secret.vercel.app, copy the string, then set it as the AUTH_SECRET environment variable describe below.

Next set the AUTH_TRUST_HOST environment variable to true for hosting providers like Cloudflare Pages or Netlify.

AUTH_SECRET=<auth-secret>
AUTH_TRUST_HOST=true

Deploying to Vercel?

Setting AUTH_TRUST_HOST is not needed as we also check for an active Vercel environment.

Requirements

  • Node version >= 17.4
  • Astro config set to output mode server
  • SSR enabled in your Astro project

Resources:

Usage

Your authentication endpoints now live under [origin]/api/auth/[operation]. You can change the prefix in the configuration.

Accessing your configuration

In case you need to access your auth configuration, you can always import it by

import authConfig from 'auth:config'

Sign in & Sign out

Astro Auth exposes two ways to sign in and out. Inline scripts and Astro Components.

With Inline script tags

The signIn and signOut methods can be imported dynamically in an inline script.

---
---

<html>
	<body>
		<button id="login">Login</button>
		<button id="logout">Logout</button>

		<script>
			const { signIn, signOut } = await import("@convocomet/auth-astro/client")
			document.querySelector("#login").onclick = () => signIn("github")
			document.querySelector("#logout").onclick = () => signOut()
		</script>
	</body>
</html>

With auth-astro's Components

Alternatively, you can use the SignIn and SignOut button components provided by @convocomet/auth-astro/components importing them into your Astro component's script

---
import { SignIn, SignOut } from '@convocomet/auth-astro/components'
---
<html>
  <body>
    ...
    <SignIn provider="github" />
    <SignOut />
    ...
  </body>
</html>

Fetching the session

You can fetch the session in one of two ways. The getSession method can be used in the component script section to fetch the session.

Within the component script section

---
import { getSession } from '@convocomet/auth-astro/server';

const session = await getSession(Astro.request)
---
{session ? (
  <p>Welcome {session.user?.name}</p>
) : (
  <p>Not logged in</p>
)}

Within the Auth component

Alternatively, you can use the Auth component to fetch the session using a render prop.

---
import type { Session } from '@auth/core/types';
import { Auth, Signin, Signout } from '@convocomet/auth-astro/components';
---
<Auth>
  {(session: Session) =>
    {session ?
      <Signin provider="github">Login</Signin>
    :
      <Signout>Logout</Signout>
    }

    <p>
      {session ? `Logged in as ${session.user?.name}` : 'Not logged in'}
    </p>
  }
</Auth>

State of Project

Hopefully, the fixes contained in this project. Eventually, this should be merged into Auth.js, and when that happens this package will be deprecated.

Contribution

Us waiting means on the PR to be merged means, we can still add new features to the PR, so, if you miss anything feel free to open a PR or issue in this repo and we will try to add it to the official package to come.