@civic/auth 0.0.1-beta.0 → 0.0.1-beta.1

package/dist/nextjs.d.ts

@@ -1,8 +1,239 @@
-import { NextRequest, NextResponse } from 'next/server';
+import * as next_dist_shared_lib_image_config from 'next/dist/shared/lib/image-config';
+import * as next_dist_lib_load_custom_routes from 'next/dist/lib/load-custom-routes';
+import * as next_dist_server_config_shared from 'next/dist/server/config-shared';
+import { NextConfig } from 'next';
+import { NextRequest, NextResponse } from 'next/server.js';
 
-type AuthMiddlewareConfig = {
+interface CookieConfig {
+    secure?: boolean;
+    sameSite?: "strict" | "lax" | "none";
+    domain?: string;
+    path?: string;
+    maxAge?: number;
+}
+type AuthConfigWithDefaults = {
+    clientId: string;
+    oauthServer: string;
+    callbackUrl: string;
     loginUrl: string;
+    logoutUrl: string;
+    challengeUrl: string;
+    include: string[];
+    exclude: string[];
+    cookies: {
+        tokens: CookieConfig;
+        user: CookieConfig;
+    };
 };
-declare const authMiddleware: (config?: AuthMiddlewareConfig) => (req: NextRequest) => Promise<NextResponse<unknown> | undefined>;
+type AuthConfig = Partial<AuthConfigWithDefaults>;
+/**
+ * Creates a Next.js plugin that handles auth configuration.
+ *
+ * This is the main configuration point for the auth system.
+ * Do not set _civic_auth_* environment variables directly - instead,
+ * pass your configuration here:
+ *
+ * @example
+ * ```js
+ * // next.config.js
+ * export tefault createCivicAuthPlugin({
+ *   clientId: 'my-client-id',
+ *   callbackUrl: '/custom/callback',
+ *   loginUrl: '/custom/login',
+ *   logoutUrl: '/custom/logout',
+ *   include: ['/protected/*'],
+ *   exclude: ['/public/*']
+ * })
+ * ```
+ *
+ * The plugin sets internal environment variables that are used by
+ * the auth system. These variables should not be set manually.
+ */
+declare const createCivicAuthPlugin: (clientId: string, authConfig?: AuthConfig) => (nextConfig?: NextConfig) => {
+    env: {
+        _civic_auth_client_id: string;
+        _civic_oauth_server: string;
+        _civic_auth_callback_url: string;
+        _civic_auth_login_url: string;
+        _civic_auth_logout_url: string;
+        _civic_auth_includes: string;
+        _civic_auth_excludes: string;
+        _civic_auth_cookie_config: string;
+    };
+    exportPathMap?: (defaultMap: next_dist_server_config_shared.ExportPathMap, ctx: {
+        dev: boolean;
+        dir: string;
+        outDir: string | null;
+        distDir: string;
+        buildId: string;
+    }) => Promise<next_dist_server_config_shared.ExportPathMap> | next_dist_server_config_shared.ExportPathMap;
+    i18n?: next_dist_server_config_shared.I18NConfig | null;
+    eslint?: next_dist_server_config_shared.ESLintConfig;
+    typescript?: next_dist_server_config_shared.TypeScriptConfig;
+    headers?: () => Promise<next_dist_lib_load_custom_routes.Header[]>;
+    rewrites?: () => Promise<next_dist_lib_load_custom_routes.Rewrite[] | {
+        beforeFiles: next_dist_lib_load_custom_routes.Rewrite[];
+        afterFiles: next_dist_lib_load_custom_routes.Rewrite[];
+        fallback: next_dist_lib_load_custom_routes.Rewrite[];
+    }>;
+    redirects?: () => Promise<next_dist_lib_load_custom_routes.Redirect[]>;
+    excludeDefaultMomentLocales?: boolean;
+    webpack?: next_dist_server_config_shared.NextJsWebpackConfig | null;
+    trailingSlash?: boolean;
+    distDir?: string;
+    cleanDistDir?: boolean;
+    assetPrefix?: string;
+    cacheHandler?: string | undefined;
+    cacheMaxMemorySize?: number;
+    useFileSystemPublicRoutes?: boolean;
+    generateBuildId?: () => string | null | Promise<string | null>;
+    generateEtags?: boolean;
+    pageExtensions?: string[];
+    compress?: boolean;
+    analyticsId?: string;
+    poweredByHeader?: boolean;
+    images?: next_dist_shared_lib_image_config.ImageConfig;
+    devIndicators?: {
+        buildActivity?: boolean;
+        buildActivityPosition?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
+    };
+    onDemandEntries?: {
+        maxInactiveAge?: number;
+        pagesBufferLength?: number;
+    };
+    amp?: {
+        canonicalBase?: string;
+    };
+    deploymentId?: string;
+    basePath?: string;
+    sassOptions?: {
+        [key: string]: any;
+    };
+    productionBrowserSourceMaps?: boolean;
+    optimizeFonts?: boolean;
+    reactProductionProfiling?: boolean;
+    reactStrictMode?: boolean | null;
+    publicRuntimeConfig?: {
+        [key: string]: any;
+    };
+    serverRuntimeConfig?: {
+        [key: string]: any;
+    };
+    httpAgentOptions?: {
+        keepAlive?: boolean;
+    };
+    outputFileTracing?: boolean;
+    staticPageGenerationTimeout?: number;
+    crossOrigin?: "anonymous" | "use-credentials";
+    swcMinify?: boolean;
+    compiler?: {
+        reactRemoveProperties?: boolean | {
+            properties?: string[];
+        };
+        relay?: {
+            src: string;
+            artifactDirectory?: string;
+            language?: "typescript" | "javascript" | "flow";
+            eagerEsModules?: boolean;
+        };
+        removeConsole?: boolean | {
+            exclude?: string[];
+        };
+        styledComponents?: boolean | next_dist_server_config_shared.StyledComponentsConfig;
+        emotion?: boolean | next_dist_server_config_shared.EmotionConfig;
+        styledJsx?: boolean | {
+            useLightningcss?: boolean;
+        };
+    };
+    output?: "standalone" | "export";
+    transpilePackages?: string[];
+    skipMiddlewareUrlNormalize?: boolean;
+    skipTrailingSlashRedirect?: boolean;
+    modularizeImports?: Record<string, {
+        transform: string | Record<string, string>;
+        preventFullImport?: boolean;
+        skipDefaultConversion?: boolean;
+    }>;
+    logging?: {
+        fetches?: {
+            fullUrl?: boolean;
+        };
+    };
+    experimental?: next_dist_server_config_shared.ExperimentalConfig;
+};
+
+/**
+ * Creates an authentication handler for Next.js API routes
+ *
+ * Usage:
+ * ```ts
+ * // app/api/auth/[...civicauth]/route.ts
+ * import { handler } from '@civic/auth/nextjs'
+ * export const GET = handler({
+ *   // optional config overrides
+ * })
+ * ```
+ */
+declare function handler(authConfig?: AuthConfig): (request: NextRequest) => Promise<NextResponse>;
+
+type UnknownObject = Record<string, unknown>;
+type EmptyObject = Record<string, never>;
+type ForwardedTokens = Record<string, {
+    idToken?: string;
+    accessToken?: string;
+    refreshToken?: string;
+}>;
+type Tokens = {
+    idToken: string;
+    accessToken: string;
+    refreshToken: string;
+    forwardedTokens: ForwardedTokens;
+};
+type BaseUser = {
+    id: string;
+    email?: string;
+    name?: string;
+    given_name?: string;
+    family_name?: string;
+    picture?: string;
+    updated_at?: Date;
+};
+type User<T extends UnknownObject = EmptyObject> = BaseUser & Tokens & T;
+
+declare const getUser: () => User<UnknownObject> | null;
+
+type Middleware = (request: NextRequest) => Promise<NextResponse> | NextResponse;
+/**
+ *
+ * Use this when auth is the only middleware you need.
+ * Usage:
+ *
+ * export default authMiddleware({ loginUrl = '/login' }); // or just authMiddleware();
+ *
+ */
+declare const authMiddleware: (authConfig?: Omit<AuthConfigWithDefaults, "clientId">) => (request: NextRequest) => Promise<NextResponse>;
+/**
+ * Usage:
+ *
+ * export default withAuth(async (request) => {
+ *    console.log('my middleware');
+ *    return NextResponse.next();
+ *  })
+ */
+declare function withAuth(middleware: Middleware): (request: NextRequest) => Promise<NextResponse>;
+/**
+ * Use this when you want to configure the middleware here (an alternative is to do it in the next.config file)
+ *
+ * Usage:
+ *
+ * const withAuth = auth({ loginUrl = '/login' }); // or just auth();
+ *
+ * export default withAuth(async (request) => {
+ *    console.log('my middleware');
+ *    return NextResponse.next();
+ *  })
+ *
+ */
+declare function auth(authConfig?: AuthConfig): (middleware: Middleware) => ((request: NextRequest) => Promise<NextResponse>);
 
-export { type AuthMiddlewareConfig, authMiddleware };
+export { auth, authMiddleware, createCivicAuthPlugin, getUser, handler, withAuth };