docs: update auth docs + add new storefront guides (#9020)

* docs: update auth docs + add new storefront guides * lint content * fix vale error * add callback response schema * Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx Co-authored-by: Stevche Radevski <sradevski@live.com> * Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx Co-authored-by: Stevche Radevski <sradevski@live.com> * Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx Co-authored-by: Stevche Radevski <sradevski@live.com> * address PR comments * replace google -> github * better explanation for refresh token --------- Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00
parent cf3c25addf
commit a28c911c24
29 changed files with 1476 additions and 315 deletions
@@ -0,0 +1,152 @@
+import { Table, Prerequisites } from "docs-ui"
+
+export const metadata = {
+  title: `Google Auth Module Provider`,
+}
+
+# {metadata.title}
+
+In this document, you’ll learn about the Google Auth Module Provider and how to install and use it in the Auth Module.
+
+The Google Auth Module Provider handles authenticating users with their Google account.
+
+<Note title="Tip">
+
+Learn about the authentication flow in [this guide](../../authentication-route/page.mdx).
+
+</Note>
+
+---
+
+## Install the Google Auth Module Provider
+
+<Prerequisites
+  items={[
+    {
+      text: "Create a project in Google Cloud.",
+      link: "https://cloud.google.com/resource-manager/docs/creating-managing-projects"
+    },
+    {
+      text: "Create authorization credentials. When setting the Redirect Uri, set it to a URL in your frontend that later uses Medusa's callback route to validate the authentication.",
+      link: "https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred"
+    }
+  ]}
+/>
+
+To install the Google auth module provider, run the following command in the directory of your Medusa application:
+
+```bash npm2yarn
+npm install @medusajs/auth-google@preview
+```
+
+Next, add the module to the array of providers passed to the Auth Module:
+
+```js title="medusa-config.js"
+import { Modules } from "@medusajs/utils"
+
+// ...
+
+const modules = {
+  // ...
+  [Modules.AUTH]: {
+    resolve: "@medusajs/auth",
+    options: {
+      providers: [
+        // other providers...
+        {
+          resolve: "@medusajs/auth-google",
+          id: "google",
+          options: {
+            clientId: process.env.GOOGLE_CLIENT_ID,
+            clientSecret: process.env.GOOGLE_CLIENT_SECRET,
+            callbackUrl: process.env.GOOGLE_CALLBACK_URL,
+          },
+        },
+      ],
+    },
+  },
+}
+```
+
+### Environment Variables
+
+Make sure to add the necessary environment variables for the above options in `.env`:
+
+```plain
+GOOGLE_CLIENT_ID=<YOUR_GOOGLE_CLIENT_ID>
+GOOGLE_CLIENT_SECRET=<YOUR_GOOGLE_CLIENT_SECRET>
+GOOGLE_CALLBACK_URL=<YOUR_GOOGLE_CALLBACK_URL>
+```
+
+### Module Options
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell>Configuration</Table.HeaderCell>
+      <Table.HeaderCell>Description</Table.HeaderCell>
+      <Table.HeaderCell className="w-1/5">Required</Table.HeaderCell>
+    </Table.Row>
+  </Table.Header>
+  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+      
+      `clientId`
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      A string indicating the [Google API Client ID](https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid).
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      Yes
+      
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+      
+      `clientSecret`
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      A string indicating the [Google Client Secret](https://support.google.com/cloud/answer/6158849?hl=en#zippy=%2Cstep-create-a-new-client-secret).
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      Yes
+      
+      </Table.Cell>
+    </Table.Row>
+    <Table.Row>
+      <Table.Cell>
+      
+      `callbackUrl`
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      A string indicating the URL to redirect to in your frontend after the user completes their authentication in Google.
+
+      At this URL, the frontend will receive a `code` query parameter. It then sends that  `code` query parameter to the Medusa application's `/auth/{actor_type}/google/callback` route.
+      
+      </Table.Cell>
+      <Table.Cell>
+      
+      Yes
+      
+      </Table.Cell>
+    </Table.Row>
+  </Table.Body>
+</Table>
+
+---
+
+## Examples
+
+- [How to implement Google social login in the storefront.](../../../../storefront-development/customers/third-party-login/page.mdx).