@monocloud/auth-nextjs 0.1.5 → 0.1.7

package/dist/components/index.cjs

@@ -1,20 +1,17 @@
-const require_chunk = require('../chunk-CbDLau6x.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_chunk = require('../chunk-C0xms8kb.cjs');
 let react = require("react");
 react = require_chunk.__toESM(react);
 
 //#region src/components/signin.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-in flow.
+* `<SignIn>` renders a link that initiates the MonoCloud sign-in flow.
 *
-* @param props - Properties for the SignIn component.
-*
-* @returns An anchor element that links to the sign-in endpoint with the specified parameters.
-*
-* @example App Router and Pages Router
+* It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* **Sign-in component works on both the server and the client in pages router and app router.**
+* @example Basic Usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignIn } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -24,21 +21,24 @@ react = require_chunk.__toESM(react);
 *
 * @example Customize the authorization request
 *
-* You can customize the authorization request by passing in props. See {@link SignInProps}.
+* You can customize the authorization request by passing props:
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the authorization request"
 * import { SignIn } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
 *   return (
-*     <SignIn loginHint="username" authenticatorHint="password">
+*     <SignIn loginHint="user@example.com" authenticatorHint="password" returnUrl="/dashboard">
 *       Sign In
 *     </SignIn>
 *   );
 * }
 * ```
+*
+* @param props - Properties for the SignIn component.
+* @returns An anchor element that links to the sign-in endpoint with the specified parameters.
+*
+* @category Components
 */
 const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLocales, scopes, acrValues, resource, maxAge, returnUrl, ...props }) => {
 	const signInUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signin`;
@@ -62,18 +62,15 @@ const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLoc
 //#endregion
 //#region src/components/signup.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-up flow.
-* * It functions similarly to the SignIn component but explicitly sets the `prompt` parameter to `create`.
-*
-* @param props - Properties for the SignUp component.
+* `<SignUp>` renders a link that initiates the MonoCloud sign-up flow.
 *
-* @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+* It works in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* @example App Router and Pages Router
+* Internally, it behaves like `<SignIn>` but sets `prompt=create` to start the registration flow.
 *
-* **Sign-up component works on both the server and the client in pages router and app router.**
+* @example Basic usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignUp } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -83,17 +80,27 @@ const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLoc
 *
 * @example Customize the authorization request
 *
-* You can customize the authorization request by passing in props. See {@link SignUpProps}.
+* You can customize the authorization request by passing in props.
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the authorization request"
 * import { SignUp } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
-*   return <SignUp returnUrl="/dashboard">Sign Up</SignUp>;
+*   return (
+*     <SignUp
+*       returnUrl="/dashboard"
+*       uiLocales="en"
+*     >
+*       Sign Up
+*     </SignUp>
+*   );
 * }
 * ```
+*
+* @param props - Properties for the SignUp component.
+* @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+*
+* @category Components
 */
 const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, scopes, uiLocales, ...props }) => {
 	const signInUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signin`;
@@ -116,17 +123,13 @@ const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, sco
 //#endregion
 //#region src/components/signout.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-out flow.
-*
-* @param props - Properties for the SignOut component.
-*
-* @returns An anchor element that links to the sign-out endpoint.
+* `<SignOut>` renders a link that initiates the MonoCloud sign-out flow.
 *
-* @example App Router and Pages Router
+* It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* **Sign-out component works on both the server and the client in pages router and app router.**
+* @example Basic usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignOut } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -134,19 +137,20 @@ const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, sco
 * }
 * ```
 *
-* @example Customize the request
-*
-* You can customize the request by passing in props. See {@link SignOutProps}.
+* @example Customize the sign-out request
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the sign-out request"
 * import { SignOut } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
-*   return <SignOut federated={true}>Sign Out</SignOut>;
+*   return <SignOut federated postLogoutUrl="/goodbye">Sign Out</SignOut>;
 * }
 * ```
+*
+* @param props - Properties for the SignOut component.
+* @returns An anchor element that links to the sign-out endpoint.
+*
+* @category Components
 */
 const SignOut = ({ children, postLogoutUrl, federated, ...props }) => {
 	const signOutUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNOUT_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signout`;

package/dist/components/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../../src/components/signin.tsx","../../src/components/signup.tsx","../../src/components/signout.tsx"],"sourcesContent":["import React, { JSX } from 'react';\nimport { ExtraAuthParams } from '../types';\n\nexport interface SignInProps extends ExtraAuthParams {\n  children: React.ReactNode;\n  /**\n   * URL to redirect to after a successful sign-in.\n   */\n  returnUrl?: string;\n}\n\n/**\n * A component that renders an anchor tag configured to initiate the sign-in flow.\n *\n * @param props - Properties for the SignIn component.\n *\n * @returns An anchor element that links to the sign-in endpoint with the specified parameters.\n *\n * @example App Router and Pages Router\n *\n * **Sign-in component works on both the server and the client in pages router and app router.**\n *\n * ```tsx\n * import { SignIn } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignIn>Sign In</SignIn>;\n * }\n * ```\n *\n * @example Customize the authorization request\n *\n * You can customize the authorization request by passing in props. See {@link SignInProps}.\n *\n * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**\n *\n * ```tsx\n * import { SignIn } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return (\n *     <SignIn loginHint=\"username\" authenticatorHint=\"password\">\n *       Sign In\n *     </SignIn>\n *   );\n * }\n * ```\n */\nexport const SignIn = ({\n  children,\n  authenticatorHint,\n  loginHint,\n  prompt,\n  display,\n  uiLocales,\n  scopes,\n  acrValues,\n  resource,\n  maxAge,\n  returnUrl,\n  ...props\n}: SignInProps &\n  Omit<\n    React.AnchorHTMLAttributes<HTMLAnchorElement>,\n    'resource'\n  >): JSX.Element => {\n  const signInUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signin`;\n\n  const query = new URLSearchParams();\n\n  if (authenticatorHint) {\n    query.set('authenticator_hint', authenticatorHint);\n  }\n\n  if (prompt) {\n    query.set('prompt', prompt);\n  }\n\n  if (display) {\n    query.set('display', display);\n  }\n\n  if (uiLocales) {\n    query.set('ui_locales', uiLocales);\n  }\n\n  if (scopes) {\n    query.set('scope', scopes);\n  }\n\n  if (acrValues) {\n    query.set('acr_values', acrValues.join(' '));\n  }\n\n  if (resource) {\n    query.set('resource', resource);\n  }\n\n  if (maxAge) {\n    query.set('max_age', maxAge.toString());\n  }\n\n  if (loginHint) {\n    query.set('login_hint', loginHint);\n  }\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  return (\n    <a\n      href={`${signInUrl}${query.size ? `?${query.toString()}` : ''}`}\n      {...props}\n    >\n      {children}\n    </a>\n  );\n};\n","import React, { JSX } from 'react';\nimport { ExtraAuthParams } from '../types';\n\nexport interface SignUpProps extends Omit<\n  ExtraAuthParams,\n  'authenticatorHint' | 'loginHint' | 'prompt'\n> {\n  /**\n   * URL to redirect to after a successful sign-up.\n   */\n  returnUrl?: string;\n}\n\n/**\n * A component that renders an anchor tag configured to initiate the sign-up flow.\n * * It functions similarly to the SignIn component but explicitly sets the `prompt` parameter to `create`.\n *\n * @param props - Properties for the SignUp component.\n *\n * @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.\n *\n * @example App Router and Pages Router\n *\n * **Sign-up component works on both the server and the client in pages router and app router.**\n *\n * ```tsx\n * import { SignUp } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignUp>Sign Up</SignUp>;\n * }\n * ```\n *\n * @example Customize the authorization request\n *\n * You can customize the authorization request by passing in props. See {@link SignUpProps}.\n *\n * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**\n *\n * ```tsx\n * import { SignUp } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignUp returnUrl=\"/dashboard\">Sign Up</SignUp>;\n * }\n * ```\n */\nexport const SignUp = ({\n  children,\n  returnUrl,\n  acrValues,\n  display,\n  maxAge,\n  resource,\n  scopes,\n  uiLocales,\n  ...props\n}: SignUpProps &\n  Omit<\n    React.AnchorHTMLAttributes<HTMLAnchorElement>,\n    'resource'\n  >): JSX.Element => {\n  const signInUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signin`;\n\n  const query = new URLSearchParams();\n\n  query.set('prompt', 'create');\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  if (display) {\n    query.set('display', display);\n  }\n\n  if (uiLocales) {\n    query.set('ui_locales', uiLocales);\n  }\n\n  if (scopes) {\n    query.set('scope', scopes);\n  }\n\n  if (acrValues) {\n    query.set('acr_values', acrValues.join(' '));\n  }\n\n  if (resource) {\n    query.set('resource', resource);\n  }\n\n  if (maxAge) {\n    query.set('max_age', maxAge.toString());\n  }\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  return (\n    <a href={`${signInUrl}?${query.toString()}`} {...props}>\n      {children}\n    </a>\n  );\n};\n","import React, { JSX } from 'react';\n\nexport interface SignOutProps {\n  /** URL to redirect the user to after they have been signed out. */\n  postLogoutUrl?: string;\n\n  /** Whether to also sign out the user from MonoCloud */\n  federated?: boolean;\n}\n\n/**\n * A component that renders an anchor tag configured to initiate the sign-out flow.\n *\n * @param props - Properties for the SignOut component.\n *\n * @returns An anchor element that links to the sign-out endpoint.\n *\n * @example App Router and Pages Router\n *\n * **Sign-out component works on both the server and the client in pages router and app router.**\n *\n * ```tsx\n * import { SignOut } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignOut>Sign Out</SignOut>;\n * }\n * ```\n *\n * @example Customize the request\n *\n * You can customize the request by passing in props. See {@link SignOutProps}.\n *\n * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**\n *\n * ```tsx\n * import { SignOut } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignOut federated={true}>Sign Out</SignOut>;\n * }\n * ```\n */\nexport const SignOut = ({\n  children,\n  postLogoutUrl,\n  federated,\n  ...props\n}: SignOutProps &\n  React.AnchorHTMLAttributes<HTMLAnchorElement>): JSX.Element => {\n  const signOutUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNOUT_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signout`;\n\n  const query = new URLSearchParams();\n\n  if (postLogoutUrl) {\n    query.set('post_logout_url', postLogoutUrl);\n  }\n\n  if (typeof federated === 'boolean') {\n    query.set('federated', federated.toString());\n  }\n\n  return (\n    <a\n      href={`${signOutUrl}${query.size ? `?${query.toString()}` : ''}`}\n      {...props}\n    >\n      {children}\n    </a>\n  );\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,MAAa,UAAU,EACrB,UACA,mBACA,WACA,QACA,SACA,WACA,QACA,WACA,UACA,QACA,WACA,GAAG,YAKgB;CACnB,MAAM,YACJ,QAAQ,IAAI,yCAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,KAAI,kBACF,OAAM,IAAI,sBAAsB,kBAAkB;AAGpD,KAAI,OACF,OAAM,IAAI,UAAU,OAAO;AAG7B,KAAI,QACF,OAAM,IAAI,WAAW,QAAQ;AAG/B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,OACF,OAAM,IAAI,SAAS,OAAO;AAG5B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU,KAAK,IAAI,CAAC;AAG9C,KAAI,SACF,OAAM,IAAI,YAAY,SAAS;AAGjC,KAAI,OACF,OAAM,IAAI,WAAW,OAAO,UAAU,CAAC;AAGzC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,QACE,4CAAC;EACC,MAAM,GAAG,YAAY,MAAM,OAAO,IAAI,MAAM,UAAU,KAAK;EAC3D,GAAI;IAEH,SACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACxER,MAAa,UAAU,EACrB,UACA,WACA,WACA,SACA,QACA,UACA,QACA,WACA,GAAG,YAKgB;CACnB,MAAM,YACJ,QAAQ,IAAI,yCAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,OAAM,IAAI,UAAU,SAAS;AAE7B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,QACF,OAAM,IAAI,WAAW,QAAQ;AAG/B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,OACF,OAAM,IAAI,SAAS,OAAO;AAG5B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU,KAAK,IAAI,CAAC;AAG9C,KAAI,SACF,OAAM,IAAI,YAAY,SAAS;AAGjC,KAAI,OACF,OAAM,IAAI,WAAW,OAAO,UAAU,CAAC;AAGzC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,QACE,4CAAC;EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,UAAU;EAAI,GAAI;IAC9C,SACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC/DR,MAAa,WAAW,EACtB,UACA,eACA,WACA,GAAG,YAE4D;CAC/D,MAAM,aACJ,QAAQ,IAAI,0CAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,KAAI,cACF,OAAM,IAAI,mBAAmB,cAAc;AAG7C,KAAI,OAAO,cAAc,UACvB,OAAM,IAAI,aAAa,UAAU,UAAU,CAAC;AAG9C,QACE,4CAAC;EACC,MAAM,GAAG,aAAa,MAAM,OAAO,IAAI,MAAM,UAAU,KAAK;EAC5D,GAAI;IAEH,SACC"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../../src/components/signin.tsx","../../src/components/signup.tsx","../../src/components/signout.tsx"],"sourcesContent":["import React from 'react';\nimport { ExtraAuthParams } from '../types';\n\n/**\n * Props for the `<SignIn />` component.\n *\n * @category Types\n */\nexport interface SignInProps extends ExtraAuthParams {\n  /**\n   * Content rendered inside the link (for example, button text).\n   */\n  children: React.ReactNode;\n\n  /**\n   * URL to redirect to after successful sign-in.\n   */\n  returnUrl?: string;\n}\n\n/**\n * `<SignIn>` renders a link that initiates the MonoCloud sign-in flow.\n *\n * It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.\n *\n * @example Basic Usage\n *\n * ```tsx title=\"Basic Usage\"\n * import { SignIn } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignIn>Sign In</SignIn>;\n * }\n * ```\n *\n * @example Customize the authorization request\n *\n * You can customize the authorization request by passing props:\n *\n * ```tsx title=\"Customize the authorization request\"\n * import { SignIn } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return (\n *     <SignIn loginHint=\"user@example.com\" authenticatorHint=\"password\" returnUrl=\"/dashboard\">\n *       Sign In\n *     </SignIn>\n *   );\n * }\n * ```\n *\n * @param props - Properties for the SignIn component.\n * @returns An anchor element that links to the sign-in endpoint with the specified parameters.\n *\n * @category Components\n */\nexport const SignIn = ({\n  children,\n  authenticatorHint,\n  loginHint,\n  prompt,\n  display,\n  uiLocales,\n  scopes,\n  acrValues,\n  resource,\n  maxAge,\n  returnUrl,\n  ...props\n}: SignInProps &\n  Omit<\n    React.AnchorHTMLAttributes<HTMLAnchorElement>,\n    'resource'\n  >): React.ReactNode => {\n  const signInUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signin`;\n\n  const query = new URLSearchParams();\n\n  if (authenticatorHint) {\n    query.set('authenticator_hint', authenticatorHint);\n  }\n\n  if (prompt) {\n    query.set('prompt', prompt);\n  }\n\n  if (display) {\n    query.set('display', display);\n  }\n\n  if (uiLocales) {\n    query.set('ui_locales', uiLocales);\n  }\n\n  if (scopes) {\n    query.set('scope', scopes);\n  }\n\n  if (acrValues) {\n    query.set('acr_values', acrValues.join(' '));\n  }\n\n  if (resource) {\n    query.set('resource', resource);\n  }\n\n  if (maxAge) {\n    query.set('max_age', maxAge.toString());\n  }\n\n  if (loginHint) {\n    query.set('login_hint', loginHint);\n  }\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  return (\n    <a\n      href={`${signInUrl}${query.size ? `?${query.toString()}` : ''}`}\n      {...props}\n    >\n      {children}\n    </a>\n  );\n};\n","import React from 'react';\nimport { ExtraAuthParams } from '../types';\n\n/**\n * Props for the `<SignUp />` component.\n *\n * @category Types\n */\nexport interface SignUpProps extends Omit<\n  ExtraAuthParams,\n  'authenticatorHint' | 'loginHint' | 'prompt'\n> {\n  /**\n   * URL to redirect to after successful sign-up.\n   */\n  returnUrl?: string;\n}\n\n/**\n * `<SignUp>` renders a link that initiates the MonoCloud sign-up flow.\n *\n * It works in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.\n *\n * Internally, it behaves like `<SignIn>` but sets `prompt=create` to start the registration flow.\n *\n * @example Basic usage\n *\n * ```tsx title=\"Basic Usage\"\n * import { SignUp } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignUp>Sign Up</SignUp>;\n * }\n * ```\n *\n * @example Customize the authorization request\n *\n * You can customize the authorization request by passing in props.\n *\n * ```tsx title=\"Customize the authorization request\"\n * import { SignUp } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return (\n *     <SignUp\n *       returnUrl=\"/dashboard\"\n *       uiLocales=\"en\"\n *     >\n *       Sign Up\n *     </SignUp>\n *   );\n * }\n * ```\n *\n * @param props - Properties for the SignUp component.\n * @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.\n *\n * @category Components\n */\nexport const SignUp = ({\n  children,\n  returnUrl,\n  acrValues,\n  display,\n  maxAge,\n  resource,\n  scopes,\n  uiLocales,\n  ...props\n}: SignUpProps &\n  Omit<\n    React.AnchorHTMLAttributes<HTMLAnchorElement>,\n    'resource'\n  >): React.ReactNode => {\n  const signInUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signin`;\n\n  const query = new URLSearchParams();\n\n  query.set('prompt', 'create');\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  if (display) {\n    query.set('display', display);\n  }\n\n  if (uiLocales) {\n    query.set('ui_locales', uiLocales);\n  }\n\n  if (scopes) {\n    query.set('scope', scopes);\n  }\n\n  if (acrValues) {\n    query.set('acr_values', acrValues.join(' '));\n  }\n\n  if (resource) {\n    query.set('resource', resource);\n  }\n\n  if (maxAge) {\n    query.set('max_age', maxAge.toString());\n  }\n\n  if (returnUrl) {\n    query.set('return_url', returnUrl);\n  }\n\n  return (\n    <a href={`${signInUrl}?${query.toString()}`} {...props}>\n      {children}\n    </a>\n  );\n};\n","import React from 'react';\n\n/**\n * Props for the `<SignOut />` component.\n *\n * @category Types\n */\nexport interface SignOutProps {\n  /** Content rendered inside the link (for example, button text). */\n  children: React.ReactNode;\n\n  /** URL to redirect the user to after they have been signed out. */\n  postLogoutUrl?: string;\n\n  /** If `true`, also signs the user out of the MonoCloud server session, ensuring the user is fully logged out of MonoCloud and not just your application. */\n  federated?: boolean;\n}\n\n/**\n * `<SignOut>` renders a link that initiates the MonoCloud sign-out flow.\n *\n * It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.\n *\n * @example Basic usage\n *\n * ```tsx title=\"Basic Usage\"\n * import { SignOut } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignOut>Sign Out</SignOut>;\n * }\n * ```\n *\n * @example Customize the sign-out request\n *\n * ```tsx title=\"Customize the sign-out request\"\n * import { SignOut } from \"@monocloud/auth-nextjs/components\";\n *\n * export default function Home() {\n *   return <SignOut federated postLogoutUrl=\"/goodbye\">Sign Out</SignOut>;\n * }\n * ```\n *\n * @param props - Properties for the SignOut component.\n * @returns An anchor element that links to the sign-out endpoint.\n *\n * @category Components\n */\nexport const SignOut = ({\n  children,\n  postLogoutUrl,\n  federated,\n  ...props\n}: SignOutProps &\n  React.AnchorHTMLAttributes<HTMLAnchorElement>): React.ReactNode => {\n  const signOutUrl =\n    process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNOUT_URL ??\n    // eslint-disable-next-line no-underscore-dangle\n    `${process.env.__NEXT_ROUTER_BASEPATH ?? ''}/api/auth/signout`;\n\n  const query = new URLSearchParams();\n\n  if (postLogoutUrl) {\n    query.set('post_logout_url', postLogoutUrl);\n  }\n\n  if (typeof federated === 'boolean') {\n    query.set('federated', federated.toString());\n  }\n\n  return (\n    <a\n      href={`${signOutUrl}${query.size ? `?${query.toString()}` : ''}`}\n      {...props}\n    >\n      {children}\n    </a>\n  );\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,MAAa,UAAU,EACrB,UACA,mBACA,WACA,QACA,SACA,WACA,QACA,WACA,UACA,QACA,WACA,GAAG,YAKoB;CACvB,MAAM,YACJ,QAAQ,IAAI,yCAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,KAAI,kBACF,OAAM,IAAI,sBAAsB,kBAAkB;AAGpD,KAAI,OACF,OAAM,IAAI,UAAU,OAAO;AAG7B,KAAI,QACF,OAAM,IAAI,WAAW,QAAQ;AAG/B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,OACF,OAAM,IAAI,SAAS,OAAO;AAG5B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU,KAAK,IAAI,CAAC;AAG9C,KAAI,SACF,OAAM,IAAI,YAAY,SAAS;AAGjC,KAAI,OACF,OAAM,IAAI,WAAW,OAAO,UAAU,CAAC;AAGzC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,QACE,4CAAC;EACC,MAAM,GAAG,YAAY,MAAM,OAAO,IAAI,MAAM,UAAU,KAAK;EAC3D,GAAI;IAEH,SACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACpER,MAAa,UAAU,EACrB,UACA,WACA,WACA,SACA,QACA,UACA,QACA,WACA,GAAG,YAKoB;CACvB,MAAM,YACJ,QAAQ,IAAI,yCAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,OAAM,IAAI,UAAU,SAAS;AAE7B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,QACF,OAAM,IAAI,WAAW,QAAQ;AAG/B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,KAAI,OACF,OAAM,IAAI,SAAS,OAAO;AAG5B,KAAI,UACF,OAAM,IAAI,cAAc,UAAU,KAAK,IAAI,CAAC;AAG9C,KAAI,SACF,OAAM,IAAI,YAAY,SAAS;AAGjC,KAAI,OACF,OAAM,IAAI,WAAW,OAAO,UAAU,CAAC;AAGzC,KAAI,UACF,OAAM,IAAI,cAAc,UAAU;AAGpC,QACE,4CAAC;EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,UAAU;EAAI,GAAI;IAC9C,SACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACtER,MAAa,WAAW,EACtB,UACA,eACA,WACA,GAAG,YAEgE;CACnE,MAAM,aACJ,QAAQ,IAAI,0CAEZ,GAAG,QAAQ,IAAI,0BAA0B,GAAG;CAE9C,MAAM,QAAQ,IAAI,iBAAiB;AAEnC,KAAI,cACF,OAAM,IAAI,mBAAmB,cAAc;AAG7C,KAAI,OAAO,cAAc,UACvB,OAAM,IAAI,aAAa,UAAU,UAAU,CAAC;AAG9C,QACE,4CAAC;EACC,MAAM,GAAG,aAAa,MAAM,OAAO,IAAI,MAAM,UAAU,KAAK;EAC5D,GAAI;IAEH,SACC"}

package/dist/components/index.d.mts

@@ -1,26 +1,30 @@
-import { i as ExtraAuthParams } from "../types-CsBjAJce.mjs";
-import React, { JSX } from "react";
+import { c as ExtraAuthParams } from "../types-xS_Me3Qg.mjs";
+import React from "react";
 
 //#region src/components/signin.d.ts
+/**
+ * Props for the `<SignIn />` component.
+ *
+ * @category Types
+ */
 interface SignInProps extends ExtraAuthParams {
+  /**
+   * Content rendered inside the link (for example, button text).
+   */
   children: React.ReactNode;
   /**
-   * URL to redirect to after a successful sign-in.
+   * URL to redirect to after successful sign-in.
    */
   returnUrl?: string;
 }
 /**
- * A component that renders an anchor tag configured to initiate the sign-in flow.
+ * `<SignIn>` renders a link that initiates the MonoCloud sign-in flow.
  *
- * @param props - Properties for the SignIn component.
+ * It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
  *
- * @returns An anchor element that links to the sign-in endpoint with the specified parameters.
- *
- * @example App Router and Pages Router
- *
- * **Sign-in component works on both the server and the client in pages router and app router.**
+ * @example Basic Usage
  *
- * ```tsx
+ * ```tsx title="Basic Usage"
  * import { SignIn } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
@@ -30,21 +34,24 @@ interface SignInProps extends ExtraAuthParams {
  *
  * @example Customize the authorization request
  *
- * You can customize the authorization request by passing in props. See {@link SignInProps}.
+ * You can customize the authorization request by passing props:
  *
- * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
- *
- * ```tsx
+ * ```tsx title="Customize the authorization request"
  * import { SignIn } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
  *   return (
- *     <SignIn loginHint="username" authenticatorHint="password">
+ *     <SignIn loginHint="user@example.com" authenticatorHint="password" returnUrl="/dashboard">
  *       Sign In
  *     </SignIn>
  *   );
  * }
  * ```
+ *
+ * @param props - Properties for the SignIn component.
+ * @returns An anchor element that links to the sign-in endpoint with the specified parameters.
+ *
+ * @category Components
  */
 declare const SignIn: ({
   children,
@@ -59,28 +66,30 @@ declare const SignIn: ({
   maxAge,
   returnUrl,
   ...props
-}: SignInProps & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "resource">) => JSX.Element;
+}: SignInProps & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "resource">) => React.ReactNode;
 //#endregion
 //#region src/components/signup.d.ts
+/**
+ * Props for the `<SignUp />` component.
+ *
+ * @category Types
+ */
 interface SignUpProps extends Omit<ExtraAuthParams, 'authenticatorHint' | 'loginHint' | 'prompt'> {
   /**
-   * URL to redirect to after a successful sign-up.
+   * URL to redirect to after successful sign-up.
    */
   returnUrl?: string;
 }
 /**
- * A component that renders an anchor tag configured to initiate the sign-up flow.
- * * It functions similarly to the SignIn component but explicitly sets the `prompt` parameter to `create`.
+ * `<SignUp>` renders a link that initiates the MonoCloud sign-up flow.
  *
- * @param props - Properties for the SignUp component.
+ * It works in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
  *
- * @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+ * Internally, it behaves like `<SignIn>` but sets `prompt=create` to start the registration flow.
  *
- * @example App Router and Pages Router
+ * @example Basic usage
  *
- * **Sign-up component works on both the server and the client in pages router and app router.**
- *
- * ```tsx
+ * ```tsx title="Basic Usage"
  * import { SignUp } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
@@ -90,17 +99,27 @@ interface SignUpProps extends Omit<ExtraAuthParams, 'authenticatorHint' | 'login
  *
  * @example Customize the authorization request
  *
- * You can customize the authorization request by passing in props. See {@link SignUpProps}.
- *
- * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
+ * You can customize the authorization request by passing in props.
  *
- * ```tsx
+ * ```tsx title="Customize the authorization request"
  * import { SignUp } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
- *   return <SignUp returnUrl="/dashboard">Sign Up</SignUp>;
+ *   return (
+ *     <SignUp
+ *       returnUrl="/dashboard"
+ *       uiLocales="en"
+ *     >
+ *       Sign Up
+ *     </SignUp>
+ *   );
  * }
  * ```
+ *
+ * @param props - Properties for the SignUp component.
+ * @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+ *
+ * @category Components
  */
 declare const SignUp: ({
   children,
@@ -112,27 +131,30 @@ declare const SignUp: ({
   scopes,
   uiLocales,
   ...props
-}: SignUpProps & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "resource">) => JSX.Element;
+}: SignUpProps & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, "resource">) => React.ReactNode;
 //#endregion
 //#region src/components/signout.d.ts
+/**
+ * Props for the `<SignOut />` component.
+ *
+ * @category Types
+ */
 interface SignOutProps {
+  /** Content rendered inside the link (for example, button text). */
+  children: React.ReactNode;
   /** URL to redirect the user to after they have been signed out. */
   postLogoutUrl?: string;
-  /** Whether to also sign out the user from MonoCloud */
+  /** If `true`, also signs the user out of the MonoCloud server session, ensuring the user is fully logged out of MonoCloud and not just your application. */
   federated?: boolean;
 }
 /**
- * A component that renders an anchor tag configured to initiate the sign-out flow.
+ * `<SignOut>` renders a link that initiates the MonoCloud sign-out flow.
  *
- * @param props - Properties for the SignOut component.
- *
- * @returns An anchor element that links to the sign-out endpoint.
+ * It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
  *
- * @example App Router and Pages Router
+ * @example Basic usage
  *
- * **Sign-out component works on both the server and the client in pages router and app router.**
- *
- * ```tsx
+ * ```tsx title="Basic Usage"
  * import { SignOut } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
@@ -140,26 +162,27 @@ interface SignOutProps {
  * }
  * ```
  *
- * @example Customize the request
- *
- * You can customize the request by passing in props. See {@link SignOutProps}.
+ * @example Customize the sign-out request
  *
- * **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
- *
- * ```tsx
+ * ```tsx title="Customize the sign-out request"
  * import { SignOut } from "@monocloud/auth-nextjs/components";
  *
  * export default function Home() {
- *   return <SignOut federated={true}>Sign Out</SignOut>;
+ *   return <SignOut federated postLogoutUrl="/goodbye">Sign Out</SignOut>;
  * }
  * ```
+ *
+ * @param props - Properties for the SignOut component.
+ * @returns An anchor element that links to the sign-out endpoint.
+ *
+ * @category Components
  */
 declare const SignOut: ({
   children,
   postLogoutUrl,
   federated,
   ...props
-}: SignOutProps & React.AnchorHTMLAttributes<HTMLAnchorElement>) => JSX.Element;
+}: SignOutProps & React.AnchorHTMLAttributes<HTMLAnchorElement>) => React.ReactNode;
 //#endregion
 export { SignIn, type SignInProps, SignOut, type SignOutProps, SignUp, type SignUpProps };
 //# sourceMappingURL=index.d.mts.map

package/dist/components/index.mjs

@@ -2,17 +2,13 @@ import React from "react";
 
 //#region src/components/signin.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-in flow.
+* `<SignIn>` renders a link that initiates the MonoCloud sign-in flow.
 *
-* @param props - Properties for the SignIn component.
-*
-* @returns An anchor element that links to the sign-in endpoint with the specified parameters.
-*
-* @example App Router and Pages Router
+* It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* **Sign-in component works on both the server and the client in pages router and app router.**
+* @example Basic Usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignIn } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -22,21 +18,24 @@ import React from "react";
 *
 * @example Customize the authorization request
 *
-* You can customize the authorization request by passing in props. See {@link SignInProps}.
+* You can customize the authorization request by passing props:
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the authorization request"
 * import { SignIn } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
 *   return (
-*     <SignIn loginHint="username" authenticatorHint="password">
+*     <SignIn loginHint="user@example.com" authenticatorHint="password" returnUrl="/dashboard">
 *       Sign In
 *     </SignIn>
 *   );
 * }
 * ```
+*
+* @param props - Properties for the SignIn component.
+* @returns An anchor element that links to the sign-in endpoint with the specified parameters.
+*
+* @category Components
 */
 const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLocales, scopes, acrValues, resource, maxAge, returnUrl, ...props }) => {
 	const signInUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signin`;
@@ -60,18 +59,15 @@ const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLoc
 //#endregion
 //#region src/components/signup.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-up flow.
-* * It functions similarly to the SignIn component but explicitly sets the `prompt` parameter to `create`.
-*
-* @param props - Properties for the SignUp component.
+* `<SignUp>` renders a link that initiates the MonoCloud sign-up flow.
 *
-* @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+* It works in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* @example App Router and Pages Router
+* Internally, it behaves like `<SignIn>` but sets `prompt=create` to start the registration flow.
 *
-* **Sign-up component works on both the server and the client in pages router and app router.**
+* @example Basic usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignUp } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -81,17 +77,27 @@ const SignIn = ({ children, authenticatorHint, loginHint, prompt, display, uiLoc
 *
 * @example Customize the authorization request
 *
-* You can customize the authorization request by passing in props. See {@link SignUpProps}.
+* You can customize the authorization request by passing in props.
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the authorization request"
 * import { SignUp } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
-*   return <SignUp returnUrl="/dashboard">Sign Up</SignUp>;
+*   return (
+*     <SignUp
+*       returnUrl="/dashboard"
+*       uiLocales="en"
+*     >
+*       Sign Up
+*     </SignUp>
+*   );
 * }
 * ```
+*
+* @param props - Properties for the SignUp component.
+* @returns An anchor element that links to the sign-in endpoint with the prompt set to 'create'.
+*
+* @category Components
 */
 const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, scopes, uiLocales, ...props }) => {
 	const signInUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNIN_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signin`;
@@ -114,17 +120,13 @@ const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, sco
 //#endregion
 //#region src/components/signout.tsx
 /**
-* A component that renders an anchor tag configured to initiate the sign-out flow.
-*
-* @param props - Properties for the SignOut component.
-*
-* @returns An anchor element that links to the sign-out endpoint.
+* `<SignOut>` renders a link that initiates the MonoCloud sign-out flow.
 *
-* @example App Router and Pages Router
+* It can be used in both **App Router** and **Pages Router**, and may be rendered from either **Server** or **Client Components**.
 *
-* **Sign-out component works on both the server and the client in pages router and app router.**
+* @example Basic usage
 *
-* ```tsx
+* ```tsx title="Basic Usage"
 * import { SignOut } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
@@ -132,19 +134,20 @@ const SignUp = ({ children, returnUrl, acrValues, display, maxAge, resource, sco
 * }
 * ```
 *
-* @example Customize the request
-*
-* You can customize the request by passing in props. See {@link SignOutProps}.
+* @example Customize the sign-out request
 *
-* **Note⚠️: You need to set the env `MONOCLOUD_AUTH_ALLOW_QUERY_PARAM_OVERRIDES=true` or `allowQueryParamOverrides` should be `true` in the client initialization for props to work**
-*
-* ```tsx
+* ```tsx title="Customize the sign-out request"
 * import { SignOut } from "@monocloud/auth-nextjs/components";
 *
 * export default function Home() {
-*   return <SignOut federated={true}>Sign Out</SignOut>;
+*   return <SignOut federated postLogoutUrl="/goodbye">Sign Out</SignOut>;
 * }
 * ```
+*
+* @param props - Properties for the SignOut component.
+* @returns An anchor element that links to the sign-out endpoint.
+*
+* @category Components
 */
 const SignOut = ({ children, postLogoutUrl, federated, ...props }) => {
 	const signOutUrl = process.env.NEXT_PUBLIC_MONOCLOUD_AUTH_SIGNOUT_URL ?? `${process.env.__NEXT_ROUTER_BASEPATH ?? ""}/api/auth/signout`;