@typed-policy/eval 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Togle Labs <m.ihsan.vp@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { Expr } from '@typed-policy/core';
+
+/**
+ * Policy action type - matches the type in policy.ts
+ */
+type PolicyAction<T, A> = Expr<T, A> | boolean | ((ctx: {
+    actor: A;
+}) => boolean | Expr<T, A>);
+/**
+ * Resource mapping for nested resource structure
+ * All fields are required as per v0.2 design
+ */
+type ResourceMapping<T> = {
+    [K in keyof T]: {
+        [P in keyof T[K]]: T[K][P];
+    };
+};
+/**
+ * Options for evaluate function
+ */
+type EvaluateOptions<T, A> = {
+    actor: A;
+    resources: ResourceMapping<T>;
+};
+/**
+ * Evaluate a policy expression
+ *
+ * @param expr - The expression to evaluate (Expr, boolean, or function)
+ * @param options - Evaluation options with actor and resources
+ * @returns boolean result
+ *
+ * @example
+ * ```typescript
+ * const canRead = evaluate(postPolicy.actions.read, {
+ *   actor: { user: { id: "1", role: "admin" } },
+ *   resources: {
+ *     post: {
+ *       id: "post-1",
+ *       ownerId: "user-1",
+ *       published: true
+ *     }
+ *   }
+ * });
+ * ```
+ */
+declare function evaluate<T, A = unknown>(expr: PolicyAction<T, A>, options: EvaluateOptions<T, A>): boolean;
+
+export { type EvaluateOptions, type ResourceMapping, evaluate };

package/dist/index.js

@@ -0,0 +1,51 @@
+// src/evaluate.ts
+function resolveValue(path, resources) {
+  const keys = path.split(".");
+  let current = resources;
+  for (const key of keys) {
+    if (current === null || current === void 0) {
+      return void 0;
+    }
+    if (typeof current !== "object") {
+      return void 0;
+    }
+    current = current[key];
+  }
+  return current;
+}
+function evaluate(expr, options) {
+  const { actor, resources } = options;
+  if (typeof expr === "boolean") {
+    return expr;
+  }
+  if (typeof expr === "function") {
+    const result = expr({ actor });
+    return evaluate(result, { actor, resources });
+  }
+  switch (expr.kind) {
+    case "literal": {
+      return expr.value;
+    }
+    case "function": {
+      const result = expr.fn({ actor });
+      return evaluate(result, { actor, resources });
+    }
+    case "eq": {
+      const leftValue = resolveValue(expr.left, resources);
+      const rightValue = typeof expr.right === "string" && expr.right.includes(".") ? resolveValue(expr.right, resources) : expr.right;
+      return leftValue === rightValue;
+    }
+    case "and": {
+      return expr.rules.every((rule) => evaluate(rule, { actor, resources }));
+    }
+    case "or": {
+      return expr.rules.some((rule) => evaluate(rule, { actor, resources }));
+    }
+    default: {
+      throw new Error(`Unknown expression kind: ${JSON.stringify(expr)}`);
+    }
+  }
+}
+export {
+  evaluate
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@typed-policy/eval",
+  "version": "0.2.0",
+  "description": "Frontend policy evaluator",
+  "author": "Ihsan VP <m.ihsan.vp@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/toglelabs/typed-policy.git",
+    "directory": "packages/eval"
+  },
+  "homepage": "https://github.com/toglelabs/typed-policy/tree/main/packages/eval#readme",
+  "bugs": {
+    "url": "https://github.com/toglelabs/typed-policy/issues"
+  },
+  "keywords": [
+    "typescript",
+    "policy",
+    "authorization",
+    "evaluator",
+    "frontend",
+    "boolean"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@typed-policy/core": "0.2.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "typescript": "^5.7.0",
+    "tsup": "^8.3.0",
+    "vitest": "^2.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "clean": "rm -rf dist",
+    "lint": "biome check src",
+    "format": "biome format --write src"
+  }
+}