@auth/solid-start 0.15.3 → 0.16.0

package/README.MD

@@ -9,7 +9,7 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/@auth/solid-start"><img src="https://img.shields.io/npm/v/@auth/solid-start?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
   <a href="https://www.npmtrends.com/@auth/solid-start"><img src="https://img.shields.io/npm/dm/@auth/solid-start?style=flat-square&color=cyan" 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&color=orange" alt="Github Stars" /></a>
+  <a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="GitHub Stars" /></a>
   <img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
 </p>
 

package/client.d.ts

@@ -1,14 +1,27 @@
-import type { BuiltInProviderType, RedirectableProviderType } from "@auth/core/providers";
-type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
-interface SignInOptions extends Record<string, unknown> {
+import type { ProviderId } from "@auth/core/providers";
+interface SignInOptions<Redirect extends boolean = true> extends Record<string, unknown> {
+    /** @deprecated Use `redirectTo` instead. */
+    callbackUrl?: string;
     /**
-     * Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
+     * Specify where the user should be redirected to after a successful signin.
      *
-     * [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl)
+     * By default, it is the page the sign-in was initiated from.
      */
-    callbackUrl?: string;
-    /** [Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option) */
-    redirect?: boolean;
+    redirectTo?: string;
+    /**
+     * You might want to deal with the signin response on the same page, instead of redirecting to another page.
+     * For example, if an error occurs (like wrong credentials given by the user), you might want to show an inline error message on the input field.
+     *
+     * For this purpose, you can set this to option `redirect: false`.
+     */
+    redirect?: Redirect;
+}
+export interface SignInResponse {
+    error: string | undefined;
+    code: string | undefined;
+    status: number;
+    ok: boolean;
+    url: string | null;
 }
 interface SignOutParams<R extends boolean = true> {
     /** [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl-1) */
@@ -29,7 +42,15 @@ export type SignInAuthorizationParams = string | string[][] | Record<string, str
  * signIn("provider") // example: signIn("github")
  * ```
  */
-export declare function signIn<P extends RedirectableProviderType | undefined = undefined>(providerId?: LiteralUnion<P extends RedirectableProviderType ? P | BuiltInProviderType : BuiltInProviderType>, options?: SignInOptions, authorizationParams?: SignInAuthorizationParams): Promise<Response | undefined>;
+/**
+ * Initiates a signin flow or sends the user to the signin page listing all possible providers.
+ * Handles CSRF protection.
+ *
+ * @note This method can only be used from Client Components ("use client" or Pages Router).
+ * For Server Actions, use the `signIn` method imported from the `auth` config.
+ */
+export declare function signIn(provider?: ProviderId, options?: SignInOptions<true>, authorizationParams?: SignInAuthorizationParams): Promise<void>;
+export declare function signIn(provider?: ProviderId, options?: SignInOptions<false>, authorizationParams?: SignInAuthorizationParams): Promise<SignInResponse>;
 /**
  * Signs the user out, by removing the session cookie.
  * Automatically adds the CSRF token to the request.

package/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACzB,MAAM,sBAAsB,CAAA;AAE7B,KAAK,YAAY,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAA;AAE3E,UAAU,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uGAAuG;IACvG,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,UAAU,aAAa,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI;IAC9C,kGAAkG;IAClG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wGAAwG;IACxG,QAAQ,CAAC,EAAE,CAAC,CAAA;CACb;AAED,4DAA4D;AAC5D,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,MAAM,EAAE,EAAE,GACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,eAAe,CAAA;AAEnB;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAC1B,CAAC,SAAS,wBAAwB,GAAG,SAAS,GAAG,SAAS,EAE1D,UAAU,CAAC,EAAE,YAAY,CACvB,CAAC,SAAS,wBAAwB,GAC9B,CAAC,GAAG,mBAAmB,GACvB,mBAAmB,CACxB,EACD,OAAO,CAAC,EAAE,aAAa,EACvB,mBAAmB,CAAC,EAAE,yBAAyB,iCA4ChD;AAED;;;;;;;;GAQG;AACH,wBAAsB,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,iBAsBpD"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,UAAU,aAAa,CAAC,QAAQ,SAAS,OAAO,GAAG,IAAI,CACrD,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC/B,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,OAAO,CAAA;IACX,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CACnB;AAED,UAAU,aAAa,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI;IAC9C,kGAAkG;IAClG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wGAAwG;IACxG,QAAQ,CAAC,EAAE,CAAC,CAAA;CACb;AAED,4DAA4D;AAC5D,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,MAAM,EAAE,EAAE,GACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,eAAe,CAAA;AAEnB;;;;;;;;;;GAUG;AAEH;;;;;;GAMG;AACH,wBAAsB,MAAM,CAC1B,QAAQ,CAAC,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,EAC7B,mBAAmB,CAAC,EAAE,yBAAyB,GAC9C,OAAO,CAAC,IAAI,CAAC,CAAA;AAChB,wBAAsB,MAAM,CAC1B,QAAQ,CAAC,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,EAC9B,mBAAmB,CAAC,EAAE,yBAAyB,GAC9C,OAAO,CAAC,cAAc,CAAC,CAAA;AA4D1B;;;;;;;;GAQG;AACH,wBAAsB,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,iBAsBpD"}

package/client.js

@@ -1,50 +1,41 @@
-/**
- * Client-side method to initiate a signin flow
- * or send the user to the signin page listing all possible providers.
- * Automatically adds the CSRF token to the request.
- *
- * ```ts
- * import { signIn } from "@auth/solid-start/client"
- * signIn()
- * signIn("provider") // example: signIn("github")
- * ```
- */
-export async function signIn(providerId, options, authorizationParams) {
-    const { callbackUrl = window.location.href, redirect = true } = options ?? {};
-    // TODO: Support custom providers
-    const isCredentials = providerId === "credentials";
-    const isEmail = providerId === "email";
-    const isSupportingReturn = isCredentials || isEmail;
-    // TODO: Handle custom base path
-    const signInUrl = `/api/auth/${isCredentials ? "callback" : "signin"}/${providerId}`;
-    const _signInUrl = `${signInUrl}?${new URLSearchParams(authorizationParams)}`;
+export async function signIn(provider, options, authorizationParams) {
+    const { callbackUrl, ...rest } = options ?? {};
+    const { redirect = true, redirectTo = callbackUrl ?? window.location.href, ...signInParams } = rest;
+    const isCredentials = provider === "credentials";
+    const signInUrl = `/api/auth/${isCredentials ? "callback" : "signin"}/${provider}`;
     // TODO: Handle custom base path
     const csrfTokenResponse = await fetch("/api/auth/csrf");
     const { csrfToken } = await csrfTokenResponse.json();
-    const res = await fetch(_signInUrl, {
+    const res = await fetch(`${signInUrl}?${new URLSearchParams(authorizationParams)}`, {
         method: "post",
         headers: {
             "Content-Type": "application/x-www-form-urlencoded",
             "X-Auth-Return-Redirect": "1",
         },
-        // @ts-ignore
         body: new URLSearchParams({
-            ...options,
+            ...signInParams,
             csrfToken,
-            callbackUrl,
+            callbackUrl: redirectTo,
         }),
     });
-    const data = await res.clone().json();
-    const error = new URL(data.url).searchParams.get("error");
-    if (redirect || !isSupportingReturn || !error) {
-        // TODO: Do not redirect for Credentials and Email providers by default in next major
-        window.location.href = data.url ?? data.redirect ?? callbackUrl;
+    const data = await res.json();
+    if (redirect) {
+        const url = data.url ?? redirectTo;
+        window.location.href = url;
         // If url contains a hash, the browser does not reload the page. We reload manually
-        if (data.url.includes("#"))
+        if (url.includes("#"))
             window.location.reload();
         return;
     }
-    return res;
+    const error = new URL(data.url).searchParams.get("error") ?? undefined;
+    const code = new URL(data.url).searchParams.get("code") ?? undefined;
+    return {
+        error,
+        code,
+        status: res.status,
+        ok: res.ok,
+        url: error ? null : data.url,
+    };
 }
 /**
  * Signs the user out, by removing the session cookie.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth/solid-start",
-  "version": "0.15.3",
+  "version": "0.16.0",
   "description": "Authentication for SolidStart.",
   "license": "ISC",
   "author": "OrJDev <orjdeveloper@gmail.com>",
@@ -49,7 +49,7 @@
     }
   },
   "dependencies": {
-    "@auth/core": "0.37.3"
+    "@auth/core": "0.38.0"
   },
   "devDependencies": {
     "@solidjs/meta": "^0.28.0",

package/providers/bitbucket.d.ts

@@ -0,0 +1,3 @@
+export * from "@auth/core/providers/bitbucket";
+export { default } from "@auth/core/providers/bitbucket";
+//# sourceMappingURL=bitbucket.d.ts.map

package/providers/bitbucket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitbucket.d.ts","sourceRoot":"","sources":["../src/providers/bitbucket.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAA;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAA"}

package/providers/bitbucket.js

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

package/providers/figma.d.ts

@@ -0,0 +1,3 @@
+export * from "@auth/core/providers/figma";
+export { default } from "@auth/core/providers/figma";
+//# sourceMappingURL=figma.d.ts.map

package/providers/figma.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"figma.d.ts","sourceRoot":"","sources":["../src/providers/figma.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA"}

package/providers/figma.js

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

package/providers/frontegg.d.ts

@@ -0,0 +1,3 @@
+export * from "@auth/core/providers/frontegg";
+export { default } from "@auth/core/providers/frontegg";
+//# sourceMappingURL=frontegg.d.ts.map

package/providers/frontegg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontegg.d.ts","sourceRoot":"","sources":["../src/providers/frontegg.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA"}

package/providers/frontegg.js

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

package/providers/logto.d.ts

@@ -0,0 +1,3 @@
+export * from "@auth/core/providers/logto";
+export { default } from "@auth/core/providers/logto";
+//# sourceMappingURL=logto.d.ts.map

package/providers/logto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logto.d.ts","sourceRoot":"","sources":["../src/providers/logto.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA"}

package/providers/logto.js

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

package/providers/loops.d.ts

@@ -0,0 +1,3 @@
+export * from "@auth/core/providers/loops";
+export { default } from "@auth/core/providers/loops";
+//# sourceMappingURL=loops.d.ts.map

package/providers/loops.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loops.d.ts","sourceRoot":"","sources":["../src/providers/loops.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA"}

package/providers/loops.js

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

package/src/client.ts

@@ -1,19 +1,30 @@
-import type {
-  BuiltInProviderType,
-  RedirectableProviderType,
-} from "@auth/core/providers"
+import type { ProviderId } from "@auth/core/providers"
 
-type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>)
-
-interface SignInOptions extends Record<string, unknown> {
+interface SignInOptions<Redirect extends boolean = true>
+  extends Record<string, unknown> {
+  /** @deprecated Use `redirectTo` instead. */
+  callbackUrl?: string
   /**
-   * Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
+   * Specify where the user should be redirected to after a successful signin.
    *
-   * [Documentation](https://next-auth.js.org/getting-started/client#specifying-a-callbackurl)
+   * By default, it is the page the sign-in was initiated from.
    */
-  callbackUrl?: string
-  /** [Documentation](https://next-auth.js.org/getting-started/client#using-the-redirect-false-option) */
-  redirect?: boolean
+  redirectTo?: string
+  /**
+   * You might want to deal with the signin response on the same page, instead of redirecting to another page.
+   * For example, if an error occurs (like wrong credentials given by the user), you might want to show an inline error message on the input field.
+   *
+   * For this purpose, you can set this to option `redirect: false`.
+   */
+  redirect?: Redirect
+}
+
+export interface SignInResponse {
+  error: string | undefined
+  code: string | undefined
+  status: number
+  ok: boolean
+  url: string | null
 }
 
 interface SignOutParams<R extends boolean = true> {
@@ -41,59 +52,81 @@ export type SignInAuthorizationParams =
  * signIn("provider") // example: signIn("github")
  * ```
  */
-export async function signIn<
-  P extends RedirectableProviderType | undefined = undefined,
->(
-  providerId?: LiteralUnion<
-    P extends RedirectableProviderType
-      ? P | BuiltInProviderType
-      : BuiltInProviderType
-  >,
-  options?: SignInOptions,
+
+/**
+ * Initiates a signin flow or sends the user to the signin page listing all possible providers.
+ * Handles CSRF protection.
+ *
+ * @note This method can only be used from Client Components ("use client" or Pages Router).
+ * For Server Actions, use the `signIn` method imported from the `auth` config.
+ */
+export async function signIn(
+  provider?: ProviderId,
+  options?: SignInOptions<true>,
   authorizationParams?: SignInAuthorizationParams
-) {
-  const { callbackUrl = window.location.href, redirect = true } = options ?? {}
+): Promise<void>
+export async function signIn(
+  provider?: ProviderId,
+  options?: SignInOptions<false>,
+  authorizationParams?: SignInAuthorizationParams
+): Promise<SignInResponse>
+export async function signIn<Redirect extends boolean = true>(
+  provider?: ProviderId,
+  options?: SignInOptions<Redirect>,
+  authorizationParams?: SignInAuthorizationParams
+): Promise<SignInResponse | void> {
+  const { callbackUrl, ...rest } = options ?? {}
+  const {
+    redirect = true,
+    redirectTo = callbackUrl ?? window.location.href,
+    ...signInParams
+  } = rest
 
-  // TODO: Support custom providers
-  const isCredentials = providerId === "credentials"
-  const isEmail = providerId === "email"
-  const isSupportingReturn = isCredentials || isEmail
+  const isCredentials = provider === "credentials"
 
-  // TODO: Handle custom base path
   const signInUrl = `/api/auth/${
     isCredentials ? "callback" : "signin"
-  }/${providerId}`
-
-  const _signInUrl = `${signInUrl}?${new URLSearchParams(authorizationParams)}`
+  }/${provider}`
 
   // TODO: Handle custom base path
   const csrfTokenResponse = await fetch("/api/auth/csrf")
   const { csrfToken } = await csrfTokenResponse.json()
+  const res = await fetch(
+    `${signInUrl}?${new URLSearchParams(authorizationParams)}`,
+    {
+      method: "post",
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded",
+        "X-Auth-Return-Redirect": "1",
+      },
+      body: new URLSearchParams({
+        ...signInParams,
+        csrfToken,
+        callbackUrl: redirectTo,
+      }),
+    }
+  )
 
-  const res = await fetch(_signInUrl, {
-    method: "post",
-    headers: {
-      "Content-Type": "application/x-www-form-urlencoded",
-      "X-Auth-Return-Redirect": "1",
-    },
-    // @ts-ignore
-    body: new URLSearchParams({
-      ...options,
-      csrfToken,
-      callbackUrl,
-    }),
-  })
+  const data = await res.json()
 
-  const data = await res.clone().json()
-  const error = new URL(data.url).searchParams.get("error")
-  if (redirect || !isSupportingReturn || !error) {
-    // TODO: Do not redirect for Credentials and Email providers by default in next major
-    window.location.href = data.url ?? data.redirect ?? callbackUrl
+  if (redirect) {
+    const url = data.url ?? redirectTo
+    window.location.href = url
     // If url contains a hash, the browser does not reload the page. We reload manually
-    if (data.url.includes("#")) window.location.reload()
+    if (url.includes("#")) window.location.reload()
     return
   }
-  return res
+
+  const error = new URL(data.url).searchParams.get("error") ?? undefined
+  const code = new URL(data.url).searchParams.get("code") ?? undefined
+
+  return {
+    error,
+    code,
+    status: res.status,
+    ok: res.ok,
+    url: error ? null : data.url,
+  }
 }
 
 /**