@holoyan/adonisjs-permissions 0.1.0 → 0.5.2

package/build/src/services/permissions/permissions_service.d.ts

@@ -1,92 +1,104 @@
 import { ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
-import ModelPermission from '../../models/model_permission.js';
-import Permission from '../../models/permission.js';
-import { ModelPermissionsQuery } from '../../types.js';
+import { ModelPermissionsQuery, MorphInterface, PermissionInterface, PermissionModel } from '../../types.js';
 import BaseService from '../base_service.js';
+import { BaseModel } from '@adonisjs/lucid/orm';
 export default class PermissionsService extends BaseService {
+    private permissionClassName;
+    private roleClassName;
+    private modelPermissionClassName;
+    private modelRoleClassName;
+    private map;
+    private permissionQuery;
+    private readonly permissionTable;
+    private modelPermissionQuery;
+    private readonly modelPermissionTable;
+    private readonly modelRoleTable;
+    constructor(permissionClassName: typeof BaseModel, roleClassName: typeof BaseModel, modelPermissionClassName: typeof BaseModel, modelRoleClassName: typeof BaseModel, map: MorphInterface);
     /**
-     * return all permissions, including fodbidden
+     * return all permissions, including forbidden
      */
-    all(modelType: string, modelId: number, includeForbiddens?: boolean): Promise<Permission[]>;
+    all(modelType: string, modelId: number, includeForbiddings?: boolean): Promise<PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>[]>;
     /**
      * return only global assigned permissions, through role or direct
      */
-    global(modelType: string, modelId: number, includeForbiddens?: boolean): Promise<Permission[]>;
+    global(modelType: string, modelId: number, includeForbiddings?: boolean): Promise<PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>[]>;
     /**
      * get all permissions which is assigned to concrete resource
      */
-    onResource(modelType: string, modelId: number, includeForbiddens?: boolean): Promise<Permission[]>;
+    onResource(modelType: string, modelId: number, includeForbiddings?: boolean): Promise<PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>[]>;
     /**
      * all direct permissions
      */
-    direct(modelType: string, modelId: number, includeForbiddens?: boolean): ModelQueryBuilderContract<typeof Permission, Permission>;
-    directGlobal(modelType: string, modelId: number, includeForbiddens?: boolean): ModelQueryBuilderContract<typeof Permission, Permission>;
+    direct(modelType: string, modelId: number, includeForbiddings?: boolean): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
+    directGlobal(modelType: string, modelId: number, includeForbiddings?: boolean): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
     /**
      * return direct and resource assigned permissions
      */
-    directResource(modelType: string, modelId: number, includeForbiddens?: boolean): ModelQueryBuilderContract<typeof Permission, Permission>;
+    directResource(modelType: string, modelId: number, includeForbiddings?: boolean): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
     /**
      * @param modelType
      * @param modelId
-     * @param permisison
+     * @param permissions
+     * @param entityType
+     * @param entityId
      * @returns
      */
-    hasAnyDirect(modelType: string, modelId: number, permisisons: (string | Permission)[], entityType: string | null, entityId: number | null): Promise<boolean>;
-    hasAllDirect(modelType: string, modelId: number, permisisons: (string | Permission)[], entityType: string | null, entityId: number | null): Promise<boolean>;
+    hasAnyDirect(modelType: string, modelId: number, permissions: (string | PermissionInterface)[], entityType: string | null, entityId: number | null): Promise<boolean>;
+    hasAllDirect(modelType: string, modelId: number, permissions: (string | PermissionInterface)[], entityType: string | null, entityId: number | null): Promise<boolean>;
     /**
      * has all permissions
      */
-    hasAll(modelType: string, modelId: number, permisisons: (string | Permission)[], entityType: string | null, entityId: number | null): Promise<boolean>;
+    hasAll(modelType: string, modelId: number, permissions: (string | PermissionInterface)[], entityType: string | null, entityId: number | null): Promise<boolean>;
     /**
      * has any of permissions
      */
-    hasAny(modelType: string, modelId: number, permisison: (string | Permission)[], entityType: string | null, entityId: number | null): Promise<boolean>;
+    hasAny(modelType: string, modelId: number, permission: (string | PermissionInterface)[], entityType: string | null, entityId: number | null): Promise<boolean>;
     /**
      * has all permissions
      */
-    containsAll(modelType: string, modelId: number, permisison: (string | Permission)[]): Promise<boolean>;
+    containsAll(modelType: string, modelId: number, permission: (string | PermissionInterface)[]): Promise<boolean>;
     /**
      * has any of permissions
      */
-    containsAny(modelType: string, modelId: number, permisison: (string | Permission)[]): Promise<boolean>;
+    containsAny(modelType: string, modelId: number, permission: (string | PermissionInterface)[]): Promise<boolean>;
     /**
      * has all permissions
      */
-    containsAllDirect(modelType: string, modelId: number, permisison: (string | Permission)[]): Promise<boolean>;
+    containsAllDirect(modelType: string, modelId: number, permission: (string | PermissionInterface)[]): Promise<boolean>;
     /**
      * has any of permissions
      */
-    containsAnyDirect(modelType: string, modelId: number, permisison: (string | Permission)[]): Promise<boolean>;
+    containsAnyDirect(modelType: string, modelId: number, permission: (string | PermissionInterface)[]): Promise<boolean>;
     /**
      * check if permission is forbidden, if there is same permission with allowed=false then return true;
      */
-    forbidden(modelType: string, modelId: number, permisison: string | Permission, entityType: string | null, entityId: number | null): boolean;
+    forbidden(modelType: string, modelId: number, permission: string | PermissionInterface, entityType: string | null, entityId: number | null): boolean;
     /**
      * give permission to model
      */
-    giveAll(modelType: string, modelId: number, slugs: string[], entityType: string | null, entityId: number | null, allowed: boolean): Promise<ModelPermission[]>;
-    revokeAll(modelType: string, modelId: number, permissions: string[], entityType: string | null, entityId: number | null): ModelQueryBuilderContract<typeof ModelPermission, ModelPermission>;
-    flush(modelType: string, modelId: number): ModelQueryBuilderContract<typeof ModelPermission, any>;
+    giveAll(modelType: string, modelId: number, slugs: string[], entityType: string | null, entityId: number | null, allowed: boolean): Promise<import("@adonisjs/lucid/types/model").LucidRow[]>;
+    revokeAll(modelType: string, modelId: number, permissions: string[], entityType: string | null, entityId: number | null): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, any>;
+    flush(modelType: string, modelId: number): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, any>;
     /**
      * sync permissions, remove everything outside of the list
      */
-    sync(modelType: string, modelId: number, permissionId: string[]): Promise<ModelPermission[]>;
+    sync(modelType: string, modelId: number, permissionId: string[]): Promise<import("@adonisjs/lucid/types/model").LucidRow[]>;
     /**
      * forbid permission on model
      */
-    forbid(modelType: string, modelId: number, permissionSlug: string, entityType: string | null, entityId: number | null): Promise<ModelPermission[]>;
+    forbid(modelType: string, modelId: number, permissionSlug: string, entityType: string | null, entityId: number | null): Promise<import("@adonisjs/lucid/types/model").LucidRow[]>;
     /**
      * forbid permission on model
      */
-    forbidAll(modelType: string, modelId: number, permissionsSlug: string[], entityType: string | null, entityId: number | null): Promise<ModelPermission[]>;
+    forbidAll(modelType: string, modelId: number, permissionsSlug: string[], entityType: string | null, entityId: number | null): Promise<import("@adonisjs/lucid/types/model").LucidRow[]>;
     /**
      * to remove forbidden permission on model
      */
     unforbidAll(modelType: string, modelId: number, permissionsSlug: string[], entityType: string | null, entityId: number | null): Promise<any[]>;
-    findBySlug(slug: string, allowed?: boolean): Promise<Permission>;
+    findBySlug(slug: string, allowed?: boolean): Promise<PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
     private modelPermissionQueryWithForbiddenCheck;
-    private modelPermissionQuery;
-    reverseModelPermissionQuery(conditions: Partial<ModelPermissionsQuery>): ModelQueryBuilderContract<typeof ModelPermission, ModelPermission>;
-    findAssignableEntity(permisison: string[], entityClass: string | null, entityId: number | null, allowed: boolean): ModelQueryBuilderContract<typeof Permission, Permission>;
+    private modelPermissionQueryBuilder;
+    reverseModelPermissionQuery(conditions: Partial<ModelPermissionsQuery>): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, import("../../types.js").ModelPermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
+    findAssignableEntity(permission: string[], entityClass: string | null, entityId: number | null, allowed: boolean): ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, PermissionModel<import("@adonisjs/lucid/types/model").LucidModel>>;
     private applyTargetRestriction;
 }