Svelte Kit SuperTokens

Hello! This is my attempt at providing an example of how to use Svelte Kit (an amazing tool for building SSR web applications in Svelte) with SuperTokens (an open source alternative to user authentication). Note that this repository uses the EmailPassword/Passwordless/ThirdParty recipes/approaches from SuperTokens for its examples. However, the code here should be easily transferrable to the other authentication repices/methods that SuperTokens provides.

The solution here is based on my work done in the Remix version of this app, but it has been modified to be more accustomed to Svelte Kit. Note that this application takes an SSR-only approach for three reasons: 1) Better security (big plus), 2) Guaranteed progressive enhancement (also a big plus), and 3) Easier code management (arguably).

If there are any questions, concerns, or ideas for improvement, feel free to reach out to me in the SuperTokens Discord or the Svelte Discord. (Technically either one works. But if your question is more oriented towards SuperTokens, you should probably ping me on the SuperTokens Discord.) If you notice any problems with the example application, feel free to open an issue here on GitHub.

How to Run the App

Start the dev server by running npm run dev. Remember to add your own .env file to configure SuperTokens! You will need to configure:

• DOMAIN (e.g., http://localhost:5173)
• SUPERTOKENS_CONNECTION_URI (e.g., https://try.supertokens.com)
• SUPERTOKENS_API_KEY (optional if your SUPERTOKENS_CONNECTION_URI is https://try.supertokens.com)
• SUPERTOKENS_WEBSITE_DOMAIN (e.g., http://localhost:5173)
• SUPERTOKENS_API_DOMAIN (e.g., http://localhost:5173)
• SUPERTOKENS_API_BASE_PATH (e.g., /auth)

Note that you will need to configure additional environment variables for testing the ThirdParty login feature. (See the usage of SuperTokens.init() in this project.)

Using Other Authentication Methods

By default, the application uses the EmailPassword recipe provided by SuperTokens for logging in. If you click the Login button, you will be directed to the EmailPassword login page (/login). If you logout, you will be redirected to that page. If you lack valid credentials and attempt to visit a protected route, you will again be redirected to that page.

To authenticate using the Passwordless recipe provided by SuperTokens, you will need to navigate to /passwordless/login instead of /login. Once you login from the Passwordless page, the rest of the user experience behaves the same (e.g., visiting protected routes, refreshing your auth session, logging out, etc.). If you prefer Passwordless authentication, feel free to change all of the links/redirects from /login to /passwordless/login. (I know that sounds tedious. In the future, I might create an ENV var that lets you toggle this behavior instead.)

Similar to above, you will need to visit /thirdparty/login to authenticate using the ThirdParty recipe provided by SuperTokens. Below are some links that can help you get started with different OAuth Providers.

• SuperTokens Custom Provider Docs
• GitHub
  • https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps
  • https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app
  • https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps
  • https://github.com/logos
• Planning Center
  • https://developer.planning.center/docs/#/overview/
  • https://developer.planning.center/docs/#/overview/authentication
  • https://developer.planning.center/docs/#/apps/people/2024-09-12/vertices/email
  • https://www.planningcenter.com/logos

Be careful to adhere to the guidelines of your OAuth Providers if you are using their logos on your site.

If you have specific questions about how the Passwordless recipe works, you might be helped by visiting the Q&A exchange between some of the developers. For questions about the ThirdParty recipe, visit the discussion here.

What Code Do I Actually Need?

• If you're using the EmailPassword recipe, then you don't need the passwordless/login/ page or the thirdparty/login/ page (or their dependencies).
• If you're using the Passwordless recipe, then you don't need the login/, reset-password/, and thirdparty/login/ pages (or their dependencies).
• If you're using the ThirdParty recipe, then you don't need the login/, reset-password/, and passwordless/login/ pages (or their dependencies).

Obviously, you can decide how much you care about the (S)CSS files. Beyond that, the rest of the code in the codebase should always be relevant for you. The (very few) parts that aren't should be obvious.

Gotchas

Account Linking

Account Linking is not supported by this example project (yet). Consequently, if you login to the application with 2 different methods (e.g., Passwordless and ThirdParty) which both use the same User Email, then you should expect 2 separate accounts to be created. These accounts will not be merged. Ideally, most users of your application will only use one method for authentication; so this shouldn't be a significant problem.

If the idea of creating 2 separate accounts with the same email concerns you, then you can require your users to use only one login method. To help you accomplish this, you can use SuperTokens.listUsersByAccountInfo to check for existing accounts related to a user. (For example, you can list all accounts having an email that you specify.) You can check this account data to ensure that users logging into your application only authenticate with the method which they originally used to sign up. Below is an example of how you could handle this.

// This function assumes that `EmailPassword`, `Passwordless`, AND `ThirdParty` are all used in the same app.
async function verifyAuthMethod(request: Request): boolean {
  // Note: If you have already read the `FormData`, then you should pass it to this function as a separate argument.
  const formData = await request.formData();
  const { searchParams } = new URL(request.url);

  // For `Passwordless`/`EmailPassword`, you can get the email from your form data.
  // For `ThirdParty`, use `provider.getUserInfo()` to get the email AFTER your user is redirected to your app.
  let email = formData.get("email");

  // Check URL for a Provider ID in case user is coming back from a Provider Redirect (`ThirdParty` only)
  if (!email) {
    const providerId = searchParams.get("provider") ?? "";
    // Note: If necessary, pass a valid `clientType` instead of `undefined`
    const provider = await ThirdParty.getProvider(tenantId, providerId, undefined);

    if (provider) {
      const oAuthTokens = await provider.exchangeAuthCodeForOAuthTokens(/* ... Provide any data needed here ... */);
      const userInfoFromProvider = await provider.getUserInfo({ oAuthTokens });
      email = userInfoFromProvider.email.id;
    }
  }

  // If your application logic is correct, this array should always be length `0` or `1`
  const [user] = await SuperTokens.listUsersByAccountInfo(tenantId, { email });

  // This is an entirely new account. Someone is signing up for the first time.
  if (!user) return true;

  // For `EmailPassword`/`Passwordless`, you can get this from a hidden input in your form.
  // For `ThirdParty`, you need to use something else (like a Query Parameter) when the user is redirected to your app.
  const recipeId = formData.get("recipeId") ?? searchParams.get("recipeId");

  // Again, if your application logic is correct, this array should always be length `0` or `1`
  const [currentLoginMethod] = user.loginMethods;
  return currentLoginMethod.recipeId === recipeId;
}

You can add to (or subtract from) the above logic according to your needs.

Note that Account Linking is a paid feature in SuperTokens. Consequently, you should expect to be charged if you run tests locally with Account Linking enabled.

Unexpected Behaviors with SvelteKit's Form Actions

Unlike Remix, SvelteKit behaves unusually when a form leveraging the use:enhance DOM Action POSTs to a regular endpoint (instead of an endpoint for a Form Action). If you end up encountering errors because of this behavior, you should upvote this GitHub issue to increase its priority. As far as this example project is concerned, this unexpected behavior can be encountered if all of the following conditions are met:

• The user has JavaScript enabled on the page
• The user's access token and refresh token are both expired
• The user tries to POST to a regular endpoint by submitting a <form> that uses enhance on a protected route

Frequently Asked Questions

Why Aren't You Using supertokens-website or supertokens-web-js?

Depending too much on supertokens-website or supertokens-web-js will result in an application that cannot run without JavaScript. And an application that can't run without JavaScript is actually inaccessible to a lot of users. Consequently, we've pursued a solution that works without these pacakages and without JavaScript. (Don't worry! We still enhance the app with JS to improve the user's experience whenever possible.) This means that our application will be accessible to the broadest range of users! :smile:

As an added bonus, we decrease our JS bundle size significantly when we avoid the use of supertokens-website and especially supertokens-web-js.

Why Aren't You Using the Middleware from supertokens-node?

If you've seen the comments from @Rich-Harris (creator of Svelte) regarding server middleware (e.g., Express Middleware), then you'll know that solutions which require you to use middleware are often restricted and will prevent you from enhancing your application with other very important features. This is especially true if you're working with an SSR framework. Unfortunately, I have found Rich Harris's statements to be correct while working with my own Svelte Kit application. There are workarounds for these problem cases that allow people to still use middleware... but those aggressive workarounds often end up looking more ugly and complicated. (And thus, such approaches are more prone to error).

Avoiding the supertokens-node middleware ended up being required for me to use HTTPS in my application and get it working with high security in Cloudflare. I'll spare you the details, but there are other edge cases like these where supertokens-node middleware just won't work (or won't work well). Thankfully, in supertokens-node@14, the SuperTokens team was kind enough to introduce functions that allow you to get authentication working without using their custom middleware. If you're using any kind of SSR framework that leverages progressive enhancement (SvelteKit, Remix, SolidStart, etc.), then you'll want to leverage these functions instead of using the middleware as well.

Why Are You Using JSDocs Instead of TypeScript in Some Svelte Files?

Unfortunately, unlike Vue, Svelte does not support TypeScript type annotations in its markup (at the time of this writing). This is due to a limitation in how Svelte files are processed. However, you can use types in Svelte's markup if you use JSDocs (because JSDocs don't have to be processed by Svelte). Consequently, we use JSDocs in the Svelte files where we deemed in-markup TS types to make the code more readable.

You're free to change these files to use TypeScript if you like. However, you'll need to move all code requiring TS type annotations into the <script> section of your Svelte files.

Can I Use Multiple Authentication Methods on the Same Page?

Absolutely! This project puts the different authentication methods on different pages. But that is only done to make the server logic on each individual page smaller. You are more than welcome to combine multiple authentication methods on a single page. For example, you could merge the EmailPassword Login Page with the ThirdParty Login Page. All you need to do is combine the UI Markup and the Server Logic as needed.

Security Insights

Although the middleware-free approach gives us many advantages when it comes to using SuperTokens with SSR frameworks, it also gives us a little more responsibility. You'll notice in this app that we have to be intentional about the settings which we use for our HTTP cookies. You don't necessarily need to use the settings in this project (though you should use HttpOnly and you should set a strict Path), but you should certainly ensure that your settings are the safest that they can be for your application. Here are some resources that may be helpful for you on the matter:

• How the Set-Cookie HTTP Header Works
• Docs for the cookie NPM package (Svelte Kit uses this under the hood to set the options for its cookies)

Note that Svelte Kit provides some CSRF protection out of the box. (See sveltejs/kit#72 and sveltejs/kit#6510.) If you're interested in doing anything more, consider the following resources:

• Cross-Site Request Forgery Prevention Cheat Sheet

SuperTokens does have some anti-CSRF features, but there are cases where it should be used and cases where it need not be used. From @rishabhpoddar:

Basically, when you call createNewSessionWithoutRequestResponse, and if you get an anti csrf token, then you should pass that in when using getSessionWithoutRequestResponse. If you do not get an anti csrf token, you don't need it (based on your apiDomain and websiteDomain setting) and should check for custom request header before calling getSessionWithoutRequestResponse. You should not explicitly set the value of disableAntiCsrf when calling createNewSession unless you are not using cookies at all.

Bear in mind that if you're using a framework that (sufficiently) protects against CSRF by default, then you don't necessarily need to worry about the custom headers yourself.

I hope you find this useful! Let me know your thoughts here on GitHub or on the SuperTokens Discord. :) If there are any ways that I can improve anything here, feel free to say so.

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

npm run build