@anievo-id/rbac-evolution-hono 0.3.1 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +12 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -1
- package/dist/index.d.ts +5 -1
- package/dist/index.js +11 -3
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.cjs
CHANGED
|
@@ -117,11 +117,21 @@ function createGuards(defaults = {}) {
|
|
|
117
117
|
async (rbac) => await rbac.hasAnyRole(all) || rbac.canAny(all)
|
|
118
118
|
);
|
|
119
119
|
}
|
|
120
|
-
|
|
120
|
+
function canAny2(...args) {
|
|
121
|
+
const { names, options } = parseArgs(args);
|
|
122
|
+
return requirePermission2(...names, { ...options, any: true });
|
|
123
|
+
}
|
|
124
|
+
function canAll2(...args) {
|
|
125
|
+
const { names, options } = parseArgs(args);
|
|
126
|
+
return requirePermission2(...names, { ...options, any: false });
|
|
127
|
+
}
|
|
128
|
+
return { requirePermission: requirePermission2, requireRole: requireRole2, requireRoleOrPermission: requireRoleOrPermission2, canAny: canAny2, canAll: canAll2 };
|
|
121
129
|
}
|
|
122
|
-
var { requirePermission, requireRole, requireRoleOrPermission } = createGuards();
|
|
130
|
+
var { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll } = createGuards();
|
|
123
131
|
|
|
124
132
|
exports.RbacMiddlewareMissingError = RbacMiddlewareMissingError;
|
|
133
|
+
exports.canAll = canAll;
|
|
134
|
+
exports.canAny = canAny;
|
|
125
135
|
exports.createGuards = createGuards;
|
|
126
136
|
exports.rbacMiddleware = rbacMiddleware;
|
|
127
137
|
exports.requirePermission = requirePermission;
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/middleware.ts","../src/guards.ts"],"names":["requirePermission","requireRole","requireRoleOrPermission"],"mappings":";;;AAwCO,SAAS,eAAoC,OAAA,EAAmE;AACrH,EAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,MAAK,GAAI,OAAA;AAE1C,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,GAAA,GAAM,CAAA;AACZ,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,GAAG,CAAA;AACpC,IAAA,IAAI,KAAA,GAA4B,IAAA;AAChC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,GAAG,CAAA,GAAI,MAAA;AACxC,MAAA,KAAA,GAAQ,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACxB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACC,IAAC,CAAA,CAAkC,GAAA,CAAI,MAAA,EAAQ,KAAK,CAAA;AACrD,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF;;;ACdO,IAAM,0BAAA,GAAN,cAAyC,KAAA,CAAM;AAAA,EAC3C,IAAA,GAAO,yBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,gFAAgF,CAAA;AACtF,IAAA,IAAA,CAAK,IAAA,GAAO,4BAAA;AAAA,EACd;AACF;AAEA,IAAM,QAAA,GAAsC;AAAA,EAC1C,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEA,IAAM,sBAAA,GAAuC,CAAC,CAAA,KAC5C,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,wBAAA,EAAyB,EAAG,GAAG,CAAA;AAE7E,IAAM,mBACJ,CAAC,MAAA,KACD,CAAC,CAAA,EAAG,YACF,CAAA,CAAE,IAAA;AAAA,EACA;AAAA,IACE,KAAA,EAAO,WAAA;AAAA,IACP,QAAQ,OAAA,CAAQ,IAAA;AAAA,IAChB,OAAA,EAAS,QAAA,CAAS,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC9B,GAAI,MAAA,IAAU,EAAE,QAAA,EAAU,QAAQ,YAAA;AAAa,GACjD;AAAA,EACA;AACF,CAAA;AAEJ,IAAM,QAAQ,CAAC,IAAA,KACb,KACG,KAAA,CAAM,GAAG,EACT,GAAA,CAAI,CAAC,CAAA,KAAM,CAAA,CAAE,MAAM,CAAA,CACnB,OAAO,CAAC,CAAA,KAAM,MAAM,EAAE,CAAA;AAG3B,SAAS,SAAS,KAAA,EAA0C;AAC1D,EAAA,MAAM,SAAqB,EAAC;AAC5B,EAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,IAAA,KAAA,MAAW,QAAQ,OAAO,IAAA,KAAS,WAAW,CAAC,IAAI,IAAI,IAAA,EAAM;AAC3D,MAAA,MAAM,KAAA,GAAQ,MAAM,IAAI,CAAA;AACxB,MAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,EAAG,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,IACzC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,UAA4B,IAAA,EAAoF;AACvH,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACjC,EAAA,IAAI,IAAA,KAAS,UAAa,OAAO,IAAA,KAAS,YAAY,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC1E,IAAA,OAAO,EAAE,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,EAAE,CAAA,EAAmB,SAAS,IAAA,EAAU;AAAA,EACxE;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAsB,OAAA,EAAS,MAAA,EAAU;AAC3D;AAEA,SAAS,WAAA,CACP,IAAA,EACA,YAAA,EACA,QAAA,EACA,KAAA,EAC4B;AAC5B,EAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,IAAI,CAAA,+BAAA,CAAiC,CAAA;AAAA,EACjF;AACA,EAAA,MAAM,iBAAA,GAAoB,SAAS,iBAAA,IAAqB,sBAAA;AACxD,EAAA,MAAM,cAAc,QAAA,CAAS,WAAA,IAAe,gBAAA,CAAiB,QAAA,CAAS,sBAAsB,KAAK,CAAA;AACjG,EAAA,MAAM,OAAA,GAAwB,EAAE,IAAA,EAAM,YAAA,EAAa;AAEnD,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,IAAA,GAAO,CAAA,CAAE,GAAA,CAAI,MAAM,CAAA;AACzB,IAAA,IAAI,IAAA,KAAS,MAAA,EAAW,MAAM,IAAI,0BAAA,EAA2B;AAC7D,IAAA,IAAI,IAAA,KAAS,IAAA,EAAM,OAAO,iBAAA,CAAkB,GAAG,OAAO,CAAA;AACtD,IAAA,IAAI,MAAM,KAAA,CAAM,IAAI,CAAA,EAAG;AACrB,MAAA,MAAM,IAAA,EAAK;AACX,MAAA;AAAA,IACF;AACA,IAAA,OAAO,WAAA,CAAY,GAAG,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAEA,eAAe,KAAA,CAAM,QAA6B,IAAA,EAA+D;AAC/G,EAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,KAAK,GAAI,OAAO,KAAA;AAAA,EACnC;AACA,EAAA,OAAO,IAAA;AACT;AAGO,SAAS,YAAA,CAAa,QAAA,GAA0B,EAAC,EAAG;AASzD,EAAA,SAASA,sBAAqB,IAAA,EAA2E;AACvG,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,IAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,IAAA,MAAM,eAAe,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,MAAA;AACrD,IAAA,OAAO,WAAA;AAAA,MAAY,YAAA;AAAA,MAAc,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,CAAC,SAC3E,KAAA,CAAM,YAAA,EAAc,CAAC,KAAA,KAAU,IAAA,CAAK,MAAA,CAAO,KAAK,CAAC;AAAA,KACnD;AAAA,EACF;AAQA,EAAA,SAASC,gBAAe,IAAA,EAAqE;AAC3F,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAA4B,IAAI,CAAA;AAChE,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,GAAA,GAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,CAAA,GAAI,CAAC,GAAG,CAAA;AAC7D,IAAA,OAAO,WAAA;AAAA,MAAY,MAAA;AAAA,MAAQ,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,IAAA,KAC3E,OAAA,CAAQ,GAAA,GAAM,IAAA,CAAK,YAAY,GAAG,CAAA,GAAI,IAAA,CAAK,UAAA,CAAW,GAAG;AAAA,KAC3D;AAAA,EACF;AAQA,EAAA,SAASC,4BAA2B,IAAA,EAAiF;AACnH,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,OAAO,WAAA;AAAA,MAAY,oBAAA;AAAA,MAAsB,CAAC,GAAG,CAAA;AAAA,MAAG,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,SACjF,MAAM,IAAA,CAAK,WAAW,GAAG,CAAA,IAAM,IAAA,CAAK,MAAA,CAAO,GAAG;AAAA,KACjD;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,iBAAA,EAAAF,kBAAAA,EAAmB,WAAA,EAAAC,YAAAA,EAAa,yBAAAC,wBAAAA,EAAwB;AACnE;AAEO,IAAM,EAAE,iBAAA,EAAmB,WAAA,EAAa,uBAAA,KAA4B,YAAA","file":"index.cjs","sourcesContent":["import type { Rbac, Subject, SubjectRbac, TeamId } from '@anievo-id/rbac-evolution'\nimport type { Context, Env, MiddlewareHandler } from 'hono'\n\ntype MaybePromise<T> = T | Promise<T>\n\n/** Context variables set by `rbacMiddleware()`. */\nexport type RbacVariables = {\n /** Roles & permissions of the current subject. `null` for guests. */\n rbac: SubjectRbac | null\n}\n\n/**\n * Hono env for apps using `rbacMiddleware()`: `new Hono<RbacEnv>()` types `c.var.rbac`.\n * Combine it with your own variables: `new Hono<{ Variables: RbacVariables & { user: User } }>()`.\n */\nexport type RbacEnv = {\n Variables: RbacVariables\n}\n\nexport interface RbacMiddlewareOptions<E extends Env = Env> {\n /** The RBAC engine created with `createRbac(...)`. */\n rbac: Rbac\n /**\n * Resolves the authenticated subject for this request (e.g. from `c.var.user` or a JWT payload).\n * Return `null` / `undefined` for guests.\n */\n getSubject: (c: Context<E>) => MaybePromise<Subject | null | undefined>\n /** Guard name (e.g. `web` or `api`). Defaults to the engine's `defaultGuard`. */\n guard?: string\n /** Resolves the current team (only when the engine was created with `teams: true`). */\n team?: (c: Context<E>) => MaybePromise<TeamId | undefined>\n}\n\n/**\n * Resolves the current subject and sets `c.var.rbac` (a `SubjectRbac`, or `null` for guests).\n *\n * ```ts\n * app.use(rbacMiddleware({ rbac, getSubject: (c) => (c.var.user ? { type: 'user', id: c.var.user.id } : null) }))\n * ```\n */\nexport function rbacMiddleware<E extends Env = Env>(options: RbacMiddlewareOptions<E>): MiddlewareHandler<E & RbacEnv> {\n const { rbac, getSubject, guard, team } = options\n\n return async (c, next) => {\n const ctx = c as unknown as Context<E>\n const subject = await getSubject(ctx)\n let value: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(ctx) : undefined\n value = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n ;(c as unknown as Context<RbacEnv>).set('rbac', value)\n await next()\n }\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { Context, MiddlewareHandler } from 'hono'\nimport type { RbacEnv } from './middleware'\n\nexport type GuardKind = 'permission' | 'role' | 'role_or_permission'\n\n/** Details about a failed check, passed to `onUnauthenticated` / `onForbidden`. */\nexport interface GuardContext {\n kind: GuardKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\n/** Returns the response to send (or throws, e.g. an `HTTPException`). */\nexport type GuardHandler = (c: Context, context: GuardContext) => Response | Promise<Response>\n\nexport interface GuardHandlers {\n /** Called when there is no subject (`c.var.rbac` is `null`). Default: 401 JSON. */\n onUnauthenticated?: GuardHandler\n /** Called when the subject lacks access. Default: 403 JSON. */\n onForbidden?: GuardHandler\n /**\n * Include the required roles/permissions in the default 403 body.\n * Default: `false` (like spatie's `display_permission_in_exception`).\n */\n exposeRequirements?: boolean\n}\n\nexport interface PermissionGuardOptions extends GuardHandlers {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleGuardOptions extends GuardHandlers {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport type RoleOrPermissionGuardOptions = GuardHandlers\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type GuardNames = string | readonly string[]\n\nexport class RbacMiddlewareMissingError extends Error {\n readonly code = 'RBAC_MIDDLEWARE_MISSING'\n\n constructor() {\n super('`c.var.rbac` is not set. Register `rbacMiddleware()` before using RBAC guards.')\n this.name = 'RbacMiddlewareMissingError'\n }\n}\n\nconst MESSAGES: Record<GuardKind, string> = {\n permission: 'User does not have the right permissions.',\n role: 'User does not have the right roles.',\n role_or_permission: 'User does not have any of the necessary access rights.',\n}\n\nconst defaultUnauthenticated: GuardHandler = (c) =>\n c.json({ error: 'UNAUTHENTICATED', message: 'User is not logged in.' }, 401)\n\nconst defaultForbidden =\n (expose: boolean): GuardHandler =>\n (c, context) =>\n c.json(\n {\n error: 'FORBIDDEN',\n reason: context.kind,\n message: MESSAGES[context.kind],\n ...(expose && { required: context.requirements }),\n },\n 403,\n )\n\nconst split = (name: string): string[] =>\n name\n .split('|')\n .map((n) => n.trim())\n .filter((n) => n !== '')\n\n/** Each argument is a group (pipes = any within the group); arrays contribute one group per item. */\nfunction toGroups(names: readonly GuardNames[]): string[][] {\n const groups: string[][] = []\n for (const name of names) {\n for (const item of typeof name === 'string' ? [name] : name) {\n const group = split(item)\n if (group.length > 0) groups.push(group)\n }\n }\n return groups\n}\n\nfunction parseArgs<O extends object>(args: readonly (GuardNames | O)[]): { names: GuardNames[]; options: O | undefined } {\n const last = args[args.length - 1]\n if (last !== undefined && typeof last === 'object' && !Array.isArray(last)) {\n return { names: args.slice(0, -1) as GuardNames[], options: last as O }\n }\n return { names: args as GuardNames[], options: undefined }\n}\n\nfunction createGuard(\n kind: GuardKind,\n requirements: string[][],\n handlers: GuardHandlers,\n check: (rbac: SubjectRbac) => Promise<boolean>,\n): MiddlewareHandler<RbacEnv> {\n if (requirements.length === 0) {\n throw new TypeError(`[rbac-evolution] A ${kind} guard needs at least one name.`)\n }\n const onUnauthenticated = handlers.onUnauthenticated ?? defaultUnauthenticated\n const onForbidden = handlers.onForbidden ?? defaultForbidden(handlers.exposeRequirements ?? false)\n const context: GuardContext = { kind, requirements }\n\n return async (c, next) => {\n const rbac = c.get('rbac') as SubjectRbac | null | undefined\n if (rbac === undefined) throw new RbacMiddlewareMissingError()\n if (rbac === null) return onUnauthenticated(c, context)\n if (await check(rbac)) {\n await next()\n return\n }\n return onForbidden(c, context)\n }\n}\n\nasync function every(groups: readonly string[][], test: (group: string[]) => Promise<boolean>): Promise<boolean> {\n for (const group of groups) {\n if (!(await test(group))) return false\n }\n return true\n}\n\n/** Builds the guards with shared defaults (e.g. a custom `onForbidden` that renders an HTML page). */\nexport function createGuards(defaults: GuardHandlers = {}) {\n /**\n * Requires permissions, like spatie's `permission:` middleware.\n *\n * - `requirePermission('edit articles')`\n * - `requirePermission('edit articles|delete articles')` — any of them\n * - `requirePermission('edit articles', 'publish articles')` — all of them\n * - `requirePermission('a', 'b', { any: true })` — any of them\n */\n function requirePermission(...args: (GuardNames | PermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<PermissionGuardOptions>(args)\n const groups = toGroups(names)\n const requirements = options.any ? [groups.flat()] : groups\n return createGuard('permission', requirements, { ...defaults, ...options }, (rbac) =>\n every(requirements, (group) => rbac.canAny(group)),\n )\n }\n\n /**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `requireRole('admin')`, `requireRole('admin|editor')`, `requireRole('admin', 'editor')` — any of them\n * - `requireRole('admin', 'editor', { all: true })` — all of them\n */\n function requireRole(...args: (GuardNames | RoleGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleGuardOptions>(args)\n const all = toGroups(names).flat()\n const requirements = options.all ? all.map((r) => [r]) : [all]\n return createGuard('role', requirements, { ...defaults, ...options }, async (rbac) =>\n options.all ? rbac.hasAllRoles(all) : rbac.hasAnyRole(all),\n )\n }\n\n /**\n * Passes when the subject has ANY of the names as a role OR as a permission,\n * like spatie's `role_or_permission:` middleware.\n *\n * - `requireRoleOrPermission('admin|edit articles')`\n */\n function requireRoleOrPermission(...args: (GuardNames | RoleOrPermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleOrPermissionGuardOptions>(args)\n const all = toGroups(names).flat()\n return createGuard('role_or_permission', [all], { ...defaults, ...options }, async (rbac) =>\n (await rbac.hasAnyRole(all)) || rbac.canAny(all),\n )\n }\n\n return { requirePermission, requireRole, requireRoleOrPermission }\n}\n\nexport const { requirePermission, requireRole, requireRoleOrPermission } = createGuards()\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/middleware.ts","../src/guards.ts"],"names":["requirePermission","requireRole","requireRoleOrPermission","canAny","canAll"],"mappings":";;;AAwCO,SAAS,eAAoC,OAAA,EAAmE;AACrH,EAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,MAAK,GAAI,OAAA;AAE1C,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,GAAA,GAAM,CAAA;AACZ,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,GAAG,CAAA;AACpC,IAAA,IAAI,KAAA,GAA4B,IAAA;AAChC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,GAAG,CAAA,GAAI,MAAA;AACxC,MAAA,KAAA,GAAQ,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACxB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACC,IAAC,CAAA,CAAkC,GAAA,CAAI,MAAA,EAAQ,KAAK,CAAA;AACrD,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF;;;ACdO,IAAM,0BAAA,GAAN,cAAyC,KAAA,CAAM;AAAA,EAC3C,IAAA,GAAO,yBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,gFAAgF,CAAA;AACtF,IAAA,IAAA,CAAK,IAAA,GAAO,4BAAA;AAAA,EACd;AACF;AAEA,IAAM,QAAA,GAAsC;AAAA,EAC1C,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEA,IAAM,sBAAA,GAAuC,CAAC,CAAA,KAC5C,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,wBAAA,EAAyB,EAAG,GAAG,CAAA;AAE7E,IAAM,mBACJ,CAAC,MAAA,KACD,CAAC,CAAA,EAAG,YACF,CAAA,CAAE,IAAA;AAAA,EACA;AAAA,IACE,KAAA,EAAO,WAAA;AAAA,IACP,QAAQ,OAAA,CAAQ,IAAA;AAAA,IAChB,OAAA,EAAS,QAAA,CAAS,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC9B,GAAI,MAAA,IAAU,EAAE,QAAA,EAAU,QAAQ,YAAA;AAAa,GACjD;AAAA,EACA;AACF,CAAA;AAEJ,IAAM,QAAQ,CAAC,IAAA,KACb,KACG,KAAA,CAAM,GAAG,EACT,GAAA,CAAI,CAAC,CAAA,KAAM,CAAA,CAAE,MAAM,CAAA,CACnB,OAAO,CAAC,CAAA,KAAM,MAAM,EAAE,CAAA;AAG3B,SAAS,SAAS,KAAA,EAA0C;AAC1D,EAAA,MAAM,SAAqB,EAAC;AAC5B,EAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,IAAA,KAAA,MAAW,QAAQ,OAAO,IAAA,KAAS,WAAW,CAAC,IAAI,IAAI,IAAA,EAAM;AAC3D,MAAA,MAAM,KAAA,GAAQ,MAAM,IAAI,CAAA;AACxB,MAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,EAAG,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,IACzC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,UAA4B,IAAA,EAAoF;AACvH,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACjC,EAAA,IAAI,IAAA,KAAS,UAAa,OAAO,IAAA,KAAS,YAAY,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC1E,IAAA,OAAO,EAAE,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,EAAE,CAAA,EAAmB,SAAS,IAAA,EAAU;AAAA,EACxE;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAsB,OAAA,EAAS,MAAA,EAAU;AAC3D;AAEA,SAAS,WAAA,CACP,IAAA,EACA,YAAA,EACA,QAAA,EACA,KAAA,EAC4B;AAC5B,EAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,IAAI,CAAA,+BAAA,CAAiC,CAAA;AAAA,EACjF;AACA,EAAA,MAAM,iBAAA,GAAoB,SAAS,iBAAA,IAAqB,sBAAA;AACxD,EAAA,MAAM,cAAc,QAAA,CAAS,WAAA,IAAe,gBAAA,CAAiB,QAAA,CAAS,sBAAsB,KAAK,CAAA;AACjG,EAAA,MAAM,OAAA,GAAwB,EAAE,IAAA,EAAM,YAAA,EAAa;AAEnD,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,IAAA,GAAO,CAAA,CAAE,GAAA,CAAI,MAAM,CAAA;AACzB,IAAA,IAAI,IAAA,KAAS,MAAA,EAAW,MAAM,IAAI,0BAAA,EAA2B;AAC7D,IAAA,IAAI,IAAA,KAAS,IAAA,EAAM,OAAO,iBAAA,CAAkB,GAAG,OAAO,CAAA;AACtD,IAAA,IAAI,MAAM,KAAA,CAAM,IAAI,CAAA,EAAG;AACrB,MAAA,MAAM,IAAA,EAAK;AACX,MAAA;AAAA,IACF;AACA,IAAA,OAAO,WAAA,CAAY,GAAG,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAEA,eAAe,KAAA,CAAM,QAA6B,IAAA,EAA+D;AAC/G,EAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,KAAK,GAAI,OAAO,KAAA;AAAA,EACnC;AACA,EAAA,OAAO,IAAA;AACT;AAGO,SAAS,YAAA,CAAa,QAAA,GAA0B,EAAC,EAAG;AASzD,EAAA,SAASA,sBAAqB,IAAA,EAA2E;AACvG,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,IAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,IAAA,MAAM,eAAe,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,MAAA;AACrD,IAAA,OAAO,WAAA;AAAA,MAAY,YAAA;AAAA,MAAc,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,CAAC,SAC3E,KAAA,CAAM,YAAA,EAAc,CAAC,KAAA,KAAU,IAAA,CAAK,MAAA,CAAO,KAAK,CAAC;AAAA,KACnD;AAAA,EACF;AAQA,EAAA,SAASC,gBAAe,IAAA,EAAqE;AAC3F,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAA4B,IAAI,CAAA;AAChE,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,GAAA,GAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,CAAA,GAAI,CAAC,GAAG,CAAA;AAC7D,IAAA,OAAO,WAAA;AAAA,MAAY,MAAA;AAAA,MAAQ,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,IAAA,KAC3E,OAAA,CAAQ,GAAA,GAAM,IAAA,CAAK,YAAY,GAAG,CAAA,GAAI,IAAA,CAAK,UAAA,CAAW,GAAG;AAAA,KAC3D;AAAA,EACF;AAQA,EAAA,SAASC,4BAA2B,IAAA,EAAiF;AACnH,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,OAAO,WAAA;AAAA,MAAY,oBAAA;AAAA,MAAsB,CAAC,GAAG,CAAA;AAAA,MAAG,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,SACjF,MAAM,IAAA,CAAK,WAAW,GAAG,CAAA,IAAM,IAAA,CAAK,MAAA,CAAO,GAAG;AAAA,KACjD;AAAA,EACF;AAOA,EAAA,SAASC,WAAU,IAAA,EAAkE;AACnF,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,UAAyB,IAAI,CAAA;AACxD,IAAA,OAAOH,kBAAAA,CAAkB,GAAG,KAAA,EAAO,EAAE,GAAG,OAAA,EAAS,GAAA,EAAK,MAAM,CAAA;AAAA,EAC9D;AAOA,EAAA,SAASI,WAAU,IAAA,EAAkE;AACnF,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,UAAyB,IAAI,CAAA;AACxD,IAAA,OAAOJ,kBAAAA,CAAkB,GAAG,KAAA,EAAO,EAAE,GAAG,OAAA,EAAS,GAAA,EAAK,OAAO,CAAA;AAAA,EAC/D;AAEA,EAAA,OAAO,EAAE,iBAAA,EAAAA,kBAAAA,EAAmB,WAAA,EAAAC,YAAAA,EAAa,yBAAAC,wBAAAA,EAAyB,MAAA,EAAAC,OAAAA,EAAQ,MAAA,EAAAC,OAAAA,EAAO;AACnF;AAEO,IAAM,EAAE,iBAAA,EAAmB,WAAA,EAAa,yBAAyB,MAAA,EAAQ,MAAA,KAAW,YAAA","file":"index.cjs","sourcesContent":["import type { Rbac, Subject, SubjectRbac, TeamId } from '@anievo-id/rbac-evolution'\nimport type { Context, Env, MiddlewareHandler } from 'hono'\n\ntype MaybePromise<T> = T | Promise<T>\n\n/** Context variables set by `rbacMiddleware()`. */\nexport type RbacVariables = {\n /** Roles & permissions of the current subject. `null` for guests. */\n rbac: SubjectRbac | null\n}\n\n/**\n * Hono env for apps using `rbacMiddleware()`: `new Hono<RbacEnv>()` types `c.var.rbac`.\n * Combine it with your own variables: `new Hono<{ Variables: RbacVariables & { user: User } }>()`.\n */\nexport type RbacEnv = {\n Variables: RbacVariables\n}\n\nexport interface RbacMiddlewareOptions<E extends Env = Env> {\n /** The RBAC engine created with `createRbac(...)`. */\n rbac: Rbac\n /**\n * Resolves the authenticated subject for this request (e.g. from `c.var.user` or a JWT payload).\n * Return `null` / `undefined` for guests.\n */\n getSubject: (c: Context<E>) => MaybePromise<Subject | null | undefined>\n /** Guard name (e.g. `web` or `api`). Defaults to the engine's `defaultGuard`. */\n guard?: string\n /** Resolves the current team (only when the engine was created with `teams: true`). */\n team?: (c: Context<E>) => MaybePromise<TeamId | undefined>\n}\n\n/**\n * Resolves the current subject and sets `c.var.rbac` (a `SubjectRbac`, or `null` for guests).\n *\n * ```ts\n * app.use(rbacMiddleware({ rbac, getSubject: (c) => (c.var.user ? { type: 'user', id: c.var.user.id } : null) }))\n * ```\n */\nexport function rbacMiddleware<E extends Env = Env>(options: RbacMiddlewareOptions<E>): MiddlewareHandler<E & RbacEnv> {\n const { rbac, getSubject, guard, team } = options\n\n return async (c, next) => {\n const ctx = c as unknown as Context<E>\n const subject = await getSubject(ctx)\n let value: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(ctx) : undefined\n value = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n ;(c as unknown as Context<RbacEnv>).set('rbac', value)\n await next()\n }\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { Context, MiddlewareHandler } from 'hono'\nimport type { RbacEnv } from './middleware'\n\nexport type GuardKind = 'permission' | 'role' | 'role_or_permission'\n\n/** Details about a failed check, passed to `onUnauthenticated` / `onForbidden`. */\nexport interface GuardContext {\n kind: GuardKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\n/** Returns the response to send (or throws, e.g. an `HTTPException`). */\nexport type GuardHandler = (c: Context, context: GuardContext) => Response | Promise<Response>\n\nexport interface GuardHandlers {\n /** Called when there is no subject (`c.var.rbac` is `null`). Default: 401 JSON. */\n onUnauthenticated?: GuardHandler\n /** Called when the subject lacks access. Default: 403 JSON. */\n onForbidden?: GuardHandler\n /**\n * Include the required roles/permissions in the default 403 body.\n * Default: `false` (like spatie's `display_permission_in_exception`).\n */\n exposeRequirements?: boolean\n}\n\nexport interface PermissionGuardOptions extends GuardHandlers {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleGuardOptions extends GuardHandlers {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport type RoleOrPermissionGuardOptions = GuardHandlers\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type GuardNames = string | readonly string[]\n\nexport class RbacMiddlewareMissingError extends Error {\n readonly code = 'RBAC_MIDDLEWARE_MISSING'\n\n constructor() {\n super('`c.var.rbac` is not set. Register `rbacMiddleware()` before using RBAC guards.')\n this.name = 'RbacMiddlewareMissingError'\n }\n}\n\nconst MESSAGES: Record<GuardKind, string> = {\n permission: 'User does not have the right permissions.',\n role: 'User does not have the right roles.',\n role_or_permission: 'User does not have any of the necessary access rights.',\n}\n\nconst defaultUnauthenticated: GuardHandler = (c) =>\n c.json({ error: 'UNAUTHENTICATED', message: 'User is not logged in.' }, 401)\n\nconst defaultForbidden =\n (expose: boolean): GuardHandler =>\n (c, context) =>\n c.json(\n {\n error: 'FORBIDDEN',\n reason: context.kind,\n message: MESSAGES[context.kind],\n ...(expose && { required: context.requirements }),\n },\n 403,\n )\n\nconst split = (name: string): string[] =>\n name\n .split('|')\n .map((n) => n.trim())\n .filter((n) => n !== '')\n\n/** Each argument is a group (pipes = any within the group); arrays contribute one group per item. */\nfunction toGroups(names: readonly GuardNames[]): string[][] {\n const groups: string[][] = []\n for (const name of names) {\n for (const item of typeof name === 'string' ? [name] : name) {\n const group = split(item)\n if (group.length > 0) groups.push(group)\n }\n }\n return groups\n}\n\nfunction parseArgs<O extends object>(args: readonly (GuardNames | O)[]): { names: GuardNames[]; options: O | undefined } {\n const last = args[args.length - 1]\n if (last !== undefined && typeof last === 'object' && !Array.isArray(last)) {\n return { names: args.slice(0, -1) as GuardNames[], options: last as O }\n }\n return { names: args as GuardNames[], options: undefined }\n}\n\nfunction createGuard(\n kind: GuardKind,\n requirements: string[][],\n handlers: GuardHandlers,\n check: (rbac: SubjectRbac) => Promise<boolean>,\n): MiddlewareHandler<RbacEnv> {\n if (requirements.length === 0) {\n throw new TypeError(`[rbac-evolution] A ${kind} guard needs at least one name.`)\n }\n const onUnauthenticated = handlers.onUnauthenticated ?? defaultUnauthenticated\n const onForbidden = handlers.onForbidden ?? defaultForbidden(handlers.exposeRequirements ?? false)\n const context: GuardContext = { kind, requirements }\n\n return async (c, next) => {\n const rbac = c.get('rbac') as SubjectRbac | null | undefined\n if (rbac === undefined) throw new RbacMiddlewareMissingError()\n if (rbac === null) return onUnauthenticated(c, context)\n if (await check(rbac)) {\n await next()\n return\n }\n return onForbidden(c, context)\n }\n}\n\nasync function every(groups: readonly string[][], test: (group: string[]) => Promise<boolean>): Promise<boolean> {\n for (const group of groups) {\n if (!(await test(group))) return false\n }\n return true\n}\n\n/** Builds the guards with shared defaults (e.g. a custom `onForbidden` that renders an HTML page). */\nexport function createGuards(defaults: GuardHandlers = {}) {\n /**\n * Requires permissions, like spatie's `permission:` middleware.\n *\n * - `requirePermission('edit articles')`\n * - `requirePermission('edit articles|delete articles')` — any of them\n * - `requirePermission('edit articles', 'publish articles')` — all of them\n * - `requirePermission('a', 'b', { any: true })` — any of them\n */\n function requirePermission(...args: (GuardNames | PermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<PermissionGuardOptions>(args)\n const groups = toGroups(names)\n const requirements = options.any ? [groups.flat()] : groups\n return createGuard('permission', requirements, { ...defaults, ...options }, (rbac) =>\n every(requirements, (group) => rbac.canAny(group)),\n )\n }\n\n /**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `requireRole('admin')`, `requireRole('admin|editor')`, `requireRole('admin', 'editor')` — any of them\n * - `requireRole('admin', 'editor', { all: true })` — all of them\n */\n function requireRole(...args: (GuardNames | RoleGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleGuardOptions>(args)\n const all = toGroups(names).flat()\n const requirements = options.all ? all.map((r) => [r]) : [all]\n return createGuard('role', requirements, { ...defaults, ...options }, async (rbac) =>\n options.all ? rbac.hasAllRoles(all) : rbac.hasAnyRole(all),\n )\n }\n\n /**\n * Passes when the subject has ANY of the names as a role OR as a permission,\n * like spatie's `role_or_permission:` middleware.\n *\n * - `requireRoleOrPermission('admin|edit articles')`\n */\n function requireRoleOrPermission(...args: (GuardNames | RoleOrPermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleOrPermissionGuardOptions>(args)\n const all = toGroups(names).flat()\n return createGuard('role_or_permission', [all], { ...defaults, ...options }, async (rbac) =>\n (await rbac.hasAnyRole(all)) || rbac.canAny(all),\n )\n }\n\n /**\n * spatie v8.5 `canAny()`: passes with ANY of the listed permissions.\n *\n * - `canAny('edit articles', 'publish articles')`, `canAny(['edit articles', 'publish articles'])`\n */\n function canAny(...args: (GuardNames | GuardHandlers)[]): MiddlewareHandler<RbacEnv> {\n const { names, options } = parseArgs<GuardHandlers>(args)\n return requirePermission(...names, { ...options, any: true })\n }\n\n /**\n * spatie v8.5 `canAll()`: requires EVERY listed entry. A `'a|b'` entry still means \"a or b\".\n *\n * - `canAll('edit articles', 'publish articles')`, `canAll(['edit articles', 'publish|review'])`\n */\n function canAll(...args: (GuardNames | GuardHandlers)[]): MiddlewareHandler<RbacEnv> {\n const { names, options } = parseArgs<GuardHandlers>(args)\n return requirePermission(...names, { ...options, any: false })\n }\n\n return { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll }\n}\n\nexport const { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll } = createGuards()\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -76,9 +76,13 @@ declare function createGuards(defaults?: GuardHandlers): {
|
|
|
76
76
|
requirePermission: (...args: (GuardNames | PermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
77
77
|
requireRole: (...args: (GuardNames | RoleGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
78
78
|
requireRoleOrPermission: (...args: (GuardNames | RoleOrPermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
79
|
+
canAny: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
80
|
+
canAll: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
79
81
|
};
|
|
80
82
|
declare const requirePermission: (...args: (GuardNames | PermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
81
83
|
declare const requireRole: (...args: (GuardNames | RoleGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
82
84
|
declare const requireRoleOrPermission: (...args: (GuardNames | RoleOrPermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
85
|
+
declare const canAny: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
86
|
+
declare const canAll: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
83
87
|
|
|
84
|
-
export { type GuardContext, type GuardHandler, type GuardHandlers, type GuardKind, type GuardNames, type PermissionGuardOptions, type RbacEnv, RbacMiddlewareMissingError, type RbacMiddlewareOptions, type RbacVariables, type RoleGuardOptions, type RoleOrPermissionGuardOptions, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
|
88
|
+
export { type GuardContext, type GuardHandler, type GuardHandlers, type GuardKind, type GuardNames, type PermissionGuardOptions, type RbacEnv, RbacMiddlewareMissingError, type RbacMiddlewareOptions, type RbacVariables, type RoleGuardOptions, type RoleOrPermissionGuardOptions, canAll, canAny, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
package/dist/index.d.ts
CHANGED
|
@@ -76,9 +76,13 @@ declare function createGuards(defaults?: GuardHandlers): {
|
|
|
76
76
|
requirePermission: (...args: (GuardNames | PermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
77
77
|
requireRole: (...args: (GuardNames | RoleGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
78
78
|
requireRoleOrPermission: (...args: (GuardNames | RoleOrPermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
79
|
+
canAny: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
80
|
+
canAll: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
79
81
|
};
|
|
80
82
|
declare const requirePermission: (...args: (GuardNames | PermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
81
83
|
declare const requireRole: (...args: (GuardNames | RoleGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
82
84
|
declare const requireRoleOrPermission: (...args: (GuardNames | RoleOrPermissionGuardOptions)[]) => MiddlewareHandler<RbacEnv>;
|
|
85
|
+
declare const canAny: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
86
|
+
declare const canAll: (...args: (GuardNames | GuardHandlers)[]) => MiddlewareHandler<RbacEnv>;
|
|
83
87
|
|
|
84
|
-
export { type GuardContext, type GuardHandler, type GuardHandlers, type GuardKind, type GuardNames, type PermissionGuardOptions, type RbacEnv, RbacMiddlewareMissingError, type RbacMiddlewareOptions, type RbacVariables, type RoleGuardOptions, type RoleOrPermissionGuardOptions, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
|
88
|
+
export { type GuardContext, type GuardHandler, type GuardHandlers, type GuardKind, type GuardNames, type PermissionGuardOptions, type RbacEnv, RbacMiddlewareMissingError, type RbacMiddlewareOptions, type RbacVariables, type RoleGuardOptions, type RoleOrPermissionGuardOptions, canAll, canAny, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
package/dist/index.js
CHANGED
|
@@ -115,10 +115,18 @@ function createGuards(defaults = {}) {
|
|
|
115
115
|
async (rbac) => await rbac.hasAnyRole(all) || rbac.canAny(all)
|
|
116
116
|
);
|
|
117
117
|
}
|
|
118
|
-
|
|
118
|
+
function canAny2(...args) {
|
|
119
|
+
const { names, options } = parseArgs(args);
|
|
120
|
+
return requirePermission2(...names, { ...options, any: true });
|
|
121
|
+
}
|
|
122
|
+
function canAll2(...args) {
|
|
123
|
+
const { names, options } = parseArgs(args);
|
|
124
|
+
return requirePermission2(...names, { ...options, any: false });
|
|
125
|
+
}
|
|
126
|
+
return { requirePermission: requirePermission2, requireRole: requireRole2, requireRoleOrPermission: requireRoleOrPermission2, canAny: canAny2, canAll: canAll2 };
|
|
119
127
|
}
|
|
120
|
-
var { requirePermission, requireRole, requireRoleOrPermission } = createGuards();
|
|
128
|
+
var { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll } = createGuards();
|
|
121
129
|
|
|
122
|
-
export { RbacMiddlewareMissingError, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
|
130
|
+
export { RbacMiddlewareMissingError, canAll, canAny, createGuards, rbacMiddleware, requirePermission, requireRole, requireRoleOrPermission };
|
|
123
131
|
//# sourceMappingURL=index.js.map
|
|
124
132
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/middleware.ts","../src/guards.ts"],"names":["requirePermission","requireRole","requireRoleOrPermission"],"mappings":";AAwCO,SAAS,eAAoC,OAAA,EAAmE;AACrH,EAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,MAAK,GAAI,OAAA;AAE1C,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,GAAA,GAAM,CAAA;AACZ,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,GAAG,CAAA;AACpC,IAAA,IAAI,KAAA,GAA4B,IAAA;AAChC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,GAAG,CAAA,GAAI,MAAA;AACxC,MAAA,KAAA,GAAQ,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACxB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACC,IAAC,CAAA,CAAkC,GAAA,CAAI,MAAA,EAAQ,KAAK,CAAA;AACrD,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF;;;ACdO,IAAM,0BAAA,GAAN,cAAyC,KAAA,CAAM;AAAA,EAC3C,IAAA,GAAO,yBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,gFAAgF,CAAA;AACtF,IAAA,IAAA,CAAK,IAAA,GAAO,4BAAA;AAAA,EACd;AACF;AAEA,IAAM,QAAA,GAAsC;AAAA,EAC1C,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEA,IAAM,sBAAA,GAAuC,CAAC,CAAA,KAC5C,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,wBAAA,EAAyB,EAAG,GAAG,CAAA;AAE7E,IAAM,mBACJ,CAAC,MAAA,KACD,CAAC,CAAA,EAAG,YACF,CAAA,CAAE,IAAA;AAAA,EACA;AAAA,IACE,KAAA,EAAO,WAAA;AAAA,IACP,QAAQ,OAAA,CAAQ,IAAA;AAAA,IAChB,OAAA,EAAS,QAAA,CAAS,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC9B,GAAI,MAAA,IAAU,EAAE,QAAA,EAAU,QAAQ,YAAA;AAAa,GACjD;AAAA,EACA;AACF,CAAA;AAEJ,IAAM,QAAQ,CAAC,IAAA,KACb,KACG,KAAA,CAAM,GAAG,EACT,GAAA,CAAI,CAAC,CAAA,KAAM,CAAA,CAAE,MAAM,CAAA,CACnB,OAAO,CAAC,CAAA,KAAM,MAAM,EAAE,CAAA;AAG3B,SAAS,SAAS,KAAA,EAA0C;AAC1D,EAAA,MAAM,SAAqB,EAAC;AAC5B,EAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,IAAA,KAAA,MAAW,QAAQ,OAAO,IAAA,KAAS,WAAW,CAAC,IAAI,IAAI,IAAA,EAAM;AAC3D,MAAA,MAAM,KAAA,GAAQ,MAAM,IAAI,CAAA;AACxB,MAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,EAAG,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,IACzC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,UAA4B,IAAA,EAAoF;AACvH,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACjC,EAAA,IAAI,IAAA,KAAS,UAAa,OAAO,IAAA,KAAS,YAAY,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC1E,IAAA,OAAO,EAAE,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,EAAE,CAAA,EAAmB,SAAS,IAAA,EAAU;AAAA,EACxE;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAsB,OAAA,EAAS,MAAA,EAAU;AAC3D;AAEA,SAAS,WAAA,CACP,IAAA,EACA,YAAA,EACA,QAAA,EACA,KAAA,EAC4B;AAC5B,EAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,IAAI,CAAA,+BAAA,CAAiC,CAAA;AAAA,EACjF;AACA,EAAA,MAAM,iBAAA,GAAoB,SAAS,iBAAA,IAAqB,sBAAA;AACxD,EAAA,MAAM,cAAc,QAAA,CAAS,WAAA,IAAe,gBAAA,CAAiB,QAAA,CAAS,sBAAsB,KAAK,CAAA;AACjG,EAAA,MAAM,OAAA,GAAwB,EAAE,IAAA,EAAM,YAAA,EAAa;AAEnD,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,IAAA,GAAO,CAAA,CAAE,GAAA,CAAI,MAAM,CAAA;AACzB,IAAA,IAAI,IAAA,KAAS,MAAA,EAAW,MAAM,IAAI,0BAAA,EAA2B;AAC7D,IAAA,IAAI,IAAA,KAAS,IAAA,EAAM,OAAO,iBAAA,CAAkB,GAAG,OAAO,CAAA;AACtD,IAAA,IAAI,MAAM,KAAA,CAAM,IAAI,CAAA,EAAG;AACrB,MAAA,MAAM,IAAA,EAAK;AACX,MAAA;AAAA,IACF;AACA,IAAA,OAAO,WAAA,CAAY,GAAG,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAEA,eAAe,KAAA,CAAM,QAA6B,IAAA,EAA+D;AAC/G,EAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,KAAK,GAAI,OAAO,KAAA;AAAA,EACnC;AACA,EAAA,OAAO,IAAA;AACT;AAGO,SAAS,YAAA,CAAa,QAAA,GAA0B,EAAC,EAAG;AASzD,EAAA,SAASA,sBAAqB,IAAA,EAA2E;AACvG,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,IAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,IAAA,MAAM,eAAe,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,MAAA;AACrD,IAAA,OAAO,WAAA;AAAA,MAAY,YAAA;AAAA,MAAc,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,CAAC,SAC3E,KAAA,CAAM,YAAA,EAAc,CAAC,KAAA,KAAU,IAAA,CAAK,MAAA,CAAO,KAAK,CAAC;AAAA,KACnD;AAAA,EACF;AAQA,EAAA,SAASC,gBAAe,IAAA,EAAqE;AAC3F,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAA4B,IAAI,CAAA;AAChE,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,GAAA,GAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,CAAA,GAAI,CAAC,GAAG,CAAA;AAC7D,IAAA,OAAO,WAAA;AAAA,MAAY,MAAA;AAAA,MAAQ,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,IAAA,KAC3E,OAAA,CAAQ,GAAA,GAAM,IAAA,CAAK,YAAY,GAAG,CAAA,GAAI,IAAA,CAAK,UAAA,CAAW,GAAG;AAAA,KAC3D;AAAA,EACF;AAQA,EAAA,SAASC,4BAA2B,IAAA,EAAiF;AACnH,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,OAAO,WAAA;AAAA,MAAY,oBAAA;AAAA,MAAsB,CAAC,GAAG,CAAA;AAAA,MAAG,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,SACjF,MAAM,IAAA,CAAK,WAAW,GAAG,CAAA,IAAM,IAAA,CAAK,MAAA,CAAO,GAAG;AAAA,KACjD;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,iBAAA,EAAAF,kBAAAA,EAAmB,WAAA,EAAAC,YAAAA,EAAa,yBAAAC,wBAAAA,EAAwB;AACnE;AAEO,IAAM,EAAE,iBAAA,EAAmB,WAAA,EAAa,uBAAA,KAA4B,YAAA","file":"index.js","sourcesContent":["import type { Rbac, Subject, SubjectRbac, TeamId } from '@anievo-id/rbac-evolution'\nimport type { Context, Env, MiddlewareHandler } from 'hono'\n\ntype MaybePromise<T> = T | Promise<T>\n\n/** Context variables set by `rbacMiddleware()`. */\nexport type RbacVariables = {\n /** Roles & permissions of the current subject. `null` for guests. */\n rbac: SubjectRbac | null\n}\n\n/**\n * Hono env for apps using `rbacMiddleware()`: `new Hono<RbacEnv>()` types `c.var.rbac`.\n * Combine it with your own variables: `new Hono<{ Variables: RbacVariables & { user: User } }>()`.\n */\nexport type RbacEnv = {\n Variables: RbacVariables\n}\n\nexport interface RbacMiddlewareOptions<E extends Env = Env> {\n /** The RBAC engine created with `createRbac(...)`. */\n rbac: Rbac\n /**\n * Resolves the authenticated subject for this request (e.g. from `c.var.user` or a JWT payload).\n * Return `null` / `undefined` for guests.\n */\n getSubject: (c: Context<E>) => MaybePromise<Subject | null | undefined>\n /** Guard name (e.g. `web` or `api`). Defaults to the engine's `defaultGuard`. */\n guard?: string\n /** Resolves the current team (only when the engine was created with `teams: true`). */\n team?: (c: Context<E>) => MaybePromise<TeamId | undefined>\n}\n\n/**\n * Resolves the current subject and sets `c.var.rbac` (a `SubjectRbac`, or `null` for guests).\n *\n * ```ts\n * app.use(rbacMiddleware({ rbac, getSubject: (c) => (c.var.user ? { type: 'user', id: c.var.user.id } : null) }))\n * ```\n */\nexport function rbacMiddleware<E extends Env = Env>(options: RbacMiddlewareOptions<E>): MiddlewareHandler<E & RbacEnv> {\n const { rbac, getSubject, guard, team } = options\n\n return async (c, next) => {\n const ctx = c as unknown as Context<E>\n const subject = await getSubject(ctx)\n let value: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(ctx) : undefined\n value = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n ;(c as unknown as Context<RbacEnv>).set('rbac', value)\n await next()\n }\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { Context, MiddlewareHandler } from 'hono'\nimport type { RbacEnv } from './middleware'\n\nexport type GuardKind = 'permission' | 'role' | 'role_or_permission'\n\n/** Details about a failed check, passed to `onUnauthenticated` / `onForbidden`. */\nexport interface GuardContext {\n kind: GuardKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\n/** Returns the response to send (or throws, e.g. an `HTTPException`). */\nexport type GuardHandler = (c: Context, context: GuardContext) => Response | Promise<Response>\n\nexport interface GuardHandlers {\n /** Called when there is no subject (`c.var.rbac` is `null`). Default: 401 JSON. */\n onUnauthenticated?: GuardHandler\n /** Called when the subject lacks access. Default: 403 JSON. */\n onForbidden?: GuardHandler\n /**\n * Include the required roles/permissions in the default 403 body.\n * Default: `false` (like spatie's `display_permission_in_exception`).\n */\n exposeRequirements?: boolean\n}\n\nexport interface PermissionGuardOptions extends GuardHandlers {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleGuardOptions extends GuardHandlers {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport type RoleOrPermissionGuardOptions = GuardHandlers\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type GuardNames = string | readonly string[]\n\nexport class RbacMiddlewareMissingError extends Error {\n readonly code = 'RBAC_MIDDLEWARE_MISSING'\n\n constructor() {\n super('`c.var.rbac` is not set. Register `rbacMiddleware()` before using RBAC guards.')\n this.name = 'RbacMiddlewareMissingError'\n }\n}\n\nconst MESSAGES: Record<GuardKind, string> = {\n permission: 'User does not have the right permissions.',\n role: 'User does not have the right roles.',\n role_or_permission: 'User does not have any of the necessary access rights.',\n}\n\nconst defaultUnauthenticated: GuardHandler = (c) =>\n c.json({ error: 'UNAUTHENTICATED', message: 'User is not logged in.' }, 401)\n\nconst defaultForbidden =\n (expose: boolean): GuardHandler =>\n (c, context) =>\n c.json(\n {\n error: 'FORBIDDEN',\n reason: context.kind,\n message: MESSAGES[context.kind],\n ...(expose && { required: context.requirements }),\n },\n 403,\n )\n\nconst split = (name: string): string[] =>\n name\n .split('|')\n .map((n) => n.trim())\n .filter((n) => n !== '')\n\n/** Each argument is a group (pipes = any within the group); arrays contribute one group per item. */\nfunction toGroups(names: readonly GuardNames[]): string[][] {\n const groups: string[][] = []\n for (const name of names) {\n for (const item of typeof name === 'string' ? [name] : name) {\n const group = split(item)\n if (group.length > 0) groups.push(group)\n }\n }\n return groups\n}\n\nfunction parseArgs<O extends object>(args: readonly (GuardNames | O)[]): { names: GuardNames[]; options: O | undefined } {\n const last = args[args.length - 1]\n if (last !== undefined && typeof last === 'object' && !Array.isArray(last)) {\n return { names: args.slice(0, -1) as GuardNames[], options: last as O }\n }\n return { names: args as GuardNames[], options: undefined }\n}\n\nfunction createGuard(\n kind: GuardKind,\n requirements: string[][],\n handlers: GuardHandlers,\n check: (rbac: SubjectRbac) => Promise<boolean>,\n): MiddlewareHandler<RbacEnv> {\n if (requirements.length === 0) {\n throw new TypeError(`[rbac-evolution] A ${kind} guard needs at least one name.`)\n }\n const onUnauthenticated = handlers.onUnauthenticated ?? defaultUnauthenticated\n const onForbidden = handlers.onForbidden ?? defaultForbidden(handlers.exposeRequirements ?? false)\n const context: GuardContext = { kind, requirements }\n\n return async (c, next) => {\n const rbac = c.get('rbac') as SubjectRbac | null | undefined\n if (rbac === undefined) throw new RbacMiddlewareMissingError()\n if (rbac === null) return onUnauthenticated(c, context)\n if (await check(rbac)) {\n await next()\n return\n }\n return onForbidden(c, context)\n }\n}\n\nasync function every(groups: readonly string[][], test: (group: string[]) => Promise<boolean>): Promise<boolean> {\n for (const group of groups) {\n if (!(await test(group))) return false\n }\n return true\n}\n\n/** Builds the guards with shared defaults (e.g. a custom `onForbidden` that renders an HTML page). */\nexport function createGuards(defaults: GuardHandlers = {}) {\n /**\n * Requires permissions, like spatie's `permission:` middleware.\n *\n * - `requirePermission('edit articles')`\n * - `requirePermission('edit articles|delete articles')` — any of them\n * - `requirePermission('edit articles', 'publish articles')` — all of them\n * - `requirePermission('a', 'b', { any: true })` — any of them\n */\n function requirePermission(...args: (GuardNames | PermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<PermissionGuardOptions>(args)\n const groups = toGroups(names)\n const requirements = options.any ? [groups.flat()] : groups\n return createGuard('permission', requirements, { ...defaults, ...options }, (rbac) =>\n every(requirements, (group) => rbac.canAny(group)),\n )\n }\n\n /**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `requireRole('admin')`, `requireRole('admin|editor')`, `requireRole('admin', 'editor')` — any of them\n * - `requireRole('admin', 'editor', { all: true })` — all of them\n */\n function requireRole(...args: (GuardNames | RoleGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleGuardOptions>(args)\n const all = toGroups(names).flat()\n const requirements = options.all ? all.map((r) => [r]) : [all]\n return createGuard('role', requirements, { ...defaults, ...options }, async (rbac) =>\n options.all ? rbac.hasAllRoles(all) : rbac.hasAnyRole(all),\n )\n }\n\n /**\n * Passes when the subject has ANY of the names as a role OR as a permission,\n * like spatie's `role_or_permission:` middleware.\n *\n * - `requireRoleOrPermission('admin|edit articles')`\n */\n function requireRoleOrPermission(...args: (GuardNames | RoleOrPermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleOrPermissionGuardOptions>(args)\n const all = toGroups(names).flat()\n return createGuard('role_or_permission', [all], { ...defaults, ...options }, async (rbac) =>\n (await rbac.hasAnyRole(all)) || rbac.canAny(all),\n )\n }\n\n return { requirePermission, requireRole, requireRoleOrPermission }\n}\n\nexport const { requirePermission, requireRole, requireRoleOrPermission } = createGuards()\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/middleware.ts","../src/guards.ts"],"names":["requirePermission","requireRole","requireRoleOrPermission","canAny","canAll"],"mappings":";AAwCO,SAAS,eAAoC,OAAA,EAAmE;AACrH,EAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,MAAK,GAAI,OAAA;AAE1C,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,GAAA,GAAM,CAAA;AACZ,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,GAAG,CAAA;AACpC,IAAA,IAAI,KAAA,GAA4B,IAAA;AAChC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,GAAG,CAAA,GAAI,MAAA;AACxC,MAAA,KAAA,GAAQ,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACxB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACC,IAAC,CAAA,CAAkC,GAAA,CAAI,MAAA,EAAQ,KAAK,CAAA;AACrD,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF;;;ACdO,IAAM,0BAAA,GAAN,cAAyC,KAAA,CAAM;AAAA,EAC3C,IAAA,GAAO,yBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,gFAAgF,CAAA;AACtF,IAAA,IAAA,CAAK,IAAA,GAAO,4BAAA;AAAA,EACd;AACF;AAEA,IAAM,QAAA,GAAsC;AAAA,EAC1C,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEA,IAAM,sBAAA,GAAuC,CAAC,CAAA,KAC5C,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,iBAAA,EAAmB,OAAA,EAAS,wBAAA,EAAyB,EAAG,GAAG,CAAA;AAE7E,IAAM,mBACJ,CAAC,MAAA,KACD,CAAC,CAAA,EAAG,YACF,CAAA,CAAE,IAAA;AAAA,EACA;AAAA,IACE,KAAA,EAAO,WAAA;AAAA,IACP,QAAQ,OAAA,CAAQ,IAAA;AAAA,IAChB,OAAA,EAAS,QAAA,CAAS,OAAA,CAAQ,IAAI,CAAA;AAAA,IAC9B,GAAI,MAAA,IAAU,EAAE,QAAA,EAAU,QAAQ,YAAA;AAAa,GACjD;AAAA,EACA;AACF,CAAA;AAEJ,IAAM,QAAQ,CAAC,IAAA,KACb,KACG,KAAA,CAAM,GAAG,EACT,GAAA,CAAI,CAAC,CAAA,KAAM,CAAA,CAAE,MAAM,CAAA,CACnB,OAAO,CAAC,CAAA,KAAM,MAAM,EAAE,CAAA;AAG3B,SAAS,SAAS,KAAA,EAA0C;AAC1D,EAAA,MAAM,SAAqB,EAAC;AAC5B,EAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACxB,IAAA,KAAA,MAAW,QAAQ,OAAO,IAAA,KAAS,WAAW,CAAC,IAAI,IAAI,IAAA,EAAM;AAC3D,MAAA,MAAM,KAAA,GAAQ,MAAM,IAAI,CAAA;AACxB,MAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,EAAG,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,IACzC;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,UAA4B,IAAA,EAAoF;AACvH,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACjC,EAAA,IAAI,IAAA,KAAS,UAAa,OAAO,IAAA,KAAS,YAAY,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AAC1E,IAAA,OAAO,EAAE,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,EAAE,CAAA,EAAmB,SAAS,IAAA,EAAU;AAAA,EACxE;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAsB,OAAA,EAAS,MAAA,EAAU;AAC3D;AAEA,SAAS,WAAA,CACP,IAAA,EACA,YAAA,EACA,QAAA,EACA,KAAA,EAC4B;AAC5B,EAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,IAAI,CAAA,+BAAA,CAAiC,CAAA;AAAA,EACjF;AACA,EAAA,MAAM,iBAAA,GAAoB,SAAS,iBAAA,IAAqB,sBAAA;AACxD,EAAA,MAAM,cAAc,QAAA,CAAS,WAAA,IAAe,gBAAA,CAAiB,QAAA,CAAS,sBAAsB,KAAK,CAAA;AACjG,EAAA,MAAM,OAAA,GAAwB,EAAE,IAAA,EAAM,YAAA,EAAa;AAEnD,EAAA,OAAO,OAAO,GAAG,IAAA,KAAS;AACxB,IAAA,MAAM,IAAA,GAAO,CAAA,CAAE,GAAA,CAAI,MAAM,CAAA;AACzB,IAAA,IAAI,IAAA,KAAS,MAAA,EAAW,MAAM,IAAI,0BAAA,EAA2B;AAC7D,IAAA,IAAI,IAAA,KAAS,IAAA,EAAM,OAAO,iBAAA,CAAkB,GAAG,OAAO,CAAA;AACtD,IAAA,IAAI,MAAM,KAAA,CAAM,IAAI,CAAA,EAAG;AACrB,MAAA,MAAM,IAAA,EAAK;AACX,MAAA;AAAA,IACF;AACA,IAAA,OAAO,WAAA,CAAY,GAAG,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAEA,eAAe,KAAA,CAAM,QAA6B,IAAA,EAA+D;AAC/G,EAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,KAAK,GAAI,OAAO,KAAA;AAAA,EACnC;AACA,EAAA,OAAO,IAAA;AACT;AAGO,SAAS,YAAA,CAAa,QAAA,GAA0B,EAAC,EAAG;AASzD,EAAA,SAASA,sBAAqB,IAAA,EAA2E;AACvG,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,IAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,IAAA,MAAM,eAAe,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,MAAA;AACrD,IAAA,OAAO,WAAA;AAAA,MAAY,YAAA;AAAA,MAAc,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,CAAC,SAC3E,KAAA,CAAM,YAAA,EAAc,CAAC,KAAA,KAAU,IAAA,CAAK,MAAA,CAAO,KAAK,CAAC;AAAA,KACnD;AAAA,EACF;AAQA,EAAA,SAASC,gBAAe,IAAA,EAAqE;AAC3F,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAA4B,IAAI,CAAA;AAChE,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,MAAM,YAAA,GAAe,OAAA,CAAQ,GAAA,GAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,CAAA,GAAI,CAAC,GAAG,CAAA;AAC7D,IAAA,OAAO,WAAA;AAAA,MAAY,MAAA;AAAA,MAAQ,YAAA;AAAA,MAAc,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,IAAA,KAC3E,OAAA,CAAQ,GAAA,GAAM,IAAA,CAAK,YAAY,GAAG,CAAA,GAAI,IAAA,CAAK,UAAA,CAAW,GAAG;AAAA,KAC3D;AAAA,EACF;AAQA,EAAA,SAASC,4BAA2B,IAAA,EAAiF;AACnH,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,IAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,IAAA,OAAO,WAAA;AAAA,MAAY,oBAAA;AAAA,MAAsB,CAAC,GAAG,CAAA;AAAA,MAAG,EAAE,GAAG,QAAA,EAAU,GAAG,OAAA,EAAQ;AAAA,MAAG,OAAO,SACjF,MAAM,IAAA,CAAK,WAAW,GAAG,CAAA,IAAM,IAAA,CAAK,MAAA,CAAO,GAAG;AAAA,KACjD;AAAA,EACF;AAOA,EAAA,SAASC,WAAU,IAAA,EAAkE;AACnF,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,UAAyB,IAAI,CAAA;AACxD,IAAA,OAAOH,kBAAAA,CAAkB,GAAG,KAAA,EAAO,EAAE,GAAG,OAAA,EAAS,GAAA,EAAK,MAAM,CAAA;AAAA,EAC9D;AAOA,EAAA,SAASI,WAAU,IAAA,EAAkE;AACnF,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,UAAyB,IAAI,CAAA;AACxD,IAAA,OAAOJ,kBAAAA,CAAkB,GAAG,KAAA,EAAO,EAAE,GAAG,OAAA,EAAS,GAAA,EAAK,OAAO,CAAA;AAAA,EAC/D;AAEA,EAAA,OAAO,EAAE,iBAAA,EAAAA,kBAAAA,EAAmB,WAAA,EAAAC,YAAAA,EAAa,yBAAAC,wBAAAA,EAAyB,MAAA,EAAAC,OAAAA,EAAQ,MAAA,EAAAC,OAAAA,EAAO;AACnF;AAEO,IAAM,EAAE,iBAAA,EAAmB,WAAA,EAAa,yBAAyB,MAAA,EAAQ,MAAA,KAAW,YAAA","file":"index.js","sourcesContent":["import type { Rbac, Subject, SubjectRbac, TeamId } from '@anievo-id/rbac-evolution'\nimport type { Context, Env, MiddlewareHandler } from 'hono'\n\ntype MaybePromise<T> = T | Promise<T>\n\n/** Context variables set by `rbacMiddleware()`. */\nexport type RbacVariables = {\n /** Roles & permissions of the current subject. `null` for guests. */\n rbac: SubjectRbac | null\n}\n\n/**\n * Hono env for apps using `rbacMiddleware()`: `new Hono<RbacEnv>()` types `c.var.rbac`.\n * Combine it with your own variables: `new Hono<{ Variables: RbacVariables & { user: User } }>()`.\n */\nexport type RbacEnv = {\n Variables: RbacVariables\n}\n\nexport interface RbacMiddlewareOptions<E extends Env = Env> {\n /** The RBAC engine created with `createRbac(...)`. */\n rbac: Rbac\n /**\n * Resolves the authenticated subject for this request (e.g. from `c.var.user` or a JWT payload).\n * Return `null` / `undefined` for guests.\n */\n getSubject: (c: Context<E>) => MaybePromise<Subject | null | undefined>\n /** Guard name (e.g. `web` or `api`). Defaults to the engine's `defaultGuard`. */\n guard?: string\n /** Resolves the current team (only when the engine was created with `teams: true`). */\n team?: (c: Context<E>) => MaybePromise<TeamId | undefined>\n}\n\n/**\n * Resolves the current subject and sets `c.var.rbac` (a `SubjectRbac`, or `null` for guests).\n *\n * ```ts\n * app.use(rbacMiddleware({ rbac, getSubject: (c) => (c.var.user ? { type: 'user', id: c.var.user.id } : null) }))\n * ```\n */\nexport function rbacMiddleware<E extends Env = Env>(options: RbacMiddlewareOptions<E>): MiddlewareHandler<E & RbacEnv> {\n const { rbac, getSubject, guard, team } = options\n\n return async (c, next) => {\n const ctx = c as unknown as Context<E>\n const subject = await getSubject(ctx)\n let value: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(ctx) : undefined\n value = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n ;(c as unknown as Context<RbacEnv>).set('rbac', value)\n await next()\n }\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { Context, MiddlewareHandler } from 'hono'\nimport type { RbacEnv } from './middleware'\n\nexport type GuardKind = 'permission' | 'role' | 'role_or_permission'\n\n/** Details about a failed check, passed to `onUnauthenticated` / `onForbidden`. */\nexport interface GuardContext {\n kind: GuardKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\n/** Returns the response to send (or throws, e.g. an `HTTPException`). */\nexport type GuardHandler = (c: Context, context: GuardContext) => Response | Promise<Response>\n\nexport interface GuardHandlers {\n /** Called when there is no subject (`c.var.rbac` is `null`). Default: 401 JSON. */\n onUnauthenticated?: GuardHandler\n /** Called when the subject lacks access. Default: 403 JSON. */\n onForbidden?: GuardHandler\n /**\n * Include the required roles/permissions in the default 403 body.\n * Default: `false` (like spatie's `display_permission_in_exception`).\n */\n exposeRequirements?: boolean\n}\n\nexport interface PermissionGuardOptions extends GuardHandlers {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleGuardOptions extends GuardHandlers {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport type RoleOrPermissionGuardOptions = GuardHandlers\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type GuardNames = string | readonly string[]\n\nexport class RbacMiddlewareMissingError extends Error {\n readonly code = 'RBAC_MIDDLEWARE_MISSING'\n\n constructor() {\n super('`c.var.rbac` is not set. Register `rbacMiddleware()` before using RBAC guards.')\n this.name = 'RbacMiddlewareMissingError'\n }\n}\n\nconst MESSAGES: Record<GuardKind, string> = {\n permission: 'User does not have the right permissions.',\n role: 'User does not have the right roles.',\n role_or_permission: 'User does not have any of the necessary access rights.',\n}\n\nconst defaultUnauthenticated: GuardHandler = (c) =>\n c.json({ error: 'UNAUTHENTICATED', message: 'User is not logged in.' }, 401)\n\nconst defaultForbidden =\n (expose: boolean): GuardHandler =>\n (c, context) =>\n c.json(\n {\n error: 'FORBIDDEN',\n reason: context.kind,\n message: MESSAGES[context.kind],\n ...(expose && { required: context.requirements }),\n },\n 403,\n )\n\nconst split = (name: string): string[] =>\n name\n .split('|')\n .map((n) => n.trim())\n .filter((n) => n !== '')\n\n/** Each argument is a group (pipes = any within the group); arrays contribute one group per item. */\nfunction toGroups(names: readonly GuardNames[]): string[][] {\n const groups: string[][] = []\n for (const name of names) {\n for (const item of typeof name === 'string' ? [name] : name) {\n const group = split(item)\n if (group.length > 0) groups.push(group)\n }\n }\n return groups\n}\n\nfunction parseArgs<O extends object>(args: readonly (GuardNames | O)[]): { names: GuardNames[]; options: O | undefined } {\n const last = args[args.length - 1]\n if (last !== undefined && typeof last === 'object' && !Array.isArray(last)) {\n return { names: args.slice(0, -1) as GuardNames[], options: last as O }\n }\n return { names: args as GuardNames[], options: undefined }\n}\n\nfunction createGuard(\n kind: GuardKind,\n requirements: string[][],\n handlers: GuardHandlers,\n check: (rbac: SubjectRbac) => Promise<boolean>,\n): MiddlewareHandler<RbacEnv> {\n if (requirements.length === 0) {\n throw new TypeError(`[rbac-evolution] A ${kind} guard needs at least one name.`)\n }\n const onUnauthenticated = handlers.onUnauthenticated ?? defaultUnauthenticated\n const onForbidden = handlers.onForbidden ?? defaultForbidden(handlers.exposeRequirements ?? false)\n const context: GuardContext = { kind, requirements }\n\n return async (c, next) => {\n const rbac = c.get('rbac') as SubjectRbac | null | undefined\n if (rbac === undefined) throw new RbacMiddlewareMissingError()\n if (rbac === null) return onUnauthenticated(c, context)\n if (await check(rbac)) {\n await next()\n return\n }\n return onForbidden(c, context)\n }\n}\n\nasync function every(groups: readonly string[][], test: (group: string[]) => Promise<boolean>): Promise<boolean> {\n for (const group of groups) {\n if (!(await test(group))) return false\n }\n return true\n}\n\n/** Builds the guards with shared defaults (e.g. a custom `onForbidden` that renders an HTML page). */\nexport function createGuards(defaults: GuardHandlers = {}) {\n /**\n * Requires permissions, like spatie's `permission:` middleware.\n *\n * - `requirePermission('edit articles')`\n * - `requirePermission('edit articles|delete articles')` — any of them\n * - `requirePermission('edit articles', 'publish articles')` — all of them\n * - `requirePermission('a', 'b', { any: true })` — any of them\n */\n function requirePermission(...args: (GuardNames | PermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<PermissionGuardOptions>(args)\n const groups = toGroups(names)\n const requirements = options.any ? [groups.flat()] : groups\n return createGuard('permission', requirements, { ...defaults, ...options }, (rbac) =>\n every(requirements, (group) => rbac.canAny(group)),\n )\n }\n\n /**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `requireRole('admin')`, `requireRole('admin|editor')`, `requireRole('admin', 'editor')` — any of them\n * - `requireRole('admin', 'editor', { all: true })` — all of them\n */\n function requireRole(...args: (GuardNames | RoleGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleGuardOptions>(args)\n const all = toGroups(names).flat()\n const requirements = options.all ? all.map((r) => [r]) : [all]\n return createGuard('role', requirements, { ...defaults, ...options }, async (rbac) =>\n options.all ? rbac.hasAllRoles(all) : rbac.hasAnyRole(all),\n )\n }\n\n /**\n * Passes when the subject has ANY of the names as a role OR as a permission,\n * like spatie's `role_or_permission:` middleware.\n *\n * - `requireRoleOrPermission('admin|edit articles')`\n */\n function requireRoleOrPermission(...args: (GuardNames | RoleOrPermissionGuardOptions)[]): MiddlewareHandler<RbacEnv> {\n const { names, options = {} } = parseArgs<RoleOrPermissionGuardOptions>(args)\n const all = toGroups(names).flat()\n return createGuard('role_or_permission', [all], { ...defaults, ...options }, async (rbac) =>\n (await rbac.hasAnyRole(all)) || rbac.canAny(all),\n )\n }\n\n /**\n * spatie v8.5 `canAny()`: passes with ANY of the listed permissions.\n *\n * - `canAny('edit articles', 'publish articles')`, `canAny(['edit articles', 'publish articles'])`\n */\n function canAny(...args: (GuardNames | GuardHandlers)[]): MiddlewareHandler<RbacEnv> {\n const { names, options } = parseArgs<GuardHandlers>(args)\n return requirePermission(...names, { ...options, any: true })\n }\n\n /**\n * spatie v8.5 `canAll()`: requires EVERY listed entry. A `'a|b'` entry still means \"a or b\".\n *\n * - `canAll('edit articles', 'publish articles')`, `canAll(['edit articles', 'publish|review'])`\n */\n function canAll(...args: (GuardNames | GuardHandlers)[]): MiddlewareHandler<RbacEnv> {\n const { names, options } = parseArgs<GuardHandlers>(args)\n return requirePermission(...names, { ...options, any: false })\n }\n\n return { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll }\n}\n\nexport const { requirePermission, requireRole, requireRoleOrPermission, canAny, canAll } = createGuards()\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@anievo-id/rbac-evolution-hono",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "Hono middleware for rbac-evolution — runs on Node, Bun, Deno, Cloudflare Workers and other edge runtimes.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "AniEvo-ID (https://github.com/AniEvo-ID)",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"access": "public"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@anievo-id/rbac-evolution": "^0.
|
|
52
|
+
"@anievo-id/rbac-evolution": "^0.4.1"
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
55
55
|
"hono": ">=4"
|