@mudrichenkoevgeny/shared-foundation 0.0.47 → 0.0.48

package/README.md

@@ -1,6 +1,6 @@
 # @mudrichenkoevgeny/shared-foundation
 
-TypeScript & Zod contracts, API routes, error codes, permission models, and branded types generated directly from the [shared-foundation](https://github.com/mudrichenkoevgeny/shared-foundation) Kotlin Multiplatform (KMP) repository.
+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.
 
@@ -19,41 +19,11 @@ yarn add @mudrichenkoevgeny/shared-foundation zod
 
 ## Features
 
-- **Zod Schemas**: Auto-generated `z.ZodType` validation schemas for all Request payloads and Response DTOs (`loginByEmailRequestSchema`, `apiErrorResponseSchema`, `userDetailsPayloadSchema`).
-- **Route Constants**: Strongly typed API endpoint routes (`ManagementSecuritySettingsRoutes`, `OpenLoginRoutes`, `SelfManagementUserRoutes`).
-- **Error & Permission Codes**: Literal string definitions for all application error codes (`SecurityErrorCodes`, `CommonErrorCodes`) and permission strings (`SecurityPermissionCode`, `UserPermissionCode`).
-- **Branded Types & Helpers**: Type-safe domain identifiers (`UserId`, `PermissionCode`, `UserSessionId`, `UserIdentifierId`, `AuditEventId`, `ClientDeviceId`) with converter helpers (`toUserIdOrThrow`, `toPermissionCodeOrNull`).
-
-## Quick Usage Example
-
-```typescript
-import { 
-  ManagementSecuritySettingsRoutes, 
-  SecurityErrorCodes, 
-  apiErrorResponseSchema, 
-  toUserIdOrThrow 
-} from '@mudrichenkoevgeny/shared-foundation';
-
-// 1. Using Route Constants
-const url = ManagementSecuritySettingsRoutes.GET_MANAGEMENT_SECURITY_SETTINGS;
-
-// 2. Branded Types
-const userId = toUserIdOrThrow('123e4567-e89b-12d3-a456-426614174000');
-
-// 3. Validating API Responses with Zod
-async function fetchUserSettings() {
-  const response = await fetch(url);
-  const json = await response.json();
-
-  if (!response.ok) {
-    const error = apiErrorResponseSchema.parse(json);
-    if (error.code === SecurityErrorCodes.TOTP_NOT_ENABLED) {
-      console.error('TOTP configuration required');
-    }
-    return;
-  }
-}
-```
+- **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