@solvapay/next 1.0.0-preview.10 → 1.0.0-preview.11

package/README.md

@@ -257,10 +257,54 @@ This package is separate from `@solvapay/server` to keep the server package fram
 
 ## Middleware Setup
 
-These helpers expect the user ID to be set in the `x-user-id` header by your Next.js middleware:
+These helpers expect the user ID to be set in the `x-user-id` header by your Next.js middleware/proxy.
+
+### Quick Setup with Supabase
+
+The easiest way is to use `createSupabaseAuthMiddleware`:
+
+**For Next.js 15:**
+```typescript
+// middleware.ts (at project root)
+import { createSupabaseAuthMiddleware } from '@solvapay/next';
+
+export const middleware = createSupabaseAuthMiddleware({
+  publicRoutes: ['/api/list-plans'],
+});
+
+export const config = {
+  matcher: ['/api/:path*'],
+};
+```
+
+**For Next.js 16 with `src/` folder:**
+```typescript
+// src/proxy.ts (in src/ folder, not project root)
+import { createSupabaseAuthMiddleware } from '@solvapay/next';
+
+// Use 'proxy' export for Next.js 16 (no deprecation warning)
+export const proxy = createSupabaseAuthMiddleware({
+  publicRoutes: ['/api/list-plans'],
+});
+
+export const config = {
+  matcher: ['/api/:path*'],
+};
+```
+
+**File Location Notes:**
+- **Next.js 15**: Place `middleware.ts` at project root
+- **Next.js 16 without `src/` folder**: Place `middleware.ts` or `proxy.ts` at project root
+- **Next.js 16 with `src/` folder**: Place `src/proxy.ts` or `src/middleware.ts` (in `src/` folder, not root)
+
+> **Note:** Next.js 16 renamed "middleware" to "proxy". You can use either export name, but `proxy` is recommended to avoid deprecation warnings.
+
+### Custom Middleware
+
+Alternatively, you can create your own middleware:
 
 ```typescript
-// middleware.ts
+// middleware.ts (or src/proxy.ts for Next.js 16)
 import { NextResponse } from 'next/server';
 import type { NextRequest } from 'next/server';
 
@@ -280,5 +324,5 @@ export async function middleware(request: NextRequest) {
 }
 ```
 
-Alternatively, you can use the `requireUserId` utility from `@solvapay/auth` in your middleware.
+You can also use the `requireUserId` utility from `@solvapay/auth` in your middleware.
 

package/dist/index.d.cts

@@ -194,10 +194,11 @@ interface AuthMiddlewareOptions {
  * 4. Returns appropriate error responses for auth failures
  *
  * @param options - Configuration options
- * @returns Next.js middleware function
+ * @returns Next.js middleware function (can be exported as `middleware` or `proxy`)
  *
- * @example
+ * @example Next.js 15
  * ```typescript
+ * // middleware.ts (at project root)
  * import { createAuthMiddleware } from '@solvapay/next';
  * import { SupabaseAuthAdapter } from '@solvapay/auth/supabase';
  *
@@ -215,6 +216,27 @@ interface AuthMiddlewareOptions {
  * };
  * ```
  *
+ * @example Next.js 16 with src/ folder
+ * ```typescript
+ * // src/proxy.ts (in src/ folder, not project root)
+ * import { createAuthMiddleware } from '@solvapay/next';
+ * import { SupabaseAuthAdapter } from '@solvapay/auth/supabase';
+ *
+ * const adapter = new SupabaseAuthAdapter({
+ *   jwtSecret: process.env.SUPABASE_JWT_SECRET!,
+ * });
+ *
+ * // Use 'proxy' export for Next.js 16 (no deprecation warning)
+ * export const proxy = createAuthMiddleware({
+ *   adapter,
+ *   publicRoutes: ['/api/list-plans'],
+ * });
+ *
+ * export const config = {
+ *   matcher: ['/api/:path*'],
+ * };
+ * ```
+ *
  * @example Custom adapter
  * ```typescript
  * import { createAuthMiddleware } from '@solvapay/next';
@@ -231,6 +253,14 @@ interface AuthMiddlewareOptions {
  *   adapter: myAdapter,
  * });
  * ```
+ *
+ * **File Location Notes:**
+ * - **Next.js 15**: Place `middleware.ts` at project root
+ * - **Next.js 16 without `src/` folder**: Place `middleware.ts` or `proxy.ts` at project root
+ * - **Next.js 16 with `src/` folder**: Place `src/proxy.ts` or `src/middleware.ts` (in `src/` folder, not root)
+ *
+ * **Note:** Next.js 16 renamed "middleware" to "proxy". You can export the return value as either
+ * `middleware` or `proxy` - both work, but `proxy` is recommended to avoid deprecation warnings.
  */
 declare function createAuthMiddleware(options: AuthMiddlewareOptions): (request: NextRequest) => Promise<NextResponse<unknown>>;
 /**
@@ -261,10 +291,11 @@ interface SupabaseAuthMiddlewareOptions {
  * Uses dynamic import to avoid requiring Supabase as a dependency in @solvapay/next.
  *
  * @param options - Configuration options
- * @returns Next.js middleware function
+ * @returns Next.js middleware function (can be exported as `middleware` or `proxy`)
  *
- * @example
+ * @example Next.js 15
  * ```typescript
+ * // middleware.ts (at project root)
  * import { createSupabaseAuthMiddleware } from '@solvapay/next';
  *
  * export const middleware = createSupabaseAuthMiddleware({
@@ -275,6 +306,29 @@ interface SupabaseAuthMiddlewareOptions {
  *   matcher: ['/api/:path*'],
  * };
  * ```
+ *
+ * @example Next.js 16 with src/ folder
+ * ```typescript
+ * // src/proxy.ts (in src/ folder, not project root)
+ * import { createSupabaseAuthMiddleware } from '@solvapay/next';
+ *
+ * // Use 'proxy' export for Next.js 16 (no deprecation warning)
+ * export const proxy = createSupabaseAuthMiddleware({
+ *   publicRoutes: ['/api/list-plans'],
+ * });
+ *
+ * export const config = {
+ *   matcher: ['/api/:path*'],
+ * };
+ * ```
+ *
+ * **File Location Notes:**
+ * - **Next.js 15**: Place `middleware.ts` at project root
+ * - **Next.js 16 without `src/` folder**: Place `middleware.ts` or `proxy.ts` at project root
+ * - **Next.js 16 with `src/` folder**: Place `src/proxy.ts` or `src/middleware.ts` (in `src/` folder, not root)
+ *
+ * **Note:** Next.js 16 renamed "middleware" to "proxy". You can export the return value as either
+ * `middleware` or `proxy` - both work, but `proxy` is recommended to avoid deprecation warnings.
  */
 declare function createSupabaseAuthMiddleware(options?: SupabaseAuthMiddlewareOptions): (request: NextRequest) => Promise<NextResponse<unknown>>;
 

package/dist/index.d.ts

@@ -194,10 +194,11 @@ interface AuthMiddlewareOptions {
  * 4. Returns appropriate error responses for auth failures
  *
  * @param options - Configuration options
- * @returns Next.js middleware function
+ * @returns Next.js middleware function (can be exported as `middleware` or `proxy`)
  *
- * @example
+ * @example Next.js 15
  * ```typescript
+ * // middleware.ts (at project root)
  * import { createAuthMiddleware } from '@solvapay/next';
  * import { SupabaseAuthAdapter } from '@solvapay/auth/supabase';
  *
@@ -215,6 +216,27 @@ interface AuthMiddlewareOptions {
  * };
  * ```
  *
+ * @example Next.js 16 with src/ folder
+ * ```typescript
+ * // src/proxy.ts (in src/ folder, not project root)
+ * import { createAuthMiddleware } from '@solvapay/next';
+ * import { SupabaseAuthAdapter } from '@solvapay/auth/supabase';
+ *
+ * const adapter = new SupabaseAuthAdapter({
+ *   jwtSecret: process.env.SUPABASE_JWT_SECRET!,
+ * });
+ *
+ * // Use 'proxy' export for Next.js 16 (no deprecation warning)
+ * export const proxy = createAuthMiddleware({
+ *   adapter,
+ *   publicRoutes: ['/api/list-plans'],
+ * });
+ *
+ * export const config = {
+ *   matcher: ['/api/:path*'],
+ * };
+ * ```
+ *
  * @example Custom adapter
  * ```typescript
  * import { createAuthMiddleware } from '@solvapay/next';
@@ -231,6 +253,14 @@ interface AuthMiddlewareOptions {
  *   adapter: myAdapter,
  * });
  * ```
+ *
+ * **File Location Notes:**
+ * - **Next.js 15**: Place `middleware.ts` at project root
+ * - **Next.js 16 without `src/` folder**: Place `middleware.ts` or `proxy.ts` at project root
+ * - **Next.js 16 with `src/` folder**: Place `src/proxy.ts` or `src/middleware.ts` (in `src/` folder, not root)
+ *
+ * **Note:** Next.js 16 renamed "middleware" to "proxy". You can export the return value as either
+ * `middleware` or `proxy` - both work, but `proxy` is recommended to avoid deprecation warnings.
  */
 declare function createAuthMiddleware(options: AuthMiddlewareOptions): (request: NextRequest) => Promise<NextResponse<unknown>>;
 /**
@@ -261,10 +291,11 @@ interface SupabaseAuthMiddlewareOptions {
  * Uses dynamic import to avoid requiring Supabase as a dependency in @solvapay/next.
  *
  * @param options - Configuration options
- * @returns Next.js middleware function
+ * @returns Next.js middleware function (can be exported as `middleware` or `proxy`)
  *
- * @example
+ * @example Next.js 15
  * ```typescript
+ * // middleware.ts (at project root)
  * import { createSupabaseAuthMiddleware } from '@solvapay/next';
  *
  * export const middleware = createSupabaseAuthMiddleware({
@@ -275,6 +306,29 @@ interface SupabaseAuthMiddlewareOptions {
  *   matcher: ['/api/:path*'],
  * };
  * ```
+ *
+ * @example Next.js 16 with src/ folder
+ * ```typescript
+ * // src/proxy.ts (in src/ folder, not project root)
+ * import { createSupabaseAuthMiddleware } from '@solvapay/next';
+ *
+ * // Use 'proxy' export for Next.js 16 (no deprecation warning)
+ * export const proxy = createSupabaseAuthMiddleware({
+ *   publicRoutes: ['/api/list-plans'],
+ * });
+ *
+ * export const config = {
+ *   matcher: ['/api/:path*'],
+ * };
+ * ```
+ *
+ * **File Location Notes:**
+ * - **Next.js 15**: Place `middleware.ts` at project root
+ * - **Next.js 16 without `src/` folder**: Place `middleware.ts` or `proxy.ts` at project root
+ * - **Next.js 16 with `src/` folder**: Place `src/proxy.ts` or `src/middleware.ts` (in `src/` folder, not root)
+ *
+ * **Note:** Next.js 16 renamed "middleware" to "proxy". You can export the return value as either
+ * `middleware` or `proxy` - both work, but `proxy` is recommended to avoid deprecation warnings.
  */
 declare function createSupabaseAuthMiddleware(options?: SupabaseAuthMiddlewareOptions): (request: NextRequest) => Promise<NextResponse<unknown>>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solvapay/next",
-  "version": "1.0.0-preview.10",
+  "version": "1.0.0-preview.11",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -29,9 +29,9 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@solvapay/auth": "1.0.0-preview.10",
-    "@solvapay/core": "1.0.0-preview.10",
-    "@solvapay/server": "1.0.0-preview.10"
+    "@solvapay/auth": "1.0.0-preview.11",
+    "@solvapay/core": "1.0.0-preview.11",
+    "@solvapay/server": "1.0.0-preview.11"
   },
   "peerDependencies": {
     "next": ">=13.0.0"