@monocloud/auth-nextjs 0.1.6 → 0.1.8

package/dist/types-Cx32VRoI.d.mts

@@ -1,409 +0,0 @@
-import { Authenticators, AuthorizationParams, DisplayOptions, MonoCloudUser, Prompt } from "@monocloud/auth-node-core";
-import { JSX } from "react";
-import { NextFetchEvent, NextRequest, NextResponse } from "next/server";
-import { GetServerSideProps, GetServerSidePropsContext, GetServerSidePropsResult, NextApiRequest, NextApiResponse } from "next/types";
-import { ParsedUrlQuery } from "node:querystring";
-
-//#region src/types.d.ts
-/**
- * Context object passed to App Router API route handlers.
- * Contains the dynamic route parameters.
- */
-interface AppRouterContext {
-  params: Record<string, string | string[]>;
-}
-/**
- * Return type of `monoCloudAuth()` handler.
- */
-type MonoCloudAuthHandler = (req: Request | NextRequest | NextApiRequest, resOrCtx?: Response | NextResponse<any> | NextApiResponse<any> | AppRouterContext) => Promise<Response | NextResponse | void | any>;
-/** Return type of Next.js middleware/proxy */
-type NextMiddlewareResult = NextResponse | Response | null | undefined | void;
-/**
- * Handler function triggered when a user is denied access in Next.js Middleware.
- *
- * @param request - The incoming Next.js request.
- * @param event - The Next.js fetch event.
- * @returns A `NextMiddlewareResult` (e.g., a redirect or rewrite) or a Promise resolving to one.
- */
-type NextMiddlewareOnAccessDenied = (request: NextRequest, event: NextFetchEvent) => NextMiddlewareResult | Promise<NextMiddlewareResult>;
-/**
- * Handler function triggered when a user is denied access in Next.js Middleware due to group restrictions.
- *
- * @param request - The incoming Next.js request.
- * @param event - The Next.js fetch event.
- * @param user - The authenticated user object.
- * @returns A `NextMiddlewareResult` (e.g., a redirect or rewrite) or a Promise resolving to one.
- */
-type NextMiddlewareOnGroupAccessDenied = (request: NextRequest, event: NextFetchEvent, user: MonoCloudUser) => NextMiddlewareResult | Promise<NextMiddlewareResult>;
-/**
- *
- * ProtectedRouteMatcher can be a combination of the following types.
- *
- * - `string` : Relative route that should be protected.
- * - `RegExp` : A regular expression used to match relative routes that should be protected.
- * - `{ routes: string[]; groups: string[] }` : Users belonging to any of the group names or IDs listed in groups are granted access to the route paths specified in routes.
- */
-type ProtectedRouteMatcher = string | RegExp | {
-  /**
-   * Routes accessible by the users of specified groups
-   */
-  routes: (string | RegExp)[];
-  /**
-   * A list of group IDs or names specifying the groups the user must belong for accessing the routes.
-   */
-  groups: string[];
-};
-/**
- * A function to be executed that determines whether the route is protected.
- */
-type CustomProtectedRouteMatcher = (req: NextRequest) => Promise<boolean> | boolean;
-/**
- * @param req - The Next.js request object.
- * @param ctx - App Router context that contains dynamic route values.
- * @param error - Error occured during execution of the endpoint.
- * @returns A promise of the response
- */
-type AppOnError<T = any> = (req: NextRequest, ctx: T, error: Error) => Promise<NextResponse | void> | NextResponse | void;
-/**
- * @param req - The Next.js API request object.
- * @param res - The Next.js API response object.
- * @param error - Error occured during execution of the endpoint.
- * @returns A promise of void
- */
-type PageOnError = (req: NextApiRequest, res: NextApiResponse, error: Error) => Promise<void> | void;
-/**
- * A route handler function used to handle errors that occur during the signin, callback, signout and userinfo endpoint execution.
- *
- * `Note` - In the app router error handler, failing to return a `NextResponse` or throw an error will cause the request to hang. Same happens in the page router if you don't call `res.send()` or `res.json()` after you handle the error.
- */
-type OnError = AppOnError | PageOnError;
-/**
- * Options for `monoCloudAuth()`.
- */
-interface MonoCloudAuthOptions {
-  /**
-   * Error handler for signin, callback, signout and userinfo endpoints.
-   */
-  onError?: OnError;
-}
-/**
- * Configuration for protected routes.
- */
-type ProtectedRoutes = ProtectedRouteMatcher[] | CustomProtectedRouteMatcher;
-/**
- * Options for configuring MonoCloud authentication middleware.
- */
-interface MonoCloudMiddlewareOptions {
-  /**
-   * Error handler for signin, callback, signout and userinfo endpoints.
-   *
-   * @param req - The Next.js request object.
-   * @param evt - The Next.js FetchEvent.
-   * @param error - Error occured during execution of the endpoint.
-   * @returns A promise of the response or void
-   */
-  onError?: (req: NextRequest, evt: NextFetchEvent, error: Error) => Promise<NextResponse | void> | NextResponse | void;
-  /**
-   * Specifies the routes that require authentication. @see ProtectedRoutes
-   *
-   * If an empty array is passed as the value for the protected routes configuration, no routes will be protected.
-   */
-  protectedRoutes?: ProtectedRoutes;
-  /**
-   * The name of the groups claim in the user profile. Default: `groups`.
-   */
-  groupsClaim?: string;
-  /**
-   * If true, user must be a member of all groups. Default: false.
-   */
-  matchAll?: boolean;
-  /**
-   * A middleware function called when the user is not authenticated.
-   */
-  onAccessDenied?: NextMiddlewareOnAccessDenied;
-  /**
-   * A middleware function called when the user is authenticated but is not a member of the specified groups.
-   */
-  onGroupAccessDenied?: NextMiddlewareOnGroupAccessDenied;
-}
-/**
- * A subset of authorization parameters used on client side functions
- */
-type ExtraAuthParams = Pick<AuthorizationParams, 'scopes' | 'resource' | 'prompt' | 'display' | 'uiLocales' | 'acrValues' | 'authenticatorHint' | 'maxAge' | 'loginHint'>;
-/**
- * Represents a Next.js App Router React Server Component.
- *
- * @param props - The props object containing `params` and `searchParams`.
- *
- * @returns A JSX Element or a Promise resolving to one.
- */
-type AppRouterPageHandler = (props: {
-  params?: Record<string, string | string[]>;
-  searchParams?: Record<string, string | string[] | undefined>;
-}) => Promise<JSX.Element> | JSX.Element;
-/** App Router API Route Handler */
-type AppRouterApiHandlerFn = (req: NextRequest | Request, ctx: AppRouterContext) => Promise<Response | NextResponse> | Response | NextResponse;
-/**
- * Options for configuring `protectPage()` in the App Router.
- */
-type ProtectAppPageOptions = {
-  /**
-   * The URL to return to after authentication.
-   */
-  returnUrl?: string;
-  /**
-   * Alternate page handler called when the user is not authenticated.
-   */
-  onAccessDenied?: (props: {
-    params?: Record<string, string | string[]>;
-    searchParams?: Record<string, string | string[] | undefined>;
-  }) => Promise<JSX.Element> | JSX.Element;
-  /**
-   * Alternate page handler called when the user is authenticated but is not a member of the specified groups.
-   */
-  onGroupAccessDenied?: (props: {
-    user: MonoCloudUser;
-    params?: Record<string, string | string[]>;
-    searchParams?: Record<string, string | string[] | undefined>;
-  }) => Promise<JSX.Element> | JSX.Element;
-  /**
-   * Authorization parameters to be used during authentication.
-   */
-  authParams?: ExtraAuthParams;
-} & GroupOptions;
-/**
- * Options for configuring `protectPage()` in the Pages Router.
- *
- * @typeParam P - The type of the props returned by `getServerSideProps`.
- * @typeParam Q - The type of the parsed query object.
- */
-type ProtectPagePageOptions<P extends Record<string, any> = Record<string, any>, Q extends ParsedUrlQuery = ParsedUrlQuery> = {
-  /**
-   * Function to fetch server-side props for the protected page handler.
-   * If provided, this function will be called before rendering the protected page.
-   *
-   * @param context - The Next.js context object, including the request and response objects.
-   * @returns Server-side props for the protected page.
-   */
-  getServerSideProps?: GetServerSideProps<P, Q>;
-  /**
-   * Specifies the URL to redirect to after authentication.
-   */
-  returnUrl?: string;
-  /**
-   * Alternate `getServerSideProps` function called when the user is not authenticated.
-   */
-  onAccessDenied?: ProtectPagePageOnAccessDeniedType<P, Q>;
-  /**
-   * Alternate `getServerSideProps` function called when the user IS authenticated but is not a member of the specified groups.
-   */
-  onGroupAccessDenied?: ProtectPagePageOnGroupAccessDeniedType<P, Q>;
-  /**
-   * Authorization parameters to be used during authentication.
-   */
-  authParams?: ExtraAuthParams;
-} & GroupOptions;
-/**
- * Handler function triggered when a user is not authenticated in a Pages Router `getServerSideProps` flow.
- *
- * @typeParam P - The type of the props.
- * @typeParam Q - The type of the parsed query object.
- *
- * @param context - The server-side props context
- *
- * @returns The result for `getServerSideProps`.
- */
-type ProtectPagePageOnAccessDeniedType<P, Q extends ParsedUrlQuery = ParsedUrlQuery> = (context: GetServerSidePropsContext<Q>) => Promise<GetServerSidePropsResult<P>> | GetServerSidePropsResult<P>;
-/**
- * Handler function triggered when a user is denied access in a Pages Router `getServerSideProps` flow due to group restrictions.
- *
- * @typeParam P - The type of the props.
- * @typeParam Q - The type of the parsed query object.
- *
- * @param context - The server-side props context with the user object.
- *
- * @returns The result for `getServerSideProps`.
- */
-type ProtectPagePageOnGroupAccessDeniedType<P, Q extends ParsedUrlQuery = ParsedUrlQuery> = (context: GetServerSidePropsContext<Q> & {
-  user: MonoCloudUser;
-}) => Promise<GetServerSidePropsResult<P>> | GetServerSidePropsResult<P>;
-/**
- * The return type of the `protectPage()` wrapper for Pages Router.
- * It returns a function compatible with `getServerSideProps` that injects the user into props.
- *
- * @typeParam P - The type of the props.
- * @typeParam Q - The type of the parsed query object.
- *
- * @returns `GetServerSidePropsResult` with user injected
- */
-type ProtectPagePageReturnType<P, Q extends ParsedUrlQuery = ParsedUrlQuery> = (context: GetServerSidePropsContext<Q>) => Promise<GetServerSidePropsResult<P & {
-  user: MonoCloudUser;
-  accessDenied?: boolean;
-}>>;
-/**
- * The App Router server component that protectPage wraps and secures
- */
-type ProtectedAppServerComponent = (props: {
-  user: MonoCloudUser;
-  params?: Record<string, string | string[]>;
-  searchParams?: Record<string, string | string[] | undefined>;
-}) => Promise<JSX.Element> | JSX.Element;
-/**
- * Handler function triggered when a user is not authenticated in an App Router API route.
- *
- * @param req - The incoming Next.js request.
- * @param ctx - The App Router context.
- *
- * @returns A Response/NextResponse or Promise resolving to one.
- */
-type AppRouterApiOnAccessDeniedHandler = (req: NextRequest, ctx: AppRouterContext) => Promise<Response> | Response;
-/**
- * Handler function triggered when a user is denied access in an App Router API route due to group restrictions.
- *
- * @param req - The incoming Next.js request.
- * @param ctx - The App Router context.
- * @param user - The authenticated user object.
- *
- * @returns A Response/NextResponse or Promise resolving to one.
- */
-type AppRouterApiOnGroupAccessDeniedHandler = (req: NextRequest, ctx: AppRouterContext, user: MonoCloudUser) => Promise<Response> | Response;
-/** Options for App Router `protectApi()` */
-type ProtectApiAppOptions = {
-  /**
-   * Alternate app router api handler called when the user is not authenticated.
-   */
-  onAccessDenied?: AppRouterApiOnAccessDeniedHandler;
-  /**
-   * Alternate app router api handler called when the user is authenticated but is not a member of the specified groups.
-   */
-  onGroupAccessDenied?: AppRouterApiOnGroupAccessDeniedHandler;
-} & GroupOptions;
-/**
- * Handler function triggered when a user is not authenticated in a Pages Router API route.
- *
- * @param req - The incoming Next.js API request.
- * @param res - The Next.js API response.
- *
- * @returns
- */
-type PageRouterApiOnAccessDeniedHandler = (req: NextApiRequest, res: NextApiResponse<any>) => Promise<unknown> | unknown;
-/**
- * Handler function triggered when a user is denied access in a Pages Router API route due to group restrictions.
- *
- * @param req - The incoming Next.js API request.
- * @param res - The Next.js API response.
- * @param user - The authenticated user object.
- *
- * @returns
- */
-type PageRouterApiOnGroupAccessDeniedHandler = (req: NextApiRequest, res: NextApiResponse<any>, user: MonoCloudUser) => Promise<unknown> | unknown;
-/** Options for Page Router `protectApi()` */
-type ProtectApiPageOptions = {
-  /**
-   * Alternate page router api handler called when the user is not authenticated.
-   */
-  onAccessDenied?: PageRouterApiOnAccessDeniedHandler;
-  /**
-   * Alternate page router api handler called when the user is authenticated but is not a member of the specified groups.
-   */
-  onGroupAccessDenied?: PageRouterApiOnGroupAccessDeniedHandler;
-} & GroupOptions;
-/**
- * Options for the `protect()` helper function.
- */
-type ProtectOptions = {
-  /**
-   * The url where the user will be redirected to after sign in.
-   */
-  returnUrl?: string;
-  /**
-   * Authorization parameters to be used during authentication.
-   */
-  authParams?: ExtraAuthParams;
-} & GroupOptions;
-/**
- * Configuration options for checking if a user belongs to specific groups.
- */
-interface IsUserInGroupOptions {
-  /**
-   * The name of the groups claim in the user profile. Default: `groups`.
-   */
-  groupsClaim?: string;
-  /**
-   * If true, user must be a member of all groups. Default: false.
-   */
-  matchAll?: boolean;
-}
-/**
- * Extended configuration options that include a list of required groups.
- */
-interface GroupOptions extends IsUserInGroupOptions {
-  /**
-   * A list of group IDs or names specifying the groups the user must belong to.
-   */
-  groups?: string[];
-}
-/**
- * Options for `redirectToSignIn()`
- */
-interface RedirectToSignInOptions {
-  /**
-   * The URL to which the user should be redirected after successful sign-in.
-   */
-  returnUrl?: string;
-  /**
-   * Maximum allowed time in seconds since the last End-User authentication.
-   */
-  maxAge?: number;
-  /**
-   * A hint to the authorization server about the desired authenticator the client wishes to authenticate the user with
-   */
-  authenticatorHint?: Authenticators;
-  /**
-   * An array of scopes requested from the authorization server
-   */
-  scopes?: string[];
-  /**
-   * List of resources the access token should be scoped to
-   */
-  resource?: string[];
-  /**
-   * User's preferred languages and scripts for the user interface
-   */
-  uiLocales?: string;
-  /**
-   * The desired user interface mode
-   */
-  display?: DisplayOptions;
-  /**
-   * An array of authentication context class references (ACRs).
-   */
-  acrValues?: string[];
-  /**
-   * A hint to the authorization server about the user's identifier
-   */
-  loginHint?: string;
-  /**
-   * The desired authentication behaviour.
-   * - `none`: User is not prompted to sign in.
-   * - `login`: Prompt the user to log in even if the user is already authenticated.
-   * - `consent`: Prompt the user for consent.
-   * - `select_account`: Prompt the user to sign in.
-   * - `create`: Prompt the user to sign up.
-   */
-  prompt?: Prompt;
-}
-/**
- * Options for `redirectToSignOut()`
- */
-interface RedirectToSignOutOptions {
-  /**
-   * The url authorization server should redirect the user to after a successful sign out. This url has to be registered in the client's sign out url section.
-   */
-  postLogoutRedirectUri?: string;
-  /** Whether to also sign out the user from MonoCloud */
-  federated?: boolean;
-}
-//#endregion
-export { ProtectPagePageOptions as _, GroupOptions as a, RedirectToSignInOptions as b, MonoCloudAuthOptions as c, PageRouterApiOnAccessDeniedHandler as d, ProtectApiAppOptions as f, ProtectPagePageOnAccessDeniedType as g, ProtectOptions as h, ExtraAuthParams as i, MonoCloudMiddlewareOptions as l, ProtectAppPageOptions as m, AppRouterApiOnAccessDeniedHandler as n, IsUserInGroupOptions as o, ProtectApiPageOptions as p, AppRouterPageHandler as r, MonoCloudAuthHandler as s, AppRouterApiHandlerFn as t, NextMiddlewareResult as u, ProtectPagePageReturnType as v, RedirectToSignOutOptions as x, ProtectedAppServerComponent as y };
-//# sourceMappingURL=types-Cx32VRoI.d.mts.map