Merge branch 'master' into improv/remove-mysql-support

Author: bcbogdan

.github/workflows/lint.yml

@@ -9,38 +9,55 @@ on:
       - "package-lock.json"
 
 jobs:
-  # changed-files:
-  #   runs-on: ubuntu-latest
-  #   outputs:
-  #     docsContentHasChanged: ${{ steps.changed-files.outputs.doc_any_changed }}
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #
-  #     - name: Get changed files
-  #       id: changed-files
-  #       uses: tj-actions/changed-files@v46.0.3
-  #       with:
-  #         files_yaml: |
-  #           doc:
-  #             - '**.mdx'
-  #             - '**.json'
-  #             - docs/**
-  #
-  #     - name: Print changed files
-  #       run: |
-  #         echo "Changed files: ${{ steps.changed-files.outputs.all_changed_files }}"
-  #         echo "Any changed: ${{ steps.changed-files.outputs.any_changed }}"
-
   vale-lint:
-    # needs: changed-files
-    # if: needs.changed-files.outputs.docsContentHasChanged == 'true'
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
+
       - name: Install mdx2vast
         run: npm install -g mdx2vast
 
-      - uses: actions/checkout@v4
+      - name: Get changed files
+        id: changed-mdx-files
+        uses: tj-actions/changed-files@v46.0.3
+        with:
+          files: |
+            **.mdx
+            docs/**.mdx
 
-      - uses: errata-ai/vale-action@v2.1.1
+      - name: Run vale
+        uses: errata-ai/vale-action@v2.1.1
+        if: steps.changed-mdx-files.outputs.any_changed == 'true'
         with:
           files: docs
+
+  # format-code:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #
+  #     - uses: oven-sh/setup-bun@v2
+  #
+  #     - name: Install Dependencies
+  #       run: bun install
+  #
+  #     - uses: docker/setup-buildx-action@v3
+  #
+  #     - name: Get changed files
+  #       id: changed-mdx-files
+  #       uses: tj-actions/changed-files@v46.0.3
+  #       with:
+  #         files: |
+  #           **.mdx
+  #           docs/**.mdx
+  #         separator: ","
+  #
+  # - name: Print changed files
+  # if: steps.changed-mdx-files.outputs.any_changed == 'true'
+  # run: |
+  #   echo ${{ steps.changed-mdx-files.outputs.all_changed_files }}
+  #   echo ${{ steps.changed-mdx-files.outputs.any_changed }}
+
+  # - name: Check code snippets for ${{ matrix.language }}
+  #   working-directory: ./scripts/code-type-checking/${{ matrix.language }}
+  #   run: docker build -t code-check-${{ matrix.language }} .

docs/authentication/email-password/disable-signup.mdx

@@ -22,11 +22,14 @@ This can be done in two steps:
 - Update the **UI** to get rid of any sign up information
 - Change the **Backend SDK** to prevent sign up attempts
 
+
 ## Before you start
 
 This guide assumes that you already have configured your application to use **SuperTokens** for authentication.
 If you have not, please check the [Quickstart Guide](/docs/quickstart/introduction). 
 
+
+
 ## Remove the sign up UI
 
 <UIType.Switch/>

docs/deployment/self-host-supertokens.mdx

@@ -249,6 +249,10 @@ You also need to make the database listen on all the IPs of the local machine.
 Edit the `postgresql.conf` configuration file and set the value of `listen_addresses` to `0.0.0.0`.
 :::
 
+:::caution
+It is important to use the `postgresql://` scheme designator in the PostgreSQL Connection URI. Using `postgres://` will lead to a startup error.
+:::
+
 ```bash
 
 docker run \

docs/quickstart/frontend-setup.mdx

@@ -195,7 +195,7 @@ Run the following command in your terminal to install the package.
 
 <FrontendPrebuiltUITabs showMobileTab>
   <FrontendPrebuiltUITabs.TabItem value="reactjs">
-    In order for the **pre-built UI** to be rendered inside your application, will will have to specify which routes will show the authentication components.
+    In order for the **pre-built UI** to be rendered inside your application, you will have to specify which routes will show the authentication components.
     The **React SDK** uses [**React Router**](https://reactrouter.com/en/main) under the hood to achieve this.
     Based on whether you already use this package or not in your project, there are two different ways of configuring the routes.
 

scripts/format-code-blocks.ts

@@ -47,7 +47,7 @@ type CodeBlock = {
       console.log(`Writing file`);
       await writeCodeBlocks(fullFilePath, codeBlocks);
     }
-    // await stopContainer();
+    await stopContainer();
   } catch (error) {
     console.error(error);
   }
@@ -59,22 +59,27 @@ async function formatCodeBlock(codeBlocks: CodeBlock[]) {
   const snippetLocalPath = "./tmp/code-snippet";
   const snippetContainerPath = "/tmp/code-snippet";
   for (const codeBlock of codeBlocks) {
-    const parsedCodeBlockValue = codeBlock.language === "go" ? `package main\n\n${codeBlock.value}` : codeBlock.value;
-    await write(snippetLocalPath, parsedCodeBlockValue);
-    execSync(`docker cp ${snippetLocalPath} ${DOCKER_CONTAINER_NAME}:${snippetContainerPath}`);
-    if (codeBlock.language === "go") {
-      execSync(`docker exec ${DOCKER_CONTAINER_NAME} gofmt ${snippetContainerPath}`);
-    } else if (codeBlock.language === "python") {
-      execSync(`docker exec ${DOCKER_CONTAINER_NAME} black ${snippetContainerPath} > /dev/null`);
-    } else if (codeBlock.language === "typescript") {
-      execSync(`docker exec ${DOCKER_CONTAINER_NAME} prettier --parser typescript --write ${snippetContainerPath}`);
-    }
+    try {
+      const parsedCodeBlockValue = codeBlock.language === "go" ? `package main\n\n${codeBlock.value}` : codeBlock.value;
+      await write(snippetLocalPath, parsedCodeBlockValue);
+      execSync(`docker cp ${snippetLocalPath} ${DOCKER_CONTAINER_NAME}:${snippetContainerPath}`);
+      if (codeBlock.language === "go") {
+        execSync(`docker exec ${DOCKER_CONTAINER_NAME} gofmt ${snippetContainerPath}`);
+      } else if (codeBlock.language === "python") {
+        execSync(`docker exec ${DOCKER_CONTAINER_NAME} black ${snippetContainerPath} > /dev/null`);
+      } else if (codeBlock.language === "typescript") {
+        execSync(`docker exec ${DOCKER_CONTAINER_NAME} prettier --parser typescript --write ${snippetContainerPath}`);
+      }
 
-    execSync(`docker cp ${DOCKER_CONTAINER_NAME}:${snippetContainerPath} ${snippetLocalPath}`);
-    let formattedCodeBlock = await file(snippetLocalPath).text();
-    formattedCodeBlock =
-      codeBlock.language === "go" ? formattedCodeBlock.replace("package main\n\n", "") : formattedCodeBlock;
-    codeBlock.value = formattedCodeBlock;
+      execSync(`docker cp ${DOCKER_CONTAINER_NAME}:${snippetContainerPath} ${snippetLocalPath}`);
+      let formattedCodeBlock = await file(snippetLocalPath).text();
+      formattedCodeBlock =
+        codeBlock.language === "go" ? formattedCodeBlock.replace("package main\n\n", "") : formattedCodeBlock;
+      codeBlock.value = formattedCodeBlock;
+    } catch (error) {
+      console.error(`Error formatting code block in ${codeBlock.filePath} ${codeBlock.language}`);
+      console.error(error);
+    }
   }
 }
 

src/lib/amplitude.ts

@@ -9,7 +9,7 @@ export const initAmplitude = () => {
     return;
   }
   const sessionReplayTracking = sessionReplayPlugin({
-    sampleRate: 1,
+    sampleRate: 0.3,
   });
   amplitude.add(sessionReplayTracking);
   amplitude.init("b61f581fe0775f56038a6264af879aa9", {

src/plugins/generateLllmsFullTxt.ts

@@ -1,4 +1,5 @@
 import fs from "fs";
+import type { OpenAPIV3 } from "@scalar/openapi-types";
 import path from "path";
 import matter from "gray-matter";
 import { getAllMdxFiles } from "./utils/getAllMdxFiles";
@@ -153,7 +154,7 @@ function removeReferences(content: string): string {
   return lines.join("\n").trim();
 }
 
-async function parseMdxContent(filePath: string): Promise<string> {
+async function parseMdxContent(filePath: string, usePageTitle = false): Promise<string> {
   const mdxContent = await fs.promises.readFile(filePath, "utf8");
   const { content } = matter(mdxContent);
   const imports: Array<{ name: string; module: string }> = await extractImportStatements(content);
@@ -223,8 +224,8 @@ async function parseMdxContent(filePath: string): Promise<string> {
   const { title, content: contentWithoutTitle } = extractMainTitle(processedContent);
   const filePathWithoutExtension = filePath.replace(/\.[^/.]+$/, "");
   const [, relativePath] = filePathWithoutExtension.split("/docs").filter(Boolean);
-  const url = `https://supertokens.com/docs/${relativePath}`;
-  const parsedTitle = buildTitle(title, filePath);
+  const url = `https://supertokens.com/docs${relativePath}`;
+  const parsedTitle = usePageTitle ? title : buildTitle(title, filePath);
   processedContent = `
 # ${parsedTitle}
 Source: ${url}
@@ -275,6 +276,28 @@ function buildTitle(currentTitle: string, filePath: string): string {
   return `${title} ${currentTitle}`;
 }
 
+async function generateApiReferenceText(apiName: "cdi" | "fdi") {
+  const apiReference = JSON.parse(await fs.promises.readFile(`./static/${apiName}.json`, "utf8")) as OpenAPIV3.Document;
+  const apiReferenceMapping = JSON.parse(
+    await fs.promises.readFile(`./static/${apiName}-mapping.json`, "utf8"),
+  ) as OpenAPIV3.Document;
+
+  let text = ``;
+  for (const route in apiReference.paths) {
+    for (const method in apiReference.paths[route]) {
+      const operation = apiReference.paths[route][method];
+      const mapping = apiReferenceMapping[operation.operationId];
+      if (operation.deprecated) continue;
+      if (!mapping) continue;
+      const title = operation.summary || route;
+      const pathWithoutExtension = mapping.filePath.replace(/\.[^/.]+$/, "");
+      const url = `https://supertokens.com/docs/references${pathWithoutExtension}`;
+      text = `${text}\n\n## ${title}\nSource: ${url}\nEndpoint: ${method.toUpperCase()} ${route}`;
+    }
+  }
+  return text;
+}
+
 export default function createLLMFullFile(context) {
   return {
     name: "generate-llms-full-txt",
@@ -314,10 +337,22 @@ export default function createLLMFullFile(context) {
       return { files: filesWithoutReferences };
     },
     postBuild: async ({ content, outDir, routes }) => {
-      const llmsFullTxt = (await Promise.all(content.files.map((file) => parseMdxContent(file.path)))).join("\n\n");
+      let llmsFullTxt = (await Promise.all(content.files.map((file) => parseMdxContent(file.path)))).join("\n\n");
+
+      const fdiIntro = await parseMdxContent("./docs/references/fdi/introduction.mdx", true);
+      const cdiIntro = await parseMdxContent("./docs/references/cdi/introduction.mdx", true);
+      const fdiReferenceFullTxt = await generateApiReferenceText("fdi");
+      const cdiReferenceFullTxt = await generateApiReferenceText("cdi");
+
+      llmsFullTxt = `${llmsFullTxt}
+${fdiIntro}
+${fdiReferenceFullTxt}
+\n\n
+${cdiIntro}
+${cdiReferenceFullTxt}
+`;
 
       fs.writeFileSync(path.join(outDir, "llms-full.txt"), llmsFullTxt);
     },
   };
 }
-

src/plugins/generateLllmsTxt.ts

@@ -157,7 +157,6 @@ ${buildContent(content.files.filter((file) => file.path.includes("/platform-conf
 ${buildContent(content.files.filter((file) => file.path.includes("/references")))}
 
 
-
 `;
 
       fs.writeFileSync(path.join(outDir, "llms.txt"), llmsTxt);

src/theme/Root.tsx

@@ -15,17 +15,13 @@ export default function Root({ children }: { children: React.ReactNode }) {
   }, []);
 
   useEffect(() => {
-    if (localStorage.getItem("analytics-consent") === "true") {
-      trackPageView();
-    }
+    trackPageView();
   }, [pathname]);
 
   useEffect(() => {
     const controller = new AbortController();
     const handleBeforeUnload = () => {
-      if (localStorage.getItem("analytics-consent") === "true") {
-        trackPageExit("app-close");
-      }
+      trackPageExit("app-close");
     };
     window.addEventListener("beforeunload", handleBeforeUnload, { signal: controller.signal });
     return () => controller.abort();
@@ -34,9 +30,7 @@ export default function Root({ children }: { children: React.ReactNode }) {
   useEffect(() => {
     const controller = new AbortController();
     const handleVisibilityChange = () => {
-      if (localStorage.getItem("analytics-consent") === "true") {
-        trackPageExit("visibility-change", document.visibilityState);
-      }
+      trackPageExit("visibility-change", document.visibilityState);
     };
     document.addEventListener("visibilitychange", handleVisibilityChange, { signal: controller.signal });
     return () => controller.abort();
@@ -79,19 +73,21 @@ function AnalyticsConsentBanner() {
         initial: "16px",
         sm: "auto",
       }}
-      width={{ initial: "auto", sm: "500px" }}
-      style={{ boxShadow: "var(--shadow-4)" }}
+      width={{ initial: "auto", sm: "370px" }}
+      style={{
+        boxShadow: "var(--shadow-4)",
+        // @ts-ignore
+        "--card-background-color": "var(--gray-2)",
+      }}
       asChild
     >
-      <Card size="2">
+      <Card size="2" variant="classic">
         <Flex direction="column">
           <Text as="p" size="3">
-            We use cookies and similar technologies to help personalize content, analyze site usage, and provide a
-            better experience. By clicking "Accept" you consent to our use of cookies. Visit our{" "}
+            This website uses cookies to improve your experience. Please click decline to disable tracking cookies{" "}
             <a href="https://supertokens.com/legal/privacy-policy" target="_blank">
               Privacy Policy
-            </a>{" "}
-            for more information.
+            </a>
           </Text>
           <Flex gap="3" justify="end">
             <Button variant="soft" onClick={onDecline}>

static/fdi-mapping.json

@@ -101,7 +101,7 @@
   "passwordlessEmailExistsDepr": {
     "frontmatter": {
       "sidebar_position": 3,
-      "sidebar_label": "get Check email exists (deprecated) (deprecated)",
+      "sidebar_label": "get Check email exists (deprecated)",
       "title": "Check email exists (deprecated)",
       "description": "Check if an email exists\nNote that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.\n"
     },
@@ -123,7 +123,7 @@
   "passwordlessPhoneNumberExistsDepr": {
     "frontmatter": {
       "sidebar_position": 4,
-      "sidebar_label": "get Check phone exists (deprecated) (deprecated)",
+      "sidebar_label": "get Check phone exists (deprecated)",
       "title": "Check phone exists (deprecated)",
       "description": "Check if a phone number exists\n"
     },
@@ -189,7 +189,7 @@
   "emailExistsDepr": {
     "frontmatter": {
       "sidebar_position": 2,
-      "sidebar_label": "get Check email exists (deprecated) (deprecated)",
+      "sidebar_label": "get Check email exists (deprecated)",
       "title": "Check email exists (deprecated)",
       "description": "Check if an email exists\n"
     },
@@ -538,4 +538,5 @@
     "method": "get",
     "filePath": "/fdi/webauthn/get-webauthn-email-exists.mdx"
   }
-}
+}
+