@logto/schemas 1.40.1 → 1.42.0

package/lib/types/logto-config/action.d.ts

@@ -0,0 +1,963 @@
+import { z } from 'zod';
+import type { Json } from '../../foundations/index.js';
+import { InteractionEvent, type InteractionIdentifier } from '../interactions.js';
+import { type UserInfo } from '../user.js';
+import { VerificationType } from '../verification-records/index.js';
+import type { JwtCustomizerUserContext } from './jwt-customizer.js';
+/** Values map to config key names in `logto_configs`. */
+export declare enum LogtoActionKey {
+    PostFirstFactorVerification = "action.postFirstFactorVerification",
+    PostSignIn = "action.postSignIn"
+}
+export declare const actionExecutionErrorPolicies: readonly ["block", "allow"];
+export type ActionExecutionErrorPolicy = (typeof actionExecutionErrorPolicies)[number];
+export type LogtoAction = {
+    script: string;
+    environmentVariables?: Record<string, string>;
+    contextSample?: Json;
+    enabled?: boolean;
+    onExecutionError?: ActionExecutionErrorPolicy;
+};
+export declare const logtoActionGuard: z.ZodObject<{
+    script: z.ZodString;
+    environmentVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    contextSample: z.ZodOptional<z.ZodType<Json, z.ZodTypeDef, Json>>;
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    onExecutionError: z.ZodOptional<z.ZodEnum<["block", "allow"]>>;
+}, "strict", z.ZodTypeAny, {
+    script: string;
+    enabled?: boolean | undefined;
+    environmentVariables?: Record<string, string> | undefined;
+    contextSample?: Json | undefined;
+    onExecutionError?: "block" | "allow" | undefined;
+}, {
+    script: string;
+    enabled?: boolean | undefined;
+    environmentVariables?: Record<string, string> | undefined;
+    contextSample?: Json | undefined;
+    onExecutionError?: "block" | "allow" | undefined;
+}>;
+/**
+ * Shared execution payload for production Actions and Management API dry runs.
+ * Cloud remote execution and the local VM runner both accept this shape.
+ */
+export declare const actionExecutionRequestBodyGuard: z.ZodObject<{
+    script: z.ZodString;
+    actionType: z.ZodNativeEnum<typeof LogtoActionKey>;
+    event: z.ZodType<Json, z.ZodTypeDef, Json>;
+    environmentVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strict", z.ZodTypeAny, {
+    event: Json;
+    script: string;
+    actionType: LogtoActionKey;
+    environmentVariables?: Record<string, string> | undefined;
+}, {
+    event: Json;
+    script: string;
+    actionType: LogtoActionKey;
+    environmentVariables?: Record<string, string> | undefined;
+}>;
+export type ActionExecutionRequestBody = z.infer<typeof actionExecutionRequestBodyGuard>;
+export type ActionUser = Pick<UserInfo, 'id' | 'username' | 'primaryEmail' | 'primaryPhone' | 'name' | 'avatar' | 'customData' | 'profile'>;
+export declare const actionUserPatchGuard: z.ZodObject<{
+    name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    profile: z.ZodOptional<z.ZodType<Partial<{
+        familyName: string;
+        givenName: string;
+        middleName: string;
+        nickname: string;
+        preferredUsername: string;
+        profile: string;
+        website: string;
+        gender: string;
+        birthdate: string;
+        zoneinfo: string;
+        locale: string;
+        address: Partial<{
+            formatted: string;
+            streetAddress: string;
+            locality: string;
+            region: string;
+            postalCode: string;
+            country: string;
+        }>;
+    }>, z.ZodTypeDef, Partial<{
+        familyName: string;
+        givenName: string;
+        middleName: string;
+        nickname: string;
+        preferredUsername: string;
+        profile: string;
+        website: string;
+        gender: string;
+        birthdate: string;
+        zoneinfo: string;
+        locale: string;
+        address: Partial<{
+            formatted: string;
+            streetAddress: string;
+            locality: string;
+            region: string;
+            postalCode: string;
+            country: string;
+        }>;
+    }>>>;
+    avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+    primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | null | undefined;
+    username?: string | null | undefined;
+    profile?: Partial<{
+        familyName: string;
+        givenName: string;
+        middleName: string;
+        nickname: string;
+        preferredUsername: string;
+        profile: string;
+        website: string;
+        gender: string;
+        birthdate: string;
+        zoneinfo: string;
+        locale: string;
+        address: Partial<{
+            formatted: string;
+            streetAddress: string;
+            locality: string;
+            region: string;
+            postalCode: string;
+            country: string;
+        }>;
+    }> | undefined;
+    avatar?: string | null | undefined;
+    customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+    primaryEmail?: string | null | undefined;
+    primaryPhone?: string | null | undefined;
+}, {
+    name?: string | null | undefined;
+    username?: string | null | undefined;
+    profile?: Partial<{
+        familyName: string;
+        givenName: string;
+        middleName: string;
+        nickname: string;
+        preferredUsername: string;
+        profile: string;
+        website: string;
+        gender: string;
+        birthdate: string;
+        zoneinfo: string;
+        locale: string;
+        address: Partial<{
+            formatted: string;
+            streetAddress: string;
+            locality: string;
+            region: string;
+            postalCode: string;
+            country: string;
+        }>;
+    }> | undefined;
+    avatar?: string | null | undefined;
+    customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+    primaryEmail?: string | null | undefined;
+    primaryPhone?: string | null | undefined;
+}>;
+export type ActionUserPatch = z.infer<typeof actionUserPatchGuard>;
+export type PostFirstFactorVerificationEvent = {
+    key: LogtoActionKey.PostFirstFactorVerification;
+    interactionEvent: InteractionEvent.SignIn;
+    verificationType: VerificationType.Password;
+    identifier: InteractionIdentifier;
+    user: ActionUser | null;
+    /** Sensitive credential provided for Action-controlled password verification. */
+    password: string;
+};
+export type PostSignInEvent = {
+    key: LogtoActionKey.PostSignIn;
+    interactionEvent: InteractionEvent.SignIn;
+    user: JwtCustomizerUserContext;
+};
+export declare const postFirstFactorVerificationResultGuard: z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
+    action: z.ZodLiteral<"createUser">;
+    user: z.ZodObject<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">>;
+    passwordVerified: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    action: "createUser";
+    user: {
+        name?: string | null | undefined;
+        username?: string | null | undefined;
+        profile?: Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }> | undefined;
+        avatar?: string | null | undefined;
+        customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+        primaryEmail?: string | null | undefined;
+        primaryPhone?: string | null | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    passwordVerified: true;
+}, {
+    action: "createUser";
+    user: {
+        name?: string | null | undefined;
+        username?: string | null | undefined;
+        profile?: Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }> | undefined;
+        avatar?: string | null | undefined;
+        customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+        primaryEmail?: string | null | undefined;
+        primaryPhone?: string | null | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    passwordVerified: true;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"updateUser">;
+    user: z.ZodObject<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">>;
+    passwordVerified: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    action: "updateUser";
+    user: {
+        name?: string | null | undefined;
+        username?: string | null | undefined;
+        profile?: Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }> | undefined;
+        avatar?: string | null | undefined;
+        customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+        primaryEmail?: string | null | undefined;
+        primaryPhone?: string | null | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    passwordVerified: true;
+}, {
+    action: "updateUser";
+    user: {
+        name?: string | null | undefined;
+        username?: string | null | undefined;
+        profile?: Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }> | undefined;
+        avatar?: string | null | undefined;
+        customData?: import("@withtyped/server/lib/types.js").JsonObject | undefined;
+        primaryEmail?: string | null | undefined;
+        primaryPhone?: string | null | undefined;
+    } & {
+        [k: string]: unknown;
+    };
+    passwordVerified: true;
+}>]>;
+export type PostFirstFactorVerificationResult = z.infer<typeof postFirstFactorVerificationResultGuard>;
+export declare const postSignInResultGuard: z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
+    action: z.ZodLiteral<"updateUser">;
+    user: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough">>>;
+}, "strip", z.ZodTypeAny, {
+    action: "updateUser";
+    user?: z.objectOutputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    action: "updateUser";
+    user?: z.objectInputType<{
+        name: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        username: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        profile: z.ZodOptional<z.ZodType<Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>, z.ZodTypeDef, Partial<{
+            familyName: string;
+            givenName: string;
+            middleName: string;
+            nickname: string;
+            preferredUsername: string;
+            profile: string;
+            website: string;
+            gender: string;
+            birthdate: string;
+            zoneinfo: string;
+            locale: string;
+            address: Partial<{
+                formatted: string;
+                streetAddress: string;
+                locality: string;
+                region: string;
+                postalCode: string;
+                country: string;
+            }>;
+        }>>>;
+        avatar: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        customData: z.ZodOptional<z.ZodType<import("@withtyped/server/lib/types.js").JsonObject, z.ZodTypeDef, import("@withtyped/server/lib/types.js").JsonObject>>;
+        primaryEmail: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+        primaryPhone: z.ZodOptional<z.ZodType<string | null, z.ZodTypeDef, string | null>>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>]>;
+export type PostSignInResult = z.infer<typeof postSignInResultGuard>;
+export declare const actionUserPatchFields: readonly ["profile", "name", "username", "avatar", "customData", "primaryEmail", "primaryPhone"];
+/**
+ * The subset of {@link PostFirstFactorVerificationEvent} that is safe to persist in audit logs.
+ *
+ * The end user's password is the only credential in the event that the tenant does not already own,
+ * so it is dropped rather than masked. The user object collapses to its ID because the audit log
+ * records the same ID as a top-level `userId`.
+ */
+export type LoggablePostFirstFactorVerificationEvent = Omit<PostFirstFactorVerificationEvent, 'password' | 'user'> & {
+    user: Pick<ActionUser, 'id'> | null;
+};
+export declare const loggablePostFirstFactorVerificationEventGuard: z.ZodObject<{
+    key: z.ZodLiteral<LogtoActionKey.PostFirstFactorVerification>;
+    interactionEvent: z.ZodLiteral<InteractionEvent.SignIn>;
+    verificationType: z.ZodLiteral<VerificationType.Password>;
+    identifier: z.ZodObject<{
+        type: z.ZodNativeEnum<typeof import("../../foundations/index.js").SignInIdentifier>;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: import("../../foundations/index.js").SignInIdentifier;
+    }, {
+        value: string;
+        type: import("../../foundations/index.js").SignInIdentifier;
+    }>;
+    user: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    key: LogtoActionKey.PostFirstFactorVerification;
+    identifier: {
+        value: string;
+        type: import("../../foundations/index.js").SignInIdentifier;
+    };
+    interactionEvent: InteractionEvent.SignIn;
+    user: {
+        id: string;
+    } | null;
+    verificationType: VerificationType.Password;
+}, {
+    key: LogtoActionKey.PostFirstFactorVerification;
+    identifier: {
+        value: string;
+        type: import("../../foundations/index.js").SignInIdentifier;
+    };
+    interactionEvent: InteractionEvent.SignIn;
+    user: {
+        id: string;
+    } | null;
+    verificationType: VerificationType.Password;
+}>;
+/**
+ * The subset of {@link PostSignInEvent} that is safe to persist in audit logs. The full
+ * {@link JwtCustomizerUserContext} carries the user's identifiers, SSO identities, MFA factors,
+ * roles, and organizations, none of which the audit log needs to describe the action run.
+ */
+export type LoggablePostSignInEvent = Omit<PostSignInEvent, 'user'> & {
+    user: Pick<JwtCustomizerUserContext, 'id'>;
+};
+export declare const loggablePostSignInEventGuard: z.ZodObject<{
+    key: z.ZodLiteral<LogtoActionKey.PostSignIn>;
+    interactionEvent: z.ZodLiteral<InteractionEvent.SignIn>;
+    user: z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    key: LogtoActionKey.PostSignIn;
+    interactionEvent: InteractionEvent.SignIn;
+    user: {
+        id: string;
+    };
+}, {
+    key: LogtoActionKey.PostSignIn;
+    interactionEvent: InteractionEvent.SignIn;
+    user: {
+        id: string;
+    };
+}>;
+export type LoggableActionEvent = LoggablePostFirstFactorVerificationEvent | LoggablePostSignInEvent;
+/**
+ * The audit-log description of what a script asked Logto to do. Action results are authored by
+ * untrusted scripts, so this reports the shape of the requested user patch instead of its values,
+ * and names only fields on the {@link actionUserPatchFields} allowlist.
+ */
+export type LoggableActionResult = {
+    passwordVerified: boolean;
+    userFields: Array<keyof ActionUserPatch>;
+    unknownFieldCount: number;
+};