@logto/schemas 1.17.0 → 1.19.0

package/lib/types/logto-config/jwt-customizer.js

@@ -1,7 +1,8 @@
 import { jsonObjectGuard } from '@logto/connector-kit';
 import { z } from 'zod';
-import { Organizations, Roles, UserSsoIdentities } from '../../db-entries/index.js';
+import { Organizations, Roles, UserSsoIdentities, } from '../../db-entries/index.js';
 import { mfaFactorsGuard } from '../../foundations/index.js';
+import { GrantType } from '../oidc-config.js';
 import { scopeResponseGuard } from '../scope.js';
 import { userInfoGuard } from '../user.js';
 import { accessTokenPayloadGuard, clientCredentialsPayloadGuard } from './oidc-provider.js';
@@ -16,6 +17,7 @@ export var LogtoJwtTokenKeyType;
     LogtoJwtTokenKeyType["ClientCredentials"] = "client-credentials";
 })(LogtoJwtTokenKeyType || (LogtoJwtTokenKeyType = {}));
 export const jwtCustomizerUserContextGuard = userInfoGuard.extend({
+    hasPassword: z.boolean(),
     ssoIdentities: UserSsoIdentities.guard
         .pick({ issuer: true, identityId: true, detail: true })
         .array(),
@@ -37,11 +39,20 @@ export const jwtCustomizerUserContextGuard = userInfoGuard.extend({
     })
         .array(),
 });
+export const jwtCustomizerGrantContextGuard = z.object({
+    type: z.literal(GrantType.TokenExchange), // Only support token exchange for now
+    subjectTokenContext: jsonObjectGuard,
+});
 export const accessTokenJwtCustomizerGuard = jwtCustomizerGuard
     .extend({
     // Use partial token guard since users customization may not rely on all fields.
     tokenSample: accessTokenPayloadGuard.partial().optional(),
-    contextSample: z.object({ user: jwtCustomizerUserContextGuard.partial() }).optional(),
+    contextSample: z
+        .object({
+        user: jwtCustomizerUserContextGuard.partial(),
+        grant: jwtCustomizerGrantContextGuard.partial().optional(),
+    })
+        .optional(),
 })
     .strict();
 export const clientCredentialsJwtCustomizerGuard = jwtCustomizerGuard

package/lib/types/logto-config/oidc-provider.d.ts

@@ -25,11 +25,11 @@ export declare const accessTokenPayloadGuard: z.ZodObject<{
     gty: string;
     kind: "AccessToken";
     jti: string;
-    aud: (string | string[]) & (string | string[] | undefined);
+    aud: string | string[];
+    scope?: string | undefined;
     expiresWithSession?: boolean | undefined;
     sessionUid?: string | undefined;
     sid?: string | undefined;
-    scope?: string | undefined;
     clientId?: string | undefined;
 }, {
     grantId: string;
@@ -37,11 +37,11 @@ export declare const accessTokenPayloadGuard: z.ZodObject<{
     gty: string;
     kind: "AccessToken";
     jti: string;
-    aud: (string | string[]) & (string | string[] | undefined);
+    aud: string | string[];
+    scope?: string | undefined;
     expiresWithSession?: boolean | undefined;
     sessionUid?: string | undefined;
     sid?: string | undefined;
-    scope?: string | undefined;
     clientId?: string | undefined;
 }>;
 export type AccessTokenPayload = z.infer<typeof accessTokenPayloadGuard>;
@@ -54,13 +54,13 @@ export declare const clientCredentialsPayloadGuard: z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     kind: "ClientCredentials";
     jti: string;
-    aud: (string | string[]) & (string | string[] | undefined);
+    aud: string | string[];
     scope?: string | undefined;
     clientId?: string | undefined;
 }, {
     kind: "ClientCredentials";
     jti: string;
-    aud: (string | string[]) & (string | string[] | undefined);
+    aud: string | string[];
     scope?: string | undefined;
     clientId?: string | undefined;
 }>;

package/lib/types/mfa.d.ts

@@ -71,12 +71,12 @@ export declare const webAuthnRegistrationOptionsGuard: z.ZodObject<{
         hmacCreateSecret: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     }, {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     user: {
@@ -108,8 +108,8 @@ export declare const webAuthnRegistrationOptionsGuard: z.ZodObject<{
     attestation?: "none" | "indirect" | "direct" | "enterprise" | undefined;
     extensions?: {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     } | undefined;
 }, {
     user: {
@@ -141,8 +141,8 @@ export declare const webAuthnRegistrationOptionsGuard: z.ZodObject<{
     attestation?: "none" | "indirect" | "direct" | "enterprise" | undefined;
     extensions?: {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     } | undefined;
 }>;
 export type WebAuthnRegistrationOptions = z.infer<typeof webAuthnRegistrationOptionsGuard>;
@@ -170,42 +170,42 @@ export declare const webAuthnAuthenticationOptionsGuard: z.ZodObject<{
         hmacCreateSecret: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     }, {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     challenge: string;
     timeout?: number | undefined;
+    userVerification?: "discouraged" | "preferred" | "required" | undefined;
+    extensions?: {
+        appid?: string | undefined;
+        hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
+    } | undefined;
     rpId?: string | undefined;
     allowCredentials?: {
         type: "public-key";
         id: string;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     }[] | undefined;
+}, {
+    challenge: string;
+    timeout?: number | undefined;
     userVerification?: "discouraged" | "preferred" | "required" | undefined;
     extensions?: {
         appid?: string | undefined;
-        credProps?: boolean | undefined;
         hmacCreateSecret?: boolean | undefined;
+        credProps?: boolean | undefined;
     } | undefined;
-}, {
-    challenge: string;
-    timeout?: number | undefined;
     rpId?: string | undefined;
     allowCredentials?: {
         type: "public-key";
         id: string;
         transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
     }[] | undefined;
-    userVerification?: "discouraged" | "preferred" | "required" | undefined;
-    extensions?: {
-        appid?: string | undefined;
-        credProps?: boolean | undefined;
-        hmacCreateSecret?: boolean | undefined;
-    } | undefined;
 }>;
 export type WebAuthnAuthenticationOptions = z.infer<typeof webAuthnAuthenticationOptionsGuard>;

package/lib/types/oidc-config.d.ts

@@ -8,5 +8,6 @@ export type OidcConfig = KeysToCamelCase<SnakeCaseOidcConfig>;
 export declare enum GrantType {
     AuthorizationCode = "authorization_code",
     RefreshToken = "refresh_token",
-    ClientCredentials = "client_credentials"
+    ClientCredentials = "client_credentials",
+    TokenExchange = "urn:ietf:params:oauth:grant-type:token-exchange"
 }

package/lib/types/oidc-config.js

@@ -3,4 +3,5 @@ export var GrantType;
     GrantType["AuthorizationCode"] = "authorization_code";
     GrantType["RefreshToken"] = "refresh_token";
     GrantType["ClientCredentials"] = "client_credentials";
+    GrantType["TokenExchange"] = "urn:ietf:params:oauth:grant-type:token-exchange";
 })(GrantType || (GrantType = {}));

package/lib/types/organization.d.ts

@@ -1,4 +1,4 @@
-import { type OrganizationRole, type Organization, type OrganizationInvitation } from '../db-entries/index.js';
+import { type OrganizationRole, type Organization, type OrganizationInvitation, type Application } from '../db-entries/index.js';
 import { type ToZodObject } from '../utils/zod.js';
 import { type UserInfo, type FeaturedUser } from './user.js';
 /**
@@ -43,10 +43,10 @@ export type OrganizationWithRoles = Organization & {
 export declare const organizationWithOrganizationRolesGuard: ToZodObject<OrganizationWithRoles>;
 /**
  * The user entity with the `organizationRoles` field that contains the roles of
- * the user in a specific organization.
+ * the user in the organization.
  */
 export type UserWithOrganizationRoles = UserInfo & {
-    /** The roles of the user in a specific organization. */
+    /** The roles of the user in the organization. */
     organizationRoles: OrganizationRoleEntity[];
 };
 export declare const userWithOrganizationRolesGuard: ToZodObject<UserWithOrganizationRoles>;
@@ -58,6 +58,15 @@ export type OrganizationWithFeatured = Organization & {
     usersCount?: number;
     featuredUsers?: FeaturedUser[];
 };
+/**
+ * The application entity with the `organizationRoles` field that contains the roles
+ * of the application in the organization.
+ */
+export type ApplicationWithOrganizationRoles = Application & {
+    /** The roles of the application in the organization. */
+    organizationRoles: OrganizationRoleEntity[];
+};
+export declare const applicationWithOrganizationRolesGuard: ToZodObject<ApplicationWithOrganizationRoles>;
 /**
  * The organization invitation with additional fields:
  *

package/lib/types/organization.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { OrganizationRoles, Organizations, OrganizationInvitations, } from '../db-entries/index.js';
+import { OrganizationRoles, Organizations, OrganizationInvitations, Applications, } from '../db-entries/index.js';
 import { userInfoGuard } from './user.js';
 export const organizationRoleWithScopesGuard = OrganizationRoles.guard.extend({
     scopes: z
@@ -29,6 +29,9 @@ export const organizationWithOrganizationRolesGuard = Organizations.guard.extend
 export const userWithOrganizationRolesGuard = userInfoGuard.extend({
     organizationRoles: organizationRoleEntityGuard.array(),
 });
+export const applicationWithOrganizationRolesGuard = Applications.guard.extend({
+    organizationRoles: organizationRoleEntityGuard.array(),
+});
 export const organizationInvitationEntityGuard = OrganizationInvitations.guard.extend({
     organizationRoles: organizationRoleEntityGuard.array(),
 });

package/lib/types/role.d.ts

@@ -1,4 +1,4 @@
-import type { Role } from '../db-entries/index.js';
+import { type Role } from '../db-entries/index.js';
 import { type FeaturedApplication } from './application.js';
 import { type FeaturedUser } from './user.js';
 export type RoleResponse = Role & {
@@ -7,3 +7,8 @@ export type RoleResponse = Role & {
     applicationsCount: number;
     featuredApplications: FeaturedApplication[];
 };
+/** The role type to i18n key mapping. */
+export declare const roleTypeToKey: Readonly<{
+    readonly User: "user";
+    readonly MachineToMachine: "machine_to_machine";
+}>;

package/lib/types/role.js

@@ -1 +1,6 @@
-export {};
+import { RoleType } from '../db-entries/index.js';
+/** The role type to i18n key mapping. */
+export const roleTypeToKey = Object.freeze({
+    [RoleType.User]: 'user',
+    [RoleType.MachineToMachine]: 'machine_to_machine',
+});

package/lib/types/scope.d.ts

@@ -1,13 +1,14 @@
 import { type z } from 'zod';
-export declare const scopeResponseGuard: z.ZodObject<{
-    name: z.ZodType<string, z.ZodTypeDef, string>;
-    id: z.ZodType<string, z.ZodTypeDef, string>;
+export declare const scopeResponseGuard: z.ZodObject<z.objectUtil.extendShape<{
     tenantId: z.ZodType<string, z.ZodTypeDef, string>;
-    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
-    description: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
     resourceId: z.ZodType<string, z.ZodTypeDef, string>;
+    name: z.ZodType<string, z.ZodTypeDef, string>;
+    description: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, {
     resource: import("../index.js").Guard<import("../db-entries/resource.js").Resource>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     name: string;
     id: string;
     tenantId: string;