docs: update examples

supertokens · Sep 15, 2023 · cabf84f · cabf84f
1 parent 60dd12d
commit cabf84f
Show file tree

Hide file tree

Showing 24 changed files with 137 additions and 62 deletions.
diff --git a/examples/with-account-linking/backend/config.ts b/examples/with-account-linking/backend/config.ts
@@ -23,7 +23,7 @@ export function getWebsiteDomain() {
 export const SuperTokensConfig: TypeInput = {
     supertokens: {
         // this is the location of the SuperTokens core.
-        connectionURI: "http://localhost:3567",
+        connectionURI: "https://try.supertokens.com",
     },
     appInfo: {
         appName: "SuperTokens Demo App",

diff --git a/examples/with-emailpassword-vercel/test/basic.test.js b/examples/with-emailpassword-vercel/test/basic.test.js
@@ -90,7 +90,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await submitForm(page);
 

diff --git a/examples/with-emailverification-then-password-thirdpartyemailpassword/api-server.js b/examples/with-emailverification-then-password-thirdpartyemailpassword/api-server.js
@@ -74,7 +74,9 @@ supertokens.init({
                                 };
                             }
                             const res = await oI.emailPasswordSignInPOST(input);
-                            await res.session.setClaimValue(RealPasswordClaim, true, input.userContext);
+                            if (res.status === "OK") {
+                                await res.session.setClaimValue(RealPasswordClaim, true, input.userContext);
+                            }
                             return res;
                         },
                         emailPasswordSignUpPOST: async function (input) {
@@ -101,34 +103,42 @@ supertokens.init({
                                     if (signInResponse.status === "WRONG_CREDENTIALS_ERROR") {
                                         return response;
                                     } else {
-                                        await EmailVerification.unverifyEmail(signInResponse.user.id, email);
+                                        await EmailVerification.unverifyEmail(signInResponse.recipeUserId, email);
                                         response = {
                                             status: "OK",
                                             user: signInResponse.user,
+                                            recipeUserId: signInResponse.recipeUserId,
                                         };
                                     }
                                 }
                                 let user = response.user;
 
                                 // we have just created a user with the fake password.
                                 // so we mark their session as unusable by the APIs
-                                await Session.createNewSession(
+                                const newSession = await Session.createNewSession(
                                     input.options.req,
                                     input.options.res,
                                     input.tenantId,
-                                    user.id,
+                                    response.recipeUserId,
                                     {
-                                        ...RealPasswordClaim.build(user.id, input.tenantId, input.userContext),
+                                        ...RealPasswordClaim.build(
+                                            user.id,
+                                            response.recipeUserId,
+                                            input.tenantId,
+                                            input.userContext
+                                        ),
                                     },
                                     {}
                                 );
                                 return {
+                                    ...response,
                                     status: "OK",
                                     user,
+                                    session: newSession,
                                 };
                             } else {
                                 // session exists.. so the user is trying to change their password now
-                                let userId = session.getUserId();
+                                let recipeUserId = session.getRecipeUserId();
                                 let password = input.formFields.filter((f) => f.id === "password")[0].value;
 
                                 if (password === FAKE_PASSWORD) {
@@ -137,16 +147,18 @@ supertokens.init({
 
                                 // now we modify the user's password to the new password + change the session to set RealPasswordClaim to true
                                 await ThirdPartyEmailPassword.updateEmailOrPassword({
-                                    userId,
+                                    recipeUserId,
                                     password,
                                 });
 
                                 await session.setClaimValue(RealPasswordClaim, true);
 
-                                let user = await ThirdPartyEmailPassword.getUserById(userId);
+                                let user = await supertokens.getUser(recipeUserId.getAsString());
                                 return {
                                     status: "OK",
                                     user,
+                                    recipeUserId,
+                                    session,
                                 };
                             }
                         },

diff --git a/examples/with-emailverification-then-password-thirdpartyemailpassword/test/basic.test.js b/examples/with-emailverification-then-password-thirdpartyemailpassword/test/basic.test.js
@@ -84,7 +84,11 @@ describe("SuperTokens Example Basic tests", function () {
             const userId = await page.evaluate(() => window.__supertokensSessionRecipe.getUserId());
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await submitForm(page);
 

diff --git a/examples/with-emailverification-with-otp/api-server/server.ts b/examples/with-emailverification-with-otp/api-server/server.ts
@@ -22,7 +22,7 @@ supertokens.init({
     framework: "express",
     supertokens: {
         // TODO: This is a core hosted for demo purposes. You can use this, but make sure to change it to your core instance URI eventually.
-        connectionURI: "https://try.supertokens.io",
+        connectionURI: "https://try.supertokens.com",
         apiKey: "<REQUIRED FOR MANAGED SERVICE, ELSE YOU CAN REMOVE THIS FIELD>",
     },
     appInfo: {

diff --git a/examples/with-hasura-thirdpartyemailpassword/api-server.js b/examples/with-hasura-thirdpartyemailpassword/api-server.js
@@ -89,12 +89,12 @@ supertokens.init({
                     return {
                         ...oI,
                         createNewSession: async function (input) {
-                            let userInfo = await ThirdPartyEmailPassword.getUserById(input.userId);
+                            let userInfo = await supertokens.getUser(input.userId);
 
                             input.accessTokenPayload = {
                                 ...input.accessTokenPayload,
                                 "https://hasura.io/jwt/claims": {
-                                    "x-hasura-user-id": userInfo.email,
+                                    "x-hasura-user-id": userInfo.emails[0],
                                     "x-hasura-default-role": "user",
                                     "x-hasura-allowed-roles": ["user"],
                                 },

diff --git a/examples/with-i18next/test/basic.test.js b/examples/with-i18next/test/basic.test.js
@@ -97,7 +97,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
 
             await submitForm(page);

diff --git a/examples/with-localstorage/test/basic.test.js b/examples/with-localstorage/test/basic.test.js
@@ -90,7 +90,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await submitForm(page);
 

diff --git a/examples/with-multiple-email-sign-in/api-server/epOverride.ts b/examples/with-multiple-email-sign-in/api-server/epOverride.ts
@@ -1,29 +1,27 @@
-import { RecipeInterface } from "supertokens-node/recipe/emailpassword";
+import { APIInterface } from "supertokens-node/recipe/emailpassword";
 import { getPrimaryEmailFromInputEmail } from "./emailLinkingMap";
 
-export function epOverride(oI: RecipeInterface): RecipeInterface {
+export function epOverride(oI: APIInterface): APIInterface {
     return {
         ...oI,
-        signIn: async function (input) {
-            let primaryEmail = getPrimaryEmailFromInputEmail(input.email);
-            if (primaryEmail !== undefined) {
-                input.email = primaryEmail;
-            }
-            return oI.signIn(input);
-        },
-        signUp: async function (input) {
-            let primaryEmail = getPrimaryEmailFromInputEmail(input.email);
+        signInPOST: async function (input) {
+            const emailField = input.formFields.find((f) => f.id === "email")!;
+
+            let primaryEmail = getPrimaryEmailFromInputEmail(emailField.value);
             if (primaryEmail !== undefined) {
-                input.email = primaryEmail;
+                emailField.value = primaryEmail;
             }
-            return oI.signUp(input);
+            return oI.signInPOST!(input);
         },
-        getUserByEmail: async function (input) {
-            let primaryEmail = getPrimaryEmailFromInputEmail(input.email);
+        signUpPOST: async function (input) {
+            const emailField = input.formFields.find((f) => f.id === "email")!;
+
+            let primaryEmail = getPrimaryEmailFromInputEmail(emailField.value);
             if (primaryEmail !== undefined) {
-                input.email = primaryEmail;
+                emailField.value = primaryEmail;
             }
-            return oI.getUserByEmail(input);
+
+            return oI.signUpPOST!(input);
         },
     };
 }
diff --git a/examples/with-multiple-email-sign-in/api-server/index.ts b/examples/with-multiple-email-sign-in/api-server/index.ts
@@ -53,7 +53,7 @@ supertokens.init({
         }),
         EmailPassword.init({
             override: {
-                functions: (oI) => epOverride(oI),
+                apis: (oI) => epOverride(oI),
             },
         }),
         Session.init(),
@@ -79,7 +79,7 @@ app.use(middleware());
 app.post("/add-email", verifySession(), async (req: SessionRequest, res) => {
     let userId = req.session!.getUserId();
     let emailToAdd = req.body.email;
-    let success = associateNewEmailWithPrimaryEmail(emailToAdd, (await EmailPassword.getUserById(userId))!.email);
+    let success = associateNewEmailWithPrimaryEmail(emailToAdd, (await supertokens.getUser(userId))!.emails[0]);
     res.send({
         status: success ? "OK" : "INPUT_EMAIL_ASSOCIATED_WITH_ANOTHER_USER",
     });

diff --git a/examples/with-multiple-email-sign-in/test/basic.test.js b/examples/with-multiple-email-sign-in/test/basic.test.js
@@ -90,7 +90,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await waitForSTElement(page, "[data-supertokens='button']");
             await submitForm(page);
@@ -121,7 +125,11 @@ describe("SuperTokens Example Basic tests", function () {
             await submitForm(page);
             // Redirected to email verification screen
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
-            const tokenInfo2 = await EmailVerification.createEmailVerificationToken("public", userId, email2);
+            const tokenInfo2 = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email2
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo2.token}`);
             await waitForSTElement(page, "[data-supertokens='button']");
             await submitForm(page);

diff --git a/examples/with-netlify/.netlify/edge-functions-import-map.json b/examples/with-netlify/.netlify/edge-functions-import-map.json
@@ -1 +1,7 @@
-{ "imports": { "netlify:edge": "https://edge.netlify.com/v1/index.ts" } }
+{
+    "imports": {
+        "@netlify/edge-functions": "https://edge.netlify.com/v1/index.ts",
+        "netlify:edge": "https://edge.netlify.com/v1/index.ts?v=legacy"
+    },
+    "scopes": {}
+}
diff --git a/examples/with-netlify/test/basic.test.js b/examples/with-netlify/test/basic.test.js
@@ -71,6 +71,7 @@ describe("SuperTokens Example Basic tests", function () {
 
     describe("Email Password test", function () {
         it("Successful signup with credentials", async function () {
+            await new Promise((res) => setTimeout(res, 1000));
             await Promise.all([page.goto(websiteDomain), page.waitForNavigation({ waitUntil: "networkidle0" })]);
 
             // redirected to /auth

diff --git a/examples/with-no-session-on-sign-up-thirdpartyemailpassword/api-server/index.js b/examples/with-no-session-on-sign-up-thirdpartyemailpassword/api-server/index.js
@@ -115,6 +115,7 @@ supertokens.init({
                                     getSessionDataFromDatabase: () => null,
                                     getTimeCreated: () => -1,
                                     getUserId: () => "",
+                                    getRecipeUserId: () => input.recipeUserId,
                                     revokeSession: () => {},
                                     updateSessionDataInDatabase: () => {},
                                     attachToRequestResponse: () => {},

diff --git a/examples/with-one-login-per-subdomain/test/basic.test.js b/examples/with-one-login-per-subdomain/test/basic.test.js
@@ -95,7 +95,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await submitForm(page);
 

diff --git a/examples/with-phone-password/api-server/index.ts b/examples/with-phone-password/api-server/index.ts
@@ -159,6 +159,7 @@ supertokens.init({
                                 // session's payload as PhoneVerifiedClaim: true so that
                                 // the user has access to API routes and the frontend UI
                                 await session.setClaimValue(PhoneVerifiedClaim, true, input.userContext);
+                                resp.user = (await supertokens.getUser(session.getUserId()))!;
                             }
 
                             return resp;
@@ -187,13 +188,18 @@ supertokens.init({
 
                                 // we also get the phone number of the user and save it in the
                                 // session so that the OTP can be sent to it directly
-                                let userInfo = await EmailPassword.getUserById(input.userId, input.userContext);
+                                let userInfo = await supertokens.getUser(input.userId, input.userContext);
                                 return originalImplementation.createNewSession({
                                     ...input,
                                     accessTokenPayload: {
                                         ...input.accessTokenPayload,
-                                        ...PhoneVerifiedClaim.build(input.userId, input.tenantId, input.userContext),
-                                        phoneNumber: userInfo?.email,
+                                        ...PhoneVerifiedClaim.build(
+                                            input.userId,
+                                            input.recipeUserId,
+                                            input.tenantId,
+                                            input.userContext
+                                        ),
+                                        phoneNumber: userInfo?.emails[0],
                                     },
                                 });
                             }

diff --git a/examples/with-phone-password/test/basic.test.js b/examples/with-phone-password/test/basic.test.js
@@ -68,9 +68,9 @@ describe("SuperTokens Example Basic tests", function () {
     const testOTP = "test123456";
 
     before(async function () {
-        const user = await EmailPassword.getUserByEmail("public", phoneNumber);
-        if (user) {
-            await SuperTokensNode.deleteUser(user.id);
+        const user = await SuperTokensNode.listUsersByAccountInfo("public", { email: phoneNumber });
+        if (user.length > 0) {
+            await SuperTokensNode.deleteUser(user[0].id);
         }
 
         browser = await puppeteer.launch({

diff --git a/examples/with-thirdpartyemailpassword-2fa-passwordless/api-server/index.ts b/examples/with-thirdpartyemailpassword-2fa-passwordless/api-server/index.ts
@@ -185,17 +185,22 @@ supertokens.init({
                                 // we alreay have a phone number associated with this user,
                                 // so we will add it to the access token payload so that
                                 // we can send an OTP to it without asking the end user.
-                                let passwordlessUserInfo = await Passwordless.getUserById({
-                                    userId: userMetadata.metadata.passwordlessUserId as string,
-                                    userContext: input.userContext,
-                                });
-                                phoneNumber = passwordlessUserInfo?.phoneNumber;
+                                let passwordlessUserInfo = await supertokens.getUser(
+                                    userMetadata.metadata.passwordlessUserId as string,
+                                    input.userContext
+                                );
+                                phoneNumber = passwordlessUserInfo?.phoneNumbers[0];
                             }
                             return originalImplementation.createNewSession({
                                 ...input,
                                 accessTokenPayload: {
                                     ...input.accessTokenPayload,
-                                    ...(await SecondFactorClaim.build(input.userId, input.tenantId, input.userContext)),
+                                    ...(await SecondFactorClaim.build(
+                                        input.userId,
+                                        input.recipeUserId,
+                                        input.tenantId,
+                                        input.userContext
+                                    )),
                                     phoneNumber,
                                 },
                             });

diff --git a/examples/with-thirdpartyemailpassword-2fa-passwordless/test/basic.test.js b/examples/with-thirdpartyemailpassword-2fa-passwordless/test/basic.test.js
@@ -139,7 +139,11 @@ describe("SuperTokens Example Basic tests", function () {
             await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']");
 
             // Create a new token and use it (we don't have access to the originally sent one)
-            const tokenInfo = await EmailVerification.createEmailVerificationToken("public", userId, email);
+            const tokenInfo = await EmailVerification.createEmailVerificationToken(
+                "public",
+                SuperTokensNode.convertToRecipeUserId(userId),
+                email
+            );
             await page.goto(`${websiteDomain}/auth/verify-email?token=${tokenInfo.token}`);
             await submitForm(page);