@logto/schemas 1.11.0 → 1.13.0

package/lib/types/consent.d.ts

@@ -0,0 +1,568 @@
+import { z } from 'zod';
+/**
+ * Define the public user info that can be exposed to the public. e.g. on the user consent page.
+ */
+export declare const publicUserInfoGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    username: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryEmail: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    primaryPhone: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncrypted: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    passwordEncryptionMethod: z.ZodType<import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null, z.ZodTypeDef, import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null>;
+    name: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    avatar: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    applicationId: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    identities: z.ZodType<Record<string, {
+        userId: string;
+        details?: Record<string, unknown> | undefined;
+    }>, z.ZodTypeDef, Record<string, {
+        userId: string;
+        details?: Record<string, unknown> | undefined;
+    }>>;
+    customData: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+    logtoConfig: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+    mfaVerifications: z.ZodType<({
+        type: import("../index.js").MfaFactor.TOTP;
+        id: string;
+        key: string;
+        createdAt: string;
+        lastUsedAt?: string | undefined;
+    } | {
+        type: import("../index.js").MfaFactor.WebAuthn;
+        id: string;
+        createdAt: string;
+        credentialId: string;
+        publicKey: string;
+        counter: number;
+        agent: string;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        lastUsedAt?: string | undefined;
+    } | {
+        type: import("../index.js").MfaFactor.BackupCode;
+        id: string;
+        createdAt: string;
+        codes: {
+            code: string;
+            usedAt?: string | undefined;
+        }[];
+        lastUsedAt?: string | undefined;
+    })[], z.ZodTypeDef, ({
+        type: import("../index.js").MfaFactor.TOTP;
+        id: string;
+        key: string;
+        createdAt: string;
+        lastUsedAt?: string | undefined;
+    } | {
+        type: import("../index.js").MfaFactor.WebAuthn;
+        id: string;
+        createdAt: string;
+        credentialId: string;
+        publicKey: string;
+        counter: number;
+        agent: string;
+        transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+        lastUsedAt?: string | undefined;
+    } | {
+        type: import("../index.js").MfaFactor.BackupCode;
+        id: string;
+        createdAt: string;
+        codes: {
+            code: string;
+            usedAt?: string | undefined;
+        }[];
+        lastUsedAt?: string | undefined;
+    })[]>;
+    isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+    lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, "name" | "id" | "username" | "primaryEmail" | "primaryPhone" | "avatar">, "strip", z.ZodTypeAny, {
+    name: string | null;
+    id: string;
+    username: string | null;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    avatar: string | null;
+}, {
+    name: string | null;
+    id: string;
+    username: string | null;
+    primaryEmail: string | null;
+    primaryPhone: string | null;
+    avatar: string | null;
+}>;
+export type PublicUserInfo = z.infer<typeof publicUserInfoGuard>;
+/**
+ * Define the public application info that can be exposed to the public. e.g. on the user consent page.
+ */
+export declare const publicApplicationGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: z.ZodType<string, z.ZodTypeDef, string>;
+    name: z.ZodType<string, z.ZodTypeDef, string>;
+    secret: z.ZodType<string, z.ZodTypeDef, string>;
+    description: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    type: z.ZodType<import("../db-entries/custom-types.js").ApplicationType, z.ZodTypeDef, import("../db-entries/custom-types.js").ApplicationType>;
+    oidcClientMetadata: z.ZodType<{
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }, z.ZodTypeDef, {
+        redirectUris: string[];
+        postLogoutRedirectUris: string[];
+        logoUri?: string | undefined;
+    }>;
+    customClientMetadata: z.ZodType<{
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }, z.ZodTypeDef, {
+        corsAllowedOrigins?: string[] | undefined;
+        idTokenTtl?: number | undefined;
+        refreshTokenTtl?: number | undefined;
+        refreshTokenTtlInDays?: number | undefined;
+        tenantId?: string | undefined;
+        alwaysIssueRefreshToken?: boolean | undefined;
+        rotateRefreshToken?: boolean | undefined;
+    }>;
+    protectedAppMetadata: z.ZodType<{
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null, z.ZodTypeDef, {
+        host: string;
+        origin: string;
+        sessionDuration: number;
+        pageRules: {
+            path: string;
+        }[];
+        customDomains?: {
+            status: import("../index.js").DomainStatus;
+            domain: string;
+            errorMessage: string | null;
+            dnsRecords: {
+                type: string;
+                value: string;
+                name: string;
+            }[];
+            cloudflareData: {
+                status: string;
+                id: string;
+                ssl: {
+                    status: string;
+                    validation_errors?: {
+                        message: string;
+                    }[] | undefined;
+                };
+                verification_errors?: string[] | undefined;
+            } | null;
+        }[] | undefined;
+    } | null>;
+    isThirdParty: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+    createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+}, "name" | "id">, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+}, {
+    name: string;
+    id: string;
+}>;
+export type PublicApplication = z.infer<typeof publicApplicationGuard>;
+export declare const applicationSignInExperienceGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    applicationId: z.ZodType<string, z.ZodTypeDef, string>;
+    branding: z.ZodType<{
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    }, z.ZodTypeDef, {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    }>;
+    termsOfUseUrl: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    privacyPolicyUrl: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+    displayName: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+}, "displayName" | "branding" | "termsOfUseUrl" | "privacyPolicyUrl">, "strip", z.ZodTypeAny, {
+    displayName: string | null;
+    branding: {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    };
+    termsOfUseUrl: string | null;
+    privacyPolicyUrl: string | null;
+}, {
+    displayName: string | null;
+    branding: {
+        logoUrl?: string | undefined;
+        darkLogoUrl?: string | undefined;
+        favicon?: string | undefined;
+    };
+    termsOfUseUrl: string | null;
+    privacyPolicyUrl: string | null;
+}>;
+/**
+ * Define the public organization info that can be exposed to the public. e.g. on the user consent page.
+ */
+export declare const publicOrganizationGuard: z.ZodObject<Pick<{
+    tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+    id: 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>;
+}, "name" | "id">, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+}, {
+    name: string;
+    id: string;
+}>;
+export declare const missingResourceScopesGuard: z.ZodObject<{
+    resource: z.ZodObject<{
+        name: z.ZodType<string, z.ZodTypeDef, string>;
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+    }, {
+        name: string;
+        id: string;
+    }>;
+    scopes: z.ZodArray<z.ZodObject<Pick<{
+        tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+        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, z.ZodTypeDef, string>;
+        createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    }, "name" | "id" | "description">, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        description: string;
+    }, {
+        name: string;
+        id: string;
+        description: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    resource: {
+        name: string;
+        id: string;
+    };
+    scopes: {
+        name: string;
+        id: string;
+        description: string;
+    }[];
+}, {
+    resource: {
+        name: string;
+        id: string;
+    };
+    scopes: {
+        name: string;
+        id: string;
+        description: string;
+    }[];
+}>;
+/**
+ * Define the missing resource scopes for the consent page.
+ */
+export type MissingResourceScopes = z.infer<typeof missingResourceScopesGuard>;
+export declare const consentInfoResponseGuard: z.ZodObject<{
+    application: z.ZodObject<{
+        name: z.ZodType<string, z.ZodTypeDef, string>;
+        id: z.ZodType<string, z.ZodTypeDef, string>;
+        displayName: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        branding: z.ZodOptional<z.ZodType<{
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        }, z.ZodTypeDef, {
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        }>>;
+        termsOfUseUrl: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        privacyPolicyUrl: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        displayName?: string | null | undefined;
+        branding?: {
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        } | undefined;
+        termsOfUseUrl?: string | null | undefined;
+        privacyPolicyUrl?: string | null | undefined;
+    }, {
+        name: string;
+        id: string;
+        displayName?: string | null | undefined;
+        branding?: {
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        } | undefined;
+        termsOfUseUrl?: string | null | undefined;
+        privacyPolicyUrl?: string | null | undefined;
+    }>;
+    user: z.ZodObject<Pick<{
+        tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+        id: z.ZodType<string, z.ZodTypeDef, string>;
+        username: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        primaryEmail: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        primaryPhone: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        passwordEncrypted: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        passwordEncryptionMethod: z.ZodType<import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null, z.ZodTypeDef, import("../db-entries/custom-types.js").UsersPasswordEncryptionMethod | null>;
+        name: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        avatar: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        applicationId: z.ZodType<string | null, z.ZodTypeDef, string | null>;
+        identities: z.ZodType<Record<string, {
+            userId: string;
+            details?: Record<string, unknown> | undefined;
+        }>, z.ZodTypeDef, Record<string, {
+            userId: string;
+            details?: Record<string, unknown> | undefined;
+        }>>;
+        customData: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+        logtoConfig: z.ZodType<import("@withtyped/server").JsonObject, z.ZodTypeDef, import("@withtyped/server").JsonObject>;
+        mfaVerifications: z.ZodType<({
+            type: import("../index.js").MfaFactor.TOTP;
+            id: string;
+            key: string;
+            createdAt: string;
+            lastUsedAt?: string | undefined;
+        } | {
+            type: import("../index.js").MfaFactor.WebAuthn;
+            id: string;
+            createdAt: string;
+            credentialId: string;
+            publicKey: string;
+            counter: number;
+            agent: string;
+            transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+            lastUsedAt?: string | undefined;
+        } | {
+            type: import("../index.js").MfaFactor.BackupCode;
+            id: string;
+            createdAt: string;
+            codes: {
+                code: string;
+                usedAt?: string | undefined;
+            }[];
+            lastUsedAt?: string | undefined;
+        })[], z.ZodTypeDef, ({
+            type: import("../index.js").MfaFactor.TOTP;
+            id: string;
+            key: string;
+            createdAt: string;
+            lastUsedAt?: string | undefined;
+        } | {
+            type: import("../index.js").MfaFactor.WebAuthn;
+            id: string;
+            createdAt: string;
+            credentialId: string;
+            publicKey: string;
+            counter: number;
+            agent: string;
+            transports?: ("usb" | "nfc" | "ble" | "internal" | "cable" | "hybrid" | "smart-card")[] | undefined;
+            lastUsedAt?: string | undefined;
+        } | {
+            type: import("../index.js").MfaFactor.BackupCode;
+            id: string;
+            createdAt: string;
+            codes: {
+                code: string;
+                usedAt?: string | undefined;
+            }[];
+            lastUsedAt?: string | undefined;
+        })[]>;
+        isSuspended: z.ZodType<boolean, z.ZodTypeDef, boolean>;
+        lastSignInAt: z.ZodType<number | null, z.ZodTypeDef, number | null>;
+        createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+    }, "name" | "id" | "username" | "primaryEmail" | "primaryPhone" | "avatar">, "strip", z.ZodTypeAny, {
+        name: string | null;
+        id: string;
+        username: string | null;
+        primaryEmail: string | null;
+        primaryPhone: string | null;
+        avatar: string | null;
+    }, {
+        name: string | null;
+        id: string;
+        username: string | null;
+        primaryEmail: string | null;
+        primaryPhone: string | null;
+        avatar: string | null;
+    }>;
+    organizations: z.ZodOptional<z.ZodArray<z.ZodObject<Pick<{
+        tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+        id: 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>;
+    }, "name" | "id">, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+    }, {
+        name: string;
+        id: string;
+    }>, "many">>;
+    missingOIDCScope: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    missingResourceScopes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        resource: z.ZodObject<{
+            name: z.ZodType<string, z.ZodTypeDef, string>;
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            id: string;
+        }, {
+            name: string;
+            id: string;
+        }>;
+        scopes: z.ZodArray<z.ZodObject<Pick<{
+            tenantId: z.ZodType<string, z.ZodTypeDef, string>;
+            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, z.ZodTypeDef, string>;
+            createdAt: z.ZodType<number, z.ZodTypeDef, number>;
+        }, "name" | "id" | "description">, "strip", z.ZodTypeAny, {
+            name: string;
+            id: string;
+            description: string;
+        }, {
+            name: string;
+            id: string;
+            description: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resource: {
+            name: string;
+            id: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }, {
+        resource: {
+            name: string;
+            id: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }>, "many">>;
+    redirectUri: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    application: {
+        name: string;
+        id: string;
+        displayName?: string | null | undefined;
+        branding?: {
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        } | undefined;
+        termsOfUseUrl?: string | null | undefined;
+        privacyPolicyUrl?: string | null | undefined;
+    };
+    user: {
+        name: string | null;
+        id: string;
+        username: string | null;
+        primaryEmail: string | null;
+        primaryPhone: string | null;
+        avatar: string | null;
+    };
+    redirectUri: string;
+    organizations?: {
+        name: string;
+        id: string;
+    }[] | undefined;
+    missingOIDCScope?: string[] | undefined;
+    missingResourceScopes?: {
+        resource: {
+            name: string;
+            id: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }[] | undefined;
+}, {
+    application: {
+        name: string;
+        id: string;
+        displayName?: string | null | undefined;
+        branding?: {
+            logoUrl?: string | undefined;
+            darkLogoUrl?: string | undefined;
+            favicon?: string | undefined;
+        } | undefined;
+        termsOfUseUrl?: string | null | undefined;
+        privacyPolicyUrl?: string | null | undefined;
+    };
+    user: {
+        name: string | null;
+        id: string;
+        username: string | null;
+        primaryEmail: string | null;
+        primaryPhone: string | null;
+        avatar: string | null;
+    };
+    redirectUri: string;
+    organizations?: {
+        name: string;
+        id: string;
+    }[] | undefined;
+    missingOIDCScope?: string[] | undefined;
+    missingResourceScopes?: {
+        resource: {
+            name: string;
+            id: string;
+        };
+        scopes: {
+            name: string;
+            id: string;
+            description: string;
+        }[];
+    }[] | undefined;
+}>;
+export type ConsentInfoResponse = z.infer<typeof consentInfoResponseGuard>;

package/lib/types/consent.js

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { Applications, Users, Organizations, Resources, Scopes, ApplicationSignInExperiences, } from '../db-entries/index.js';
+/**
+ * Define the public user info that can be exposed to the public. e.g. on the user consent page.
+ */
+export const publicUserInfoGuard = Users.guard.pick({
+    id: true,
+    name: true,
+    avatar: true,
+    username: true,
+    primaryEmail: true,
+    primaryPhone: true,
+});
+/**
+ * Define the public application info that can be exposed to the public. e.g. on the user consent page.
+ */
+export const publicApplicationGuard = Applications.guard.pick({
+    id: true,
+    name: true,
+});
+export const applicationSignInExperienceGuard = ApplicationSignInExperiences.guard.pick({
+    branding: true,
+    displayName: true,
+    privacyPolicyUrl: true,
+    termsOfUseUrl: true,
+});
+/**
+ * Define the public organization info that can be exposed to the public. e.g. on the user consent page.
+ */
+export const publicOrganizationGuard = Organizations.guard.pick({
+    id: true,
+    name: true,
+});
+export const missingResourceScopesGuard = z.object({
+    // The original resource id has a maximum length of 21 restriction. We need to make it compatible with the logto reserved organization name.
+    // use string here, as we do not care about the resource id length here.
+    resource: Resources.guard.pick({ name: true }).extend({ id: z.string() }),
+    scopes: Scopes.guard.pick({ id: true, name: true, description: true }).array(),
+});
+export const consentInfoResponseGuard = z.object({
+    application: publicApplicationGuard.merge(applicationSignInExperienceGuard.partial()),
+    user: publicUserInfoGuard,
+    organizations: publicOrganizationGuard.array().optional(),
+    missingOIDCScope: z.string().array().optional(),
+    missingResourceScopes: missingResourceScopesGuard.array().optional(),
+    redirectUri: z.string(),
+});