How to send a custom response

Important

This feature is only applicable for users who build their own frontend since our frontend requires on a specific output from the APIs as defined here.

Let's take an example of sending a custom response for the /auth/emailpassword/email/exists GET API (does email exist).

We need to first override the function for that API (emailExistsGET) and then use the response object in the input param to send a custom response.

The function signature expects an return type that has a certain shape, therefore, we must still return a valid response object from the function, but that will be ignored since you have already sent a response to the client.

import SuperTokens from "supertokens-node";
import EmailPassword from "supertokens-node/recipe/emailpassword";
import Session from "supertokens-node/recipe/session";

SuperTokens.init({
    appInfo: {
        apiDomain: "...",
        appName: "...",
        websiteDomain: "..."
    },
    supertokens: {
        connectionURI: "...",
    },
    recipeList: [
        Session.init({
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,

                        // here we are only overriding the function that signs out a user
                        signOutPOST: async function (input) {

                            if (originalImplementation.signOutPOST === undefined) {
                                throw Error("Should never come here")
                            }
                            // TODO: some custom logic

                            // or call the default behaviour as show below
                            return await originalImplementation.signOutPOST(input);
                        },
                        // ...
                        // TODO: override more apis
                    }
                }
            }
        }),
        EmailPassword.init({
            override: {
                apis: (originalImplementation) => {
                    return {
                        ...originalImplementation,
                        emailExistsGET: async function (input) {

                            // we can send a custom response like this:
                            input.options.res.setStatusCode(200); // or any other status code
                            input.options.res.sendJSONResponse({
                                message: "my custom response",
                                //...
                            })

                            // this return doesn't matter. But we must do it
                            // cause the function signature expects a response.
                            return {
                                status: "OK",
                                exists: false
                            };
                        }
                    }
                }
            }
        })
    ]
});