chore(docs): cleanup netsuite doc page

ndom91 · ndom91 · commit abf597bbb727 · 2024-04-30T17:51:06.000+02:00
diff --git a/docs/pages/getting-started/providers/netsuite.mdx b/docs/pages/getting-started/providers/netsuite.mdx
@@ -5,6 +5,8 @@ import { Code } from "@/components/Code"
 
 # NetSuite
 
+<Callout type="warning">To be released in `next-auth@5.0.0-beta.18`</Callout>
+
 ## Resources
 
 - [NetSuite - Creating an Integration Record (OAuth 2.0)](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_157771733782.html#Related-Topics)
@@ -16,11 +18,6 @@ import { Code } from "@/components/Code"
 
 ### Callback URL
 
-<Callout>
-  NetSuite does not support http. When testing locally, you can use a service
-  like [ngrok](https://ngrok.com) to get a local https URL.
-</Callout>
-
 <Code>
   <Code.Next>
 
@@ -36,17 +33,53 @@ https://example.com/auth/callback/netsuite
 ```
 
   </Code.Svelte>
+  <Code.Express>
+
+```bash
+https://example.com/auth/callback/netsuite
+```
+
+  </Code.Express>
 </Code>
 
-### Userinfo RESTlet
+> NetSuite does not support `http://` callback URLs. When testing locally, you can use a service like [ngrok](https://ngrok.com) to get a local `https` URL.
+
+### Environment Variables
+
+```
+AUTH_NETSUITE_ID
+AUTH_NETSUITE_SECRET
+AUTH_NETSUITE_ACCOUNT_ID
+```
+
+### Configuration
+
+Before setting up the provider, you will need to ensure the following is setup.
+
+- [Create an Integration Record](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_157771733782.html#procedure_157838925981)
+  - Uncheck the TBA Auth Flow checkbox.
+  - Check OAuth 2.0 Auth Flow checkbox.
+  - Copy and paste the `Callback URL` below into the `Redirect URI` field.
+  - Then select the scope(s) you want to use.
+    - **REST Web Services** (`rest_webservices`) - Access to REST Web Services.
+    - **RESTlets**(`restlets`) - Access to RESTLets.
+    - **SuiteAnalytics Connect** (`suiteanalytics_connect`) - Access to SuiteAnalytics Connect.
+  - Add any policies you want to use.
+    - Application Logo (_Optional_) (Shown to users when they are asked to grant access to your application). - Consent Screen
+    - Application Terms of Use (_Optional_) - A PDF file that contains the terms of use for your application. - Consent Screen
+    - Application Privacy Policy (_Optional_) - A PDF file that contains the privacy policy for your application. - Consent Screen
+  - OAuth 2.0 Consent Policy Preference - This setting determines whether the user is asked to grant access to your application **every time** they sign in or only the **first time** they sign in or **never**.
+  - **Save** the Integration record.
+  - The Integration record will be used to generate the `clientId` and `clientSecret` for the provider. **Save the generated values for later**
+
+### Userinfo RESTLet Handler
 
+To use this provider, you'll need to create a userinfo RESTlet in your NetSuite instance.
 Our `userinfo` URL needs to be a suitelet or RESTLet URL that gives us the
 information about the user. The best bet is to use the `N/runtime` module to
 get the basics first. - Here is an example of a RESTlet below. Be sure to
 deploy and enable access to "All Roles".
 
-### Example RESTLet Callback Handler
-
 Be sure to deploy and use the **external** RESTLet url of any usage of the URIs.
 
 ```js
@@ -55,16 +88,15 @@ Be sure to deploy and use the **external** RESTLet url of any usage of the URIs.
  * @NScriptType Restlet
  */
 define(["N/runtime"],
- @param{runtime} runtimee
  (runtime) => {
- /**
-  * Defines the function that is executed when a GET request is sent to a RESTlet.
-  * @param {Object} requestParams - Parameters from HTTP request URL; parameters passed as an Object (for all supported
-  *     content types)
-  * @returns {string | Object} HTTP response body; returns a string when request Content-Type is 'text/plain'; returns an
-  *     Object when request Content-Type is 'application/json' or 'application/xml'
-  * @since 2015.2
-  *\/
+/**
+ * Defines the function that is executed when a GET request is sent to a RESTlet.
+ * @param {Object} requestParams - Parameters from HTTP request URL; parameters passed as an Object (for all supported
+ *     content types)
+ * @returns {string | Object} HTTP response body; returns a string when request Content-Type is 'text/plain'; returns an
+ *     Object when request Content-Type is 'application/json' or 'application/xml'
+ * @since 2015.2
+ */
   const get = (requestParams) => {
     let userObject = runtime.getCurrentUser();
 
@@ -100,46 +132,21 @@ define(["N/runtime"],
 
 Above is an example of returning the basic runtime information. Be sure to create a new script record and deployment record. When you save the deployment record, you will get the URLs for your RESTlet, which we will use as the `userinfo` URL.
 
-### Environment Variables
-
-```
-AUTH_NETSUITE_ID
-AUTH_NETSUITE_SECRET
-```
-
-### Configuration
-
-Before setting up the provider, you will need to ensure the following is setup.
-
-- [Create an Integration Record](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_157771733782.html#procedure_157838925981)
-  - Uncheck the TBA Auth Flow checkbox.
-  - Check OAuth 2.0 Auth Flow checkbox.
-  - Copy and paste the `Callback URL` below into the `Redirect URI` field.
-  - Then select the scope(s) you want to use.
-    - **REST Web Services** (`rest_webservices`) - Access to REST Web Services.
-    - **RESTlets**(`restlets`) - Access to RESTLets.
-    - **SuiteAnalytics Connect** (`suiteanalytics_connect`) - Access to SuiteAnalytics Connect.
-  - Add any policies you want to use.
-    - Application Logo (_Optional_) (Shown to users when they are asked to grant access to your application). - Consent Screen
-    - Application Terms of Use (_Optional_) - A PDF file that contains the terms of use for your application. - Consent Screen
-    - Application Privacy Policy (_Optional_) - A PDF file that contains the privacy policy for your application. - Consent Screen
-  - OAuth 2.0 Consent Policy Preference - This setting determines whether the user is asked to grant access to your application **every time** they sign in or only the **first time** they sign in or **never**.
-  - **Save** the Integration record.
-  - The Integration record will be used to generate the `clientId` and `clientSecret` for the provider. **Save the generated values for later**
+### Example Usage
 
 <Code>
   <Code.Next>
 
-```ts filename="/auth.ts"
+```ts filename="@auth.ts"
 import NextAuth from "next-auth"
 import NetSuite from "next-auth/providers/netsuite"
 
 export const { handlers, auth, signIn, signOut } = NextAuth({
   providers: [
     NetSuite({
-      clientId: AUTH_NETSUITE_ID,
-      clientSecret: AUTH_NETSUITE_SECRET,
-      issuer: AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
+      clientId: process.env.AUTH_NETSUITE_ID,
+      clientSecret: process.env.AUTH_NETSUITE_SECRET,
+      issuer: process.env.AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
       // Returns the current user using the N/runtime module. This url can be a suitelet or RESTlet (Recommended)
       // Using getCurrentUser(); So we match this schema returned from this RESTlet in the profile callback. (Required)
       userinfo:
@@ -158,13 +165,14 @@ export const { handlers, auth, signIn, signOut } = NextAuth({
 ```ts filename="/src/auth.ts"
 import { SvelteKitAuth } from "@auth/sveltekit"
 import NetSuite from "@auth/sveltekit/providers/netsuite"
+import { env } from "$env/dynamic/private"
 
 export const { handle, signIn, signOut } = SvelteKitAuth({
   providers: [
     NetSuite({
-      clientId: AUTH_NETSUITE_ID,
-      clientSecret: AUTH_NETSUITE_SECRET,
-      issuer: AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
+      clientId: env.AUTH_NETSUITE_ID,
+      clientSecret: env.AUTH_NETSUITE_SECRET,
+      issuer: env.AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
       // Returns the current user using the N/runtime module. This url can be a suitelet or RESTlet (Recommended)
       // Using getCurrentUser(); So we match this schema returned from this RESTlet in the profile callback. (Required)
       userinfo:
@@ -189,9 +197,9 @@ app.use(
   ExpressAuth({
     providers: [
       NetSuite({
-        clientId: AUTH_NETSUITE_ID,
-        clientSecret: AUTH_NETSUITE_SECRET,
-        issuer: AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
+        clientId: process.env.AUTH_NETSUITE_ID,
+        clientSecret: process.env.AUTH_NETSUITE_SECRET,
+        issuer: process.env.AUTH_NETSUITE_ACCOUNT_ID, // EX: TSTDRV1234567 or 81555 for prod, and 1234567-SB1 for Sandbox accounts not "_" use "-".
         // Returns the current user using the N/runtime module. This url can be a suitelet or RESTlet (Recommended)
         // Using getCurrentUser(); So we match this schema returned from this RESTlet in the profile callback. (Required)
         userinfo:
