A shared contracts library providing REST/WS API contracts, JSON DTOs, Zod schemas, WebSocket envelopes, error codes, permissions, and domain models for Backend (JVM), Web (TypeScript/NPM), Mobile, and Desktop applications.

• JVM (Server / Desktop)
• Android (API 24+)
• iOS (iosArm64, iosSimulatorArm64)
• WasmJS / Node.js (Browser & Web via npm)

Use the BOM and add only the modules you need:

// build.gradle.kts
dependencies {
    implementation(platform("io.github.mudrichenkoevgeny:shared-foundation-bom:0.1.8"))
    implementation("io.github.mudrichenkoevgeny:shared-foundation-core-common")
    implementation("io.github.mudrichenkoevgeny:shared-foundation-core-security")
    implementation("io.github.mudrichenkoevgeny:shared-foundation-feature-user")
    
    // For unit, integration, and UI preview tests:
    testImplementation("io.github.mudrichenkoevgeny:shared-foundation-testing")

    // For enforcing shared architectural Detekt lint rules (NoFQN, NoInlineComment, PreferValueOverName):
    detektPlugins("io.github.mudrichenkoevgeny:shared-foundation-detekt-rules")
}

With a version catalog: declare BOM and module aliases in gradle/libs.versions.toml, then use implementation(platform(libs.shared.foundation.bom)) and testImplementation(libs.shared.foundation.fixtures).

For TypeScript and React applications, install the generated Zod schemas, routes, branded types, and test fixtures from npm:

pnpm add @mudrichenkoevgeny/shared-foundation

Published artifacts (versions aligned via the BOM):

• core-common — shared errors, network contracts (CommonNetworkRoutes, BaseSettingsNetworkRoutes), WebSocket envelopes, common DTOs, navigation contracts, root navigation (ClientMainNavigation, ManagementMainNavigation), parameter parsers, and core localization infrastructure (LocalizedStringResolver, LocalizationFormatter, CommonModuleStrings) (module README).
• core-security — Open/Management password policies, MFA logic, security settings, account lockout policies, HTTP routes, permission codes, mappers, navigation (ManagementSecurityNavigation), and security localization (SecurityModuleStrings) (module README).
• core-settings — Open/Management global settings, client app version requirements, HTTP routes, permission codes, mappers, and settings navigation (ManagementSettingsNavigation) (module README).
• core-storage — Direct-to-S3 presigned upload contracts, FileId, StorageCategory, StorageFileStatus, StorageFileVisibility, entity projections, storage settings, HTTP routes, permission codes, mappers, and storage navigation (OpenStorageNavigation, ManagementStorageNavigation, ManagementStorageSettingsNavigation) (module README).
• core-audit — audit events, filters, sort keys, payloads, management HTTP routes, permission codes, mappers, and audit navigation (ManagementAuditNavigation) (module README).
• feature-user — comprehensive HTTP contracts for authentication, MFA, session management, user identifiers, open/management user configurations, self-service account unlocking, navigation screen routes, screen parameters, parameter parsers, and user localization (UserModuleStrings) (module README).
• testing — standardized test data builders (createTest*), screen parameter fixtures, deterministic constants, value class factories, and in-memory mocks for unit, integration, and UI preview tests (module README).
• tools-detekt-rules — custom Detekt static analysis rules (NoFullyQualifiedName, NoInlineComment, PreferValueOverName) for enforcing shared library architectural standards across consumer applications.
• tools-npm-generator — executable JVM generator generating TypeScript declarations, Zod schemas, routes, domain mappers, testing constants/fixtures, and localization classes into @mudrichenkoevgeny/shared-foundation (module README).
• bom — dependency constraints for the modules above.

The library provides ready-to-use test data builders (createTest*), deterministic constants, value class factories, screen parameter fixtures, and in-memory mocks.

You can include :shared:foundation:testing in your testImplementation / commonTest.dependencies (or import from @mudrichenkoevgeny/shared-foundation in npm) to use these pre-built fixtures in unit and integration tests instead of writing custom mocks.

Note on Gradle Version Catalog (libs.versions.toml): When defining an alias for the testing module, it is recommended to use the suffix -fixtures (e.g. shared-foundation-fixtures = { ... name = "shared-foundation-testing" }) instead of -testing to prevent naming conflicts with the built-in Gradle Project.testing extension in JVM modules. See the testing README for details.

• ARCHITECTURE.md — Architectural diagrams in Mermaid covering module dependencies, surface separation (Open vs Management), WebSocket wire contract, error handling taxonomy, navigation, and localization architecture.
• core/common README — Core localization infrastructure (LocalizedStringResolver, LocalizationFormatter) and platform integration examples (Ktor/JVM, Android, iOS, Web).
• testing README — Testing module documentation, mock factories, screen parameter fixtures, value class factories, and mocks.
• CONTRIBUTING.md — Build instructions, dependency health checks (./gradlew projectHealth), and Maven Central publishing guidelines.
• AGENTS.md — Project coding standards, architectural boundaries, KDoc requirements, and constraints for contributors and AI coding assistants.

Check out these projects to see the library in action:

• Backend Platform SDK — A server-side library that uses this library for server-side development.
• KMP Platform SDK — A Kotlin Multiplatform library that uses this library for client-side development.
• Web Platform SDK — A TypeScript / React client SDK that uses @mudrichenkoevgeny/shared-foundation for Zod schema validation, API routes, and security policies.

This project is licensed under the Apache License 2.0 — see the LICENSE file for details.