@mudrichenkoevgeny/shared-foundation 0.0.46 → 0.0.48

package/README.md

@@ -0,0 +1,35 @@
+# @mudrichenkoevgeny/shared-foundation
+
+TypeScript & Zod contracts, API routes, error codes, permission models, runtime enums, and branded types generated directly from the [shared-foundation](https://github.com/mudrichenkoevgeny/shared-foundation) Kotlin Multiplatform (KMP) repository.
+
+Provides a single source of truth (SSOT) between Kotlin Backend/KMP services and TypeScript/React web applications.
+
+## Installation
+
+```bash
+# pnpm
+pnpm add @mudrichenkoevgeny/shared-foundation zod
+
+# npm
+npm install @mudrichenkoevgeny/shared-foundation zod
+
+# yarn
+yarn add @mudrichenkoevgeny/shared-foundation zod
+```
+
+## Features
+
+- **Zod Schemas**: Auto-generated `z.ZodType` validation schemas for all Request payloads and Response DTOs.
+- **Runtime Enums**: TS types & runtime JS objects for all enums and string unions (`UserAuthProvider`, `UserRole`, `UserAccountStatus`, `AccountLockoutType`, `ClientType`, `SortOrder`, `UserSortValues`, etc.).
+- **Route Constants**: Strongly typed API endpoint routes.
+- **Error & Permission Codes**: Literal string definitions for all application error codes and permission strings.
+- **Branded Types & Helpers**: Type-safe domain identifiers with converter helpers.
+
+## Source Code & Repository
+
+The source code for this library and generator is maintained in the main GitHub repository:
+**[GitHub Repository: mudrichenkoevgeny/shared-foundation](https://github.com/mudrichenkoevgeny/shared-foundation)**
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/mudrichenkoevgeny/shared-foundation/blob/main/LICENSE) for details.

package/index.d.ts

@@ -228,6 +228,212 @@ readonly UPDATE_MANAGEMENT_AUTH_SETTINGS: "/management/auth/settings";
 readonly RESET_MANAGEMENT_AUTH_SETTINGS: "/management/auth/settings/reset";
     };
 
+        export declare const CommonApiFields: {
+        readonly ITEMS: "items";
+readonly TOTAL_COUNT: "total_count";
+readonly TOTAL_PAGES: "total_pages";
+readonly ID: "id";
+readonly CREATED_AT: "created_at";
+readonly UPDATED_AT: "updated_at";
+readonly CODE: "code";
+readonly MESSAGE: "message";
+readonly ARGS: "args";
+readonly TYPE: "type";
+readonly PAYLOAD: "payload";
+readonly METADATA: "metadata";
+readonly TIMESTAMP: "timestamp";
+readonly CLIENT_TYPE: "client_type";
+readonly CLIENT_DEVICE_INFO: "client_device_info";
+readonly CLIENT_INFO: "client_info";
+readonly USER_AGENT: "user_agent";
+readonly IP_ADDRESS: "ip_address";
+readonly MASKED_IP_ADDRESS: "masked_ip_address";
+readonly LANGUAGE: "language";
+readonly DEVICE_ID: "device_id";
+readonly DEVICE_NAME: "device_name";
+readonly APP_VERSION: "app_version";
+readonly OPERATION_SYSTEM_VERSION: "operation_system_version";
+readonly API_VERSION: "api_version";
+readonly IS_SENSITIVE_VALUES_MASKED: "is_sensitive_values_masked";
+    };
+
+    export declare const SecurityApiFields: {
+        readonly RECENT_AUTHENTICATION_VALIDITY_SECONDS_FOR_OPEN_USER: "recent_authentication_validity_seconds_for_open_user";
+readonly RECENT_AUTHENTICATION_VALIDITY_SECONDS_FOR_MANAGEMENT_USER: "recent_authentication_validity_seconds_for_management_user";
+readonly MFA_TOKEN: "mfa_token";
+readonly TOTP_CODE: "totp_code";
+readonly TOTP_SECRET_KEY: "totp_secret_key";
+readonly TOTP_OTP_AUTH_URL: "totp_otp_auth_url";
+readonly TOTP_RECOVERY_CODES: "totp_recovery_codes";
+readonly OPEN_PASSWORD_POLICY: "open_password_policy";
+readonly MANAGEMENT_PASSWORD_POLICY: "management_password_policy";
+readonly MIN_LENGTH: "min_length";
+readonly REQUIRE_LETTER: "require_letter";
+readonly REQUIRE_UPPER_CASE: "require_upper_case";
+readonly REQUIRE_LOWER_CASE: "require_lower_case";
+readonly REQUIRE_DIGIT: "require_digit";
+readonly REQUIRE_SPECIAL_CHAR: "require_special_char";
+readonly COMMON_PASSWORDS: "common_passwords";
+readonly OTP_CONFIRMATION: "otp_confirmation";
+readonly RETRY_AFTER_SECONDS: "retry_after_seconds";
+readonly NUMBER_OF_SYMBOLS: "number_of_symbols";
+readonly EXPIRATION_SECONDS: "expiration_seconds";
+readonly MAX_REQUESTS_PER_PERIOD: "max_requests_per_period";
+readonly RATE_LIMIT_PERIOD_SECONDS: "rate_limit_period_seconds";
+readonly REFRESH_TOKEN_ROTATION_GRACE_PERIOD_SECONDS: "refresh_token_rotation_grace_period_seconds";
+readonly ACCOUNT_LOCKOUT_POLICY: "account_lockout_policy";
+readonly ACCOUNT_LOCKOUT_CHECK_INTERVAL_SECONDS: "account_lockout_check_interval_seconds";
+readonly MAX_FAILED_PASSWORD_ATTEMPTS: "max_failed_password_attempts";
+readonly MAX_FAILED_OTP_ATTEMPTS: "max_failed_otp_attempts";
+readonly MAX_FAILED_TOTP_ATTEMPTS: "max_failed_totp_attempts";
+readonly FAILED_ATTEMPTS_WINDOW_SECONDS: "failed_attempts_window_seconds";
+readonly LOCKOUT_DURATION_SECONDS: "lockout_duration_seconds";
+readonly INDEFINITE_LOCKOUT_THRESHOLD: "indefinite_lockout_threshold";
+readonly IS_SELF_SERVICE_UNLOCK_ENABLED: "is_self_service_unlock_enabled";
+readonly OPEN_IP_RESTRICTION_POLICY: "open_ip_restriction_policy";
+readonly MANAGEMENT_IP_RESTRICTION_POLICY: "management_ip_restriction_policy";
+readonly IS_BLACKLIST_ENABLED: "is_blacklist_enabled";
+readonly BLACKLIST: "blacklist";
+readonly IS_WHITELIST_ENABLED: "is_whitelist_enabled";
+readonly WHITELIST: "whitelist";
+    };
+
+    export declare const GlobalSettingsApiFields: {
+        readonly PRIVACY_POLICY_URL: "privacy_policy_url";
+readonly TERMS_OF_SERVICE_URL: "terms_of_service_url";
+readonly CONTACT_SUPPORT_EMAIL: "contact_support_email";
+readonly IS_TRACING_ENABLED: "is_tracing_enabled";
+readonly IS_METRICS_ENABLED: "is_metrics_enabled";
+readonly IS_VERBOSE_LOGGING_ENABLED: "is_verbose_logging_enabled";
+readonly MIN_SUPPORTED_APP_VERSIONS: "min_supported_app_versions";
+    };
+
+    export declare const UserApiFields: {
+        readonly EXTERNAL_PROVIDER_TOKEN: "external_provider_token";
+readonly TOKEN_TYPE: "token_type";
+readonly SESSION_ID: "session_id";
+readonly ACCESS_TOKEN: "access_token";
+readonly REFRESH_TOKEN: "refresh_token";
+readonly SESSION_TOKEN: "session_token";
+readonly EXPIRES_AT: "expires_at";
+readonly EMAIL: "email";
+readonly PHONE_NUMBER: "phone_number";
+readonly PASSWORD: "password";
+readonly OLD_PASSWORD: "old_password";
+readonly NEW_PASSWORD: "new_password";
+readonly CONFIRMATION_CODE: "confirmation_code";
+readonly AUTH_PROVIDER: "auth_provider";
+readonly USER: "user";
+readonly USER_ID: "user_id";
+readonly ROLE: "role";
+readonly USER_ROLE: "user_role";
+readonly ACCOUNT_STATUS: "account_status";
+readonly ACCOUNT_STATUS_ON_RESTORE: "account_status_on_restore";
+readonly AUTHORITY_LEVEL: "authority_level";
+readonly PERMISSION_CODES: "permission_codes";
+readonly IS_TOTP_ENABLED: "is_totp_enabled";
+readonly LAST_LOGIN_AT: "last_login_at";
+readonly LAST_ACTIVE_AT: "last_active_at";
+readonly SCHEDULED_PERMANENT_DELETION_AT: "scheduled_permanent_deletion_at";
+readonly ACCOUNT_LOCKOUT_TYPE: "account_lockout_type";
+readonly TEMPORARY_LOCKOUT_UNTIL: "temporary_lockout_until";
+readonly IDENTIFIER: "identifier";
+readonly EXTERNAL_PROVIDER_EMAIL: "external_provider_email";
+readonly USER_AUTH_PROVIDER: "user_auth_provider";
+readonly IDENTIFIER_ID: "identifier_id";
+readonly DISPLAY_NAME: "display_name";
+readonly IDENTIFIER_DISPLAY_NAME: "identifier_display_name";
+readonly IDENTIFIER_AUTH_PROVIDER: "identifier_auth_provider";
+readonly LAST_ACCESSED_AT: "last_accessed_at";
+readonly LAST_REAUTHENTICATED_AT: "last_reauthenticated_at";
+readonly DELETED_SESSION_IDS: "deleted_session_ids";
+readonly DELETED_IDENTIFIER_IDS: "deleted_identifier_ids";
+readonly MAX_TOTAL_IDENTIFIERS: "max_total_identifiers";
+readonly MAX_EMAIL_IDENTIFIERS: "max_email_identifiers";
+readonly MAX_PHONE_IDENTIFIERS: "max_phone_identifiers";
+readonly MAX_IDENTIFIERS_PER_EXTERNAL_PROVIDER: "max_identifiers_per_external_provider";
+readonly MAX_ACTIVE_SESSIONS_FOR_OPEN_USER: "max_active_sessions_for_open_user";
+readonly MAX_ACTIVE_SESSIONS_FOR_MANAGEMENT_USER: "max_active_sessions_for_management_user";
+readonly AVAILABLE_AUTH_PROVIDERS: "available_auth_providers";
+readonly ACCESS_TOKEN_VALIDITY_SECONDS: "access_token_validity_seconds";
+readonly REFRESH_TOKEN_VALIDITY_SECONDS: "refresh_token_validity_seconds";
+readonly ACCOUNT_DELETION_GRACE_PERIOD_SECONDS: "account_deletion_grace_period_seconds";
+readonly ACCOUNT_DELETION_CHECK_INTERVAL_SECONDS: "account_deletion_check_interval_seconds";
+readonly IS_REGISTRATION_ENABLED: "is_registration_enabled";
+readonly EMAIL_RESTRICTION_POLICY: "email_restriction_policy";
+readonly OPEN_EMAIL_RESTRICTION_POLICY: "open_email_restriction_policy";
+readonly MANAGEMENT_EMAIL_RESTRICTION_POLICY: "management_email_restriction_policy";
+readonly PRIMARY: "primary";
+readonly SECONDARY: "secondary";
+readonly OPEN_GLOBAL_SETTINGS: "open_global_settings";
+readonly MANAGEMENT_GLOBAL_SETTINGS: "management_global_settings";
+readonly OPEN_SECURITY_SETTINGS: "open_security_settings";
+readonly MANAGEMENT_SECURITY_SETTINGS: "management_security_settings";
+readonly OPEN_AUTH_SETTINGS: "open_auth_settings";
+readonly MANAGEMENT_AUTH_SETTINGS: "management_auth_settings";
+    };
+
+    export declare const AuditEventFields: {
+        readonly ACTOR_ID: "actor_id";
+readonly ACTOR_TYPE: "actor_type";
+readonly ACTOR_USER_ROLE: "actor_user_role";
+readonly ACTION: "action";
+readonly RESOURCE: "resource";
+readonly RESOURCE_ID: "resource_id";
+readonly STATUS: "status";
+readonly METADATA_KEY: "key";
+readonly METADATA_VALUE: "value";
+readonly METADATA_VALUE_SENSITIVITY: "value_sensitivity";
+    };
+
+    export declare const CommonHttpHeaders: {
+        readonly TRACE_HEADER_NAME: "X-Trace-Id";
+readonly CLIENT_TYPE_HEADER_NAME: "X-Client-Type";
+readonly DEVICE_ID_HEADER_NAME: "X-Device-Id";
+readonly DEVICE_NAME_HEADER_NAME: "X-Device-Name";
+readonly APP_VERSION_HEADER_NAME: "X-App-Version";
+readonly OPERATION_SYSTEM_VERSION_HEADER_NAME: "X-OS-Version";
+readonly API_VERSION_HEADER_NAME: "X-Api-Version";
+    };
+
+    export declare const CommonWebSocketCloseReasons: {
+        readonly NORMAL: "Normal";
+readonly SERVER_RESTART: "Server restart";
+readonly INTERNAL_SERVER_ERROR: "Internal server error";
+    };
+
+    export declare const CommonWebSocketEventTypes: {
+        readonly PING: "PING";
+readonly PONG: "PONG";
+readonly INITIALIZE: "INITIALIZE";
+readonly INITIALIZED_SUCCESS: "INITIALIZED_SUCCESS";
+    };
+
+    export declare const SecurityWebSocketEventTypes: {
+        readonly OPEN_SECURITY_SETTINGS_UPDATED: "OPEN_SECURITY_SETTINGS_UPDATED";
+readonly MANAGEMENT_SECURITY_SETTINGS_UPDATED: "MANAGEMENT_SECURITY_SETTINGS_UPDATED";
+    };
+
+    export declare const SettingsWebSocketEventTypes: {
+        readonly OPEN_GLOBAL_SETTINGS_UPDATED: "OPEN_GLOBAL_SETTINGS_UPDATED";
+readonly MANAGEMENT_GLOBAL_SETTINGS_UPDATED: "MANAGEMENT_GLOBAL_SETTINGS_UPDATED";
+    };
+
+    export declare const ListingParamNames: {
+  readonly PAGE_NUMBER: "page_number";
+  readonly PAGE_SIZE: "page_size";
+  readonly SORT_BY: "sort_by";
+  readonly SORT_ORDER: "sort_order";
+  readonly Pagination: {
+    readonly PAGE_NUMBER: "page_number";
+    readonly PAGE_SIZE: "page_size";
+  };
+  readonly Sort: {
+    readonly SORT_BY: "sort_by";
+    readonly SORT_ORDER: "sort_order";
+  };
+};
+
         export declare const CommonErrorCodes: {
         readonly UNKNOWN: "UNKNOWN";
 readonly INTERNAL: "INTERNAL";
@@ -320,87 +526,322 @@ readonly ACCOUNT_LOCKOUT_TYPE: "accountLockoutType";
 readonly TEMPORARY_LOCKOUT_UNTIL: "temporaryLockoutUntil";
     };
 
-    export declare const AuditPermissionCode: {
+    export const AuditPermissionCode: {
 
 };
 
-export declare const SecurityPermissionCode: {
+export const SecurityPermissionCode: {
 
 };
 
-export declare const SettingsPermissionCode: {
+export const SettingsPermissionCode: {
 
 };
 
-export declare const AuthSettingsPermissionCode: {
+export const AuthSettingsPermissionCode: {
 
 };
 
-export declare const IdentifierPermissionCode: {
+export const IdentifierPermissionCode: {
 
 };
 
-export declare const SessionPermissionCode: {
+export const SessionPermissionCode: {
 
 };
 
-export declare const UserPermissionCode: {
+export const UserPermissionCode: {
 
 };
 
-    export const clientTypeSchema: z.ZodType<string>;
-export type ClientType = z.infer<typeof clientTypeSchema>;
-
-export const sortOrderSchema: z.ZodType<string>;
-export type SortOrder = z.infer<typeof sortOrderSchema>;
-
-export const accountLockoutTypeSchema: z.ZodType<string>;
-export type AccountLockoutType = z.infer<typeof accountLockoutTypeSchema>;
-
-export const passwordPolicyFailReasonSchema: z.ZodType<string>;
-export type PasswordPolicyFailReason = z.infer<typeof passwordPolicyFailReasonSchema>;
-
-export const auditActorTypeSchema: z.ZodType<string>;
-export type AuditActorType = z.infer<typeof auditActorTypeSchema>;
-
-export const auditValueSensitivitySchema: z.ZodType<string>;
-export type AuditValueSensitivity = z.infer<typeof auditValueSensitivitySchema>;
-
-export const auditStatusSchema: z.ZodType<string>;
-export type AuditStatus = z.infer<typeof auditStatusSchema>;
-
-export const commonAuditResourceTypeSchema: z.ZodType<string>;
-export type CommonAuditResourceType = z.infer<typeof commonAuditResourceTypeSchema>;
-
-export const securityAuditResourceTypeSchema: z.ZodType<string>;
-export type SecurityAuditResourceType = z.infer<typeof securityAuditResourceTypeSchema>;
-
-export const settingsAuditResourceTypeSchema: z.ZodType<string>;
-export type SettingsAuditResourceType = z.infer<typeof settingsAuditResourceTypeSchema>;
-
-export const userAuditResourceTypeSchema: z.ZodType<string>;
-export type UserAuditResourceType = z.infer<typeof userAuditResourceTypeSchema>;
-
-export const securityAuditActionTypeSchema: z.ZodType<string>;
-export type SecurityAuditActionType = z.infer<typeof securityAuditActionTypeSchema>;
-
-export const settingsAuditActionTypeSchema: z.ZodType<string>;
-export type SettingsAuditActionType = z.infer<typeof settingsAuditActionTypeSchema>;
-
-export const userAuditActionTypeSchema: z.ZodType<string>;
-export type UserAuditActionType = z.infer<typeof userAuditActionTypeSchema>;
-
-export const userAccountStatusSchema: z.ZodType<string>;
-export type UserAccountStatus = z.infer<typeof userAccountStatusSchema>;
-
-export const userRoleSchema: z.ZodType<string>;
-export type UserRole = z.infer<typeof userRoleSchema>;
-
-export const userAuthProviderSchema: z.ZodType<string>;
-export type UserAuthProvider = z.infer<typeof userAuthProviderSchema>;
+          export type ClientType = 'web' | 'android' | 'ios' | 'desktop';
+      export const ClientType: {
+        readonly WEB: 'web';
+readonly ANDROID: 'android';
+readonly IOS: 'ios';
+readonly DESKTOP: 'desktop';
+      };
+      export const clientTypeSchema: z.ZodType<ClientType>;
+
+      export type SortOrder = 'asc' | 'desc';
+      export const SortOrder: {
+        readonly ASC: 'asc';
+readonly DESC: 'desc';
+      };
+      export const sortOrderSchema: z.ZodType<SortOrder>;
+
+      export type AccountLockoutType = 'none' | 'indefinite' | 'temporary';
+      export const AccountLockoutType: {
+        readonly NONE: 'none';
+readonly INDEFINITE: 'indefinite';
+readonly TEMPORARY: 'temporary';
+readonly PERMANENT: 'indefinite';
+      };
+      export const accountLockoutTypeSchema: z.ZodType<AccountLockoutType>;
+
+      export type PasswordPolicyFailReason = 'too_short' | 'no_letter' | 'no_uppercase' | 'no_lowercase' | 'no_digit' | 'no_special_char' | 'too_common';
+      export const PasswordPolicyFailReason: {
+        readonly TOO_SHORT: 'too_short';
+readonly NO_LETTER: 'no_letter';
+readonly NO_UPPERCASE: 'no_uppercase';
+readonly NO_LOWERCASE: 'no_lowercase';
+readonly NO_DIGIT: 'no_digit';
+readonly NO_SPECIAL_CHAR: 'no_special_char';
+readonly TOO_COMMON: 'too_common';
+      };
+      export const passwordPolicyFailReasonSchema: z.ZodType<PasswordPolicyFailReason>;
+
+      export type AuditActorType = 'user' | 'system' | 'service';
+      export const AuditActorType: {
+        readonly USER: 'user';
+readonly SYSTEM: 'system';
+readonly SERVICE: 'service';
+      };
+      export const auditActorTypeSchema: z.ZodType<AuditActorType>;
+
+      export type AuditValueSensitivity = 'non_sensitive' | 'email' | 'phone_number' | 'ip_address' | 'partial_value_mask' | 'full_value_mask';
+      export const AuditValueSensitivity: {
+        readonly NON_SENSITIVE: 'non_sensitive';
+readonly EMAIL: 'email';
+readonly PHONE_NUMBER: 'phone_number';
+readonly IP_ADDRESS: 'ip_address';
+readonly PARTIAL_VALUE_MASK: 'partial_value_mask';
+readonly FULL_VALUE_MASK: 'full_value_mask';
+      };
+      export const auditValueSensitivitySchema: z.ZodType<AuditValueSensitivity>;
+
+      export type AuditStatus = 'success' | 'failed' | 'denied';
+      export const AuditStatus: {
+        readonly SUCCESS: 'success';
+readonly FAILED: 'failed';
+readonly DENIED: 'denied';
+      };
+      export const auditStatusSchema: z.ZodType<AuditStatus>;
+
+      export type CommonAuditResourceType = 'audit_event' | 'audit_events';
+      export const CommonAuditResourceType: {
+        readonly AUDIT_EVENT: 'audit_event';
+readonly AUDIT_EVENTS: 'audit_events';
+      };
+      export const commonAuditResourceTypeSchema: z.ZodType<CommonAuditResourceType>;
+
+export type SecurityAuditResourceType = 'security_settings';
+export const SecurityAuditResourceType: {
+  readonly SECURITY_SETTINGS: 'security_settings';
+};
+export const securityAuditResourceTypeSchema: z.ZodType<SecurityAuditResourceType>;
 
-export const externalAuthProviderSchema: z.ZodType<string>;
-export type ExternalAuthProvider = z.infer<typeof externalAuthProviderSchema>;
+export type SettingsAuditResourceType = 'global_settings';
+export const SettingsAuditResourceType: {
+  readonly GLOBAL_SETTINGS: 'global_settings';
+};
+export const settingsAuditResourceTypeSchema: z.ZodType<SettingsAuditResourceType>;
+
+      export type UserAuditResourceType = 'auth_settings' | 'user' | 'email_address' | 'phone_number' | 'identifier' | 'session';
+      export const UserAuditResourceType: {
+        readonly AUTH_SETTINGS: 'auth_settings';
+readonly USER: 'user';
+readonly EMAIL_ADDRESS: 'email_address';
+readonly PHONE_NUMBER: 'phone_number';
+readonly IDENTIFIER: 'identifier';
+readonly SESSION: 'session';
+      };
+      export const userAuditResourceTypeSchema: z.ZodType<UserAuditResourceType>;
+
+      export type SecurityAuditActionType = 'management_update_security_settings' | 'management_reset_security_settings';
+      export const SecurityAuditActionType: {
+        readonly MANAGEMENT_UPDATE_SECURITY_SETTINGS: 'management_update_security_settings';
+readonly MANAGEMENT_RESET_SECURITY_SETTINGS: 'management_reset_security_settings';
+      };
+      export const securityAuditActionTypeSchema: z.ZodType<SecurityAuditActionType>;
+
+      export type SettingsAuditActionType = 'management_update_global_settings' | 'management_reset_global_settings';
+      export const SettingsAuditActionType: {
+        readonly MANAGEMENT_UPDATE_GLOBAL_SETTINGS: 'management_update_global_settings';
+readonly MANAGEMENT_RESET_GLOBAL_SETTINGS: 'management_reset_global_settings';
+      };
+      export const settingsAuditActionTypeSchema: z.ZodType<SettingsAuditActionType>;
+
+      export type UserAuditActionType = 'management_update_auth_settings' | 'management_reset_auth_settings' | 'management_delete_identifier' | 'management_delete_identifier_password' | 'management_delete_session' | 'management_delete_all_user_sessions' | 'management_update_user' | 'management_delete_user' | 'management_create_user' | 'management_disable_user_totp' | 'login_by_email' | 'login_by_phone' | 'login_by_external_auth_provider' | 'login_by_totp' | 'login_by_totp_recovery_code' | 'new_device_detected' | 'register_by_email' | 'reset_password' | 'self_unlock_account' | 'logout' | 'self_delete_session' | 'self_delete_other_sessions' | 'reauthenticate_session' | 'self_delete_identifier' | 'add_identifier_email' | 'add_identifier_phone' | 'add_identifier_external_auth_provider' | 'change_password' | 'self_schedule_user_deletion' | 'self_restore_user' | 'self_setup_totp_initiated' | 'self_enable_totp' | 'self_disable_totp' | 'self_get_recovery_codes' | 'self_regenerate_recovery_codes' | 'refresh_token_reuse_detected';
+      export const UserAuditActionType: {
+        readonly MANAGEMENT_UPDATE_AUTH_SETTINGS: 'management_update_auth_settings';
+readonly MANAGEMENT_RESET_AUTH_SETTINGS: 'management_reset_auth_settings';
+readonly MANAGEMENT_DELETE_IDENTIFIER: 'management_delete_identifier';
+readonly MANAGEMENT_DELETE_IDENTIFIER_PASSWORD: 'management_delete_identifier_password';
+readonly MANAGEMENT_DELETE_SESSION: 'management_delete_session';
+readonly MANAGEMENT_DELETE_ALL_USER_SESSIONS: 'management_delete_all_user_sessions';
+readonly MANAGEMENT_UPDATE_USER: 'management_update_user';
+readonly MANAGEMENT_DELETE_USER: 'management_delete_user';
+readonly MANAGEMENT_CREATE_USER: 'management_create_user';
+readonly MANAGEMENT_DISABLE_USER_TOTP: 'management_disable_user_totp';
+readonly LOGIN_BY_EMAIL: 'login_by_email';
+readonly LOGIN_BY_PHONE: 'login_by_phone';
+readonly LOGIN_BY_EXTERNAL_AUTH_PROVIDER: 'login_by_external_auth_provider';
+readonly LOGIN_BY_TOTP: 'login_by_totp';
+readonly LOGIN_BY_TOTP_RECOVERY_CODE: 'login_by_totp_recovery_code';
+readonly NEW_DEVICE_DETECTED: 'new_device_detected';
+readonly REGISTER_BY_EMAIL: 'register_by_email';
+readonly RESET_PASSWORD: 'reset_password';
+readonly SELF_UNLOCK_ACCOUNT: 'self_unlock_account';
+readonly LOGOUT: 'logout';
+readonly SELF_DELETE_SESSION: 'self_delete_session';
+readonly SELF_DELETE_OTHER_SESSIONS: 'self_delete_other_sessions';
+readonly REAUTHENTICATE_SESSION: 'reauthenticate_session';
+readonly SELF_DELETE_IDENTIFIER: 'self_delete_identifier';
+readonly ADD_IDENTIFIER_EMAIL: 'add_identifier_email';
+readonly ADD_IDENTIFIER_PHONE: 'add_identifier_phone';
+readonly ADD_IDENTIFIER_EXTERNAL_AUTH_PROVIDER: 'add_identifier_external_auth_provider';
+readonly CHANGE_PASSWORD: 'change_password';
+readonly SELF_SCHEDULE_USER_DELETION: 'self_schedule_user_deletion';
+readonly SELF_RESTORE_USER: 'self_restore_user';
+readonly SELF_SETUP_TOTP_INITIATED: 'self_setup_totp_initiated';
+readonly SELF_ENABLE_TOTP: 'self_enable_totp';
+readonly SELF_DISABLE_TOTP: 'self_disable_totp';
+readonly SELF_GET_RECOVERY_CODES: 'self_get_recovery_codes';
+readonly SELF_REGENERATE_RECOVERY_CODES: 'self_regenerate_recovery_codes';
+readonly REFRESH_TOKEN_REUSE_DETECTED: 'refresh_token_reuse_detected';
+      };
+      export const userAuditActionTypeSchema: z.ZodType<UserAuditActionType>;
+
+      export type UserAccountStatus = 'active' | 'read_only' | 'banned' | 'security_hold' | 'pending_deletion';
+      export const UserAccountStatus: {
+        readonly ACTIVE: 'active';
+readonly READ_ONLY: 'read_only';
+readonly BANNED: 'banned';
+readonly SECURITY_HOLD: 'security_hold';
+readonly PENDING_DELETION: 'pending_deletion';
+      };
+      export const userAccountStatusSchema: z.ZodType<UserAccountStatus>;
+
+      export type UserRole = 'user' | 'staff' | 'admin';
+      export const UserRole: {
+        readonly USER: 'user';
+readonly STAFF: 'staff';
+readonly ADMIN: 'admin';
+readonly CLIENT_USER: 'user';
+readonly MANAGEMENT_USER: 'admin';
+      };
+      export const userRoleSchema: z.ZodType<UserRole>;
+
+      export type UserAuthProvider = 'email' | 'phone' | 'google' | 'apple';
+      export const UserAuthProvider: {
+        readonly EMAIL: 'email';
+readonly PHONE: 'phone';
+readonly GOOGLE: 'google';
+readonly APPLE: 'apple';
+      };
+      export const userAuthProviderSchema: z.ZodType<UserAuthProvider>;
+
+      export type ExternalAuthProvider = 'google' | 'apple';
+      export const ExternalAuthProvider: {
+        readonly GOOGLE: 'google';
+readonly APPLE: 'apple';
+      };
+      export const externalAuthProviderSchema: z.ZodType<ExternalAuthProvider>;
+
+      export type UserSortBy = 'last_login_at' | 'last_active_at' | 'scheduled_permanent_deletion_at' | 'account_lockout_type' | 'temporary_lockout_until' | 'created_at' | 'updated_at';
+      export const UserSortBy: {
+        readonly LAST_LOGIN_AT: 'last_login_at';
+readonly LAST_ACTIVE_AT: 'last_active_at';
+readonly SCHEDULED_PERMANENT_DELETION_AT: 'scheduled_permanent_deletion_at';
+readonly ACCOUNT_LOCKOUT_TYPE: 'account_lockout_type';
+readonly TEMPORARY_LOCKOUT_UNTIL: 'temporary_lockout_until';
+readonly CREATED_AT: 'created_at';
+readonly UPDATED_AT: 'updated_at';
+      };
+      export const userSortBySchema: z.ZodType<UserSortBy>;
+
+      export type UserIdentifierSortBy = 'created_at' | 'updated_at';
+      export const UserIdentifierSortBy: {
+        readonly CREATED_AT: 'created_at';
+readonly UPDATED_AT: 'updated_at';
+      };
+      export const userIdentifierSortBySchema: z.ZodType<UserIdentifierSortBy>;
+
+      export type UserSessionSortBy = 'expires_at' | 'last_accessed_at' | 'last_reauthenticated_at' | 'created_at' | 'updated_at';
+      export const UserSessionSortBy: {
+        readonly EXPIRES_AT: 'expires_at';
+readonly LAST_ACCESSED_AT: 'last_accessed_at';
+readonly LAST_REAUTHENTICATED_AT: 'last_reauthenticated_at';
+readonly CREATED_AT: 'created_at';
+readonly UPDATED_AT: 'updated_at';
+      };
+      export const userSessionSortBySchema: z.ZodType<UserSessionSortBy>;
+
+export type AuditEventSortBy = 'created_at';
+export const AuditEventSortBy: {
+  readonly CREATED_AT: 'created_at';
+};
+export const auditEventSortBySchema: z.ZodType<AuditEventSortBy>;
+
+      export type TimestampSortBy = 'created_at' | 'updated_at';
+      export const TimestampSortBy: {
+        readonly CREATED_AT: 'created_at';
+readonly UPDATED_AT: 'updated_at';
+      };
+      export const timestampSortBySchema: z.ZodType<TimestampSortBy>;
+
+      export type UnlockMethod = 'EMAIL' | 'PHONE';
+      export const UnlockMethod: {
+        readonly EMAIL: 'EMAIL';
+readonly PHONE: 'PHONE';
+      };
+      export const unlockMethodSchema: z.ZodType<UnlockMethod>;
+
+      export type ConfirmationType = 'REGISTRATION_EMAIL' | 'ADD_EMAIL' | 'PASSWORD_RESET_EMAIL' | 'LOGIN_PHONE' | 'ADD_PHONE' | 'UNLOCK_EMAIL' | 'UNLOCK_PHONE';
+      export const ConfirmationType: {
+        readonly REGISTRATION_EMAIL: 'REGISTRATION_EMAIL';
+readonly ADD_EMAIL: 'ADD_EMAIL';
+readonly PASSWORD_RESET_EMAIL: 'PASSWORD_RESET_EMAIL';
+readonly LOGIN_PHONE: 'LOGIN_PHONE';
+readonly ADD_PHONE: 'ADD_PHONE';
+readonly UNLOCK_EMAIL: 'UNLOCK_EMAIL';
+readonly UNLOCK_PHONE: 'UNLOCK_PHONE';
+      };
+      export const confirmationTypeSchema: z.ZodType<ConfirmationType>;
+
+      export type AppType = 'CLIENT' | 'MANAGEMENT';
+      export const AppType: {
+        readonly CLIENT: 'CLIENT';
+readonly MANAGEMENT: 'MANAGEMENT';
+      };
+      export const appTypeSchema: z.ZodType<AppType>;
+
+    export interface ConfirmationKey {
+  readonly type: ConfirmationType;
+  readonly identifier: string;
+}
+export const confirmationKeySchema: z.ZodType<ConfirmationKey>;
+
+export type UserSortValues = 'created_at' | 'updated_at' | 'last_accessed_at' | 'last_reauthenticated_at' | 'expires_at';
+
+export namespace UserSortValues {
+  export type UserSortBy = 'last_login_at' | 'last_active_at' | 'scheduled_permanent_deletion_at' | 'account_lockout_type' | 'temporary_lockout_until' | 'created_at' | 'updated_at';
+  export const UserSortBy: {
+    readonly LAST_LOGIN_AT: 'last_login_at';
+    readonly LAST_ACTIVE_AT: 'last_active_at';
+    readonly SCHEDULED_PERMANENT_DELETION_AT: 'scheduled_permanent_deletion_at';
+    readonly ACCOUNT_LOCKOUT_TYPE: 'account_lockout_type';
+    readonly TEMPORARY_LOCKOUT_UNTIL: 'temporary_lockout_until';
+    readonly CREATED_AT: 'created_at';
+    readonly UPDATED_AT: 'updated_at';
+  };
+
+  export type UserIdentifierSortBy = 'created_at' | 'updated_at';
+  export const UserIdentifierSortBy: {
+    readonly CREATED_AT: 'created_at';
+    readonly UPDATED_AT: 'updated_at';
+  };
+
+  export type UserSessionSortBy = 'expires_at' | 'last_accessed_at' | 'last_reauthenticated_at' | 'created_at' | 'updated_at';
+  export const UserSessionSortBy: {
+    readonly EXPIRES_AT: 'expires_at';
+    readonly LAST_ACCESSED_AT: 'last_accessed_at';
+    readonly LAST_REAUTHENTICATED_AT: 'last_reauthenticated_at';
+    readonly CREATED_AT: 'created_at';
+    readonly UPDATED_AT: 'updated_at';
+  };
+}
 
     export function pagedResultSchema<T extends z.ZodTypeAny>(itemSchema: T): z.ZodObject<{
       items: z.ZodArray<T>;
@@ -712,6 +1153,26 @@ account_status: UserAccountStatus;
     }
     export const userPublicPayloadSchema: z.ZodType<UserPublicPayload>;
 
+    export interface SocketFrame {
+        id: UserId;
+type: string;
+payload: unknown | null;
+metadata: Record<string, string>;
+timestamp: number;
+    }
+    export const socketFrameSchema: z.ZodType<SocketFrame>;
+
+    export interface WebSocketInitializePayload {
+        client_type: ClientType | null;
+language: string | null;
+device_id: ClientDeviceId | null;
+device_name: string | null;
+app_version: string | null;
+operation_system_version: string | null;
+api_version: string | null;
+    }
+    export const webSocketInitializePayloadSchema: z.ZodType<WebSocketInitializePayload>;
+
     export interface CreateByEmailRequest {
         email: string;
 password: string | null;