@biorate/sequelize 2.2.0 → 2.2.2

package/README.md

@@ -1,79 +1,120 @@
-# Sequelize
+# @biorate/sequelize
 
-Sequelize ORM connector
+Sequelize ORM connector — connection manager for Sequelize with model auto-loading and multi-connection support.
 
-### Examples:
+## Features
 
-```ts
-import { join } from 'path';
-import { tmpdir } from 'os';
-import { container, Core, inject, Types } from '@biorate/inversion';
-import { Config, IConfig } from '@biorate/config';
-import {
-  ISequelizeConnector,
-  SequelizeConnector as BaseSequelizeConnector,
-} from '@biorate/sequelize';
-import { Table, Column, Model, DataType } from '@biorate/sequelize';
-
-const connectionName = 'db';
-
-// Create model
-@Table({
-  tableName: 'test',
-  timestamps: false,
-})
-export class TestModel extends Model {
-  @Column({ type: DataType.CHAR, primaryKey: true })
-  key: string;
-
-  @Column(DataType.INTEGER)
-  value: number;
-}
+- **Auto-connect** — creates Sequelize instance on `@init()` via config namespace `Sequelize`.
+- **Model auto-loading** — `add()` registers models; `load()` attaches them to all connections.
+- **Connection verification** — calls `authenticate()` after initialisation.
+- **Multi-connection** — named connections with model-copy per connection.
+- **Typed errors** — `SequelizeCantConnectError` on failure.
 
-// Assign models with sequelize connector
-class SequelizeConnector extends BaseSequelizeConnector {
-  protected readonly models = { [connectionName]: [TestModel] };
-}
+## Installation
+
+```bash
+pnpm add @biorate/sequelize
+```
+
+Requires `@biorate/connector`, `@biorate/inversion`, `@biorate/config`, `sequelize`.
 
-// Create Root class
-export class Root extends Core() {
-  @inject(SequelizeConnector) public connector: ISequelizeConnector;
+## Quick start
+
+```ts
+import { inject, container, Types, Core } from '@biorate/inversion';
+import { IConfig, Config } from '@biorate/config';
+import { SequelizeConnector } from '@biorate/sequelize';
+import { Sequelize, DataTypes, Model } from 'sequelize';
+
+class User extends Model {}
+
+const attributes = {
+  firstName: { type: DataTypes.STRING, allowNull: false },
+  lastName: { type: DataTypes.STRING, allowNull: false },
+};
+
+class Root extends Core() {
+  @inject(SequelizeConnector) public connector: SequelizeConnector;
+  protected constructor() {
+    super();
+    this.connector.add(User, { tableName: 'users' }, attributes);
+  }
 }
 
-// Bind dependencies
 container.bind<IConfig>(Types.Config).to(Config).inSingletonScope();
-container.bind<ISequelizeConnector>(SequelizeConnector).toSelf().inSingletonScope();
+container.bind<SequelizeConnector>(SequelizeConnector).toSelf().inSingletonScope();
 container.bind<Root>(Root).toSelf().inSingletonScope();
 
-// Merge config
 container.get<IConfig>(Types.Config).merge({
-  Sequelize: [
-    {
-      name: connectionName,
-      options: {
-        logging: false,
-        dialect: 'sqlite',
-        storage: join(tmpdir(), 'sqlite-test.db'),
-      },
+  Sequelize: [{
+    name: 'connection',
+    options: {
+      dialect: 'postgres',
+      host: 'localhost',
+      port: 5432,
+      username: 'postgres',
+      password: 'postgres',
+      database: 'postgres',
     },
-  ],
+  }],
 });
 
-// Example
 (async () => {
-  await container.get<Root>(Root).$run();
-  // Drop table if exists
-  await TestModel.drop();
-  // Create table
-  await TestModel.sync();
-  // Create model item
-  await TestModel.create({ key: 'test', value: 1 });
-  // Create find model item by key
-  const data = await TestModel.findOne({ where: { key: 'test' } });
-  console.log(data.toJSON()); // { key: 'test', value: 1 }
+  const root = container.get<Root>(Root);
+  await root.$run();
+  root.connector.load('connection');  // attaches User model to 'connection'
+  await root.connector.current!.sync();
+  const user = await root.connector.current!.model('User').create({
+    firstName: 'Vasya', lastName: 'Pupkin',
+  });
+  console.log(user.toJSON());
 })();
 ```
 
+## API Reference
+
+### `SequelizeConnector`
+
+| Member           | Type                                        | Description                              |
+|------------------|---------------------------------------------|------------------------------------------|
+| `namespace`      | `'Sequelize'`                               | Config key for connection definitions.   |
+| `connect(config)` | `(config) => Promise<ISequelizeConnection>` | Creates Sequelize instance and authenticates. |
+| `add(model, options?, attributes?, indexes?)` | `(...) => void` | Register a model class for later loading. |
+| `load(name)`     | `(name) => void`                            | Copies all registered models into a named connection. |
+
+### Config
+
+```ts
+interface ISequelizeConfig extends IConnectorConfig {
+  options: SequelizeOptions;  // dialect, host, port, username, password, database, etc.
+}
+```
+
+### Errors
+
+| Error                          | Condition                                    |
+|--------------------------------|----------------------------------------------|
+| `SequelizeCantConnectError`    | `new Sequelize()` or `authenticate()` fails. |
+
+## Architecture
+
+```
+SequelizeConnector extends Connector<ISequelizeConfig, ISequelizeConnection>
+│
+├── namespace = 'Sequelize'
+├── connect(config) → new Sequelize(config.options)
+│   └── await connection.authenticate()
+│
+├── add(Model, options?, attributes?, indexes?)
+│   └── stores model definition in internal registry
+│
+├── load(name)
+│   ├── get connection(name)
+│   └── for each registered model → connection.define(...)
+│
+└── connection is a Sequelize instance with attached model classes
+```
+
 ### Learn
 
 - Documentation can be found here - [docs](https://biorate.github.io/core/modules/sequelize.html).
@@ -82,8 +123,6 @@ container.get<IConfig>(Types.Config).merge({
 
 See the [CHANGELOG](https://github.com/biorate/core/blob/master/packages/%40biorate/sequelize/CHANGELOG.md)
 
-### License
+## License
 
 [MIT](https://github.com/biorate/core/blob/master/packages/%40biorate/sequelize/LICENSE)
-
-Copyright (c) 2021-present [Leonid Levkin (llevkin)](mailto:llevkin@yandex.ru)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biorate/sequelize",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Sequelize ORM connector",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -18,6 +18,21 @@
     "README.md",
     "LICENSE"
   ],
+  "scripts": {
+    "clean": "cleanup dist",
+    "build:cjs": "npx tsc -p ./tsconfig.build.cjs.json",
+    "build:esm": "npx tsc -p ./tsconfig.build.esm.json",
+    "build:types": "npx tsc -p ./tsconfig.build.types.json",
+    "build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
+    "postbuild:cjs": "node ../../../.scripts/write-package-type.js dist/cjs commonjs",
+    "postbuild:esm": "tsc-esm-fix --tsconfig=./tsconfig.build.esm.json --target=./dist/esm && node ../../../.scripts/write-package-type.js dist/esm module",
+    "format": "prettier --check src",
+    "lint": "eslint src --ext .ts",
+    "format:fix": "prettier --write src",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "test": "npx vitest run --coverage",
+    "prepublishOnly": "pnpm run build"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/biorate/core.git",
@@ -33,32 +48,18 @@
   ],
   "author": "llevkin",
   "license": "MIT",
-  "gitHead": "fdd6dbd61368f7a9f9deb3b72243b19ecb3767a6",
+  "gitHead": "e17a03900999e261a0eb04c6afb09b9535cad952",
   "peerDependencies": {
     "sequelize": "6.37.3",
     "sequelize-typescript": "2.1.6"
   },
   "dependencies": {
-    "@biorate/config": "3.2.0",
-    "@biorate/errors": "3.1.0",
-    "@biorate/connector": "3.1.0",
-    "@biorate/inversion": "3.1.0"
+    "@biorate/config": "3.2.2",
+    "@biorate/connector": "3.1.2",
+    "@biorate/errors": "3.1.2",
+    "@biorate/inversion": "3.1.2"
   },
   "devDependencies": {
     "sqlite3": "5.0.7"
-  },
-  "scripts": {
-    "clean": "cleanup dist",
-    "build:cjs": "npx tsc -p ./tsconfig.build.cjs.json",
-    "build:esm": "npx tsc -p ./tsconfig.build.esm.json",
-    "build:types": "npx tsc -p ./tsconfig.build.types.json",
-    "build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
-    "postbuild:cjs": "node ../../../.scripts/write-package-type.js dist/cjs commonjs",
-    "postbuild:esm": "tsc-esm-fix --tsconfig=./tsconfig.build.esm.json --target=./dist/esm && node ../../../.scripts/write-package-type.js dist/esm module",
-    "format": "prettier --check src",
-    "lint": "eslint src --ext .ts",
-    "format:fix": "prettier --write src",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "test": "npx vitest run --coverage"
   }
-}
+}