@autofleet/sequelize-utils 6.1.2 → 6.1.3

package/README.md

@@ -1,6 +1,91 @@
-# V6 migration
+# v6 Migration Guide
+
+## What changed (breaking)
+
+* `@autofleet/events` **and** `@autofleet/logger` are now **peerDependencies** of this package, instead of being direct deps.
+* `@autofleet/events` minimum version was changed from **v4** to **v5**, removing the implicit dep on `@autofleet/zehut`
+* `registerModelEventHooks` now **requires** an `events` instance.
+* Minimum Node.js version is **18**.
+
+## Why
+
+* Peer deps ensure a single shared instance of `logger`/`events` across services, keeping trace context intact.
+* Requiring `events` at hook registration avoids hidden globals and makes wiring explicit.
+
+## Install/upgrade
+
+```bash
+# npm
+npm i @autofleet/events@latest @autofleet/logger
+```
+
+Ensure Node ≥ 18:
+
+## API changes
+
+**Init**
+
+```ts
+// was
+sequelizeUtilsInit(sequelize)
+
+// now (logger is optional but recommended to preserve trace context)
+sequelizeUtilsInit(sequelize, logger)
+```
+
+**Hooks**
+
+```ts
+// was
+registerModelEventHooks(mapping)
+
+// now (events is required)
+registerModelEventHooks(mapping, events)
+```
+
+## Migration steps
+
+1. **Install peers**: `@autofleet/events` (v5) and `@autofleet/logger`.
+2. **Pass logger at init** to keep original trace context.
+3. **Pass events to hooks** (required).
+4. **Run on Node 18+**.
+
+## Before / After
+
+**Before**
+
+```ts
+import sequelizeUtilsInit from '@autofleet/sequelize-utils';
+import { Sequelize } from 'sequelize-typescript';
+
+const modelEventsTableMapping = {
+  SequelizeModel: { tableName: 'big_query_table' },
+};
+
+const { registerModelEventHooks } = sequelizeUtilsInit(sequelize);
+```
+
+**After**
+
+```ts
+import sequelizeUtilsInit from '@autofleet/sequelize-utils';
+import { Sequelize } from 'sequelize-typescript';
+import logger from '../../logger';
+import events from '../../events';
+
+const modelEventsTableMapping = {
+  SequelizeModel: { tableName: 'big_query_table' },
+};
+
+// pass logger to preserve trace context
+const { registerModelEventHooks } = sequelizeUtilsInit(sequelize, logger);
+
+// events is now required
+registerModelEventHooks(modelEventsTableMapping, events);
+```
+
+## Reference
+
+Read the `@autofleet/events` v5 changes here: README: [link](https://github.com/Autofleet/autorepo/blob/60a175c70ebdba217612c2ee58be8f31881d6540/packages/events/README.md)
 
-The breaking change in this version is the **implicit** upgrade of `zehut` from v3 to v4, via the upgrade of `@autofleet/events`.
-The required version of zehut is now `^4.0.0`.
 
-Additionally, the minimum node version is now 18, due to the minimum version of node defined in `zehut`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sequelize-utils",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "description": "",
   "type": "module",
   "main": "dist/index.js",