@cerbos/orm-prisma 2.0.0 → 3.0.1

package/README.md

@@ -16,7 +16,7 @@ An adapter library that takes a [Cerbos](https://cerbos.dev) Query Plan ([PlanRe
 
 - One-to-one: `is`, `isNot`
 - One-to-many/Many-to-many: `some`, `none`, `every`
-- Collection operators: `exists`, `exists_one`, `all`, `filter`
+- Collection operators: `exists`, `exists_one`, `all`, `filter`, `except`
 - Set operations: `hasIntersection`
 
 #### Advanced Features
@@ -33,6 +33,12 @@ An adapter library that takes a [Cerbos](https://cerbos.dev) Query Plan ([PlanRe
 - `@cerbos/http` or `@cerbos/grpc` client
 - Prisma > v6.0
 
+## System Requirements
+
+- Node.js >= 20.0.
+- Prisma CLI & Client >= 6.0
+- A database supported by Prisma (SQLite/PostgreSQL/MySQL/etc.) so the Prisma client can communicate with stored data
+
 ## Installation
 
 ```bash
@@ -145,6 +151,37 @@ const records = await prisma.resource.findMany({
 });
 ```
 
+### Collection Operators
+
+The adapter understands the full Cerbos collection operator set, including `except`. For example, the configuration below ensures a resource’s categories do not have any sub-category named `finance`:
+
+```ts
+const result = queryPlanToPrisma({
+  queryPlan,
+  mapper: {
+    "request.resource.attr.categories": {
+      relation: {
+        name: "categories",
+        type: "many",
+        fields: {
+          subCategories: {
+            relation: {
+              name: "subCategories",
+              type: "many",
+              fields: {
+                name: { field: "name" },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+});
+```
+
+`queryPlanToPrisma` emits the necessary nested `NOT` structure so Prisma receives a valid filter for the entire relation chain.
+
 ### Field Name Mapping
 
 Fields can be mapped using either an object or a function:
@@ -237,6 +274,14 @@ When using relations, fields are automatically inferred from the path unless exp
 }
 ```
 
+### Handling `in` Operators
+
+`queryPlanToPrisma` normalises Cerbos `in` expressions to match Prisma expectations:
+
+- Single values become equality comparisons (`{ field: "value" }`).
+- Arrays remain `{ field: { in: [...] } }`.
+- Relation-backed fields retain their relation structure while still applying the appropriate equality or `in` operator at the leaf.
+
 ### Complex Example with Multiple Relations and Direct Fields
 
 ```ts
@@ -321,6 +366,18 @@ const result = await primsa.resource.findMany({
 });
 ```
 
+## Development
+
+### Running Tests
+
+```bash
+npm test
+```
+
+> **Note:** The suite seeds `prisma/dev.db` and invokes `prisma db push --force-reset`. Only run it against disposable development databases.
+
+The tests populate Prisma with fixture data and assert query results directly against those fixtures, covering scalar and relation `in` operators, collection behaviour (including `except`), nested relations, and lambda expressions.
+
 ## Types
 
 ### Query Plan Response Types

package/lib/index.d.ts

@@ -7,14 +7,10 @@ export type MapperConfig = {
         name: string;
         type: "one" | "many";
         field?: string;
-        fields?: {
-            [key: string]: MapperConfig;
-        };
+        fields?: Record<string, MapperConfig>;
     };
 };
-export type Mapper = {
-    [key: string]: MapperConfig;
-} | ((key: string) => MapperConfig);
+export type Mapper = Record<string, MapperConfig> | ((key: string) => MapperConfig);
 export interface QueryPlanToPrismaArgs {
     queryPlan: PlanResourcesResponse;
     mapper?: Mapper;
@@ -23,11 +19,10 @@ export type QueryPlanToPrismaResult = {
     kind: PlanKind.ALWAYS_ALLOWED | PlanKind.ALWAYS_DENIED;
 } | {
     kind: PlanKind.CONDITIONAL;
-    filters: Record<string, any>;
+    filters: PrismaFilter;
 };
 /**
  * Converts a Cerbos query plan to a Prisma filter.
- * @param {QueryPlanToPrismaArgs} args - The arguments containing the query plan and mapper.
- * @returns {QueryPlanToPrismaResult} The result containing the kind and filters.
  */
 export declare function queryPlanToPrisma({ queryPlan, mapper, }: QueryPlanToPrismaArgs): QueryPlanToPrismaResult;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EAErB,QAAQ,EAET,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,QAAQ,EAAE,CAAC;AAGpB,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACvC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,MAAM,GACd,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAC5B,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,YAAY,CAAC,CAAC;AAEpC,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,qBAAqB,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,uBAAuB,GAC/B;IACE,IAAI,EAAE,QAAQ,CAAC,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC;CACxD,GACD;IACE,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;IAC3B,OAAO,EAAE,YAAY,CAAC;CACvB,CAAC;AA2FN;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,SAAS,EACT,MAAW,GACZ,EAAE,qBAAqB,GAAG,uBAAuB,CAiBjD"}