Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-30 20:33:54 -05:00
Code Issues Activity

chore(console): update custom JWT scripts sample (#5747)

Browse source
This commit is contained in:
Darcy Ye 2024-04-19 00:34:50 +08:00 committed by GitHub
parent e035377b83
commit 959f2d2795
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 31 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
packages/console/src/pages/CustomizeJwtDetails/MainContent/SettingsSection/InstructionTab/index.tsx
View file

@ -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}

82
packages/console/src/pages/CustomizeJwtDetails/utils/config.tsx
View file

@ -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,8 +144,8 @@ 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: {