TypeScript errors upgrading CASL Prisma from 1.0.1 to 1.0.2

Describe the bug We’re having troubling upgrading CASL Prisma from 1.0.1 to 1.0.2. Our approach follows the example in the documentation here:

https://www.npmjs.com/package/@casl/prisma

So I’m not sure what we are doing wrong or if this is a bug.

To Reproduce

Prisma file.

model DbMessage {
  tenantQid String @map(name: "tenant_qid")
  qid       String @id

  topic       String
  authorQid   String @map(name: "author_qid")

  @@map(name: "message")
}

Ability file:

type AppAbility = PrismaAbility<
  [
    string,
    Subjects<{
      Message: DbMessage;
    }>,
  ]
>;
const AppAbility = PrismaAbility as AbilityClass<AppAbility>;
const { can, cannot, build } = new AbilityBuilder(AppAbility);
can('read', 'Message', { tenantQid: 'example-qid' });

TypeScript error:

TS2769: No overload matches this call.   Overload 1 of 2, '(action: string | string[], subject: "Message" | "Message"[], conditions?: undefined): RuleBuilder<AppAbility>', gave the following error.     Argument of type '{ tenantQid: string; }' is not assignable to parameter of type 'undefined'.   Overload 2 of 2, '(action: string | string[], subject: "Message" | "Message"[], fields?: string | string[] | undefined, conditions?: undefined): RuleBuilder<AppAbility>', gave the following error.     Argument of type '{ tenantQid: string; }' is not assignable to parameter of type 'string | string[] | undefined'.       Object literal may only specify known properties, and 'tenantQid' does not exist in type 'string[]'.

Expected behavior Expected no TypeScript error.

Versions

@casl/ability - 5.4.4 @casl/prisma - 1.0.2 typescript - 4.6.4

Environment: Node, TypeScript

[stalniy]

Not related. You cannot name your models differently, it should be this:

type AppAbility = PrismaAbility<
  [
    string,
    Subjects<{
      DbMessage: DbMessage; // <-- here we map model name to its actual TS representation, prisma doesn't provide this info
    }>,
  ]
>;
const AppAbility = PrismaAbility as AbilityClass<AppAbility>;
const { can, cannot, build } = new AbilityBuilder(AppAbility);
can('read', 'DbMessage', { tenantQid: 'example-qid' });

So, the name MUST be DbMessage and cannot be Message because then CASL cant find related types inside Prisma types

[stalniy]

Thank you for the report. I’ll take a look at it today