feat(sequelize): add sequelize support

modified mixin argument type to accept non default crud repositories
added directory import syntax to provide sequelize specific artifacts

GH-69

.cz-config.js

@@ -33,6 +33,7 @@ module.exports = {
     {name: 'core'},
     {name: 'maintenance'},
     {name: 'mixin'},
+    {name: 'sequelize'},
   ],
 
   appendBranchNameToCommitMessage: true,

README.md

@@ -238,6 +238,42 @@ export class GroupRepository extends ConditionalAuditRepositoryMixin(
 }
 ```
 
+## Using with Sequelize ORM
+
+This extension provides support to both juggler (the default loopback ORM) and sequelize.
+
+If your loopback project is already using `SequelizeCrudRepository` from [@loopback/sequelize](https://www.npmjs.com/package/@loopback/sequelize) or equivalent add on repositories from sourceloop packages like [`SequelizeUserModifyCrudRepository`](https://sourcefuse.github.io/arc-docs/arc-api-docs/packages/core/#sequelizeusermodifycrudrepository). You'll need to make just two changes:
+
+1. The import statements should have the suffix `/sequelize`, like below:
+
+```ts
+import {
+  AuditRepositoryMixin,
+  AuditLogRepository,
+} from '@sourceloop/audit-log/sequelize';
+```
+
+2. The Audit datasource's parent class should be `SequelizeDataSource`.
+
+```ts
+import {SequelizeDataSource} from '@loopback/sequelize';
+
+export class AuditDataSource
+  extends SequelizeDataSource
+  implements LifeCycleObserver
+{
+  static dataSourceName = AuditDbSourceName;
+  static readonly defaultConfig = config;
+
+  constructor(
+    @inject('datasources.config.audit', {optional: true})
+    dsConfig: object = config,
+  ) {
+    super(dsConfig);
+  }
+}
+```
+
 ## Feedback
 
 If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-audit-log/issues) to see if someone else in the community has already created a ticket.

package.json

@@ -8,6 +8,20 @@
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./sequelize": {
+      "types": "./dist/index.sequelize.d.ts",
+      "default": "./dist/index.sequelize.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "sequelize": [
+        "./dist/index.sequelize.d.ts"
+      ]
+    }
+  },
   "engines": {
     "node": ">=16"
   },
@@ -55,6 +69,7 @@
     "@commitlint/config-conventional": "^16.2.1",
     "@loopback/build": "^9.0.10",
     "@loopback/eslint-config": "^13.0.10",
+    "@loopback/sequelize": "^0.2.0",
     "@loopback/testlab": "^5.0.10",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
@@ -78,6 +93,14 @@
     "source-map-support": "^0.5.21",
     "typescript": "~4.9.5"
   },
+  "peerDependencies": {
+    "@loopback/sequelize": "^0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@loopback/sequelize": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },

src/index.sequelize.ts

@@ -0,0 +1,5 @@
+export * from './component';
+export * from './mixins';
+export * from './types';
+export * from './models';
+export * from './repositories/sequelize';

src/mixins/audit.mixin.ts

@@ -1,16 +1,11 @@
-import {
-  Count,
-  DataObject,
-  DefaultCrudRepository,
-  Entity,
-  Where,
-} from '@loopback/repository';
+import {Count, DataObject, Entity, Where} from '@loopback/repository';
 import {keyBy, cloneDeep} from 'lodash';
 
 import {Action, AuditLog} from '../models';
 import {AuditLogRepository} from '../repositories';
 import {
   AbstractConstructor,
+  AuditMixinBase,
   AuditOptions,
   IAuditMixin,
   IAuditMixinOptions,
@@ -23,7 +18,7 @@ export function AuditRepositoryMixin<
   Relations extends object,
   UserID,
   //sonarignore:end
-  R extends AbstractConstructor<DefaultCrudRepository<M, ID, Relations>>,
+  R extends AuditMixinBase<M, ID, Relations>,
 >(
   superClass: R,
   opts: IAuditMixinOptions,