@holoyan/adonisjs-permissions 1.1.0 → 1.2.0

package/README.md

@@ -12,6 +12,11 @@ Checkout other AdonisJS packages
 - It's simple, just star this repository, that is enough to keep me motivated to maintain this package.
 
 
+## Release Notes
+
+Version: >= v1.2.0
+* Added [Morph Map](https://github.com/holoyan/morph-map-js) as a dependency to handle polymorphic relations - fixed [#20](https://github.com/holoyan/adonisjs-permissions/issues/20)
+
 ## Table of Contents
 
 <details><summary>Click to expand</summary><p>
@@ -49,7 +54,7 @@ Checkout other AdonisJS packages
     - [The Scope middleware](#the-scope-middleware) 
     - [Default Scope](#default-scope-tenant)
   - [Transactions](#transactions)
-  - [Events] (#events)
+  - [Events](#events)
 - [Cheat sheet](#cheat-sheet)
 - [Todo](#todo)
 - [Test](#test)
@@ -105,7 +110,7 @@ Example.
 ```typescript
 
 import { BaseModel, column } from '@adonisjs/lucid/orm'
-import { MorphMap } from '@holoyan/adonisjs-permissions'
+import { MorphMap } from '@holoyan/morph-map-js'  // (NOTE upper case `MorphMap`)
 import { AclModelInterface } from '@holoyan/adonisjs-permissions/types'
 
 @MorphMap('users')
@@ -136,11 +141,6 @@ export default class Post extends BaseModel implements AclModelInterface {
 
 ```
 
-## Release Notes
-
-Version: >= v1.1.0
-* Added support for [Events](#events)
-
 ## Mixins
 
 If you want to be able to call `Acl` methods on a `User` model then consider using `hasPermissions` mixin
@@ -148,7 +148,7 @@ If you want to be able to call `Acl` methods on a `User` model then consider usi
 ```typescript
 
 import { BaseModel, column } from '@adonisjs/lucid/orm'
-import { MorphMap } from '@holoyan/adonisjs-permissions'
+import { MorphMap } from '@holoyan/morph-map-js'  // (NOTE upper case `MorphMap`)
 import { AclModelInterface } from '@holoyan/adonisjs-permissions/types'
 
 // import mixin
@@ -1011,6 +1011,42 @@ await Acl.model(myUser).allow('create')
 
 ```
 
+
+You can also disable events per query by calling withoutEvents() method
+
+```typescript
+
+emitter.on(RoleCreatedEvent, () => {
+  console.log('Role created') // this will not be called
+})
+
+//
+await Acl.role().withoutEvents().create({ // this one will not trigger RoleCreatedEvent
+  slug: 'admin',
+})
+
+await Acl.role().create({ // this will trigger
+  slug: 'admin',
+})
+
+```
+
+If you want to completely disable events, you can do that by calling `withoutEvents()` method on the `Acl` class
+
+```typescript
+
+Acl.withoutEvents()
+
+// any method called on the Acl will not trigger any events
+emitter.on(RoleCreatedEvent, () => {
+  console.log('Role created') // this will not be called
+})
+
+await Acl.role().create({ // this will not trigger because globaly withoutEvents() is set
+  slug: 'admin',
+})
+```
+
 List of events you can listen to:
 
 ```
@@ -1251,7 +1287,7 @@ await Acl.permission(myPermission).detachFromRole(role_slug)
 
 | AdonisJS Lucid version | Package version |
 |------------------------|-----------------|
-| v20.x                  | 0.9.x           |
+| v20.x                  | 0.10.x          |
 | v21.x                  | 1.x             |
 
 

package/build/index.d.ts

@@ -10,6 +10,5 @@ export { configure } from './configure.js';
 export { stubsRoot } from './stubs/main.js';
 export { AclManager, Acl } from './src/acl.js';
 export { MorphMap, getClassPath } from './src/decorators.js';
-export * as morphMapModel from './src/morph_map.js';
 export { hasPermissions } from './src/mixins/has_permissions.js';
 export { Scope } from './src/scope.js';

package/build/index.js

@@ -18,6 +18,5 @@ export { configure } from './configure.js';
 export { stubsRoot } from './stubs/main.js';
 export { AclManager, Acl } from './src/acl.js';
 export { MorphMap, getClassPath } from './src/decorators.js';
-export * as morphMapModel from './src/morph_map.js';
 export { hasPermissions } from './src/mixins/has_permissions.js';
 export { Scope } from './src/scope.js';

package/build/providers/role_permission_provider.d.ts

@@ -1,9 +1,9 @@
 import { ApplicationService } from '@adonisjs/core/types';
 import ModelManager from '../src/model_manager.js';
-import MorphMap from '../src/morph_map.js';
+import { MorphMapManager } from '@holoyan/morph-map-js';
 declare module '@adonisjs/core/types' {
     interface ContainerBindings {
-        morphMap: MorphMap;
+        morphMap: MorphMapManager;
         modelManager: ModelManager;
     }
 }

package/build/providers/role_permission_provider.js

@@ -4,8 +4,8 @@ import ModelPermission from '../src/models/model_permission.js';
 import ModelRole from '../src/models/model_role.js';
 import ModelManager from '../src/model_manager.js';
 import { AclManager } from '../src/acl.js';
-import MorphMap from '../src/morph_map.js';
 import { Scope } from '../src/scope.js';
+import { morphMap } from '@holoyan/morph-map-js';
 export default class RolePermissionProvider {
     app;
     constructor(app) {
@@ -13,7 +13,7 @@ export default class RolePermissionProvider {
     }
     register() {
         this.app.container.singleton('morphMap', async () => {
-            return new MorphMap();
+            return morphMap;
         });
         this.app.container.singleton('modelManager', async () => {
             return new ModelManager();
@@ -39,8 +39,8 @@ export default class RolePermissionProvider {
         AclManager.setModelManager(modelManager);
         AclManager.setEmitter(emitter);
         const map = await this.app.container.make('morphMap');
-        map.set('permissions', Permission);
-        map.set('roles', Role);
+        // map.set('permissions', Permission)
+        // map.set('roles', Role)
         AclManager.setMorphMap(map);
     }
 }

package/build/src/decorators.js

@@ -1,19 +1,11 @@
-import app from '@adonisjs/core/services/app';
+import { morphMap, getClassPath as baseGetClassPath } from '@holoyan/morph-map-js';
+// keep for backward compatibility
 export function MorphMap(param) {
     return function (target) {
-        const service = async function () {
-            var result = await app.container.make('morphMap');
-            result.set(param, target);
-            return param;
-        };
-        target.prototype.__morphMapName = service();
+        morphMap.set(param, target);
         target.prototype.__morphMapName = param;
     };
 }
 export function getClassPath(clazz) {
-    const morphMapName = clazz.prototype.__morphMapName;
-    if (!morphMapName) {
-        throw new Error('morph map name not specified');
-    }
-    return morphMapName;
+    return baseGetClassPath(clazz);
 }

package/build/src/mixins/has_permissions.d.ts

@@ -246,8 +246,10 @@ export declare function hasPermissions(): <Model extends NormalizeConstructor<ty
         isDirty(fields?: undefined[] | undefined): boolean;
         enableForceUpdate(): /*elided*/ any;
         save(): Promise</*elided*/ any>;
+        saveQuietly(): Promise</*elided*/ any>;
         lockForUpdate<T>(callback: (user: /*elided*/ any) => T | Promise<T>): Promise<T>;
         delete(): Promise<void>;
+        deleteQuietly(): Promise<void>;
         refresh(): Promise</*elided*/ any>;
         load: import("@adonisjs/lucid/types/model").LucidRowPreload</*elided*/ any>;
         loadOnce: import("@adonisjs/lucid/types/model").LucidRowPreloadOnce</*elided*/ any>;
@@ -315,7 +317,9 @@ export declare function hasPermissions(): <Model extends NormalizeConstructor<ty
         <Model_1 extends import("@adonisjs/lucid/types/model").LucidModel, Event_2 extends import("@adonisjs/lucid/types/model").EventsList>(this: Model_1, event: Event_2, handler: import("@adonisjs/lucid/types/model").HooksHandler<InstanceType<Model_1>, Event_2>): void;
     };
     create: <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions) => Promise<InstanceType<T>>;
+    createQuietly: <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions) => Promise<InstanceType<T>>;
     createMany: <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions) => Promise<InstanceType<T>[]>;
+    createManyQuietly: <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions) => Promise<InstanceType<T>[]>;
     findOrFail: <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions) => Promise<InstanceType<T>>;
     findBy: {
         <T extends import("@adonisjs/lucid/types/model").LucidModel>(this: T, clause: Record<string, unknown>, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions): Promise<null | InstanceType<T>>;

package/build/src/models/permission.js

@@ -6,7 +6,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { v4 as uuidv4 } from 'uuid';
 import { BaseModel, beforeCreate, column } from '@adonisjs/lucid/orm';
-export default class Permission extends BaseModel {
+import { MorphMap } from '@holoyan/morph-map-js';
+let Permission = class Permission extends BaseModel {
     static uuidSupport = false;
     static assignUuid(permission) {
         if (this.uuidSupport) {
@@ -16,7 +17,7 @@ export default class Permission extends BaseModel {
     getModelId() {
         return this.id;
     }
-}
+};
 __decorate([
     column({ isPrimary: true })
 ], Permission.prototype, "id", void 0);
@@ -47,3 +48,7 @@ __decorate([
 __decorate([
     beforeCreate()
 ], Permission, "assignUuid", null);
+Permission = __decorate([
+    MorphMap('permissions')
+], Permission);
+export default Permission;

package/build/src/models/role.js

@@ -6,7 +6,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { BaseModel, beforeCreate, column } from '@adonisjs/lucid/orm';
 import { v4 as uuidv4 } from 'uuid';
-export default class Role extends BaseModel {
+import { MorphMap } from '@holoyan/morph-map-js';
+let Role = class Role extends BaseModel {
     static uuidSupport = false;
     static assignUuid(role) {
         if (this.uuidSupport) {
@@ -16,7 +17,7 @@ export default class Role extends BaseModel {
     getModelId() {
         return this.id;
     }
-}
+};
 __decorate([
     column({ isPrimary: true })
 ], Role.prototype, "id", void 0);
@@ -47,3 +48,7 @@ __decorate([
 __decorate([
     beforeCreate()
 ], Role, "assignUuid", null);
+Role = __decorate([
+    MorphMap('roles')
+], Role);
+export default Role;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@holoyan/adonisjs-permissions",
-  "description": "Adonisjs roles and permissions system",
-  "version": "1.1.0",
+  "description": "AdonisJs roles and permissions system",
+  "version": "1.2.0",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -72,9 +72,9 @@
   "peerDependencies": {
     "@adonisjs/core": "^6.2.0",
     "@adonisjs/lucid": "^21.0.0",
+    "@types/uuid": "^10.0.0",
     "luxon": "^3.4.4",
-    "uuid": "^10.0.0",
-    "@types/uuid": "^10.0.0"
+    "uuid": "^10.0.0"
   },
   "publishConfig": {
     "access": "public",
@@ -98,5 +98,8 @@
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
-  "prettier": "@adonisjs/prettier-config"
+  "prettier": "@adonisjs/prettier-config",
+  "dependencies": {
+    "@holoyan/morph-map-js": "^0.1.1"
+  }
 }

package/build/src/morph_map.d.ts

@@ -1,11 +0,0 @@
-import { MorphInterface } from './types.js';
-export default class MorphMap implements MorphInterface {
-    private _map;
-    private static _instance?;
-    static create(): MorphMap;
-    set(alias: string, target: any): void;
-    get(alias: string): any;
-    has(alias: string): boolean;
-    hasTarget(target: any): boolean;
-    getAlias(target: any): string;
-}

package/build/src/morph_map.js

@@ -1,40 +0,0 @@
-export default class MorphMap {
-    _map = {};
-    static _instance;
-    static create() {
-        if (this._instance) {
-            return this._instance;
-        }
-        return new MorphMap();
-    }
-    set(alias, target) {
-        this._map[alias] = target;
-    }
-    get(alias) {
-        if (!(alias in this._map)) {
-            throw new Error('morph map not found for ' + alias);
-        }
-        return this._map[alias] || null;
-    }
-    has(alias) {
-        return alias in this._map;
-    }
-    hasTarget(target) {
-        const keys = Object.keys(this._map);
-        for (const key of keys) {
-            if (this._map[key] === target) {
-                return true;
-            }
-        }
-        return false;
-    }
-    getAlias(target) {
-        const keys = Object.keys(this._map);
-        for (const key of keys) {
-            if (target instanceof this._map[key] || target === this._map[key]) {
-                return key;
-            }
-        }
-        throw new Error('Target not found');
-    }
-}