fix(mixin): pass the extra values via options (#142)

* fix(mixin): pass the extra values via options

dynamically pass extra values to add to audit log model

GH-141

* fix(ci-cd): updated the documentation

update the readme

GH-141

Author: yeshamavani

README.md

@@ -220,7 +220,20 @@ export class GroupRepository extends AuditRepositoryMixin<
 }
 ```
 
-You can pass any extra attributes to save into audit table using the `IAuditMixinOptions` parameter of mixin function.
+You can pass any extra attributes to save into audit table using the `IAuditMixinOptions` parameter of mixin function. You can also pass some dynamic values to the extra columns of the audit-log table via the method options.
+
+```ts
+const groupAuditOpts: IAuditMixinOptions = {
+  actionKey: 'Group_Logs',
+  extra: 'static value',
+};
+```
+
+```ts
+repo.create(data, {extra: 'random calculated value'});
+```
+
+So the method options will have a priority over repository mixin options.
 
 Make sure you provide `getCurrentUser` and `getAuditLogRepository` Getter functions in constructor.
 

docs/README.md

@@ -220,7 +220,20 @@ export class GroupRepository extends AuditRepositoryMixin<
 }
 ```
 
-You can pass any extra attributes to save into audit table using the `IAuditMixinOptions` parameter of mixin function.
+You can pass any extra attributes to save into audit table using the `IAuditMixinOptions` parameter of mixin function. You can also pass some dynamic values to the extra columns of the audit-log table via the method options.
+
+```ts
+const groupAuditOpts: IAuditMixinOptions = {
+  actionKey: 'Group_Logs',
+  extra: 'static value',
+};
+```
+
+```ts
+repo.create(data, {extra: 'random calculated value'});
+```
+
+So the method options will have a priority over repository mixin options.
 
 Make sure you provide `getCurrentUser` and `getAuditLogRepository` Getter functions in constructor.
 

package-lock.json

@@ -48,8 +48,13 @@ export function AuditRepositoryMixin<
       options?: AuditOptions,
     ): AuditLog {
       const {before, after} = modification;
-      const extras: Omit<IAuditMixinOptions, 'actionKey'> = {...opts};
+      //dynamic will take precedence over static
+      const extras: AnyObject = {
+        ...opts, // passing options to the model helps in adding custom and static values to it if needed
+        ...options, // passing options to the model helps in adding custom and dynamic values to it if needed
+      };
       delete extras.actionKey;
+      delete extras.noAudit;
       return new AuditLog({
         actedAt: new Date(),
         actor: this.getActor(user, options?.actorId),