Merge pull request #54 from DouglasNeuroInformatics/export-create-app-ability

fix: export createAppAbility for testing

Author: joshunrau

src/index.ts

@@ -15,6 +15,7 @@ export { ValidationSchema } from './decorators/validation-schema.decorator.js';
 export type { AppVersion, DocsConfig } from './docs/docs.factory.js';
 export { acceptLanguage } from './middleware/accept-language.middleware.js';
 export { DataTransferObject } from './mixins/data-transfer-object.mixin.js';
+export { createAppAbility } from './modules/auth/ability.utils.js';
 export type {
   AppAbility,
   AppAction,

src/modules/auth/ability.factory.ts

@@ -1,21 +1,15 @@
-import { AbilityBuilder, detectSubjectType } from '@casl/ability';
+import { AbilityBuilder } from '@casl/ability';
 import { createPrismaAbility } from '@casl/prisma';
 import { Inject, Injectable } from '@nestjs/common';
 
 import { LoggingService } from '../logging/logging.service.js';
+import { createAppAbility, detectAppSubject } from './ability.utils.js';
 import { DEFINE_ABILITY_TOKEN } from './auth.config.js';
 
-import type { AppAbilities, AppAbility, DefineAbility, Permission } from './auth.config.js';
+import type { AppAbility, DefineAbility, Permission } from './auth.config.js';
 
 @Injectable()
 export class AbilityFactory {
-  private detectSubjectType = (obj: { [key: string]: unknown }): string => {
-    if (typeof obj.__modelName === 'string') {
-      return obj.__modelName;
-    }
-    return detectSubjectType(obj);
-  };
-
   constructor(
     private readonly loggingService: LoggingService,
     @Inject(DEFINE_ABILITY_TOKEN) private readonly defineAbility?: DefineAbility
@@ -32,7 +26,7 @@ export class AbilityFactory {
       this.defineAbility(abilityBuilder, payload, metadata);
     }
     return abilityBuilder.build({
-      detectSubjectType: this.detectSubjectType
+      detectSubjectType: detectAppSubject
     });
   }
 
@@ -41,8 +35,6 @@ export class AbilityFactory {
       message: 'Creating Ability From Permissions',
       permissions
     });
-    return createPrismaAbility<AppAbilities>(permissions, {
-      detectSubjectType: this.detectSubjectType
-    });
+    return createAppAbility(permissions);
   }
 }

src/modules/auth/ability.utils.ts

@@ -0,0 +1,17 @@
+import { detectSubjectType } from '@casl/ability';
+import { createPrismaAbility } from '@casl/prisma';
+
+import type { AppAbilities, AppAbility, Permission } from './auth.config.js';
+
+export function detectAppSubject(obj: { [key: string]: unknown }): string {
+  if (typeof obj.__modelName === 'string') {
+    return obj.__modelName;
+  }
+  return detectSubjectType(obj);
+}
+
+export function createAppAbility(permissions: Permission[]): AppAbility {
+  return createPrismaAbility<AppAbilities>(permissions, {
+    detectSubjectType: detectAppSubject
+  });
+}

src/modules/auth/auth.config.ts

@@ -40,7 +40,7 @@ type DefineAbility<TPayload extends { [key: string]: unknown } = { [key: string]
   metadata: TMetadata
 ) => void;
 
-type Permission = RawRuleOf<PureAbility<[AppAction, AppSubjectName]>>;
+type Permission = RawRuleOf<PureAbility<[AppAction, AppSubjectName], AppConditions>>;
 
 type BaseLoginCredentials = {
   password: string;