@auth/qwik 0.0.0

package/src/index.ts

@@ -0,0 +1,373 @@
+/**
+ *
+ * :::warning
+ * `@auth/qwik` is currently experimental. The API _will_ change in the future.
+ * :::
+ *
+ * Qwik Auth is the official Qwik integration for Auth.js.
+ * It provides a simple way to add authentication to your Qwik app in a few lines of code.
+ *
+ * ## Installation
+ * ```bash npm2yarn
+ * npm install @auth/qwik
+ * ```
+ *
+ * ## Usage
+ *
+ * ### Provider Configuration
+ *
+ * Create a `plugin@auth.ts` file in the routes folder
+ *
+ * import GitHub from "@auth/qwik/providers/github"
+ * import { QwikAuth$ } from "@auth/qwik"
+ *
+ * export const {
+ *   onRequest, useSession, useSignIn, useSignOut
+ * } = QwikAuth$(() => ({ providers: [GitHub] }))
+ *
+ * ## Signing in and signing out
+ *
+ * Sign In via form
+ *
+ * import { component$ } from '@builder.io/qwik';
+ * import { Form } from '@builder.io/qwik-city';
+ * import { useSignIn } from '~/routes/plugin@auth';
+ *
+ * export default component$(() => {
+ *   const signIn = useSignIn();
+ *   return (
+ *     <Form action={signIn}>
+ *       <input type="hidden" name="providerId" value="github" />
+ *       <input type="hidden" name="options.redirectTo" value="http://qwik-auth-example.com/dashboard" />
+ *       <button>Sign In</button>
+ *     </Form>
+ *   );
+ * });
+ *
+ * Sign In via code
+ *
+ * import { component$ } from '@builder.io/qwik';
+ * import { useSignIn } from '~/routes/plugin@auth';
+ *
+ * export default component$(() => {
+ *   const signIn = useSignIn();
+ *   return (
+ *     <button onClick$={() => signIn.submit({ providerId: 'github', options: { redirectTo: 'http://qwik-auth-example.com/dashboard' } })}>Sign In</button>
+ *   );
+ * });
+ *
+ * Sign out via form
+ *
+ * import { component$ } from '@builder.io/qwik';
+ * import { Form } from '@builder.io/qwik-city';
+ * import { useSignOut } from '~/routes/plugin@auth';
+ *
+ * export default component$(() => {
+ *   const signOut = useSignOut();
+ *   return (
+ *     <Form action={signOut}>
+ *       <input type="hidden" name="redirectTo" value="/signedout" />
+ *       <button>Sign Out</button>
+ *     </Form>
+ *   );
+ * });
+ *
+ * Sign out via code
+ *
+ * import { component$ } from '@builder.io/qwik';
+ * import { useSignOut } from '~/routes/plugin@auth';
+ *
+ * export default component$(() => {
+ *   const signOut = useSignOut();
+ *   return <button onClick$={() => signOut.submit({ redirectTo: '/signedout' })}>Sign Out</button>;
+ * });
+ *
+ * ## Managing the session
+ *
+ * import { component$ } from '@builder.io/qwik';
+ * import { useSession } from '~/routes/plugin@auth';
+ *
+ * export default component$(() => {
+ *   const session = useSession();
+ *   return <p>{session.value?.user?.email}</p>;
+ * });
+ *
+ * ## Authorization
+ *
+ * Session data can be accessed via the route event.sharedMap.
+ * So a route can be protected and redirect using something like this located in a layout.tsx or page index.tsx:
+ *
+ * export const onRequest: RequestHandler = (event) => {
+ *   const session = event.sharedMap.get("session")
+ *   if (!session || new Date(session.expires) < new Date()) {
+ *     throw event.redirect(302, `/auth/signin?redirectTo=${event.url.pathname}`);
+ *   }
+ * };
+ *
+ * ```
+ *
+ * @module @auth/qwik
+ */
+
+import type { AuthConfig } from "@auth/core"
+import { Auth, isAuthAction, skipCSRFCheck } from "@auth/core"
+import { AuthAction, Session } from "@auth/core/types"
+import { implicit$FirstArg, type QRL } from "@builder.io/qwik"
+import {
+  globalAction$,
+  routeLoader$,
+  z,
+  zod$,
+  type RequestEventCommon,
+} from "@builder.io/qwik-city"
+import { EnvGetter } from "@builder.io/qwik-city/middleware/request-handler"
+import { isServer } from "@builder.io/qwik/build"
+import { parseString, splitCookiesString } from "set-cookie-parser"
+
+/** Configure the {@link QwikAuth$} method. */
+export interface QwikAuthConfig extends Omit<AuthConfig, "raw"> {}
+
+export type GetSessionResult = Promise<{ data: Session | null; cookie: any }>
+
+function qwikAuthQrl(
+  authOptions: QRL<(ev: RequestEventCommon) => QwikAuthConfig>
+) {
+  const useSignIn = globalAction$(
+    async (
+      { providerId, redirectTo: _redirectTo, options, authorizationParams },
+      req
+    ) => {
+      const { redirectTo = _redirectTo ?? defaultRedirectTo(req), ...rest } =
+        options ?? {}
+
+      const isCredentials = providerId === "credentials"
+
+      const authOpts = await authOptions(req)
+      setEnvDefaults(req.env, authOpts)
+      const body = new URLSearchParams({ redirectTo })
+      Object.entries(rest).forEach(([key, value]) => {
+        body.set(key, String(value))
+      })
+
+      const baseSignInUrl = `/auth/${isCredentials ? "callback" : "signin"}${
+        providerId ? `/${providerId}` : ""
+      }`
+      const signInUrl = `${baseSignInUrl}?${new URLSearchParams(
+        authorizationParams
+      )}`
+
+      const data = await authAction(body, req, signInUrl, authOpts)
+
+      // set authjs.callback-url cookie. Fix for https://github.com/QwikDev/qwik/issues/5227
+      req.cookie.set("authjs.callback-url", redirectTo, {
+        path: "/",
+      })
+
+      if (data.url) {
+        throw req.redirect(301, data.url)
+      }
+    },
+    zod$({
+      providerId: z.string().optional(),
+      /** Yoooo */
+      redirectTo: z.string().optional(),
+      options: z
+        .object({
+          redirectTo: z.string(),
+        })
+        .passthrough()
+        .partial()
+        .optional(),
+      authorizationParams: z
+        .union([z.string(), z.custom<URLSearchParams>(), z.record(z.string())])
+        .optional(),
+    })
+  )
+
+  const useSignOut = globalAction$(
+    async ({ redirectTo }, req) => {
+      redirectTo ??= defaultRedirectTo(req)
+      const authOpts = await authOptions(req)
+      setEnvDefaults(req.env, authOpts)
+      const body = new URLSearchParams({ redirectTo })
+      await authAction(body, req, `/auth/signout`, authOpts)
+    },
+    zod$({
+      redirectTo: z.string().optional(),
+    })
+  )
+
+  const useSession = routeLoader$((req) => {
+    return req.sharedMap.get("session") as Session | null
+  })
+
+  const onRequest = async (req: RequestEventCommon) => {
+    if (isServer) {
+      const prefix: string = "/auth"
+
+      const action = req.url.pathname
+        .slice(prefix.length + 1)
+        .split("/")[0] as AuthAction
+
+      const authOpts = await authOptions(req)
+      setEnvDefaults(req.env, authOpts)
+      if (isAuthAction(action) && req.url.pathname.startsWith(prefix + "/")) {
+        const res = (await Auth(req.request, authOpts)) as Response
+        const cookie = res.headers.get("set-cookie")
+        if (cookie) {
+          req.headers.set("set-cookie", cookie)
+          res.headers.delete("set-cookie")
+          fixCookies(req)
+        }
+        throw req.send(res)
+      } else {
+        const { data, cookie } = await getSessionData(req.request, authOpts)
+        req.sharedMap.set("session", data)
+        if (cookie) {
+          req.headers.set("set-cookie", cookie)
+          fixCookies(req)
+        }
+      }
+    }
+  }
+
+  return { useSignIn, useSignOut, useSession, onRequest }
+}
+
+/**
+ *  Initialize Qwik Auth.
+ *
+ *  @example
+ * ```ts title="plugin@auth.ts"
+ * import { QwikAuth } from "@auth/qwik"
+ * import GitHub from "@auth/qwik/providers/github"
+ *
+ * export const {
+ *   onRequest, useSession, useSignIn, useSignOut
+ * } = QwikAuth$(() => ({ providers: [GitHub] }))
+ * ```
+ */
+export const QwikAuth$ = /*#__PURE__*/ implicit$FirstArg(qwikAuthQrl)
+
+async function authAction(
+  body: URLSearchParams | undefined,
+  req: RequestEventCommon,
+  path: string,
+  authOptions: QwikAuthConfig
+) {
+  const request = new Request(new URL(path, req.request.url), {
+    method: req.request.method,
+    headers: req.request.headers,
+    body: body,
+  })
+  request.headers.set("content-type", "application/x-www-form-urlencoded")
+  const res = (await Auth(request, authOptions)) as Response
+
+  const cookies: string[] = []
+  res.headers.forEach((value, key) => {
+    if (key === "set-cookie") {
+      // while browsers would support setting multiple cookies, the fetch implementation does not, so we join them later.
+      cookies.push(value)
+    } else if (!req.headers.has(key)) {
+      req.headers.set(key, value)
+    }
+  })
+
+  if (cookies.length > 0) {
+    req.headers.set("set-cookie", cookies.join(", "))
+  }
+
+  fixCookies(req)
+
+  try {
+    return await res.json()
+  } catch (error) {
+    return await res.text()
+  }
+}
+
+const fixCookies = (req: RequestEventCommon) => {
+  req.headers.set("set-cookie", req.headers.get("set-cookie") || "")
+  const cookie = req.headers.get("set-cookie")
+  if (cookie) {
+    req.headers.delete("set-cookie")
+    splitCookiesString(cookie).forEach((cookie) => {
+      const { name, value, ...rest } = parseString(cookie)
+      req.cookie.set(name, value, rest as any)
+    })
+  }
+}
+
+const defaultRedirectTo = (req: RequestEventCommon) => {
+  req.url.searchParams.delete("qaction")
+  return req.url.href
+}
+
+async function getSessionData(
+  req: Request,
+  options: AuthConfig
+): GetSessionResult {
+  options.secret ??= process.env.AUTH_SECRET
+  options.trustHost ??= true
+
+  const url = new URL("/auth/session", req.url)
+  const response = (await Auth(
+    new Request(url, { headers: req.headers }),
+    options
+  )) as Response
+
+  const { status = 200 } = response
+
+  const data = await response.json()
+  const cookie = response.headers.get("set-cookie")
+  if (!data || !Object.keys(data).length) {
+    return { data: null, cookie }
+  }
+  if (status === 200) {
+    return { data, cookie }
+  }
+
+  throw new Error(data.message)
+}
+
+export const setEnvDefaults = (env: EnvGetter, config: AuthConfig) => {
+  config.basePath = "/auth"
+  if (!config.secret?.length) {
+    config.secret = []
+    const secret = env.get("AUTH_SECRET")
+    if (secret) {
+      config.secret.push(secret)
+    }
+    for (const i of [1, 2, 3]) {
+      const secret = env.get(`AUTH_SECRET_${i}`)
+      if (secret) {
+        config.secret.unshift(secret)
+      }
+    }
+  }
+
+  config.redirectProxyUrl ??= env.get("AUTH_REDIRECT_PROXY_URL")
+  config.trustHost ??= !!(
+    env.get("AUTH_URL") ??
+    env.get("AUTH_TRUST_HOST") ??
+    env.get("VERCEL") ??
+    env.get("CF_PAGES") ??
+    env.get("NODE_ENV") !== "production"
+  )
+  config.skipCSRFCheck = skipCSRFCheck
+
+  config.providers = config.providers.map((p) => {
+    const finalProvider = typeof p === "function" ? p({}) : p
+    const ID = finalProvider.id.toUpperCase().replace(/-/g, "_")
+    if (finalProvider.type === "oauth" || finalProvider.type === "oidc") {
+      finalProvider.clientId ??= env.get(`AUTH_${ID}_ID`)
+      finalProvider.clientSecret ??= env.get(`AUTH_${ID}_SECRET`)
+      if (finalProvider.type === "oidc") {
+        finalProvider.issuer ??= env.get(`AUTH_${ID}_ISSUER`)
+      }
+    } else if (finalProvider.type === "email") {
+      finalProvider.apiKey ??= env.get(`AUTH_${ID}_KEY`)
+    }
+    return finalProvider
+  })
+}

package/src/providers/42-school.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/42-school"
+export { default } from "@auth/core/providers/42-school"

package/src/providers/apple.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/apple"
+export { default } from "@auth/core/providers/apple"

package/src/providers/asgardeo.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/asgardeo"
+export { default } from "@auth/core/providers/asgardeo"

package/src/providers/auth0.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/auth0"
+export { default } from "@auth/core/providers/auth0"

package/src/providers/authentik.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/authentik"
+export { default } from "@auth/core/providers/authentik"

package/src/providers/azure-ad-b2c.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/azure-ad-b2c"
+export { default } from "@auth/core/providers/azure-ad-b2c"

package/src/providers/azure-ad.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/azure-ad"
+export { default } from "@auth/core/providers/azure-ad"

package/src/providers/azure-devops.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/azure-devops"
+export { default } from "@auth/core/providers/azure-devops"

package/src/providers/bankid-no.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/bankid-no"
+export { default } from "@auth/core/providers/bankid-no"

package/src/providers/battlenet.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/battlenet"
+export { default } from "@auth/core/providers/battlenet"

package/src/providers/beyondidentity.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/beyondidentity"
+export { default } from "@auth/core/providers/beyondidentity"

package/src/providers/box.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/box"
+export { default } from "@auth/core/providers/box"

package/src/providers/boxyhq-saml.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/boxyhq-saml"
+export { default } from "@auth/core/providers/boxyhq-saml"

package/src/providers/bungie.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/bungie"
+export { default } from "@auth/core/providers/bungie"

package/src/providers/click-up.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/click-up"
+export { default } from "@auth/core/providers/click-up"

package/src/providers/cognito.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/cognito"
+export { default } from "@auth/core/providers/cognito"

package/src/providers/coinbase.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/coinbase"
+export { default } from "@auth/core/providers/coinbase"

package/src/providers/credentials.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/credentials"
+export { default } from "@auth/core/providers/credentials"

package/src/providers/descope.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/descope"
+export { default } from "@auth/core/providers/descope"

package/src/providers/discord.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/discord"
+export { default } from "@auth/core/providers/discord"

package/src/providers/dribbble.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/dribbble"
+export { default } from "@auth/core/providers/dribbble"

package/src/providers/dropbox.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/dropbox"
+export { default } from "@auth/core/providers/dropbox"

package/src/providers/duende-identity-server6.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/duende-identity-server6"
+export { default } from "@auth/core/providers/duende-identity-server6"

package/src/providers/email.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/email"
+export { default } from "@auth/core/providers/email"

package/src/providers/eveonline.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/eveonline"
+export { default } from "@auth/core/providers/eveonline"

package/src/providers/facebook.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/facebook"
+export { default } from "@auth/core/providers/facebook"

package/src/providers/faceit.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/faceit"
+export { default } from "@auth/core/providers/faceit"

package/src/providers/foursquare.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/foursquare"
+export { default } from "@auth/core/providers/foursquare"

package/src/providers/freshbooks.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/freshbooks"
+export { default } from "@auth/core/providers/freshbooks"

package/src/providers/fusionauth.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/fusionauth"
+export { default } from "@auth/core/providers/fusionauth"

package/src/providers/github.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/github"
+export { default } from "@auth/core/providers/github"

package/src/providers/gitlab.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/gitlab"
+export { default } from "@auth/core/providers/gitlab"

package/src/providers/google.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/google"
+export { default } from "@auth/core/providers/google"

package/src/providers/hubspot.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/hubspot"
+export { default } from "@auth/core/providers/hubspot"

package/src/providers/identity-server4.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/identity-server4"
+export { default } from "@auth/core/providers/identity-server4"

package/src/providers/index.ts

@@ -0,0 +1 @@
+export * from "@auth/core/providers"

package/src/providers/instagram.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/instagram"
+export { default } from "@auth/core/providers/instagram"

package/src/providers/kakao.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/kakao"
+export { default } from "@auth/core/providers/kakao"

package/src/providers/keycloak.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/keycloak"
+export { default } from "@auth/core/providers/keycloak"

package/src/providers/line.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/line"
+export { default } from "@auth/core/providers/line"

package/src/providers/linkedin.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/linkedin"
+export { default } from "@auth/core/providers/linkedin"

package/src/providers/mailchimp.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/mailchimp"
+export { default } from "@auth/core/providers/mailchimp"

package/src/providers/mailru.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/mailru"
+export { default } from "@auth/core/providers/mailru"

package/src/providers/mastodon.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/mastodon"
+export { default } from "@auth/core/providers/mastodon"

package/src/providers/mattermost.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/mattermost"
+export { default } from "@auth/core/providers/mattermost"

package/src/providers/medium.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/medium"
+export { default } from "@auth/core/providers/medium"

package/src/providers/microsoft-entra-id.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/microsoft-entra-id"
+export { default } from "@auth/core/providers/microsoft-entra-id"

package/src/providers/naver.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/naver"
+export { default } from "@auth/core/providers/naver"

package/src/providers/netlify.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/netlify"
+export { default } from "@auth/core/providers/netlify"

package/src/providers/netsuite.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/netsuite"
+export { default } from "@auth/core/providers/netsuite"

package/src/providers/nodemailer.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/nodemailer"
+export { default } from "@auth/core/providers/nodemailer"

package/src/providers/notion.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/notion"
+export { default } from "@auth/core/providers/notion"

package/src/providers/okta.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/okta"
+export { default } from "@auth/core/providers/okta"

package/src/providers/onelogin.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/onelogin"
+export { default } from "@auth/core/providers/onelogin"

package/src/providers/ory-hydra.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/ory-hydra"
+export { default } from "@auth/core/providers/ory-hydra"

package/src/providers/osso.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/osso"
+export { default } from "@auth/core/providers/osso"

package/src/providers/osu.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/osu"
+export { default } from "@auth/core/providers/osu"

package/src/providers/passage.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/passage"
+export { default } from "@auth/core/providers/passage"

package/src/providers/passkey.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/passkey"
+export { default } from "@auth/core/providers/passkey"

package/src/providers/patreon.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/patreon"
+export { default } from "@auth/core/providers/patreon"

package/src/providers/pinterest.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/pinterest"
+export { default } from "@auth/core/providers/pinterest"

package/src/providers/pipedrive.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/pipedrive"
+export { default } from "@auth/core/providers/pipedrive"

package/src/providers/postmark.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/postmark"
+export { default } from "@auth/core/providers/postmark"

package/src/providers/reddit.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/reddit"
+export { default } from "@auth/core/providers/reddit"

package/src/providers/resend.ts

@@ -0,0 +1,2 @@
+export * from "@auth/core/providers/resend"
+export { default } from "@auth/core/providers/resend"