feat: deprecation notice in readme and index.ts

Author: mandarini

README.md

@@ -1,8 +1,28 @@
 # Supabase clients for use in SSR frameworks
+>
+> **Package Consolidation Notice**: This package replaces the deprecated `@supabase/auth-helpers-*` packages. All framework-specific auth-helpers packages have been consolidated into `@supabase/ssr` for better maintenance and consistency.
 
-This package is useful for using the [Supabase JavaScript library](https://supabase.com/docs/reference/javascript/introduction) in
-server-side rendering frameworks.
+## Overview
 
-It provides a framework-agnostic way of creating a Supabase client.
+This package provides a framework-agnostic way to use the [Supabase JavaScript library](https://supabase.com/docs/reference/javascript/introduction) in server-side rendering (SSR) frameworks.
+
+## Installation
+
+```bash
+npm install @supabase/ssr @supabase/supabase-js
+```
+
+## Deprecated Packages
+
+The following packages have been deprecated and consolidated into `@supabase/ssr`:
+
+- `@supabase/auth-helpers-nextjs` → Use `@supabase/ssr`
+- `@supabase/auth-helpers-react` → Use `@supabase/ssr`
+- `@supabase/auth-helpers-remix` → Use `@supabase/ssr`
+- `@supabase/auth-helpers-sveltekit` → Use `@supabase/ssr`
+
+If you're currently using any of these packages, please update your dependencies to use `@supabase/ssr` directly.
+
+## Documentation
 
 Please refer to the [official server-side rendering guides](https://supabase.com/docs/guides/auth/server-side) for the latest best practices on using this package in your SSR framework of choice.

package-lock.json

@@ -34,6 +34,7 @@
   "devDependencies": {
     "@eslint/js": "^9.3.0",
     "@supabase/supabase-js": "^2.43.4",
+    "@types/node": "^24.3.0",
     "@vitest/coverage-v8": "^1.6.0",
     "eslint": "^8.57.0",
     "prettier": "^3.2.5",

package.json

@@ -1,3 +1,36 @@
+// Check if this package is being used as one of the deprecated auth-helpers packages
+if (typeof process !== 'undefined' && process.env?.npm_package_name) {
+  const packageName = process.env.npm_package_name;
+  const deprecatedPackages = [
+    '@supabase/auth-helpers-nextjs',
+    '@supabase/auth-helpers-react',
+    '@supabase/auth-helpers-remix',
+    '@supabase/auth-helpers-sveltekit'
+  ];
+  
+  if (deprecatedPackages.includes(packageName)) {
+    console.warn(`
+╔════════════════════════════════════════════════════════════════════════════╗
+║ ⚠️  IMPORTANT: Package Consolidation Notice                                ║
+║                                                                            ║
+║ The ${packageName.padEnd(35)} package name is deprecated.  ║
+║                                                                            ║
+║ You are now using @supabase/ssr - a unified solution for all frameworks.  ║
+║                                                                            ║
+║ The auth-helpers packages have been consolidated into @supabase/ssr       ║
+║ to provide better maintenance and consistent APIs across frameworks.      ║
+║                                                                            ║
+║ Please update your package.json to use @supabase/ssr directly:            ║
+║   npm uninstall ${packageName.padEnd(42)} ║
+║   npm install @supabase/ssr                                               ║
+║                                                                            ║
+║ For more information, visit:                                              ║
+║ https://supabase.com/docs/guides/auth/server-side                         ║
+╚════════════════════════════════════════════════════════════════════════════╝
+    `);
+  }
+}
+
 export * from "./createBrowserClient";
 export * from "./createServerClient";
 export * from "./types";