@cerbos/orm-prisma 0.1.1

package/README.md

@@ -0,0 +1,46 @@
+# Cerbos + Prisma ORM Adapter
+
+An adapater library that takes a [Cerbos](https://cerbos.dev) Query Plan ([PlanResources API](https://docs.cerbos.dev/cerbos/latest/api/index.html#resources-query-plan)) response and converts it into a [Prisma](https://prisma.io) where class object. This is designed to work alongside a project using the [Cerbos Javascript SDK](https://github.com/cerbos/cerbos-sdk-javascript).
+
+The following conditions are supported: `and`, `or`, `eq`, `ne`, `lt`, `gt`, `lte`, `gte` and `in`.
+
+## Requirements
+- Cerbos > v0.16
+
+## Usage
+
+```
+npm install @cerbos/orm-prisma
+```
+
+This package exports a single function:
+
+```js
+queryPlanToPrisma({ queryPlan, fieldNameMapper }): PrismaCondition
+```
+
+The function reqiures the full query plan from Cerbos to be passed in an object along with a `fieldNameMapper`.
+
+The `fieldNameMapper` is used to convert the field names in the query plan response to names of fields in the Prisma model - this can be done as a map or a function:
+
+```js
+{
+  "request.resource.attr.aFieldName": "prismaModelFieldName"
+}
+
+//or
+
+(fieldName: string): string => {
+  if(fieldName.indexOf("request.resource.") > 0) {
+    return fieldName.replace("request.resource.attr", "")
+  }
+
+  if(fieldName.indexOf("request.principal.") > 0) {
+    return fieldName.replace("request.principal.attr", "")
+  }
+}
+```
+
+## Full Example
+
+A full Prisma application making use of this adapater can be found at [https://github.com/cerbos/express-prisma-cerbos](https://github.com/cerbos/express-prisma-cerbos)

package/lib/cjs/index.d.ts

@@ -0,0 +1,9 @@
+import { PlanResourcesResponse } from "@cerbos/core";
+interface QueryPlanToPrismaArgs {
+    queryPlan: PlanResourcesResponse;
+    fieldNameMapper: {
+        [key: string]: string;
+    } | ((key: string) => string);
+}
+export default function queryPlanToPrisma({ queryPlan, fieldNameMapper, }: QueryPlanToPrismaArgs): any;
+export {};

package/lib/cjs/index.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@cerbos/core");
+function queryPlanToPrisma({ queryPlan, fieldNameMapper, }) {
+    if (queryPlan.kind === core_1.PlanKind.ALWAYS_ALLOWED)
+        return {};
+    if (queryPlan.kind === core_1.PlanKind.ALWAYS_DENIED)
+        return { "1": { "equals": 0 } };
+    return mapOperand(queryPlan.condition, (key) => {
+        if (typeof fieldNameMapper === "function") {
+            return fieldNameMapper(key);
+        }
+        else {
+            return (fieldNameMapper[key] = fieldNameMapper[key] || key);
+        }
+    }, {});
+}
+exports.default = queryPlanToPrisma;
+function isExpression(e) {
+    return e.operator !== undefined;
+}
+function isValue(e) {
+    return e.value !== undefined;
+}
+function isVariable(e) {
+    return e.variable !== undefined;
+}
+function mapOperand(operand, getFieldName, output = {}) {
+    if (isExpression(operand)) {
+        const { operator, operands } = operand;
+        switch (operator) {
+            case "and":
+                output.AND = operands.map((o) => mapOperand(o, getFieldName, {}));
+                break;
+            case "or":
+                output.OR = operands.map((o) => mapOperand(o, getFieldName, {}));
+                break;
+            case "eq":
+                output[getFieldName(operands[0].name)] = {
+                    equals: operands[1].value,
+                };
+                break;
+            case "ne":
+                output[getFieldName(operands[0].name)] = {
+                    not: operands[1].value,
+                };
+                break;
+            case "lt":
+                output[getFieldName(operands[0].name)] = {
+                    lt: operands[1].value,
+                };
+                break;
+            case "gt":
+                output[getFieldName(operands[0].name)] = {
+                    gt: operands[1].value,
+                };
+                break;
+            case "lte":
+                output[getFieldName(operands[0].name)] = {
+                    lte: operands[1].value,
+                };
+                break;
+            case "gte":
+                output[getFieldName(operands[0].name)] = {
+                    gte: operands[1].value,
+                };
+                break;
+            case "in":
+                output[getFieldName(operands[0].name)] = {
+                    in: operands[1].value,
+                };
+                break;
+        }
+    }
+    return output;
+}

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;AAAA,iCAOgB;AAWhB,SAAwB,iBAAiB,CAAC,EAGlB;QAFtB,SAAS,eAAA,EACT,eAAe,qBAAA;IAEf,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAa,CAAC,mBAAmB;QAAE,OAAO,EAAE,CAAC;IAC3E,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAa,CAAC,kBAAkB;QAAE,OAAO,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;IAChG,OAAO,UAAU,CACf,SAAS,CAAC,MAAM,CAAC,SAAS,EAC1B,UAAC,GAAW;QACV,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;YACzC,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;SAC7B;aAAM;YACL,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;SAC7D;IACH,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC;AAjBD,uCAiBC;AAED,SAAS,YAAY,CAAC,CAAoB;IACxC,OAAQ,CAAS,CAAC,UAAU,KAAK,SAAS,CAAC;AAC7C,CAAC;AAED,SAAS,OAAO,CAAC,CAAoB;IACnC,OAAQ,CAAS,CAAC,KAAK,KAAK,SAAS,CAAC;AACxC,CAAC;AAED,SAAS,UAAU,CAAC,CAAoB;IACtC,OAAQ,CAAS,CAAC,QAAQ,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED,SAAS,UAAU,CACjB,OAA0B,EAC1B,YAAqC,EACrC,MAAgB;IAAhB,uBAAA,EAAA,WAAgB;IAEhB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;QACjB,IAAA,UAAU,GAAK,OAAO,WAAZ,CAAa;QAC/B,QAAQ,UAAU,CAAC,QAAQ,EAAE;YAC3B,KAAK,KAAK;gBACR,MAAM,CAAC,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC;oBACrC,OAAA,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,CAAC;gBAA/B,CAA+B,CAChC,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CAAC,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC;oBACpC,OAAA,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,CAAC;gBAA/B,CAA+B,CAChC,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,MAAM,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBAC1D,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,GAAG,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACvD,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,EAAE,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACtD,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,EAAE,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACtD,CAAC;gBACF,MAAM;YACR,KAAK,KAAK;gBACR,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,GAAG,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACvD,CAAC;gBACF,MAAM;YACR,KAAK,KAAK;gBACR,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,GAAG,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACvD,CAAC;gBACF,MAAM;YACR,KAAK,IAAI;gBACP,MAAM,CACJ,YAAY,CAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAwB,CAAC,QAAQ,CAAC,CACtE,GAAG;oBACF,IAAE,EAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAqB,CAAC,KAAK;iBACtD,CAAC;gBACF,MAAM;SACT;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+import { PlanResourcesResponse } from "@cerbos/core";
+interface QueryPlanToPrismaArgs {
+    queryPlan: PlanResourcesResponse;
+    fieldNameMapper: {
+        [key: string]: string;
+    } | ((key: string) => string);
+}
+export default function queryPlanToPrisma({ queryPlan, fieldNameMapper, }: QueryPlanToPrismaArgs): any;
+export {};

package/lib/index.js

@@ -0,0 +1,73 @@
+import { PlanKind } from "@cerbos/core";
+export default function queryPlanToPrisma({ queryPlan, fieldNameMapper, }) {
+    if (queryPlan.kind === PlanKind.ALWAYS_ALLOWED)
+        return {};
+    if (queryPlan.kind === PlanKind.ALWAYS_DENIED)
+        return { "1": { "equals": 0 } };
+    return mapOperand(queryPlan.condition, (key) => {
+        if (typeof fieldNameMapper === "function") {
+            return fieldNameMapper(key);
+        }
+        else {
+            return (fieldNameMapper[key] = fieldNameMapper[key] || key);
+        }
+    }, {});
+}
+function isExpression(e) {
+    return e.operator !== undefined;
+}
+function isValue(e) {
+    return e.value !== undefined;
+}
+function isVariable(e) {
+    return e.variable !== undefined;
+}
+function mapOperand(operand, getFieldName, output = {}) {
+    if (isExpression(operand)) {
+        const { operator, operands } = operand;
+        switch (operator) {
+            case "and":
+                output.AND = operands.map((o) => mapOperand(o, getFieldName, {}));
+                break;
+            case "or":
+                output.OR = operands.map((o) => mapOperand(o, getFieldName, {}));
+                break;
+            case "eq":
+                output[getFieldName(operands[0].name)] = {
+                    equals: operands[1].value,
+                };
+                break;
+            case "ne":
+                output[getFieldName(operands[0].name)] = {
+                    not: operands[1].value,
+                };
+                break;
+            case "lt":
+                output[getFieldName(operands[0].name)] = {
+                    lt: operands[1].value,
+                };
+                break;
+            case "gt":
+                output[getFieldName(operands[0].name)] = {
+                    gt: operands[1].value,
+                };
+                break;
+            case "lte":
+                output[getFieldName(operands[0].name)] = {
+                    lte: operands[1].value,
+                };
+                break;
+            case "gte":
+                output[getFieldName(operands[0].name)] = {
+                    gte: operands[1].value,
+                };
+                break;
+            case "in":
+                output[getFieldName(operands[0].name)] = {
+                    in: operands[1].value,
+                };
+                break;
+        }
+    }
+    return output;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@cerbos/orm-prisma",
+  "version": "0.1.1",
+  "homepage": "https://cerbos.dev",
+  "description": "",
+  "private": false,
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
+    "prepare": "npm run build",
+    "preversion": "npm run lint",
+    "version": "git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "author": "Cerbos",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.4"
+  },
+  "dependencies": {
+    "@cerbos/core": "^0.5.0"
+  }
+}