From 18dfcdabb9cf17b4671fc05bae5591478830aa90 Mon Sep 17 00:00:00 2001
From: Darcy Ye <darcyye@silverhand.io>
Date: Wed, 6 Mar 2024 16:24:57 +0800
Subject: [PATCH] chore(schemas): renaming

---
 packages/schemas/src/types/logto-config/index.ts |  6 +++---
 .../src/types/logto-config/oidc-provider.ts      | 16 ++++++++--------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/packages/schemas/src/types/logto-config/index.ts b/packages/schemas/src/types/logto-config/index.ts
index 46fe610b8..0674d82bd 100644
--- a/packages/schemas/src/types/logto-config/index.ts
+++ b/packages/schemas/src/types/logto-config/index.ts
@@ -3,7 +3,7 @@ import { z } from 'zod';
 
 import { jsonObjectGuard } from '../../foundations/index.js';
 
-import { accessTokenGuard, clientCredentialsGuard } from './oidc-provider.js';
+import { accessTokenPayloadGuard, clientCredentialsPayloadGuard } from './oidc-provider.js';
 
 export * from './oidc-provider.js';
 
@@ -66,14 +66,14 @@ const jwtCustomizerGuard = z
 
 export const jwtCustomizerAccessTokenGuard = jwtCustomizerGuard.extend({
   // Use partial token guard since users customization may not rely on all fields.
-  tokenSample: accessTokenGuard.partial().optional(),
+  tokenSample: accessTokenPayloadGuard.partial().optional(),
 });
 
 export type JwtCustomizerAccessToken = z.infer<typeof jwtCustomizerAccessTokenGuard>;
 
 export const jwtCustomizerClientCredentialsGuard = jwtCustomizerGuard.extend({
   // Use partial token guard since users customization may not rely on all fields.
-  tokenSample: clientCredentialsGuard.partial().optional(),
+  tokenSample: clientCredentialsPayloadGuard.partial().optional(),
 });
 
 export type JwtCustomizerClientCredentials = z.infer<typeof jwtCustomizerClientCredentialsGuard>;
diff --git a/packages/schemas/src/types/logto-config/oidc-provider.ts b/packages/schemas/src/types/logto-config/oidc-provider.ts
index 8f8540291..1bcd381e1 100644
--- a/packages/schemas/src/types/logto-config/oidc-provider.ts
+++ b/packages/schemas/src/types/logto-config/oidc-provider.ts
@@ -1,7 +1,7 @@
 /**
  * Manually implement zod guards of some node OIDC provider types.
  *
- * Please note that we defined `accessTokenGuard` and `clientCredentialsGuard` in this file, they are used to make the user-defined token
+ * Please note that we defined `accessTokenPayloadGuard` and `clientCredentialsPayloadGuard` in this file, they are used to make the user-defined token
  * sample to be aligned with the real token payload given by the OIDC provider in a real use case.
  *
  * But these token payload is not a pure "claims" payload, it contains some OIDC provider specific fields (e.g. `kind`). These fields could
@@ -23,7 +23,7 @@ import { jsonObjectGuard } from '../../foundations/index.js';
  * https://github.com/panva/node-oidc-provider/blob/270af1da83dda4c49edb4aaab48908f737d73379/lib/models/base_model.js#L11
  * https://github.com/panva/node-oidc-provider/blob/270af1da83dda4c49edb4aaab48908f737d73379/lib/models/base_token.js#L62
  */
-const baseTokenGuardObject = {
+const baseTokenPayloadGuardObject = {
   jti: z.string(),
   iat: z.number(),
   exp: z.number().optional(),
@@ -41,8 +41,8 @@ const baseTokenGuardObject = {
  * `feature.claimsParameter`: https://github.com/panva/node-oidc-provider/blob/main/docs/README.md#featuresclaimsparameter
  * OIDC claims parameter: https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter
  */
-export const accessTokenGuard = z.object({
-  ...baseTokenGuardObject,
+export const accessTokenPayloadGuard = z.object({
+  ...baseTokenPayloadGuardObject,
   kind: z.literal('AccessToken'),
   accountId: z.string(),
   aud: z.string().or(z.array(z.string())),
@@ -52,19 +52,19 @@ export const accessTokenGuard = z.object({
   sid: z.string().optional(),
 });
 
-export type AccessToken = z.infer<typeof accessTokenGuard>;
+export type AccessTokenPayload = z.infer<typeof accessTokenPayloadGuard>;
 
 /**
  * Ref:
  * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b7b01b70c4c211a4f69caf05008228ac065413c/types/oidc-provider/index.d.ts#L515
  * https://github.com/panva/node-oidc-provider/blob/270af1da83dda4c49edb4aaab48908f737d73379/lib/models/client_credentials.js#L11
  */
-export const clientCredentialsGuard = z.object({
-  ...baseTokenGuardObject,
+export const clientCredentialsPayloadGuard = z.object({
+  ...baseTokenPayloadGuardObject,
   kind: z.literal('ClientCredentials'),
   aud: z.string().or(z.array(z.string())),
   extra: jsonObjectGuard.optional(),
   scope: z.string().optional(),
 });
 
-export type ClientCredentials = z.infer<typeof clientCredentialsGuard>;
+export type ClientCredentialsPayload = z.infer<typeof clientCredentialsPayloadGuard>;