@stackframe/stack 2.3.2 → 2.3.4

package/README.md

@@ -0,0 +1,29 @@
+# Stack
+
+Stack is an open-source, self-hostable, and highly customizable authentication and user management system.
+
+We provide frontend and backend libraries for Next.js, React, and JavaScript. You can set it up in one minute and scale with the project as it grows. Think of it as Supabase Auth or next-auth, but better.
+
+## Features
+
+- Composable React components & hooks
+- OAuth (Google, Facebook, GitHub, etc.)
+- Email and password authentication (with email verification and password reset)
+- Easy to set up with proxied providers (no need to sign up and create OAuth endpoints yourself on all the providers)
+- User management & analytics
+- User-associated metadata with client-/server-specific permissions
+- Out-of-the-box Dark/Light mode support
+- suports switching out the underlying UI library, support MUI Joy out of the box
+- **100% open-source!**
+
+Currently, only Next.js is supported, but we are working on adding other frameworks.
+
+## Installation
+
+To get started with Stack, you need to [create a Next.js project](https://nextjs.org/docs/getting-started/installation) using the App router. Then, you can install Stack by running the following command:
+
+```bash
+npm install @stackframe/stack
+```
+
+For setup, refer to [our documentation](https://docs.stack-auth.com).

package/dist/lib/stack-app.d.ts

@@ -108,6 +108,7 @@ export type Project = {
         readonly id: string;
         readonly allowLocalhost: boolean;
         readonly credentialEnabled: boolean;
+        readonly magicLinkEnabled: boolean;
         readonly oauthProviders: OAuthProviderConfig[];
         readonly emailConfig?: EmailConfig;
         readonly domains: DomainConfig[];

package/dist/lib/stack-app.js

@@ -36,10 +36,10 @@ function getUrls(partial) {
     };
 }
 function getDefaultProjectId() {
-    return process.env.NEXT_PUBLIC_STACK_PROJECT_ID || throwErr("No project ID provided. Please copy your project ID from the Stack dashboard and put it in the NEXT_PUBLIC_STACK_PROJECT_ID environment variable.");
+    return process.env.NEXT_PUBLIC_STACK_PROJECT_ID || throwErr("Welcome to Stack! It seems that you haven't provided a project ID. Please create a project on the Stack dashboard at https://app.stack-auth.com and put it in the NEXT_PUBLIC_STACK_PROJECT_ID environment variable.");
 }
 function getDefaultPublishableClientKey() {
-    return process.env.NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY || throwErr("No publishable client key provided. Please copy your publishable client key from the Stack dashboard and put it in the NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY environment variable.");
+    return process.env.NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY || throwErr("Welcome to Stack! It seems that you haven't provided a publishable client key. Please create an API key for your project on the Stack dashboard at https://app.stack-auth.com and copy your publishable client key into the NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY environment variable.");
 }
 function getDefaultSecretServerKey() {
     return process.env.STACK_SECRET_SERVER_KEY || throwErr("No secret server key provided. Please copy your publishable client key from the Stack dashboard and put your it in the STACK_SECRET_SERVER_KEY environment variable.");
@@ -323,6 +323,7 @@ class _StackClientAppImpl {
             evaluatedConfig: {
                 id: data.evaluatedConfig.id,
                 credentialEnabled: data.evaluatedConfig.credentialEnabled,
+                magicLinkEnabled: data.evaluatedConfig.magicLinkEnabled,
                 allowLocalhost: data.evaluatedConfig.allowLocalhost,
                 oauthProviders: data.evaluatedConfig.oauthProviders,
                 emailConfig: data.evaluatedConfig.emailConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackframe/stack",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "type": "module",
   "exports": {
     ".": {
@@ -12,6 +12,7 @@
       "default": "./dist/joy.js"
     }
   },
+  "homepage": "https://stack-auth.com",
   "files": [
     "README.md",
     "dist"
@@ -34,7 +35,7 @@
     "tailwindcss-scoped-preflight": "^2.1.0",
     "yup": "^1.4.0",
     "@stackframe/stack-sc": "1.4.1",
-    "@stackframe/stack-shared": "2.3.1"
+    "@stackframe/stack-shared": "2.3.2"
   },
   "peerDependencies": {
     "@mui/joy": "^5.0.0-beta.30",