@warlock.js/access 4.2.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog — @warlock.js/access
+
+All notable changes to `@warlock.js/access` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). `@warlock.js/*` packages are released in lockstep — every package shares the same version number, so a version below may list only the changes that affected this package.
+
+## [Unreleased]
+
+## 4.2.0
+
+### Added
+
+- Shipped Warlock.js Access Package.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hassan Zohdy
+
+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/README.md

@@ -0,0 +1,76 @@
+# Warlock Access
+
+Authorization (RBAC + ABAC) for [Warlock.js](https://github.com/warlockjs/core) applications — permission checks (`can` / `authorize` / `gate`), attribute-based `definePolicy` conditions, role checks, and a pluggable `AccessResolver` that connects the engine to however your app stores roles.
+
+`@warlock.js/auth` answers _who you are_; `@warlock.js/access` answers _what you can do_.
+
+## Installation
+
+```bash
+npx warlock add access
+```
+
+This ejects `src/config/access.ts`, a DB-backed `DatabaseAccessResolver`, the `Role` + `UserRole` tables, and registers the locale. `@warlock.js/access` reads `request.user`, so it lives inside a Warlock project alongside `@warlock.js/auth`.
+
+## Configure
+
+The resolver is the **one required piece** — it tells the engine how to read a user's roles + permissions. The ejected `DatabaseAccessResolver` reads roles from the `user_roles` table and maps them through the `roles` catalog table (so roles + their permissions are managed at runtime, in the DB):
+
+```ts title="src/config/access.ts"
+import { type AccessConfigurations } from "@warlock.js/access";
+import { DatabaseAccessResolver } from "app/access/services/access-resolver";
+
+const access: AccessConfigurations = {
+  resolver: new DatabaseAccessResolver(),
+};
+
+export default access;
+```
+
+For a fixed, code-defined catalog with no tables, swap in `DefaultAccessResolver` (reads `user.get("roles")` and maps through an inline map):
+
+```ts
+import { DefaultAccessResolver } from "@warlock.js/access";
+
+const access: AccessConfigurations = {
+  resolver: new DefaultAccessResolver({ owner: ["*"], editor: ["orders.*"] }),
+};
+```
+
+See the `configure-access` and `implement-resolver` skills for the full story.
+
+## Use it
+
+```ts
+import { authMiddleware } from "@warlock.js/auth";
+import { authorize, can, definePolicy, gate } from "@warlock.js/access";
+
+// route gate (class-level)
+router.post("/orders", createOrder, {
+  middleware: [authMiddleware([]), gate("orders.create")],
+});
+
+// in a service (instance-level — runs the policy)
+definePolicy("orders.update", (user, order) => order.get("customer_id") === user.id);
+await authorize(user, "orders.update", { resource: order });
+
+// boolean, anywhere
+if (await can(user, "orders.viewCost")) { /* … */ }
+```
+
+> Register `definePolicy` calls per module, in `src/app/<module>/policies/`, loaded by an `import "./policies";` side-effect in that module's `main.ts` — a policy defined in an unimported module silently never registers.
+
+## Documentation
+
+Task-focused guides live under [`skills/`](./skills):
+
+- **overview** — what the package does and the engine + resolver mental model
+- **configure-access** — the required resolver (`DefaultAccessResolver` vs the ejected `DatabaseAccessResolver`), cache + tenant
+- **check-permissions** — `can` / `authorize` / `gate` and friends
+- **define-policies** — attribute conditions (ownership / tenant / state)
+- **manage-roles** — assign / revoke via the ejected `UserRole` (auto-flushes), plus `hasRole` and out-of-band `access.flush`
+- **implement-resolver** — connect the engine to your storage (DB catalog, column, pivot, token claim)
+
+## License
+
+MIT © Hasan Zohdy

package/cjs/index.cjs

@@ -0,0 +1,367 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _warlock_js_core = require("@warlock.js/core");
+let _warlock_js_cache = require("@warlock.js/cache");
+let _warlock_js_logger = require("@warlock.js/logger");
+
+//#region ../@warlock.js/access/src/utils/access-error-codes.ts
+/**
+* Wire-stable error codes emitted by `@warlock.js/access`. Map these in your
+* error transformer the way you map `AuthErrorCodes`. A value change here is a
+* breaking change for any client that reacts to the code.
+*/
+let AccessErrorCodes = /* @__PURE__ */ function(AccessErrorCodes) {
+	/** EC100 — authenticated, but missing the required permission. */
+	AccessErrorCodes["Forbidden"] = "EC100";
+	return AccessErrorCodes;
+}({});
+
+//#endregion
+//#region ../@warlock.js/access/src/utils/access-config-error.ts
+/**
+* Thrown when `@warlock.js/access` is misconfigured (e.g. no resolver). Unlike a
+* runtime resolution failure — which fails CLOSED (denies) — a config error is a
+* developer mistake, so the engine re-throws it LOUD instead of silently denying.
+*/
+var AccessConfigError = class extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "AccessConfigError";
+	}
+};
+
+//#endregion
+//#region ../@warlock.js/access/src/services/access-config.ts
+/**
+* The active configuration, fed once at boot by the framework's access connector
+* via {@link setAccessConfig} (the connector reads `src/config/access.ts`).
+* Reading it before it's set throws {@link AccessConfigError} — a loud
+* misconfiguration, never a silent deny.
+*/
+let current;
+/**
+* Register the access configuration. The framework's access connector calls this
+* at boot with the default export of `src/config/access.ts`. It validates that a
+* `resolver` is present, so a misconfigured authorization layer fails at STARTUP
+* rather than on the first protected request.
+*
+* @example
+* setAccessConfig({ resolver: new DefaultAccessResolver({ admin: ["*"] }) });
+*/
+function setAccessConfig(configuration) {
+	if (!configuration?.resolver) throw new AccessConfigError("No access resolver configured. Set `resolver` in src/config/access.ts to a class implementing AccessResolver — the ejected DatabaseAccessResolver, or `new DefaultAccessResolver(rolesMap)` for a fixed-role catalog.");
+	current = configuration;
+}
+/** Clear the active config. Used by the connector on dev-restart and by tests. */
+function resetAccessConfig() {
+	current = void 0;
+}
+/** Accessors over the active access configuration. */
+const accessConfig = {
+	/**
+	* The configured resolver. Throws {@link AccessConfigError} if access was never
+	* configured (no `src/config/access.ts`, or the connector hasn't run).
+	*/
+	resolver() {
+		if (!current) throw new AccessConfigError("@warlock.js/access is not configured. Add src/config/access.ts (exporting a `resolver`) — it is wired at boot by the access connector.");
+		return current.resolver;
+	},
+	/** Cache TTL for resolved permission sets. */
+	cacheTtl() {
+		return current?.cache?.ttl ?? "10m";
+	},
+	/** Ambient tenant for this user, delegated to the resolver's optional hook. */
+	tenant(user) {
+		return this.resolver().resolveTenant?.(user);
+	}
+};
+
+//#endregion
+//#region ../@warlock.js/access/src/services/matcher.ts
+/**
+* Whether a set of granted permission patterns covers a requested permission.
+*
+* Supports three forms:
+* - exact — `"orders.update"` covers `"orders.update"`
+* - global — `"*"` covers everything (the super-grant)
+* - prefix wildcard — `"orders.*"` covers `"orders.update"` and `"orders.update.status"`
+*
+* `"orders.*"` does NOT cover the bare `"orders"` (no trailing segment).
+*/
+function matchesPermission(granted, permission) {
+	for (const pattern of granted) {
+		if (pattern === "*" || pattern === permission) return true;
+		if (pattern.endsWith(".*") && permission.startsWith(pattern.slice(0, -1))) return true;
+	}
+	return false;
+}
+
+//#endregion
+//#region ../@warlock.js/access/src/services/policies.ts
+const policies = /* @__PURE__ */ new Map();
+/**
+* Register an ABAC condition for a permission. It runs ON TOP of the RBAC grant
+* whenever an authorization check carries a `resource` — letting you express
+* "...but only their own / only in their tenant / only while pending".
+*
+* @example
+* definePolicy("orders.update", (user, order) => order.get("customer_id") === user.id);
+*/
+function definePolicy(permission, policy) {
+	policies.set(permission, policy);
+}
+/** The policy registered for a permission, if any. */
+function getPolicy(permission) {
+	return policies.get(permission);
+}
+/** Remove every registered policy. Primarily for tests. */
+function clearPolicies() {
+	policies.clear();
+}
+
+//#endregion
+//#region ../@warlock.js/access/src/services/engine.ts
+const PERMISSIONS_PREFIX = "access.perms.";
+const ROLES_PREFIX = "access.roles.";
+/** Resolve the effective tenant for a check (explicit → ambient → undefined). */
+function tenantFor(user, context) {
+	return context.tenant ?? accessConfig.tenant(user);
+}
+function cacheKey(prefix, user, tenant) {
+	const segment = (value) => encodeURIComponent(String(value));
+	return `${prefix}${segment(user.userType)}.${segment(user.id)}.${segment(tenant ?? "_")}`;
+}
+/**
+* Read a list through the cache, falling back to the loader.
+*
+* The cache is **best-effort**: a cache failure degrades to the loader (the
+* source of truth) and is logged, never denied. A loader failure propagates —
+* so the DECISION fails closed in {@link check}.
+*/
+async function cached(key, loader) {
+	try {
+		const hit = await _warlock_js_cache.cache.get(key);
+		if (hit) return hit;
+	} catch (error) {
+		_warlock_js_logger.log.error("access", "cache", error);
+	}
+	const value = await loader();
+	try {
+		await _warlock_js_cache.cache.set(key, value, { ttl: accessConfig.cacheTtl() });
+	} catch (error) {
+		_warlock_js_logger.log.error("access", "cache", error);
+	}
+	return value;
+}
+/** The user's effective permission set for a tenant (cached). */
+function permissionsFor(user, tenant) {
+	return cached(cacheKey(PERMISSIONS_PREFIX, user, tenant), () => accessConfig.resolver().resolvePermissions(user, tenant));
+}
+/** The user's roles for a tenant (cached). */
+function rolesFor(user, tenant) {
+	return cached(cacheKey(ROLES_PREFIX, user, tenant), () => accessConfig.resolver().resolveRoles(user, tenant));
+}
+/** Drop the cached role/permission sets for a user (after any out-of-band role change). */
+async function flush(user, tenant) {
+	try {
+		await _warlock_js_cache.cache.remove(cacheKey(PERMISSIONS_PREFIX, user, tenant));
+		await _warlock_js_cache.cache.remove(cacheKey(ROLES_PREFIX, user, tenant));
+	} catch (error) {
+		_warlock_js_logger.log.error("access", "cache", error);
+	}
+}
+/**
+* The core decision: does the user hold `permission`, and — when a `resource`
+* is supplied — does its policy pass too?
+*
+* Fails CLOSED: any error while resolving the decision denies (and logs).
+*/
+async function check(user, permission, context = {}) {
+	try {
+		const tenant = tenantFor(user, context);
+		const permissions = await permissionsFor(user, tenant);
+		if (!matchesPermission(permissions, permission)) return false;
+		const policy = getPolicy(permission);
+		if (policy === void 0 || context.resource === void 0) return true;
+		const roles = await rolesFor(user, tenant);
+		return Boolean(await policy(user, context.resource, {
+			...context,
+			tenant,
+			hasRole: (role) => roles.includes(role),
+			hasPermission: (perm) => matchesPermission(permissions, perm)
+		}));
+	} catch (error) {
+		if (error instanceof AccessConfigError) throw error;
+		_warlock_js_logger.log.error("access", "check", error);
+		return false;
+	}
+}
+
+//#endregion
+//#region ../@warlock.js/access/src/services/access.ts
+/** Whether the user holds `permission` (and passes its policy when a resource is given). */
+function can(user, permission, context) {
+	return check(user, permission, context);
+}
+/** Inverse of {@link can}. */
+async function cannot(user, permission, context) {
+	return !await can(user, permission, context);
+}
+/** Whether the user holds EVERY listed permission. Short-circuits on the first miss. */
+async function canAll(user, permissions, context) {
+	for (const permission of permissions) if (!await can(user, permission, context)) return false;
+	return true;
+}
+/** Whether the user holds ANY listed permission. Short-circuits on the first hit. */
+async function canAny(user, permissions, context) {
+	for (const permission of permissions) if (await can(user, permission, context)) return true;
+	return false;
+}
+function forbidden() {
+	throw new _warlock_js_core.ForbiddenError((0, _warlock_js_core.t)("access.errors.forbidden"), { errorCode: "EC100" });
+}
+/** Assert the user holds `permission`; throw `ForbiddenError` (403) otherwise. */
+async function authorize(user, permission, context) {
+	if (!await can(user, permission, context)) forbidden();
+}
+/** Assert the user holds EVERY listed permission; throw otherwise. */
+async function authorizeAll(user, permissions, context) {
+	if (!await canAll(user, permissions, context)) forbidden();
+}
+/** Assert the user holds ANY listed permission; throw otherwise. */
+async function authorizeAny(user, permissions, context) {
+	if (!await canAny(user, permissions, context)) forbidden();
+}
+/** Whether the user has the given role. */
+async function hasRole(user, role, tenant) {
+	return (await rolesFor(user, tenant)).includes(role);
+}
+/** Whether the user has ANY of the given roles. */
+async function hasAnyRole(user, roles, tenant) {
+	const held = await rolesFor(user, tenant);
+	return roles.some((role) => held.includes(role));
+}
+/** Whether the user has ALL of the given roles. */
+async function hasAllRoles(user, roles, tenant) {
+	const held = await rolesFor(user, tenant);
+	return roles.every((role) => held.includes(role));
+}
+/**
+* The access facade — every check plus `flush` to drop a user's cached set.
+* Role assignment lives on the ejected `UserRole` model in app-land; callers do
+* `UserRole.assign(...)` then `access.flush(user, tenant)`.
+*
+* @example
+* import { access } from "@warlock.js/access";
+* if (await access.can(user, "orders.update", { resource: order })) { ... }
+* await access.flush(user, "tenant-1");
+*/
+const access = {
+	can,
+	cannot,
+	canAll,
+	canAny,
+	authorize,
+	authorizeAll,
+	authorizeAny,
+	hasRole,
+	hasAnyRole,
+	hasAllRoles,
+	/** Drop the user's cached role/permission set (call after you mutate role rows). */
+	flush
+};
+
+//#endregion
+//#region ../@warlock.js/access/src/middleware/gate.middleware.ts
+function deny(response) {
+	return response.forbidden({
+		error: (0, _warlock_js_core.t)("access.errors.forbidden"),
+		errorCode: "EC100"
+	});
+}
+/**
+* Gate a route on a single permission (class-level). Stack it AFTER
+* `authMiddleware`, which sets `request.user`.
+*
+* @example
+* router.post("/orders", createOrder, {
+*   middleware: [authMiddleware([]), gate("orders.create")],
+* });
+*/
+function gate(permission) {
+	return async (request, response) => {
+		if (!request.user) return deny(response);
+		if (!await can(request.user, permission)) return deny(response);
+	};
+}
+/** Gate a route on holding ANY of the listed permissions. */
+function gateAny(permissions) {
+	return async (request, response) => {
+		if (!request.user) return deny(response);
+		if (!await canAny(request.user, permissions)) return deny(response);
+	};
+}
+/** Gate a route on holding ALL of the listed permissions. */
+function gateAll(permissions) {
+	return async (request, response) => {
+		if (!request.user) return deny(response);
+		if (!await canAll(request.user, permissions)) return deny(response);
+	};
+}
+
+//#endregion
+//#region ../@warlock.js/access/src/services/default-resolver.ts
+/** Coerce a roles value (`undefined` / single string / array) into a string array. */
+function toRoleList(value) {
+	if (Array.isArray(value)) return value;
+	if (typeof value === "string" && value.length > 0) return [value];
+	return [];
+}
+/**
+* The zero-config resolver: reads a user's roles from a model field and maps
+* them to permissions through your `roles` catalog. Works out of the box for
+* both a `roles` array column and a single `role` column.
+*
+* Swap `readRoles` to read from anywhere else (a relation, a token claim); for
+* a different storage shape entirely, implement {@link AccessResolver} directly.
+*
+* @example
+* new DefaultAccessResolver({ editor: ["orders.*"], viewer: ["orders.view"] });
+* new DefaultAccessResolver(rolesMap, (user) => user.get("memberRoles"));
+*/
+var DefaultAccessResolver = class {
+	constructor(roles, readRoles = (user) => user.get("roles") ?? user.get("role")) {
+		this.roles = roles;
+		this.readRoles = readRoles;
+	}
+	async resolveRoles(user) {
+		return toRoleList(await this.readRoles(user));
+	}
+	async resolvePermissions(user) {
+		return (await this.resolveRoles(user)).flatMap((role) => Object.prototype.hasOwnProperty.call(this.roles, role) ? this.roles[role] : []);
+	}
+};
+
+//#endregion
+exports.AccessConfigError = AccessConfigError;
+exports.AccessErrorCodes = AccessErrorCodes;
+exports.DefaultAccessResolver = DefaultAccessResolver;
+exports.access = access;
+exports.authorize = authorize;
+exports.authorizeAll = authorizeAll;
+exports.authorizeAny = authorizeAny;
+exports.can = can;
+exports.canAll = canAll;
+exports.canAny = canAny;
+exports.cannot = cannot;
+exports.clearPolicies = clearPolicies;
+exports.definePolicy = definePolicy;
+exports.flush = flush;
+exports.gate = gate;
+exports.gateAll = gateAll;
+exports.gateAny = gateAny;
+exports.hasAllRoles = hasAllRoles;
+exports.hasAnyRole = hasAnyRole;
+exports.hasRole = hasRole;
+exports.resetAccessConfig = resetAccessConfig;
+exports.setAccessConfig = setAccessConfig;
+//# sourceMappingURL=index.cjs.map

package/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["cache","ForbiddenError","flushUser"],"sources":["../../../../../../@warlock.js/access/src/utils/access-error-codes.ts","../../../../../../@warlock.js/access/src/utils/access-config-error.ts","../../../../../../@warlock.js/access/src/services/access-config.ts","../../../../../../@warlock.js/access/src/services/matcher.ts","../../../../../../@warlock.js/access/src/services/policies.ts","../../../../../../@warlock.js/access/src/services/engine.ts","../../../../../../@warlock.js/access/src/services/access.ts","../../../../../../@warlock.js/access/src/middleware/gate.middleware.ts","../../../../../../@warlock.js/access/src/services/default-resolver.ts"],"sourcesContent":["/**\n * Wire-stable error codes emitted by `@warlock.js/access`. Map these in your\n * error transformer the way you map `AuthErrorCodes`. A value change here is a\n * breaking change for any client that reacts to the code.\n */\nexport enum AccessErrorCodes {\n  /** EC100 — authenticated, but missing the required permission. */\n  Forbidden = \"EC100\",\n}\n","/**\n * Thrown when `@warlock.js/access` is misconfigured (e.g. no resolver). Unlike a\n * runtime resolution failure — which fails CLOSED (denies) — a config error is a\n * developer mistake, so the engine re-throws it LOUD instead of silently denying.\n */\nexport class AccessConfigError extends Error {\n  public constructor(message: string) {\n    super(message);\n    this.name = \"AccessConfigError\";\n  }\n}\n","import type { Auth } from \"@warlock.js/auth\";\nimport type { AccessResolver } from \"../contracts/access-resolver\";\nimport type { AccessConfigurations } from \"../contracts/types\";\nimport { AccessConfigError } from \"../utils/access-config-error\";\n\n/**\n * The active configuration, fed once at boot by the framework's access connector\n * via {@link setAccessConfig} (the connector reads `src/config/access.ts`).\n * Reading it before it's set throws {@link AccessConfigError} — a loud\n * misconfiguration, never a silent deny.\n */\nlet current: AccessConfigurations | undefined;\n\n/**\n * Register the access configuration. The framework's access connector calls this\n * at boot with the default export of `src/config/access.ts`. It validates that a\n * `resolver` is present, so a misconfigured authorization layer fails at STARTUP\n * rather than on the first protected request.\n *\n * @example\n * setAccessConfig({ resolver: new DefaultAccessResolver({ admin: [\"*\"] }) });\n */\nexport function setAccessConfig(configuration: AccessConfigurations): void {\n  if (!configuration?.resolver) {\n    throw new AccessConfigError(\n      \"No access resolver configured. Set `resolver` in src/config/access.ts to a class \" +\n        \"implementing AccessResolver — the ejected DatabaseAccessResolver, or \" +\n        \"`new DefaultAccessResolver(rolesMap)` for a fixed-role catalog.\",\n    );\n  }\n\n  current = configuration;\n}\n\n/** Clear the active config. Used by the connector on dev-restart and by tests. */\nexport function resetAccessConfig(): void {\n  current = undefined;\n}\n\n/** Accessors over the active access configuration. */\nexport const accessConfig = {\n  /**\n   * The configured resolver. Throws {@link AccessConfigError} if access was never\n   * configured (no `src/config/access.ts`, or the connector hasn't run).\n   */\n  resolver(): AccessResolver {\n    if (!current) {\n      throw new AccessConfigError(\n        \"@warlock.js/access is not configured. Add src/config/access.ts (exporting a `resolver`) \" +\n          \"— it is wired at boot by the access connector.\",\n      );\n    }\n\n    return current.resolver;\n  },\n\n  /** Cache TTL for resolved permission sets. */\n  cacheTtl(): string | number {\n    return current?.cache?.ttl ?? \"10m\";\n  },\n\n  /** Ambient tenant for this user, delegated to the resolver's optional hook. */\n  tenant(user: Auth): string | undefined {\n    return this.resolver().resolveTenant?.(user);\n  },\n};\n","/**\n * Whether a set of granted permission patterns covers a requested permission.\n *\n * Supports three forms:\n * - exact — `\"orders.update\"` covers `\"orders.update\"`\n * - global — `\"*\"` covers everything (the super-grant)\n * - prefix wildcard — `\"orders.*\"` covers `\"orders.update\"` and `\"orders.update.status\"`\n *\n * `\"orders.*\"` does NOT cover the bare `\"orders\"` (no trailing segment).\n */\nexport function matchesPermission(granted: string[], permission: string): boolean {\n  for (const pattern of granted) {\n    if (pattern === \"*\" || pattern === permission) {\n      return true;\n    }\n\n    // \"orders.*\" → prefix \"orders.\" — matches any nested permission.\n    if (pattern.endsWith(\".*\") && permission.startsWith(pattern.slice(0, -1))) {\n      return true;\n    }\n  }\n\n  return false;\n}\n","import type { PolicyFn } from \"../contracts/types\";\n\nconst policies = new Map<string, PolicyFn>();\n\n/**\n * Register an ABAC condition for a permission. It runs ON TOP of the RBAC grant\n * whenever an authorization check carries a `resource` — letting you express\n * \"...but only their own / only in their tenant / only while pending\".\n *\n * @example\n * definePolicy(\"orders.update\", (user, order) => order.get(\"customer_id\") === user.id);\n */\nexport function definePolicy(permission: string, policy: PolicyFn): void {\n  policies.set(permission, policy);\n}\n\n/** The policy registered for a permission, if any. */\nexport function getPolicy(permission: string): PolicyFn | undefined {\n  return policies.get(permission);\n}\n\n/** Remove every registered policy. Primarily for tests. */\nexport function clearPolicies(): void {\n  policies.clear();\n}\n","import type { Auth } from \"@warlock.js/auth\";\nimport { cache } from \"@warlock.js/cache\";\nimport { log } from \"@warlock.js/logger\";\nimport type { AccessContext } from \"../contracts/types\";\nimport { AccessConfigError } from \"../utils/access-config-error\";\nimport { accessConfig } from \"./access-config\";\nimport { matchesPermission } from \"./matcher\";\nimport { getPolicy } from \"./policies\";\n\nconst PERMISSIONS_PREFIX = \"access.perms.\";\nconst ROLES_PREFIX = \"access.roles.\";\n\n/** Resolve the effective tenant for a check (explicit → ambient → undefined). */\nfunction tenantFor(user: Auth, context: AccessContext): string | undefined {\n  return context.tenant ?? accessConfig.tenant(user);\n}\n\nfunction cacheKey(prefix: string, user: Auth, tenant?: string): string {\n  // Encode each segment so a `.` in an id or tenant can't collide two distinct\n  // principals onto the same cache key (and serve one's grants to the other).\n  const segment = (value: unknown) => encodeURIComponent(String(value));\n\n  return `${prefix}${segment(user.userType)}.${segment(user.id)}.${segment(tenant ?? \"_\")}`;\n}\n\n/**\n * Read a list through the cache, falling back to the loader.\n *\n * The cache is **best-effort**: a cache failure degrades to the loader (the\n * source of truth) and is logged, never denied. A loader failure propagates —\n * so the DECISION fails closed in {@link check}.\n */\nasync function cached(\n  key: string,\n  loader: () => Promise<string[]>,\n): Promise<string[]> {\n  try {\n    const hit = await cache.get<string[]>(key);\n\n    if (hit) return hit;\n  } catch (error) {\n    log.error(\"access\", \"cache\", error);\n  }\n\n  const value = await loader();\n\n  try {\n    await cache.set(key, value, { ttl: accessConfig.cacheTtl() });\n  } catch (error) {\n    log.error(\"access\", \"cache\", error);\n  }\n\n  return value;\n}\n\n/** The user's effective permission set for a tenant (cached). */\nexport function permissionsFor(user: Auth, tenant?: string): Promise<string[]> {\n  return cached(cacheKey(PERMISSIONS_PREFIX, user, tenant), () =>\n    accessConfig.resolver().resolvePermissions(user, tenant),\n  );\n}\n\n/** The user's roles for a tenant (cached). */\nexport function rolesFor(user: Auth, tenant?: string): Promise<string[]> {\n  return cached(cacheKey(ROLES_PREFIX, user, tenant), () =>\n    accessConfig.resolver().resolveRoles(user, tenant),\n  );\n}\n\n/** Drop the cached role/permission sets for a user (after any out-of-band role change). */\nexport async function flush(user: Auth, tenant?: string): Promise<void> {\n  try {\n    await cache.remove(cacheKey(PERMISSIONS_PREFIX, user, tenant));\n    await cache.remove(cacheKey(ROLES_PREFIX, user, tenant));\n  } catch (error) {\n    log.error(\"access\", \"cache\", error);\n  }\n}\n\n/**\n * The core decision: does the user hold `permission`, and — when a `resource`\n * is supplied — does its policy pass too?\n *\n * Fails CLOSED: any error while resolving the decision denies (and logs).\n */\nexport async function check(\n  user: Auth,\n  permission: string,\n  context: AccessContext = {},\n): Promise<boolean> {\n  try {\n    const tenant = tenantFor(user, context);\n    const permissions = await permissionsFor(user, tenant);\n\n    if (!matchesPermission(permissions, permission)) return false;\n\n    const policy = getPolicy(permission);\n\n    // A policy only runs on an instance check (a resource was supplied);\n    // class-level checks (`gate`) stop at the grant.\n    if (policy === undefined || context.resource === undefined) return true;\n\n    const roles = await rolesFor(user, tenant);\n\n    return Boolean(\n      await policy(user, context.resource, {\n        ...context,\n        tenant,\n        hasRole: (role) => roles.includes(role),\n        hasPermission: (perm) => matchesPermission(permissions, perm),\n      }),\n    );\n  } catch (error) {\n    if (error instanceof AccessConfigError) throw error; // misconfig is loud, not a silent deny\n\n    log.error(\"access\", \"check\", error);\n\n    return false;\n  }\n}\n","import type { Auth } from \"@warlock.js/auth\";\nimport { ForbiddenError, t } from \"@warlock.js/core\";\nimport type { AccessContext } from \"../contracts/types\";\nimport { AccessErrorCodes } from \"../utils/access-error-codes\";\nimport { check, flush as flushUser, rolesFor } from \"./engine\";\n\n/** Whether the user holds `permission` (and passes its policy when a resource is given). */\nexport function can(\n  user: Auth,\n  permission: string,\n  context?: AccessContext,\n): Promise<boolean> {\n  return check(user, permission, context);\n}\n\n/** Inverse of {@link can}. */\nexport async function cannot(\n  user: Auth,\n  permission: string,\n  context?: AccessContext,\n): Promise<boolean> {\n  return !(await can(user, permission, context));\n}\n\n/** Whether the user holds EVERY listed permission. Short-circuits on the first miss. */\nexport async function canAll(\n  user: Auth,\n  permissions: string[],\n  context?: AccessContext,\n): Promise<boolean> {\n  for (const permission of permissions) {\n    if (!(await can(user, permission, context))) return false;\n  }\n\n  return true;\n}\n\n/** Whether the user holds ANY listed permission. Short-circuits on the first hit. */\nexport async function canAny(\n  user: Auth,\n  permissions: string[],\n  context?: AccessContext,\n): Promise<boolean> {\n  for (const permission of permissions) {\n    if (await can(user, permission, context)) return true;\n  }\n\n  return false;\n}\n\nfunction forbidden(): never {\n  throw new ForbiddenError(t(\"access.errors.forbidden\"), {\n    errorCode: AccessErrorCodes.Forbidden,\n  });\n}\n\n/** Assert the user holds `permission`; throw `ForbiddenError` (403) otherwise. */\nexport async function authorize(\n  user: Auth,\n  permission: string,\n  context?: AccessContext,\n): Promise<void> {\n  if (!(await can(user, permission, context))) forbidden();\n}\n\n/** Assert the user holds EVERY listed permission; throw otherwise. */\nexport async function authorizeAll(\n  user: Auth,\n  permissions: string[],\n  context?: AccessContext,\n): Promise<void> {\n  if (!(await canAll(user, permissions, context))) forbidden();\n}\n\n/** Assert the user holds ANY listed permission; throw otherwise. */\nexport async function authorizeAny(\n  user: Auth,\n  permissions: string[],\n  context?: AccessContext,\n): Promise<void> {\n  if (!(await canAny(user, permissions, context))) forbidden();\n}\n\n/** Whether the user has the given role. */\nexport async function hasRole(\n  user: Auth,\n  role: string,\n  tenant?: string,\n): Promise<boolean> {\n  return (await rolesFor(user, tenant)).includes(role);\n}\n\n/** Whether the user has ANY of the given roles. */\nexport async function hasAnyRole(\n  user: Auth,\n  roles: string[],\n  tenant?: string,\n): Promise<boolean> {\n  const held = await rolesFor(user, tenant);\n\n  return roles.some((role) => held.includes(role));\n}\n\n/** Whether the user has ALL of the given roles. */\nexport async function hasAllRoles(\n  user: Auth,\n  roles: string[],\n  tenant?: string,\n): Promise<boolean> {\n  const held = await rolesFor(user, tenant);\n\n  return roles.every((role) => held.includes(role));\n}\n\n/**\n * The access facade — every check plus `flush` to drop a user's cached set.\n * Role assignment lives on the ejected `UserRole` model in app-land; callers do\n * `UserRole.assign(...)` then `access.flush(user, tenant)`.\n *\n * @example\n * import { access } from \"@warlock.js/access\";\n * if (await access.can(user, \"orders.update\", { resource: order })) { ... }\n * await access.flush(user, \"tenant-1\");\n */\nexport const access = {\n  can,\n  cannot,\n  canAll,\n  canAny,\n  authorize,\n  authorizeAll,\n  authorizeAny,\n  hasRole,\n  hasAnyRole,\n  hasAllRoles,\n  /** Drop the user's cached role/permission set (call after you mutate role rows). */\n  flush: flushUser,\n};\n","import { t, type Middleware, type Request, type Response } from \"@warlock.js/core\";\nimport { can, canAll, canAny } from \"../services/access\";\nimport { AccessErrorCodes } from \"../utils/access-error-codes\";\n\nfunction deny(response: Response) {\n  return response.forbidden({\n    error: t(\"access.errors.forbidden\"),\n    errorCode: AccessErrorCodes.Forbidden,\n  });\n}\n\n/**\n * Gate a route on a single permission (class-level). Stack it AFTER\n * `authMiddleware`, which sets `request.user`.\n *\n * @example\n * router.post(\"/orders\", createOrder, {\n *   middleware: [authMiddleware([]), gate(\"orders.create\")],\n * });\n */\nexport function gate(permission: string): Middleware {\n  return async (request: Request, response: Response) => {\n    if (!request.user) return deny(response);\n\n    if (!(await can(request.user, permission))) return deny(response);\n  };\n}\n\n/** Gate a route on holding ANY of the listed permissions. */\nexport function gateAny(permissions: string[]): Middleware {\n  return async (request: Request, response: Response) => {\n    if (!request.user) return deny(response);\n\n    if (!(await canAny(request.user, permissions))) return deny(response);\n  };\n}\n\n/** Gate a route on holding ALL of the listed permissions. */\nexport function gateAll(permissions: string[]): Middleware {\n  return async (request: Request, response: Response) => {\n    if (!request.user) return deny(response);\n\n    if (!(await canAll(request.user, permissions))) return deny(response);\n  };\n}\n","import type { Auth } from \"@warlock.js/auth\";\nimport type { AccessResolver } from \"../contracts/access-resolver\";\nimport type { RolesMap } from \"../contracts/types\";\n\n/** Coerce a roles value (`undefined` / single string / array) into a string array. */\nfunction toRoleList(value: unknown): string[] {\n  if (Array.isArray(value)) return value as string[];\n\n  if (typeof value === \"string\" && value.length > 0) return [value];\n\n  return [];\n}\n\n/**\n * The zero-config resolver: reads a user's roles from a model field and maps\n * them to permissions through your `roles` catalog. Works out of the box for\n * both a `roles` array column and a single `role` column.\n *\n * Swap `readRoles` to read from anywhere else (a relation, a token claim); for\n * a different storage shape entirely, implement {@link AccessResolver} directly.\n *\n * @example\n * new DefaultAccessResolver({ editor: [\"orders.*\"], viewer: [\"orders.view\"] });\n * new DefaultAccessResolver(rolesMap, (user) => user.get(\"memberRoles\"));\n */\nexport class DefaultAccessResolver implements AccessResolver {\n  public constructor(\n    private readonly roles: RolesMap,\n    private readonly readRoles: (user: Auth) => unknown = (user) =>\n      user.get(\"roles\") ?? user.get(\"role\"),\n  ) {}\n\n  public async resolveRoles(user: Auth): Promise<string[]> {\n    return toRoleList(await this.readRoles(user));\n  }\n\n  public async resolvePermissions(user: Auth): Promise<string[]> {\n    const roles = await this.resolveRoles(user);\n\n    // Guard against a role named `__proto__` / `constructor` resolving to an\n    // inherited (non-array) value.\n    return roles.flatMap((role) =>\n      Object.prototype.hasOwnProperty.call(this.roles, role)\n        ? this.roles[role]\n        : [],\n    );\n  }\n}\n"],"mappings":";;;;;;;;;;;AAKA,IAAY,mBAAL;;CAEL;;AACF;;;;;;;;;ACHA,IAAa,oBAAb,cAAuC,MAAM;CAC3C,AAAO,YAAY,SAAiB;EAClC,MAAM,OAAO;EACb,KAAK,OAAO;CACd;AACF;;;;;;;;;;ACCA,IAAI;;;;;;;;;;AAWJ,SAAgB,gBAAgB,eAA2C;CACzE,IAAI,CAAC,eAAe,UAClB,MAAM,IAAI,kBACR,uNAGF;CAGF,UAAU;AACZ;;AAGA,SAAgB,oBAA0B;CACxC,UAAU;AACZ;;AAGA,MAAa,eAAe;;;;;CAK1B,WAA2B;EACzB,IAAI,CAAC,SACH,MAAM,IAAI,kBACR,wIAEF;EAGF,OAAO,QAAQ;CACjB;;CAGA,WAA4B;EAC1B,OAAO,SAAS,OAAO,OAAO;CAChC;;CAGA,OAAO,MAAgC;EACrC,OAAO,KAAK,SAAS,CAAC,CAAC,gBAAgB,IAAI;CAC7C;AACF;;;;;;;;;;;;;;ACvDA,SAAgB,kBAAkB,SAAmB,YAA6B;CAChF,KAAK,MAAM,WAAW,SAAS;EAC7B,IAAI,YAAY,OAAO,YAAY,YACjC,OAAO;EAIT,IAAI,QAAQ,SAAS,IAAI,KAAK,WAAW,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC,GACtE,OAAO;CAEX;CAEA,OAAO;AACT;;;;ACrBA,MAAM,2BAAW,IAAI,IAAsB;;;;;;;;;AAU3C,SAAgB,aAAa,YAAoB,QAAwB;CACvE,SAAS,IAAI,YAAY,MAAM;AACjC;;AAGA,SAAgB,UAAU,YAA0C;CAClE,OAAO,SAAS,IAAI,UAAU;AAChC;;AAGA,SAAgB,gBAAsB;CACpC,SAAS,MAAM;AACjB;;;;ACfA,MAAM,qBAAqB;AAC3B,MAAM,eAAe;;AAGrB,SAAS,UAAU,MAAY,SAA4C;CACzE,OAAO,QAAQ,UAAU,aAAa,OAAO,IAAI;AACnD;AAEA,SAAS,SAAS,QAAgB,MAAY,QAAyB;CAGrE,MAAM,WAAW,UAAmB,mBAAmB,OAAO,KAAK,CAAC;CAEpE,OAAO,GAAG,SAAS,QAAQ,KAAK,QAAQ,EAAE,GAAG,QAAQ,KAAK,EAAE,EAAE,GAAG,QAAQ,UAAU,GAAG;AACxF;;;;;;;;AASA,eAAe,OACb,KACA,QACmB;CACnB,IAAI;EACF,MAAM,MAAM,MAAMA,wBAAM,IAAc,GAAG;EAEzC,IAAI,KAAK,OAAO;CAClB,SAAS,OAAO;EACd,uBAAI,MAAM,UAAU,SAAS,KAAK;CACpC;CAEA,MAAM,QAAQ,MAAM,OAAO;CAE3B,IAAI;EACF,MAAMA,wBAAM,IAAI,KAAK,OAAO,EAAE,KAAK,aAAa,SAAS,EAAE,CAAC;CAC9D,SAAS,OAAO;EACd,uBAAI,MAAM,UAAU,SAAS,KAAK;CACpC;CAEA,OAAO;AACT;;AAGA,SAAgB,eAAe,MAAY,QAAoC;CAC7E,OAAO,OAAO,SAAS,oBAAoB,MAAM,MAAM,SACrD,aAAa,SAAS,CAAC,CAAC,mBAAmB,MAAM,MAAM,CACzD;AACF;;AAGA,SAAgB,SAAS,MAAY,QAAoC;CACvE,OAAO,OAAO,SAAS,cAAc,MAAM,MAAM,SAC/C,aAAa,SAAS,CAAC,CAAC,aAAa,MAAM,MAAM,CACnD;AACF;;AAGA,eAAsB,MAAM,MAAY,QAAgC;CACtE,IAAI;EACF,MAAMA,wBAAM,OAAO,SAAS,oBAAoB,MAAM,MAAM,CAAC;EAC7D,MAAMA,wBAAM,OAAO,SAAS,cAAc,MAAM,MAAM,CAAC;CACzD,SAAS,OAAO;EACd,uBAAI,MAAM,UAAU,SAAS,KAAK;CACpC;AACF;;;;;;;AAQA,eAAsB,MACpB,MACA,YACA,UAAyB,CAAC,GACR;CAClB,IAAI;EACF,MAAM,SAAS,UAAU,MAAM,OAAO;EACtC,MAAM,cAAc,MAAM,eAAe,MAAM,MAAM;EAErD,IAAI,CAAC,kBAAkB,aAAa,UAAU,GAAG,OAAO;EAExD,MAAM,SAAS,UAAU,UAAU;EAInC,IAAI,WAAW,UAAa,QAAQ,aAAa,QAAW,OAAO;EAEnE,MAAM,QAAQ,MAAM,SAAS,MAAM,MAAM;EAEzC,OAAO,QACL,MAAM,OAAO,MAAM,QAAQ,UAAU;GACnC,GAAG;GACH;GACA,UAAU,SAAS,MAAM,SAAS,IAAI;GACtC,gBAAgB,SAAS,kBAAkB,aAAa,IAAI;EAC9D,CAAC,CACH;CACF,SAAS,OAAO;EACd,IAAI,iBAAiB,mBAAmB,MAAM;EAE9C,uBAAI,MAAM,UAAU,SAAS,KAAK;EAElC,OAAO;CACT;AACF;;;;;AChHA,SAAgB,IACd,MACA,YACA,SACkB;CAClB,OAAO,MAAM,MAAM,YAAY,OAAO;AACxC;;AAGA,eAAsB,OACpB,MACA,YACA,SACkB;CAClB,OAAO,CAAE,MAAM,IAAI,MAAM,YAAY,OAAO;AAC9C;;AAGA,eAAsB,OACpB,MACA,aACA,SACkB;CAClB,KAAK,MAAM,cAAc,aACvB,IAAI,CAAE,MAAM,IAAI,MAAM,YAAY,OAAO,GAAI,OAAO;CAGtD,OAAO;AACT;;AAGA,eAAsB,OACpB,MACA,aACA,SACkB;CAClB,KAAK,MAAM,cAAc,aACvB,IAAI,MAAM,IAAI,MAAM,YAAY,OAAO,GAAG,OAAO;CAGnD,OAAO;AACT;AAEA,SAAS,YAAmB;CAC1B,MAAM,IAAIC,wDAAiB,yBAAyB,GAAG,EACrD,mBACF,CAAC;AACH;;AAGA,eAAsB,UACpB,MACA,YACA,SACe;CACf,IAAI,CAAE,MAAM,IAAI,MAAM,YAAY,OAAO,GAAI,UAAU;AACzD;;AAGA,eAAsB,aACpB,MACA,aACA,SACe;CACf,IAAI,CAAE,MAAM,OAAO,MAAM,aAAa,OAAO,GAAI,UAAU;AAC7D;;AAGA,eAAsB,aACpB,MACA,aACA,SACe;CACf,IAAI,CAAE,MAAM,OAAO,MAAM,aAAa,OAAO,GAAI,UAAU;AAC7D;;AAGA,eAAsB,QACpB,MACA,MACA,QACkB;CAClB,QAAQ,MAAM,SAAS,MAAM,MAAM,EAAC,CAAE,SAAS,IAAI;AACrD;;AAGA,eAAsB,WACpB,MACA,OACA,QACkB;CAClB,MAAM,OAAO,MAAM,SAAS,MAAM,MAAM;CAExC,OAAO,MAAM,MAAM,SAAS,KAAK,SAAS,IAAI,CAAC;AACjD;;AAGA,eAAsB,YACpB,MACA,OACA,QACkB;CAClB,MAAM,OAAO,MAAM,SAAS,MAAM,MAAM;CAExC,OAAO,MAAM,OAAO,SAAS,KAAK,SAAS,IAAI,CAAC;AAClD;;;;;;;;;;;AAYA,MAAa,SAAS;CACpB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;;CAEOC;AACT;;;;ACrIA,SAAS,KAAK,UAAoB;CAChC,OAAO,SAAS,UAAU;EACxB,+BAAS,yBAAyB;EAClC;CACF,CAAC;AACH;;;;;;;;;;AAWA,SAAgB,KAAK,YAAgC;CACnD,OAAO,OAAO,SAAkB,aAAuB;EACrD,IAAI,CAAC,QAAQ,MAAM,OAAO,KAAK,QAAQ;EAEvC,IAAI,CAAE,MAAM,IAAI,QAAQ,MAAM,UAAU,GAAI,OAAO,KAAK,QAAQ;CAClE;AACF;;AAGA,SAAgB,QAAQ,aAAmC;CACzD,OAAO,OAAO,SAAkB,aAAuB;EACrD,IAAI,CAAC,QAAQ,MAAM,OAAO,KAAK,QAAQ;EAEvC,IAAI,CAAE,MAAM,OAAO,QAAQ,MAAM,WAAW,GAAI,OAAO,KAAK,QAAQ;CACtE;AACF;;AAGA,SAAgB,QAAQ,aAAmC;CACzD,OAAO,OAAO,SAAkB,aAAuB;EACrD,IAAI,CAAC,QAAQ,MAAM,OAAO,KAAK,QAAQ;EAEvC,IAAI,CAAE,MAAM,OAAO,QAAQ,MAAM,WAAW,GAAI,OAAO,KAAK,QAAQ;CACtE;AACF;;;;;ACvCA,SAAS,WAAW,OAA0B;CAC5C,IAAI,MAAM,QAAQ,KAAK,GAAG,OAAO;CAEjC,IAAI,OAAO,UAAU,YAAY,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK;CAEhE,OAAO,CAAC;AACV;;;;;;;;;;;;;AAcA,IAAa,wBAAb,MAA6D;CAC3D,AAAO,YACL,AAAiB,OACjB,AAAiB,aAAsC,SACrD,KAAK,IAAI,OAAO,KAAK,KAAK,IAAI,MAAM,GACtC;EAHiB;EACA;CAEhB;CAEH,MAAa,aAAa,MAA+B;EACvD,OAAO,WAAW,MAAM,KAAK,UAAU,IAAI,CAAC;CAC9C;CAEA,MAAa,mBAAmB,MAA+B;EAK7D,QAAO,MAJa,KAAK,aAAa,IAAI,EAI9B,CAAC,SAAS,SACpB,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO,IAAI,IACjD,KAAK,MAAM,QACX,CAAC,CACP;CACF;AACF"}

package/esm/contracts/access-resolver.d.mts

@@ -0,0 +1,40 @@
+import { Auth } from "@warlock.js/auth";
+
+//#region ../@warlock.js/access/src/contracts/access-resolver.d.ts
+/**
+ * The one adapter the engine depends on. Implement it to connect the engine to
+ * however YOUR app stores roles and permissions — a user column, a pivot table,
+ * a token claim, an external directory.
+ *
+ * The engine owns the hard parts (wildcard matching, caching, policies,
+ * fail-closed); the resolver only fetches. Keep it dumb — never cache inside it.
+ *
+ * @example
+ * export class AppAccessResolver implements AccessResolver {
+ *   public async resolveRoles(user: Auth, tenant?: string): Promise<string[]> {
+ *     const rows = await UserRole.query().where({ user_id: user.id, tenant: tenant ?? null }).get();
+ *     return rows.map((row) => row.get("role") as string);
+ *   }
+ *   public async resolvePermissions(user: Auth, tenant?: string): Promise<string[]> {
+ *     const names = await this.resolveRoles(user, tenant);
+ *     const roles = await Role.query().whereIn("name", names).get();
+ *     return roles.flatMap((role) => role.get("permissions") as string[]);
+ *   }
+ * }
+ */
+interface AccessResolver {
+  /** The role names this user holds (powers `hasRole` / `hasAnyRole`). */
+  resolveRoles(user: Auth, tenant?: string): Promise<string[]>;
+  /** The effective permission strings this user has (powers `can` / `authorize`). */
+  resolvePermissions(user: Auth, tenant?: string): Promise<string[]>;
+  /**
+   * Optional. The ambient tenant for this user when a check doesn't pass one
+   * explicitly — commonly derived from the user (e.g. `user.get("organization_id")`),
+   * which is safer than trusting client-supplied request input. Return `undefined`
+   * for single-tenant apps.
+   */
+  resolveTenant?(user: Auth): string | undefined;
+}
+//#endregion
+export { AccessResolver };
+//# sourceMappingURL=access-resolver.d.mts.map

package/esm/contracts/access-resolver.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-resolver.d.mts","names":[],"sources":["../../../../../../../@warlock.js/access/src/contracts/access-resolver.ts"],"mappings":";;;;;AAuBA;;;;;;;;;;;;;;;;;;;UAAiB,cAAA;EAaf;EAXA,YAAA,CAAa,IAAA,EAAM,IAAA,EAAM,MAAA,YAAkB,OAAA;EAW5B;EARf,kBAAA,CAAmB,IAAA,EAAM,IAAA,EAAM,MAAA,YAAkB,OAAA;EAQxB;;;;;;EAAzB,aAAA,EAAe,IAAA,EAAM,IAAA;AAAA"}

package/esm/contracts/index.d.mts

@@ -0,0 +1,2 @@
+import { AccessResolver } from "./access-resolver.mjs";
+import { AccessConfigurations, AccessContext, PolicyContext, PolicyFn, RolesMap } from "./types.mjs";

package/esm/contracts/types.d.mts

@@ -0,0 +1,38 @@
+import { AccessResolver } from "./access-resolver.mjs";
+import { Auth } from "@warlock.js/auth";
+
+//#region ../@warlock.js/access/src/contracts/types.d.ts
+/** A role name mapped to the permission strings it grants. */
+type RolesMap = Record<string, string[]>;
+/**
+ * Extra context for an authorization check. `resource` and `tenant` are
+ * **reserved** (the engine acts on them); every other key is forwarded to the
+ * policy verbatim.
+ */
+type AccessContext = {
+  /** The object being authorized. Its presence is what enables the ABAC policy. */resource?: unknown; /** Tenant scope. Defaults to the resolver's optional `resolveTenant()`. */
+  tenant?: string;
+  [key: string]: unknown;
+};
+/** The context a policy receives — the access context plus engine-injected helpers. */
+type PolicyContext = AccessContext & {
+  tenant?: string; /** Whether the user holds the given role (in the resolved tenant). */
+  hasRole: (role: string) => boolean; /** Whether the user's effective set covers the given permission. */
+  hasPermission: (permission: string) => boolean;
+};
+/** An ABAC policy: may the user act on this specific resource? */
+type PolicyFn = (user: Auth, resource: unknown, context: PolicyContext) => boolean | Promise<boolean>;
+type AccessConfigurations = {
+  /**
+   * REQUIRED. The adapter that reads a user's roles + permissions (and,
+   * optionally, the ambient tenant). The role→permission catalog lives INSIDE
+   * the resolver — there is no separate config map.
+   */
+  resolver: AccessResolver; /** Cache settings for resolved permission sets. */
+  cache?: {
+    /** TTL for a cached set. @default "10m" */ttl?: string | number;
+  };
+};
+//#endregion
+export { AccessConfigurations, AccessContext, PolicyContext, PolicyFn, RolesMap };
+//# sourceMappingURL=types.d.mts.map

package/esm/contracts/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../../../../../../@warlock.js/access/src/contracts/types.ts"],"mappings":";;;;;KAIY,QAAA,GAAW,MAAM;AAA7B;;;;AAA6B;AAA7B,KAOY,aAAA;EAAa,iFAEvB,QAAA,YAFuB;EAIvB,MAAA;EAAA,CACC,GAAA;AAAA;;KAIS,aAAA,GAAgB,aAAa;EACvC,MAAA,WADuB;EAGvB,OAAA,GAAU,IAAA,sBAH6B;EAKvC,aAAA,GAAgB,UAAA;AAAA;;KAIN,QAAA,IACV,IAAA,EAAM,IAAA,EACN,QAAA,WACA,OAAA,EAAS,aAAA,eACI,OAAA;AAAA,KAEH,oBAAA;EAVM;;AAAkB;AAIpC;;EAYE,QAAA,EAAU,cAAc,EAXlB;EAcN,KAAA;IAXa,2CAaX,GAAA;EAAA;AAAA"}

package/esm/index.d.mts

@@ -0,0 +1,11 @@
+import { AccessResolver } from "./contracts/access-resolver.mjs";
+import { AccessConfigurations, AccessContext, PolicyContext, PolicyFn, RolesMap } from "./contracts/types.mjs";
+import { gate, gateAll, gateAny } from "./middleware/gate.middleware.mjs";
+import { flush } from "./services/engine.mjs";
+import { access, authorize, authorizeAll, authorizeAny, can, canAll, canAny, cannot, hasAllRoles, hasAnyRole, hasRole } from "./services/access.mjs";
+import { DefaultAccessResolver } from "./services/default-resolver.mjs";
+import { clearPolicies, definePolicy } from "./services/policies.mjs";
+import { resetAccessConfig, setAccessConfig } from "./services/access-config.mjs";
+import { AccessConfigError } from "./utils/access-config-error.mjs";
+import { AccessErrorCodes } from "./utils/access-error-codes.mjs";
+export { AccessConfigError, AccessConfigurations, AccessContext, AccessErrorCodes, AccessResolver, DefaultAccessResolver, PolicyContext, PolicyFn, RolesMap, access, authorize, authorizeAll, authorizeAny, can, canAll, canAny, cannot, clearPolicies, definePolicy, flush, gate, gateAll, gateAny, hasAllRoles, hasAnyRole, hasRole, resetAccessConfig, setAccessConfig };

package/esm/index.mjs

@@ -0,0 +1,12 @@
+import { AccessErrorCodes } from "./utils/access-error-codes.mjs";
+import { AccessConfigError } from "./utils/access-config-error.mjs";
+import { resetAccessConfig, setAccessConfig } from "./services/access-config.mjs";
+import { clearPolicies, definePolicy } from "./services/policies.mjs";
+import { flush } from "./services/engine.mjs";
+import { access, authorize, authorizeAll, authorizeAny, can, canAll, canAny, cannot, hasAllRoles, hasAnyRole, hasRole } from "./services/access.mjs";
+import { gate, gateAll, gateAny } from "./middleware/gate.middleware.mjs";
+import "./middleware/index.mjs";
+import { DefaultAccessResolver } from "./services/default-resolver.mjs";
+import "./services/index.mjs";
+
+export { AccessConfigError, AccessErrorCodes, DefaultAccessResolver, access, authorize, authorizeAll, authorizeAny, can, canAll, canAny, cannot, clearPolicies, definePolicy, flush, gate, gateAll, gateAny, hasAllRoles, hasAnyRole, hasRole, resetAccessConfig, setAccessConfig };