From 4ac26a0217ae1d01d6aa6d406f50a5df2b799906 Mon Sep 17 00:00:00 2001
From: Darcy Ye <darcyye@silverhand.io>
Date: Thu, 18 Apr 2024 14:45:30 +0800
Subject: [PATCH] chore(console): update custom JWT scripts sample

---
 .../SettingsSection/InstructionTab/index.tsx  |  1 +
 .../CustomizeJwtDetails/utils/config.tsx      | 86 +++++++------------
 2 files changed, 31 insertions(+), 56 deletions(-)

diff --git a/packages/console/src/pages/CustomizeJwtDetails/MainContent/SettingsSection/InstructionTab/index.tsx b/packages/console/src/pages/CustomizeJwtDetails/MainContent/SettingsSection/InstructionTab/index.tsx
index 489222de8867..856c392dd8cc 100644
--- a/packages/console/src/pages/CustomizeJwtDetails/MainContent/SettingsSection/InstructionTab/index.tsx
+++ b/packages/console/src/pages/CustomizeJwtDetails/MainContent/SettingsSection/InstructionTab/index.tsx
@@ -111,6 +111,7 @@ function InstructionTab({ isActive }: Props) {
           language="typescript"
           className={styles.sampleCode}
           value={environmentVariablesCodeExample}
+          path='file:///env-variables-sample.js'
           height="400px"
           theme="logto-dark"
           options={sampleCodeEditorOptions}
diff --git a/packages/console/src/pages/CustomizeJwtDetails/utils/config.tsx b/packages/console/src/pages/CustomizeJwtDetails/utils/config.tsx
index 4264623ce02b..7fc158059e0b 100644
--- a/packages/console/src/pages/CustomizeJwtDetails/utils/config.tsx
+++ b/packages/console/src/pages/CustomizeJwtDetails/utils/config.tsx
@@ -20,70 +20,43 @@ import {
  * JWT token code editor configuration
  */
 const accessTokenJwtCustomizerDefinition = `
-declare global {
-  export interface CustomJwtClaims extends Record<string, any> {}
+declare interface CustomJwtClaims extends Record<string, any> {}
 
-  /** Logto internal data that can be used to pass additional information
-   * @param {${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext}} user - The user info associated with the token.
-   */
-  export type Data = {
-    user: ${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext};
-  }
-
-  export interface Exports {
-    /**
-     * This function is called during the access token generation process to get custom claims for the JWT token.
-     * 
-     * @param {${JwtCustomizerTypeDefinitionKey.AccessTokenPayload}} token -The JWT token.
-     * @param {Data} data - Logto internal data that can be used to pass additional information
-     * @param {${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext}} data.user - The user info associated with the token.
-     * @param {${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}} envVariables - The environment variables.
-     * 
-     * @returns The custom claims.
-     */
-    getCustomJwtClaims: (token: ${JwtCustomizerTypeDefinitionKey.AccessTokenPayload}, data: Data, envVariables: ${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}) => Promise<CustomJwtClaims>;
-  }
-
-  const exports: Exports;
+/** Logto internal data that can be used to pass additional information
+ * @param {${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext}} user - The user info associated with the token.
+ */
+declare type Context = {
+  user: ${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext};
 }
 
-export { exports as default };
-`;
+declare type Payload = {
+  token: ${JwtCustomizerTypeDefinitionKey.AccessTokenPayload};
+  context: Context;
+  environmentVariables: ${JwtCustomizerTypeDefinitionKey.EnvironmentVariables};
+};`;
 
 const clientCredentialsJwtCustomizerDefinition = `
-declare global {
-  export interface CustomJwtClaims extends Record<string, any> {}
+declare interface CustomJwtClaims extends Record<string, any> {}
 
-  export interface Exports {
-    /**
-     * This function is called during the access token generation process to get custom claims for the JWT token.
-     * 
-     * @param {${JwtCustomizerTypeDefinitionKey.ClientCredentialsPayload}} token -The JWT token.
-     * 
-     * @returns The custom claims.
-     */
-    getCustomJwtClaims: (token: ${JwtCustomizerTypeDefinitionKey.ClientCredentialsPayload}, envVariables: ${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}) => Promise<CustomJwtClaims>;
-  }
-
-  const exports: Exports;
-}
-
-export { exports as default };
-`;
+declare type Payload = {
+  token: ${JwtCustomizerTypeDefinitionKey.AccessTokenPayload};
+  environmentVariables: ${JwtCustomizerTypeDefinitionKey.EnvironmentVariables};
+};`;
 
 export const defaultAccessTokenJwtCustomizerCode = `/**
 * This function is called during the access token generation process to get custom claims for the JWT token.
 * Limit custom claims to under 50KB.
-* 
-* @param {${JwtCustomizerTypeDefinitionKey.AccessTokenPayload}} token -The JWT token.
-* @param {Data} data - Logto internal data that can be used to pass additional information
-* @param {${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext}} data.user - The user info associated with the token.
-* @param {${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}} [envVariables] - The environment variables.
+*
+* @param {Payload} payload - The input payload of the function.
+* @param {${JwtCustomizerTypeDefinitionKey.AccessTokenPayload}} payload.token -The JWT token.
+* @param {Context} payload.context - Logto internal data that can be used to pass additional information
+* @param {${JwtCustomizerTypeDefinitionKey.JwtCustomizerUserContext}} payload.context.user - The user info associated with the token.
+* @param {${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}} [payload.environmentVariables] - The environment variables.
 *
 * @returns The custom claims.
 */
 
-exports.getCustomJwtClaims = async (token, data, envVariables) => {
+const getCustomJwtClaims = async ({ token, context, environmentVariables }) => {
   return {};
 }`;
 
@@ -91,13 +64,14 @@ export const defaultClientCredentialsJwtCustomizerCode = `/**
 * This function is called during the access token generation process to get custom claims for the JWT token.
 * Limit custom claims to under 50KB.
 *
-* @param {${JwtCustomizerTypeDefinitionKey.ClientCredentialsPayload}} token -The JWT token.
-* @param {${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}} [envVariables] - The environment variables.
+* @param {Payload} payload - The input payload of the function.
+* @param {${JwtCustomizerTypeDefinitionKey.ClientCredentialsPayload}} payload.token -The JWT token.
+* @param {${JwtCustomizerTypeDefinitionKey.EnvironmentVariables}} [payload.environmentVariables] - The environment variables.
 *
 * @returns The custom claims.
 */
 
-exports.getCustomJwtClaims = async (token, envVariables) => {
+const getCustomJwtClaims = async ({ token, environmentVariables }) => {
   return {};
 }`;
 
@@ -170,15 +144,15 @@ return {
   externalData: data,
 };`;
 
-export const environmentVariablesCodeExample = `exports.getCustomJwtClaims = async (token, data, envVariables) => {
-  const { apiKey } = envVariables;
+export const environmentVariablesCodeExample = `const getCustomJwtClaimsSample = async ({ environmentVariables }) => {
+  const { apiKey } = environmentVariables;
 
   const response = await fetch('https://api.example.com/data', {
     headers: {
       Authorization: apiKey,
     }
   });
-  
+
   const data = await response.json();
 
   return {