@biorate/schema-registry 3.1.1 → 3.1.3

package/README.md

@@ -1,64 +1,98 @@
-# Schema registry
+# @biorate/schema-registry
 
-Schema registry connector
+Schema Registry connector — wraps the Confluent Schema Registry REST API for Avro schema management.
 
-### Examples:
+## Features
+
+- **Auto-connect** — creates HTTP client on `@init()` via config namespace `SchemaRegistry`.
+- **CRUD for subjects** — register, save, query schemas and subjects.
+- **Compatibility check** — test schema compatibility against a subject.
+- **Typed errors** — `SchemaRegistryCantConnectError`, `SchemaRegistryRequestError`.
+- **Axios-based** — configurable HTTP client with auth and TLS.
+
+## Installation
+
+```bash
+pnpm add @biorate/schema-registry
+```
+
+Requires `@biorate/connector`, `@biorate/inversion`, `@biorate/config`, `@biorate/axios`.
+
+## Quick start
 
 ```ts
 import { inject, container, Types, Core } from '@biorate/inversion';
 import { IConfig, Config } from '@biorate/config';
-import { IConnector } from '@biorate/connector';
-import {
-  SchemaRegistryConnector,
-  ISchemaRegistryConnector,
-} from '@biorate/schema-registry';
-
-export class Root extends Core() {
-  @inject(SchemaRegistryConnector) public connector: ISchemaRegistryConnector;
+import { SchemaRegistryConnector } from '@biorate/schema-registry';
+
+class Root extends Core() {
+  @inject(SchemaRegistryConnector) public connector: SchemaRegistryConnector;
 }
 
 container.bind<IConfig>(Types.Config).to(Config).inSingletonScope();
-container
-  .bind<ISchemaRegistryConnector>(SchemaRegistryConnector)
-  .toSelf()
-  .inSingletonScope();
+container.bind<SchemaRegistryConnector>(SchemaRegistryConnector).toSelf().inSingletonScope();
 container.bind<Root>(Root).toSelf().inSingletonScope();
 
 container.get<IConfig>(Types.Config).merge({
-  SchemaRegistry: [{ name: 'connection', baseURL: 'http://localhost:8085' }],
+  SchemaRegistry: [{
+    name: 'connection',
+    options: { baseURL: 'http://localhost:8081' },
+  }],
 });
 
 (async () => {
   const root = container.get<Root>(Root);
   await root.$run();
-
-  const { PostSubjectsVersions } = root.connector.connection('connection');
-  const { data } = await PostSubjectsVersions.fetch({
-    subject: 'test',
-    schema: {
-      type: 'record',
-      name: 'Test',
-      namespace: 'test',
-      fields: [
-        {
-          name: 'firstName',
-          type: 'string',
-        },
-        {
-          name: 'lastName',
-          type: 'string',
-        },
-        {
-          name: 'age',
-          type: 'int',
-        },
-      ],
-    },
-  });
-  console.log(data); // { id: 1 }
+  console.log(await root.connector.current!.subjects()); // ['test-value', ...]
 })();
 ```
 
+## API Reference
+
+### `SchemaRegistryConnector`
+
+| Member           | Type                                      | Description                              |
+|------------------|-------------------------------------------|------------------------------------------|
+| `namespace`      | `'SchemaRegistry'`                        | Config key for connection definitions.   |
+| `connect(config)` | `(config) => Promise<AxiosInstance>`     | Creates an Axios instance for the API.   |
+
+### Connection methods (via `axios`)
+
+The connection is an `AxiosInstance` configured with `baseURL` from config. Use its `.get()`, `.post()`, `.put()`, `.delete()` for Schema Registry endpoints:
+
+| Endpoint                     | Method    | Description                |
+|------------------------------|-----------|----------------------------|
+| `/subjects`                  | GET       | List all subjects.         |
+| `/subjects/:subject/versions`| GET       | List versions.             |
+| `/subjects/:subject/versions/:version` | GET | Fetch schema.    |
+| `/subjects/:subject`         | POST      | Register new schema.       |
+| `/compatibility/subjects/:subject/versions/:version` | POST | Check compatibility. |
+
+### Config
+
+```ts
+interface ISchemaRegistryConfig extends IConnectorConfig {
+  options: AxiosRequestConfig;  // baseURL, headers, auth, httpsAgent, etc.
+}
+```
+
+### Errors
+
+| Error                              | Condition                                    |
+|------------------------------------|----------------------------------------------|
+| `SchemaRegistryCantConnectError`   | Axios instance creation fails.              |
+| `SchemaRegistryRequestError`       | API response indicates failure.             |
+
+## Architecture
+
+```
+SchemaRegistryConnector extends Connector<ISchemaRegistryConfig, AxiosInstance>
+│
+├── namespace = 'SchemaRegistry'
+├── connect(config) → axios.create(config.options)
+└── connection is an AxiosInstance
+```
+
 ### Learn
 
 - Documentation can be found here - [docs](https://biorate.github.io/core/modules/schema_registry.html).
@@ -67,8 +101,6 @@ container.get<IConfig>(Types.Config).merge({
 
 See the [CHANGELOG](https://github.com/biorate/core/blob/master/packages/%40biorate/schema-registry/CHANGELOG.md)
 
-### License
+## License
 
 [MIT](https://github.com/biorate/core/blob/master/packages/%40biorate/schema-registry/LICENSE)
-
-Copyright (c) 2021-present [Leonid Levkin (llevkin)](mailto:llevkin@yandex.ru)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biorate/schema-registry",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "Schema registry connector",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -50,13 +50,13 @@
   ],
   "author": "llevkin",
   "license": "MIT",
-  "gitHead": "4ec073f69a7fc223e802ced6a632e7a45fa324d9",
+  "gitHead": "ff1dcf14a733ce8004ca582d2c421a2154ce97cb",
   "dependencies": {
-    "@biorate/axios-prometheus": "^2.2.1",
-    "@biorate/config": "^3.2.0",
-    "@biorate/connector": "^3.1.0",
-    "@biorate/errors": "^3.1.0",
-    "@biorate/inversion": "^3.1.0",
+    "@biorate/axios-prometheus": "^2.2.3",
+    "@biorate/config": "^3.2.1",
+    "@biorate/connector": "^3.1.1",
+    "@biorate/errors": "^3.1.1",
+    "@biorate/inversion": "^3.1.1",
     "avsc": "^5.7.4"
   }
 }