@mudrichenkoevgeny/shared-foundation 0.0.48 → 0.0.49

package/README.md

@@ -19,11 +19,44 @@ yarn add @mudrichenkoevgeny/shared-foundation zod
 
 ## Features
 
-- **Zod Schemas**: Auto-generated `z.ZodType` validation schemas for all Request payloads and Response DTOs.
+- **Zod Schemas**: Auto-generated `z.ZodType` validation schemas for all Request payloads and Response DTOs (`loginByEmailRequestSchema`, `apiErrorResponseSchema`, `userDetailsPayloadSchema`).
 - **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.
+- **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`).
+- **Domain Models & Mappers**: Fully typed TS domain models (`UserSession`, `UserDetails`, `ClientDeviceInfo`) and their runtime mappers from/to API payloads (`toUserSession`, `toUserSessionPayload`).
+- **Composite Parsers**: Helper classes for runtime parsing of polymorphic values (`CompositeAuditActionTypeParser`, `CompositeAuditMetadataKeyParser`, `CompositeAuditResourceTypeParser`).
+
+## 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;
+  }
+}
+```
 
 ## Source Code & Repository