diff --git a/README.md b/README.md index ae2444b..2dc06be 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Modular, framework-agnostic SDK for Mixcore projects. Built with TypeScript and - **Production-ready**: Well-tested and documented - **Secure by design**: Configuration injection prevents hardcoded secrets - **Extensible**: Plugin/adapter architecture for custom implementations +- **Fully typed**: All public APIs include TSDoc/JSDoc comments and auto-generated TypeScript declarations ## Packages @@ -63,6 +64,8 @@ const data = await sdk.database.fetchDataItems('module-id'); ## API Reference +All public APIs are documented with TSDoc/JSDoc comments and include auto-generated TypeScript declarations. Type definitions are available for all methods, interfaces, and configuration options. + ### Core SDK Methods | Method | Parameters | Returns | Description | diff --git a/packages/api/README.md b/packages/api/README.md index d104da0..32f8b79 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -65,6 +65,8 @@ const sdk = createMixcoreSdk( ## API Reference +All public APIs include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations. + ### ApiService Methods | Method | Parameters | Returns | Description | diff --git a/packages/base/README.md b/packages/base/README.md index 4dfec2c..cfbe08c 100644 --- a/packages/base/README.md +++ b/packages/base/README.md @@ -46,6 +46,8 @@ class MyService extends BaseService { ## API Reference +All base classes and interfaces include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations. + ### BaseService Methods | Method | Parameters | Returns | Description | diff --git a/packages/shared/README.md b/packages/shared/README.md index b78f334..67e8ec4 100644 --- a/packages/shared/README.md +++ b/packages/shared/README.md @@ -49,6 +49,8 @@ console.log(DEFAULT_CONFIG.apiBaseUrl); ## API Reference +All utilities and helper functions include comprehensive TSDoc/JSDoc documentation and auto-generated TypeScript declarations. + ### Utility Functions | Function | Description | diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 9d57879..17958c8 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -65,6 +65,9 @@ importers: '@mixcore/api': specifier: workspace:* version: link:../api + '@mixcore/base': + specifier: workspace:* + version: link:../base packages/file: dependencies: @@ -81,6 +84,9 @@ importers: '@mixcore/api': specifier: workspace:* version: link:../api + '@mixcore/shared': + specifier: workspace:* + version: link:../shared packages/user: dependencies: