@anievo-id/rbac-evolution-nestjs 0.3.0 → 0.3.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 +7 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +7 -8
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.cjs
CHANGED
|
@@ -127,6 +127,7 @@ var RBAC_REQUIREMENTS = "rbac-evolution:requirements";
|
|
|
127
127
|
|
|
128
128
|
// src/guard.ts
|
|
129
129
|
var enforced = /* @__PURE__ */ new WeakMap();
|
|
130
|
+
var isPerCall = (context) => ["http", "rpc"].includes(context.getType());
|
|
130
131
|
exports.RbacGuard = class RbacGuard {
|
|
131
132
|
// Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.
|
|
132
133
|
constructor(reflector, options) {
|
|
@@ -137,13 +138,10 @@ exports.RbacGuard = class RbacGuard {
|
|
|
137
138
|
options;
|
|
138
139
|
async canActivate(context) {
|
|
139
140
|
const key = requestKey(context);
|
|
140
|
-
const
|
|
141
|
+
const perCall = isPerCall(context);
|
|
142
|
+
const rbac = await this.resolve(context, key, perCall);
|
|
141
143
|
const handler = context.getHandler();
|
|
142
|
-
if (key !== void 0)
|
|
143
|
-
const done = enforced.get(key) ?? /* @__PURE__ */ new Set();
|
|
144
|
-
if (done.has(handler)) return true;
|
|
145
|
-
enforced.set(key, done.add(handler));
|
|
146
|
-
}
|
|
144
|
+
if (perCall && key !== void 0 && enforced.get(key)?.has(handler)) return true;
|
|
147
145
|
const requirements = [
|
|
148
146
|
...this.reflector.get(RBAC_REQUIREMENTS, context.getClass()) ?? [],
|
|
149
147
|
...this.reflector.get(RBAC_REQUIREMENTS, handler) ?? []
|
|
@@ -162,10 +160,11 @@ exports.RbacGuard = class RbacGuard {
|
|
|
162
160
|
});
|
|
163
161
|
}
|
|
164
162
|
}
|
|
163
|
+
if (perCall && key !== void 0) enforced.set(key, (enforced.get(key) ?? /* @__PURE__ */ new Set()).add(handler));
|
|
165
164
|
return true;
|
|
166
165
|
}
|
|
167
|
-
async resolve(context, key) {
|
|
168
|
-
if (key !== void 0 && hasResolved(key)) return getResolved(key) ?? null;
|
|
166
|
+
async resolve(context, key, perCall) {
|
|
167
|
+
if (perCall && key !== void 0 && hasResolved(key)) return getResolved(key) ?? null;
|
|
169
168
|
const { rbac, getSubject, guard, team } = this.options;
|
|
170
169
|
const subject = await getSubject(context);
|
|
171
170
|
let result = null;
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/context.ts","../src/requirements.ts","../src/tokens.ts","../src/guard.ts","../src/module.ts","../src/decorators.ts"],"names":["RbacGuard","UnauthorizedException","ForbiddenException","Injectable","Reflector","RbacModule","APP_GUARD","Global","Module","applyDecorators","UseGuards","createParamDecorator"],"mappings":";;;;;;;;;;;;;;;;;AAGO,IAAM,qBAAA,GAAN,cAAoC,KAAA,CAAM;AAAA,EACtC,IAAA,GAAO,oBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA;AAAA,MACE;AAAA,KAEF;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAGA,IAAM,QAAA,uBAAe,OAAA,EAAoC;AAMlD,SAAS,WAAW,OAAA,EAA+C;AACxE,EAAA,IAAI,GAAA;AACJ,EAAA,QAAQ,OAAA,CAAQ,SAAgB;AAAG,IACjC,KAAK,MAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,YAAA,EAAa,CAAE,UAAA,EAAW;AACxC,MAAA;AAAA,IACF,KAAK,KAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,WAAA,EAAY,CAAE,UAAA,EAAW;AACvC,MAAA;AAAA,IACF,KAAK,IAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,UAAA,EAAW,CAAE,SAAA,EAAU;AACrC,MAAA;AAAA,IACF;AACE,MAAA,GAAA,GAAM,OAAA,CAAQ,cAAc,CAAC,CAAA;AAAA;AAEjC,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,OAAO,GAAA,GAAM,MAAA;AACzD;AAEO,SAAS,YAAY,GAAA,EAAsB;AAChD,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,YAAY,GAAA,EAA6C;AACvE,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,WAAA,CAAY,KAAa,IAAA,EAAgC;AACvE,EAAA,QAAA,CAAS,GAAA,CAAI,KAAK,IAAI,CAAA;AACxB;AAMO,SAAS,QAAQ,OAAA,EAA+C;AACrE,EAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,EAAA,IAAI,GAAA,KAAQ,UAAa,CAAC,QAAA,CAAS,IAAI,GAAG,CAAA,EAAG,MAAM,IAAI,qBAAA,EAAsB;AAC7E,EAAA,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,IAAK,IAAA;AAC9B;;;ACnCO,IAAM,QAAA,GAA4C;AAAA,EACvD,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEO,IAAM,uBAAA,GAA0B,wBAAA;AAEvC,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,EAAgD;AAChE,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,EAAgG;AACnI,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,EAAyB,SAAS,IAAA,EAAU;AAAA,EAC9E;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAA4B,OAAA,EAAS,MAAA,EAAU;AACjE;AAEA,SAAS,OAAO,WAAA,EAA+C;AAC7D,EAAA,MAAM,EAAE,cAAa,GAAI,WAAA;AACzB,EAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,IAAK,YAAA,CAAa,IAAA,CAAK,CAAC,KAAA,KAAU,KAAA,CAAM,MAAA,KAAW,CAAC,CAAA,EAAG;AACjF,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,WAAA,CAAY,IAAI,CAAA,qCAAA,CAAuC,CAAA;AAAA,EACnG;AACA,EAAA,OAAO,WAAA;AACT;AAGO,SAAS,sBAAsB,IAAA,EAAqF;AACzH,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,YAAA,EAAc,YAAA,EAAc,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,QAAQ,CAAA;AAC5F;AAGO,SAAS,gBAAgB,IAAA,EAA+E;AAC7G,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,EAAA,OAAO,OAAO,EAAE,IAAA,EAAM,QAAQ,YAAA,EAAc,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;AACzF;AAGO,SAAS,4BAA4B,KAAA,EAAqD;AAC/F,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,oBAAA,EAAsB,YAAA,EAAc,CAAC,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAM,CAAA,EAAG,CAAA;AACtF;AAGA,eAAsB,SAAA,CAAU,MAAmB,WAAA,EAAgD;AACjG,EAAA,KAAA,MAAW,KAAA,IAAS,YAAY,YAAA,EAAc;AAC5C,IAAA,IAAI,IAAA;AACJ,IAAA,QAAQ,YAAY,IAAA;AAAM,MACxB,KAAK,YAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA;AAC9B,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA;AAClC,QAAA;AAAA,MACF;AACE,QAAA,IAAA,GAAQ,MAAM,KAAK,UAAA,CAAW,KAAK,KAAO,MAAM,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA;AAErE,IAAA,IAAI,CAAC,MAAM,OAAO,KAAA;AAAA,EACpB;AACA,EAAA,OAAO,IAAA;AACT;;;ACtGO,IAAM,mBAAA,mBAAsB,MAAA,CAAO,GAAA,CAAI,+BAA+B;AAGtE,IAAM,IAAA,mBAAO,MAAA,CAAO,GAAA,CAAI,4BAA4B;AAGpD,IAAM,iBAAA,GAAoB;;;ACSjC,IAAM,QAAA,uBAAe,OAAA,EAA8B;AAYtCA,oBAAN,eAAA,CAAuC;AAAA;AAAA,EAE5C,WAAA,CACsC,WACU,OAAA,EAC9C;AAFoC,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACU,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AAAA,EAC7C;AAAA,EAFmC,SAAA;AAAA,EACU,OAAA;AAAA,EAGhD,MAAM,YAAY,OAAA,EAA6C;AAC7D,IAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,SAAS,GAAG,CAAA;AAE5C,IAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,EAAW;AACnC,IAAA,IAAI,QAAQ,MAAA,EAAW;AACrB,MAAA,MAAM,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,wBAAS,GAAA,EAAa;AACnD,MAAA,IAAI,IAAA,CAAK,GAAA,CAAI,OAAO,CAAA,EAAG,OAAO,IAAA;AAC9B,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,EAAK,IAAA,CAAK,GAAA,CAAI,OAAO,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,YAAA,GAAe;AAAA,MACnB,GAAI,KAAK,SAAA,CAAU,GAAA,CAAmC,mBAAmB,OAAA,CAAQ,QAAA,EAAU,CAAA,IAAK,EAAC;AAAA,MACjG,GAAI,IAAA,CAAK,SAAA,CAAU,IAAmC,iBAAA,EAAmB,OAAO,KAAK;AAAC,KACxF;AACA,IAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,EAAG,OAAO,IAAA;AAEtC,IAAA,IAAI,SAAS,IAAA,EAAM;AACjB,MAAA,MAAM,IAAIC,4BAAA,CAAsB,EAAE,OAAO,iBAAA,EAAmB,OAAA,EAAS,yBAAyB,CAAA;AAAA,IAChG;AAEA,IAAA,KAAA,MAAW,eAAe,YAAA,EAAc;AACtC,MAAA,IAAI,CAAE,MAAM,SAAA,CAAU,IAAA,EAAM,WAAW,CAAA,EAAI;AACzC,QAAA,MAAM,IAAIC,yBAAA,CAAmB;AAAA,UAC3B,KAAA,EAAO,WAAA;AAAA,UACP,QAAQ,WAAA,CAAY,IAAA;AAAA,UACpB,OAAA,EAAS,QAAA,CAAS,WAAA,CAAY,IAAI,CAAA;AAAA,UAClC,GAAI,IAAA,CAAK,OAAA,CAAQ,sBAAsB,EAAE,QAAA,EAAU,YAAY,YAAA;AAAa,SAC7E,CAAA;AAAA,MACH;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEA,MAAc,OAAA,CAAQ,OAAA,EAA2B,GAAA,EAAsD;AACrG,IAAA,IAAI,GAAA,KAAQ,UAAa,WAAA,CAAY,GAAG,GAAG,OAAO,WAAA,CAAY,GAAG,CAAA,IAAK,IAAA;AAEtE,IAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,IAAA,KAAS,IAAA,CAAK,OAAA;AAC/C,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,OAAO,CAAA;AACxC,IAAA,IAAI,MAAA,GAA6B,IAAA;AACjC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,OAAO,CAAA,GAAI,MAAA;AAC5C,MAAA,MAAA,GAAS,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACzB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACA,IAAA,IAAI,GAAA,KAAQ,MAAA,EAAW,WAAA,CAAY,GAAA,EAAK,MAAM,CAAA;AAC9C,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAzDaF,iBAAA,GAAN,eAAA,CAAA;AAAA,EADNG,iBAAA,EAAW;AAAA,EAIP,iCAAOC,cAAS,CAAA,CAAA;AAAA,EAChB,iCAAO,mBAAmB,CAAA;AAAA,CAAA,EAJlBJ,iBAAA,CAAA;;;ACtBb,SAAS,KAAA,CAAM,eAAA,EAA2B,WAAA,EAAsB,OAAA,GAAoC,EAAC,EAAkB;AACrH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQK,kBAAA;AAAA,IACR,MAAA,EAAQ,IAAA;AAAA,IACR,OAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,eAAA;AAAA,MACA,EAAE,OAAA,EAAS,IAAA,EAAM,UAAA,EAAY,CAAC,OAAA,KAA+B,OAAA,CAAQ,IAAA,EAAM,MAAA,EAAQ,CAAC,mBAAmB,CAAA,EAAE;AAAA,MACzGL,iBAAA;AAAA,MACA,GAAI,WAAA,GAAc,CAAC,EAAE,OAAA,EAASM,gBAAW,QAAA,EAAUN,iBAAA,EAAW,CAAA,GAAI;AAAC,KACrE;AAAA,IACA,OAAA,EAAS,CAAC,mBAAA,EAAqB,IAAA,EAAMA,iBAAS;AAAA,GAChD;AACF;AAsBaK,qBAAN,gBAAA,CAAiB;AAAA,EACtB,OAAO,QAAQ,MAAA,EAAyC;AACtD,IAAA,MAAM,EAAE,WAAA,GAAc,KAAA,EAAO,GAAG,SAAQ,GAAI,MAAA;AAC5C,IAAA,OAAO,MAAM,EAAE,OAAA,EAAS,qBAAqB,QAAA,EAAU,OAAA,IAAW,WAAW,CAAA;AAAA,EAC/E;AAAA;AAAA,EAGA,OAAO,aAAa,MAAA,EAA8C;AAChE,IAAA,OAAO,KAAA;AAAA,MACL,EAAE,OAAA,EAAS,mBAAA,EAAqB,UAAA,EAAY,MAAA,CAAO,YAAY,MAAA,EAAQ,MAAA,CAAO,MAAA,IAAU,EAAC,EAAE;AAAA,MAC3F,OAAO,WAAA,IAAe,KAAA;AAAA,MACtB,MAAA,CAAO,WAAW;AAAC,KACrB;AAAA,EACF;AACF;AAdaA,kBAAA,GAAN,eAAA,CAAA;AAAA,EAFNE,aAAA,EAAO;AAAA,EACPC,aAAA,CAAO,EAAE;AAAA,CAAA,EACGH,kBAAA,CAAA;AClBb,SAAS,kBAAkB,WAAA,EAAsD;AAC/E,EAAA,OAAO,CAAC,MAAA,EAAQ,YAAA,EAAc,UAAA,KAAe;AAC3C,IAAA,MAAM,MAAA,GAAiB,UAAA,EAAY,KAAA,KAAU,MAAA,GAAa,WAAW,KAAA,GAAmB,MAAA;AACxF,IAAA,MAAM,UAAW,OAAA,CAAQ,WAAA,CAAY,iBAAA,EAAmB,MAAM,KAAuC,EAAC;AACtG,IAAA,OAAA,CAAQ,eAAe,iBAAA,EAAmB,CAAC,GAAG,OAAA,EAAS,WAAW,GAAG,MAAM,CAAA;AAAA,EAC7E,CAAA;AACF;AAEA,IAAM,oBAAA,GAAuB,CAAC,WAAA,KAC5BI,sBAAA,CAAgB,kBAAkB,WAAW,CAAA,EAAGC,gBAAA,CAAUV,iBAAS,CAAC,CAAA;AAU/D,SAAS,sBAAsB,IAAA,EAA2D;AAC/F,EAAA,OAAO,oBAAA,CAAqB,qBAAA,CAAsB,IAAI,CAAC,CAAA;AACzD;AAQO,SAAS,gBAAgB,IAAA,EAAqD;AACnF,EAAA,OAAO,oBAAA,CAAqB,eAAA,CAAgB,IAAI,CAAC,CAAA;AACnD;AAQO,SAAS,2BAA2B,KAAA,EAA2B;AACpE,EAAA,OAAO,oBAAA,CAAqB,2BAAA,CAA4B,KAAK,CAAC,CAAA;AAChE;AAaO,IAAM,WAAA,GAAwCW,2BAAA;AAAA,EACnD,CAAC,KAAA,EAAgB,OAAA,KAAkD,OAAA,CAAQ,OAAO;AACpF","file":"index.cjs","sourcesContent":["import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { ExecutionContext } from '@nestjs/common'\n\nexport class RbacGuardMissingError extends Error {\n readonly code = 'RBAC_GUARD_MISSING'\n\n constructor() {\n super(\n '`@CurrentRbac()` was used but `RbacGuard` did not run for this route. Add a `@Require*()` decorator, ' +\n '`@UseGuards(RbacGuard)`, or `RbacModule.forRoot({ globalGuard: true })`.',\n )\n this.name = 'RbacGuardMissingError'\n }\n}\n\n/** Per-request resolved `SubjectRbac` (`null` for guests), keyed by the request/client/context object. */\nconst resolved = new WeakMap<object, SubjectRbac | null>()\n\n/**\n * The object that identifies the current request: the HTTP request, the RPC context, the WebSocket client,\n * or (for GraphQL and other context types) the third handler argument.\n */\nexport function requestKey(context: ExecutionContext): object | undefined {\n let key: unknown\n switch (context.getType<string>()) {\n case 'http':\n key = context.switchToHttp().getRequest()\n break\n case 'rpc':\n key = context.switchToRpc().getContext()\n break\n case 'ws':\n key = context.switchToWs().getClient()\n break\n default:\n key = context.getArgByIndex(2)\n }\n return typeof key === 'object' && key !== null ? key : undefined\n}\n\nexport function hasResolved(key: object): boolean {\n return resolved.has(key)\n}\n\nexport function getResolved(key: object): SubjectRbac | null | undefined {\n return resolved.get(key)\n}\n\nexport function setResolved(key: object, rbac: SubjectRbac | null): void {\n resolved.set(key, rbac)\n}\n\n/**\n * Returns the `SubjectRbac` that `RbacGuard` resolved for this execution context (`null` for guests).\n * Throws {@link RbacGuardMissingError} when the guard has not run.\n */\nexport function getRbac(context: ExecutionContext): SubjectRbac | null {\n const key = requestKey(context)\n if (key === undefined || !resolved.has(key)) throw new RbacGuardMissingError()\n return resolved.get(key) ?? null\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\n\n/** Which kind of requirement failed — same values as the Express package. */\nexport type RequirementKind = 'permission' | 'role' | 'role_or_permission'\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type RequirementNames = string | readonly string[]\n\n/** One `@Require*` decorator, normalized. */\nexport interface RbacRequirement {\n kind: RequirementKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\nexport interface PermissionRequirementOptions {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleRequirementOptions {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport const MESSAGES: Record<RequirementKind, 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\nexport const UNAUTHENTICATED_MESSAGE = 'User is not logged in.'\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 RequirementNames[]): 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 (RequirementNames | O)[]): { names: RequirementNames[]; 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 RequirementNames[], options: last as O }\n }\n return { names: args as RequirementNames[], options: undefined }\n}\n\nfunction ensure(requirement: RbacRequirement): RbacRequirement {\n const { requirements } = requirement\n if (requirements.length === 0 || requirements.some((group) => group.length === 0)) {\n throw new TypeError(`[rbac-evolution] A ${requirement.kind} requirement needs at least one name.`)\n }\n return requirement\n}\n\n/** `'a', 'b'` = all; `'a|b'` = any; `{ any: true }` = any of everything. */\nexport function permissionRequirement(args: readonly (RequirementNames | PermissionRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<PermissionRequirementOptions>(args)\n const groups = toGroups(names)\n return ensure({ kind: 'permission', requirements: options.any ? [groups.flat()] : groups })\n}\n\n/** Any of the roles by default; `{ all: true }` = all of them. */\nexport function roleRequirement(args: readonly (RequirementNames | RoleRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<RoleRequirementOptions>(args)\n const all = toGroups(names).flat()\n return ensure({ kind: 'role', requirements: options.all ? all.map((r) => [r]) : [all] })\n}\n\n/** Any of the names, as a role OR as a permission. */\nexport function roleOrPermissionRequirement(names: readonly RequirementNames[]): RbacRequirement {\n return ensure({ kind: 'role_or_permission', requirements: [toGroups(names).flat()] })\n}\n\n/** `true` when every group of the requirement passes for the subject. */\nexport async function satisfies(rbac: SubjectRbac, requirement: RbacRequirement): Promise<boolean> {\n for (const group of requirement.requirements) {\n let pass: boolean\n switch (requirement.kind) {\n case 'permission':\n pass = await rbac.canAny(group)\n break\n case 'role':\n pass = await rbac.hasAnyRole(group)\n break\n default:\n pass = (await rbac.hasAnyRole(group)) || (await rbac.canAny(group))\n }\n if (!pass) return false\n }\n return true\n}\n","/** Injection token for the resolved {@link RbacModuleOptions}. */\nexport const RBAC_MODULE_OPTIONS = Symbol.for('rbac-evolution:nestjs:options')\n\n/** Injection token for the `Rbac` engine passed to `RbacModule.forRoot({ rbac })`. */\nexport const RBAC = Symbol.for('rbac-evolution:nestjs:rbac')\n\n/** Metadata key under which `@Require*` decorators store their requirements. */\nexport const RBAC_REQUIREMENTS = 'rbac-evolution:requirements'\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport {\n type CanActivate,\n type ExecutionContext,\n ForbiddenException,\n Inject,\n Injectable,\n UnauthorizedException,\n} from '@nestjs/common'\nimport { Reflector } from '@nestjs/core'\nimport { getResolved, hasResolved, requestKey, setResolved } from './context'\nimport type { RbacModuleOptions } from './options'\nimport { MESSAGES, type RbacRequirement, satisfies, UNAUTHENTICATED_MESSAGE } from './requirements'\nimport { RBAC_MODULE_OPTIONS, RBAC_REQUIREMENTS } from './tokens'\n\n/** Handlers already enforced for a request — the guard may run twice (global + `@UseGuards`). */\nconst enforced = new WeakMap<object, Set<unknown>>()\n\n/**\n * Resolves the current subject (once per request) and enforces the `@RequirePermissions()`,\n * `@RequireRoles()` and `@RequireRoleOrPermission()` metadata of the class and the handler.\n *\n * - no subject → `UnauthorizedException` `401 { error: 'UNAUTHENTICATED', message }`\n * - missing access → `ForbiddenException` `403 { error: 'FORBIDDEN', reason, message }`\n *\n * Bodies are identical to `@anievo-id/rbac-evolution-express`.\n */\n@Injectable()\nexport class RbacGuard implements CanActivate {\n // Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.\n constructor(\n @Inject(Reflector) private readonly reflector: Reflector,\n @Inject(RBAC_MODULE_OPTIONS) private readonly options: RbacModuleOptions,\n ) {}\n\n async canActivate(context: ExecutionContext): Promise<boolean> {\n const key = requestKey(context)\n const rbac = await this.resolve(context, key)\n\n const handler = context.getHandler()\n if (key !== undefined) {\n const done = enforced.get(key) ?? new Set<unknown>()\n if (done.has(handler)) return true\n enforced.set(key, done.add(handler))\n }\n\n const requirements = [\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, context.getClass()) ?? []),\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, handler) ?? []),\n ]\n if (requirements.length === 0) return true\n\n if (rbac === null) {\n throw new UnauthorizedException({ error: 'UNAUTHENTICATED', message: UNAUTHENTICATED_MESSAGE })\n }\n\n for (const requirement of requirements) {\n if (!(await satisfies(rbac, requirement))) {\n throw new ForbiddenException({\n error: 'FORBIDDEN',\n reason: requirement.kind,\n message: MESSAGES[requirement.kind],\n ...(this.options.exposeRequirements && { required: requirement.requirements }),\n })\n }\n }\n return true\n }\n\n private async resolve(context: ExecutionContext, key: object | undefined): Promise<SubjectRbac | null> {\n if (key !== undefined && hasResolved(key)) return getResolved(key) ?? null\n\n const { rbac, getSubject, guard, team } = this.options\n const subject = await getSubject(context)\n let result: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(context) : undefined\n result = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n if (key !== undefined) setResolved(key, result)\n return result\n }\n}\n","import { type DynamicModule, Global, Module, type Provider } from '@nestjs/common'\nimport { APP_GUARD } from '@nestjs/core'\nimport { RbacGuard } from './guard'\nimport type { RbacModuleAsyncConfig, RbacModuleConfig, RbacModuleOptions } from './options'\nimport { RBAC, RBAC_MODULE_OPTIONS } from './tokens'\n\nfunction build(optionsProvider: Provider, globalGuard: boolean, imports: DynamicModule['imports'] = []): DynamicModule {\n return {\n module: RbacModule,\n global: true,\n imports,\n providers: [\n optionsProvider,\n { provide: RBAC, useFactory: (options: RbacModuleOptions) => options.rbac, inject: [RBAC_MODULE_OPTIONS] },\n RbacGuard,\n ...(globalGuard ? [{ provide: APP_GUARD, useClass: RbacGuard }] : []),\n ],\n exports: [RBAC_MODULE_OPTIONS, RBAC, RbacGuard],\n }\n}\n\n/**\n * Registers rbac-evolution in a Nest application (global module).\n *\n * ```ts\n * @Module({\n * imports: [\n * RbacModule.forRoot({\n * rbac,\n * getSubject: (ctx) => {\n * const user = ctx.switchToHttp().getRequest().user\n * return user ? { type: 'user', id: user.id } : null\n * },\n * }),\n * ],\n * })\n * export class AppModule {}\n * ```\n */\n@Global()\n@Module({})\nexport class RbacModule {\n static forRoot(config: RbacModuleConfig): DynamicModule {\n const { globalGuard = false, ...options } = config\n return build({ provide: RBAC_MODULE_OPTIONS, useValue: options }, globalGuard)\n }\n\n /** Like {@link forRoot}, with options built by a factory (e.g. from a `ConfigService`). */\n static forRootAsync(config: RbacModuleAsyncConfig): DynamicModule {\n return build(\n { provide: RBAC_MODULE_OPTIONS, useFactory: config.useFactory, inject: config.inject ?? [] },\n config.globalGuard ?? false,\n config.imports ?? [],\n )\n }\n}\n","import 'reflect-metadata'\nimport type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport { applyDecorators, createParamDecorator, type ExecutionContext, UseGuards } from '@nestjs/common'\nimport { getRbac } from './context'\nimport { RbacGuard } from './guard'\nimport {\n type PermissionRequirementOptions,\n permissionRequirement,\n type RbacRequirement,\n type RequirementNames,\n roleOrPermissionRequirement,\n roleRequirement,\n type RoleRequirementOptions,\n} from './requirements'\nimport { RBAC_REQUIREMENTS } from './tokens'\n\ntype ClassOrMethodDecorator = <T>(\n target: object,\n propertyKey?: string | symbol,\n descriptor?: TypedPropertyDescriptor<T>,\n) => void\n\n/** Appends a requirement (stacked decorators all apply), unlike `SetMetadata` which overwrites. */\nfunction appendRequirement(requirement: RbacRequirement): ClassOrMethodDecorator {\n return (target, _propertyKey, descriptor) => {\n const holder: object = descriptor?.value !== undefined ? (descriptor.value as object) : target\n const current = (Reflect.getMetadata(RBAC_REQUIREMENTS, holder) as RbacRequirement[] | undefined) ?? []\n Reflect.defineMetadata(RBAC_REQUIREMENTS, [...current, requirement], holder)\n }\n}\n\nconst requirementDecorator = (requirement: RbacRequirement) =>\n applyDecorators(appendRequirement(requirement), UseGuards(RbacGuard))\n\n/**\n * Requires permissions, like spatie's `permission:` middleware. Works on controllers and handlers.\n *\n * - `@RequirePermissions('edit articles')`\n * - `@RequirePermissions('edit articles|delete articles')` — any of them\n * - `@RequirePermissions('edit articles', 'publish articles')` — all of them\n * - `@RequirePermissions('a', 'b', { any: true })` — any of them\n */\nexport function RequirePermissions(...args: (RequirementNames | PermissionRequirementOptions)[]) {\n return requirementDecorator(permissionRequirement(args))\n}\n\n/**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `@RequireRoles('admin')`, `@RequireRoles('admin|editor')`, `@RequireRoles('admin', 'editor')` — any of them\n * - `@RequireRoles('admin', 'editor', { all: true })` — all of them\n */\nexport function RequireRoles(...args: (RequirementNames | RoleRequirementOptions)[]) {\n return requirementDecorator(roleRequirement(args))\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 */\nexport function RequireRoleOrPermission(...names: RequirementNames[]) {\n return requirementDecorator(roleOrPermissionRequirement(names))\n}\n\n/**\n * Injects the current subject's `SubjectRbac` (`null` for guests), as resolved by `RbacGuard`.\n *\n * ```ts\n * @Get('me/permissions')\n * @UseGuards(RbacGuard)\n * snapshot(@CurrentRbac() rbac: SubjectRbac | null) {\n * return rbac?.snapshot() ?? null\n * }\n * ```\n */\nexport const CurrentRbac: () => ParameterDecorator = createParamDecorator(\n (_data: unknown, context: ExecutionContext): SubjectRbac | null => getRbac(context),\n)\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/context.ts","../src/requirements.ts","../src/tokens.ts","../src/guard.ts","../src/module.ts","../src/decorators.ts"],"names":["RbacGuard","UnauthorizedException","ForbiddenException","Injectable","Reflector","RbacModule","APP_GUARD","Global","Module","applyDecorators","UseGuards","createParamDecorator"],"mappings":";;;;;;;;;;;;;;;;;AAGO,IAAM,qBAAA,GAAN,cAAoC,KAAA,CAAM;AAAA,EACtC,IAAA,GAAO,oBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA;AAAA,MACE;AAAA,KAEF;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAGA,IAAM,QAAA,uBAAe,OAAA,EAAoC;AAMlD,SAAS,WAAW,OAAA,EAA+C;AACxE,EAAA,IAAI,GAAA;AACJ,EAAA,QAAQ,OAAA,CAAQ,SAAgB;AAAG,IACjC,KAAK,MAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,YAAA,EAAa,CAAE,UAAA,EAAW;AACxC,MAAA;AAAA,IACF,KAAK,KAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,WAAA,EAAY,CAAE,UAAA,EAAW;AACvC,MAAA;AAAA,IACF,KAAK,IAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,UAAA,EAAW,CAAE,SAAA,EAAU;AACrC,MAAA;AAAA,IACF;AACE,MAAA,GAAA,GAAM,OAAA,CAAQ,cAAc,CAAC,CAAA;AAAA;AAEjC,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,OAAO,GAAA,GAAM,MAAA;AACzD;AAEO,SAAS,YAAY,GAAA,EAAsB;AAChD,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,YAAY,GAAA,EAA6C;AACvE,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,WAAA,CAAY,KAAa,IAAA,EAAgC;AACvE,EAAA,QAAA,CAAS,GAAA,CAAI,KAAK,IAAI,CAAA;AACxB;AAMO,SAAS,QAAQ,OAAA,EAA+C;AACrE,EAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,EAAA,IAAI,GAAA,KAAQ,UAAa,CAAC,QAAA,CAAS,IAAI,GAAG,CAAA,EAAG,MAAM,IAAI,qBAAA,EAAsB;AAC7E,EAAA,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,IAAK,IAAA;AAC9B;;;ACnCO,IAAM,QAAA,GAA4C;AAAA,EACvD,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEO,IAAM,uBAAA,GAA0B,wBAAA;AAEvC,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,EAAgD;AAChE,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,EAAgG;AACnI,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,EAAyB,SAAS,IAAA,EAAU;AAAA,EAC9E;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAA4B,OAAA,EAAS,MAAA,EAAU;AACjE;AAEA,SAAS,OAAO,WAAA,EAA+C;AAC7D,EAAA,MAAM,EAAE,cAAa,GAAI,WAAA;AACzB,EAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,IAAK,YAAA,CAAa,IAAA,CAAK,CAAC,KAAA,KAAU,KAAA,CAAM,MAAA,KAAW,CAAC,CAAA,EAAG;AACjF,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,WAAA,CAAY,IAAI,CAAA,qCAAA,CAAuC,CAAA;AAAA,EACnG;AACA,EAAA,OAAO,WAAA;AACT;AAGO,SAAS,sBAAsB,IAAA,EAAqF;AACzH,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,YAAA,EAAc,YAAA,EAAc,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,QAAQ,CAAA;AAC5F;AAGO,SAAS,gBAAgB,IAAA,EAA+E;AAC7G,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,EAAA,OAAO,OAAO,EAAE,IAAA,EAAM,QAAQ,YAAA,EAAc,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;AACzF;AAGO,SAAS,4BAA4B,KAAA,EAAqD;AAC/F,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,oBAAA,EAAsB,YAAA,EAAc,CAAC,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAM,CAAA,EAAG,CAAA;AACtF;AAGA,eAAsB,SAAA,CAAU,MAAmB,WAAA,EAAgD;AACjG,EAAA,KAAA,MAAW,KAAA,IAAS,YAAY,YAAA,EAAc;AAC5C,IAAA,IAAI,IAAA;AACJ,IAAA,QAAQ,YAAY,IAAA;AAAM,MACxB,KAAK,YAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA;AAC9B,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA;AAClC,QAAA;AAAA,MACF;AACE,QAAA,IAAA,GAAQ,MAAM,KAAK,UAAA,CAAW,KAAK,KAAO,MAAM,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA;AAErE,IAAA,IAAI,CAAC,MAAM,OAAO,KAAA;AAAA,EACpB;AACA,EAAA,OAAO,IAAA;AACT;;;ACtGO,IAAM,mBAAA,mBAAsB,MAAA,CAAO,GAAA,CAAI,+BAA+B;AAGtE,IAAM,IAAA,mBAAO,MAAA,CAAO,GAAA,CAAI,4BAA4B;AAGpD,IAAM,iBAAA,GAAoB;;;ACSjC,IAAM,QAAA,uBAAe,OAAA,EAA8B;AAOnD,IAAM,SAAA,GAAY,CAAC,OAAA,KAAuC,CAAC,MAAA,EAAQ,KAAK,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,OAAA,EAAiB,CAAA;AAY/FA,oBAAN,eAAA,CAAuC;AAAA;AAAA,EAE5C,WAAA,CACsC,WACU,OAAA,EAC9C;AAFoC,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACU,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AAAA,EAC7C;AAAA,EAFmC,SAAA;AAAA,EACU,OAAA;AAAA,EAGhD,MAAM,YAAY,OAAA,EAA6C;AAC7D,IAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,IAAA,MAAM,OAAA,GAAU,UAAU,OAAO,CAAA;AACjC,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,OAAA,EAAS,KAAK,OAAO,CAAA;AAErD,IAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,EAAW;AACnC,IAAA,IAAI,OAAA,IAAW,GAAA,KAAQ,MAAA,IAAa,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,EAAG,GAAA,CAAI,OAAO,CAAA,EAAG,OAAO,IAAA;AAE5E,IAAA,MAAM,YAAA,GAAe;AAAA,MACnB,GAAI,KAAK,SAAA,CAAU,GAAA,CAAmC,mBAAmB,OAAA,CAAQ,QAAA,EAAU,CAAA,IAAK,EAAC;AAAA,MACjG,GAAI,IAAA,CAAK,SAAA,CAAU,IAAmC,iBAAA,EAAmB,OAAO,KAAK;AAAC,KACxF;AACA,IAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,EAAG,OAAO,IAAA;AAEtC,IAAA,IAAI,SAAS,IAAA,EAAM;AACjB,MAAA,MAAM,IAAIC,4BAAA,CAAsB,EAAE,OAAO,iBAAA,EAAmB,OAAA,EAAS,yBAAyB,CAAA;AAAA,IAChG;AAEA,IAAA,KAAA,MAAW,eAAe,YAAA,EAAc;AACtC,MAAA,IAAI,CAAE,MAAM,SAAA,CAAU,IAAA,EAAM,WAAW,CAAA,EAAI;AACzC,QAAA,MAAM,IAAIC,yBAAA,CAAmB;AAAA,UAC3B,KAAA,EAAO,WAAA;AAAA,UACP,QAAQ,WAAA,CAAY,IAAA;AAAA,UACpB,OAAA,EAAS,QAAA,CAAS,WAAA,CAAY,IAAI,CAAA;AAAA,UAClC,GAAI,IAAA,CAAK,OAAA,CAAQ,sBAAsB,EAAE,QAAA,EAAU,YAAY,YAAA;AAAa,SAC7E,CAAA;AAAA,MACH;AAAA,IACF;AAEA,IAAA,IAAI,OAAA,IAAW,GAAA,KAAQ,MAAA,EAAW,QAAA,CAAS,IAAI,GAAA,EAAA,CAAM,QAAA,CAAS,GAAA,CAAI,GAAG,qBAAK,IAAI,GAAA,EAAa,EAAG,GAAA,CAAI,OAAO,CAAC,CAAA;AAC1G,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEA,MAAc,OAAA,CAAQ,OAAA,EAA2B,GAAA,EAAyB,OAAA,EAA+C;AACvH,IAAA,IAAI,OAAA,IAAW,QAAQ,MAAA,IAAa,WAAA,CAAY,GAAG,CAAA,EAAG,OAAO,WAAA,CAAY,GAAG,CAAA,IAAK,IAAA;AAEjF,IAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,IAAA,KAAS,IAAA,CAAK,OAAA;AAC/C,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,OAAO,CAAA;AACxC,IAAA,IAAI,MAAA,GAA6B,IAAA;AACjC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,OAAO,CAAA,GAAI,MAAA;AAC5C,MAAA,MAAA,GAAS,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACzB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACA,IAAA,IAAI,GAAA,KAAQ,MAAA,EAAW,WAAA,CAAY,GAAA,EAAK,MAAM,CAAA;AAC9C,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAxDaF,iBAAA,GAAN,eAAA,CAAA;AAAA,EADNG,iBAAA,EAAW;AAAA,EAIP,iCAAOC,cAAS,CAAA,CAAA;AAAA,EAChB,iCAAO,mBAAmB,CAAA;AAAA,CAAA,EAJlBJ,iBAAA,CAAA;;;AC7Bb,SAAS,KAAA,CAAM,eAAA,EAA2B,WAAA,EAAsB,OAAA,GAAoC,EAAC,EAAkB;AACrH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQK,kBAAA;AAAA,IACR,MAAA,EAAQ,IAAA;AAAA,IACR,OAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,eAAA;AAAA,MACA,EAAE,OAAA,EAAS,IAAA,EAAM,UAAA,EAAY,CAAC,OAAA,KAA+B,OAAA,CAAQ,IAAA,EAAM,MAAA,EAAQ,CAAC,mBAAmB,CAAA,EAAE;AAAA,MACzGL,iBAAA;AAAA,MACA,GAAI,WAAA,GAAc,CAAC,EAAE,OAAA,EAASM,gBAAW,QAAA,EAAUN,iBAAA,EAAW,CAAA,GAAI;AAAC,KACrE;AAAA,IACA,OAAA,EAAS,CAAC,mBAAA,EAAqB,IAAA,EAAMA,iBAAS;AAAA,GAChD;AACF;AAsBaK,qBAAN,gBAAA,CAAiB;AAAA,EACtB,OAAO,QAAQ,MAAA,EAAyC;AACtD,IAAA,MAAM,EAAE,WAAA,GAAc,KAAA,EAAO,GAAG,SAAQ,GAAI,MAAA;AAC5C,IAAA,OAAO,MAAM,EAAE,OAAA,EAAS,qBAAqB,QAAA,EAAU,OAAA,IAAW,WAAW,CAAA;AAAA,EAC/E;AAAA;AAAA,EAGA,OAAO,aAAa,MAAA,EAA8C;AAChE,IAAA,OAAO,KAAA;AAAA,MACL,EAAE,OAAA,EAAS,mBAAA,EAAqB,UAAA,EAAY,MAAA,CAAO,YAAY,MAAA,EAAQ,MAAA,CAAO,MAAA,IAAU,EAAC,EAAE;AAAA,MAC3F,OAAO,WAAA,IAAe,KAAA;AAAA,MACtB,MAAA,CAAO,WAAW;AAAC,KACrB;AAAA,EACF;AACF;AAdaA,kBAAA,GAAN,eAAA,CAAA;AAAA,EAFNE,aAAA,EAAO;AAAA,EACPC,aAAA,CAAO,EAAE;AAAA,CAAA,EACGH,kBAAA,CAAA;AClBb,SAAS,kBAAkB,WAAA,EAAsD;AAC/E,EAAA,OAAO,CAAC,MAAA,EAAQ,YAAA,EAAc,UAAA,KAAe;AAC3C,IAAA,MAAM,MAAA,GAAiB,UAAA,EAAY,KAAA,KAAU,MAAA,GAAa,WAAW,KAAA,GAAmB,MAAA;AACxF,IAAA,MAAM,UAAW,OAAA,CAAQ,WAAA,CAAY,iBAAA,EAAmB,MAAM,KAAuC,EAAC;AACtG,IAAA,OAAA,CAAQ,eAAe,iBAAA,EAAmB,CAAC,GAAG,OAAA,EAAS,WAAW,GAAG,MAAM,CAAA;AAAA,EAC7E,CAAA;AACF;AAEA,IAAM,oBAAA,GAAuB,CAAC,WAAA,KAC5BI,sBAAA,CAAgB,kBAAkB,WAAW,CAAA,EAAGC,gBAAA,CAAUV,iBAAS,CAAC,CAAA;AAU/D,SAAS,sBAAsB,IAAA,EAA2D;AAC/F,EAAA,OAAO,oBAAA,CAAqB,qBAAA,CAAsB,IAAI,CAAC,CAAA;AACzD;AAQO,SAAS,gBAAgB,IAAA,EAAqD;AACnF,EAAA,OAAO,oBAAA,CAAqB,eAAA,CAAgB,IAAI,CAAC,CAAA;AACnD;AAQO,SAAS,2BAA2B,KAAA,EAA2B;AACpE,EAAA,OAAO,oBAAA,CAAqB,2BAAA,CAA4B,KAAK,CAAC,CAAA;AAChE;AAaO,IAAM,WAAA,GAAwCW,2BAAA;AAAA,EACnD,CAAC,KAAA,EAAgB,OAAA,KAAkD,OAAA,CAAQ,OAAO;AACpF","file":"index.cjs","sourcesContent":["import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { ExecutionContext } from '@nestjs/common'\n\nexport class RbacGuardMissingError extends Error {\n readonly code = 'RBAC_GUARD_MISSING'\n\n constructor() {\n super(\n '`@CurrentRbac()` was used but `RbacGuard` did not run for this route. Add a `@Require*()` decorator, ' +\n '`@UseGuards(RbacGuard)`, or `RbacModule.forRoot({ globalGuard: true })`.',\n )\n this.name = 'RbacGuardMissingError'\n }\n}\n\n/** Per-request resolved `SubjectRbac` (`null` for guests), keyed by the request/client/context object. */\nconst resolved = new WeakMap<object, SubjectRbac | null>()\n\n/**\n * The object that identifies the current request: the HTTP request, the RPC context, the WebSocket client,\n * or (for GraphQL and other context types) the third handler argument.\n */\nexport function requestKey(context: ExecutionContext): object | undefined {\n let key: unknown\n switch (context.getType<string>()) {\n case 'http':\n key = context.switchToHttp().getRequest()\n break\n case 'rpc':\n key = context.switchToRpc().getContext()\n break\n case 'ws':\n key = context.switchToWs().getClient()\n break\n default:\n key = context.getArgByIndex(2)\n }\n return typeof key === 'object' && key !== null ? key : undefined\n}\n\nexport function hasResolved(key: object): boolean {\n return resolved.has(key)\n}\n\nexport function getResolved(key: object): SubjectRbac | null | undefined {\n return resolved.get(key)\n}\n\nexport function setResolved(key: object, rbac: SubjectRbac | null): void {\n resolved.set(key, rbac)\n}\n\n/**\n * Returns the `SubjectRbac` that `RbacGuard` resolved for this execution context (`null` for guests).\n * Throws {@link RbacGuardMissingError} when the guard has not run.\n */\nexport function getRbac(context: ExecutionContext): SubjectRbac | null {\n const key = requestKey(context)\n if (key === undefined || !resolved.has(key)) throw new RbacGuardMissingError()\n return resolved.get(key) ?? null\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\n\n/** Which kind of requirement failed — same values as the Express package. */\nexport type RequirementKind = 'permission' | 'role' | 'role_or_permission'\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type RequirementNames = string | readonly string[]\n\n/** One `@Require*` decorator, normalized. */\nexport interface RbacRequirement {\n kind: RequirementKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\nexport interface PermissionRequirementOptions {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleRequirementOptions {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport const MESSAGES: Record<RequirementKind, 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\nexport const UNAUTHENTICATED_MESSAGE = 'User is not logged in.'\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 RequirementNames[]): 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 (RequirementNames | O)[]): { names: RequirementNames[]; 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 RequirementNames[], options: last as O }\n }\n return { names: args as RequirementNames[], options: undefined }\n}\n\nfunction ensure(requirement: RbacRequirement): RbacRequirement {\n const { requirements } = requirement\n if (requirements.length === 0 || requirements.some((group) => group.length === 0)) {\n throw new TypeError(`[rbac-evolution] A ${requirement.kind} requirement needs at least one name.`)\n }\n return requirement\n}\n\n/** `'a', 'b'` = all; `'a|b'` = any; `{ any: true }` = any of everything. */\nexport function permissionRequirement(args: readonly (RequirementNames | PermissionRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<PermissionRequirementOptions>(args)\n const groups = toGroups(names)\n return ensure({ kind: 'permission', requirements: options.any ? [groups.flat()] : groups })\n}\n\n/** Any of the roles by default; `{ all: true }` = all of them. */\nexport function roleRequirement(args: readonly (RequirementNames | RoleRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<RoleRequirementOptions>(args)\n const all = toGroups(names).flat()\n return ensure({ kind: 'role', requirements: options.all ? all.map((r) => [r]) : [all] })\n}\n\n/** Any of the names, as a role OR as a permission. */\nexport function roleOrPermissionRequirement(names: readonly RequirementNames[]): RbacRequirement {\n return ensure({ kind: 'role_or_permission', requirements: [toGroups(names).flat()] })\n}\n\n/** `true` when every group of the requirement passes for the subject. */\nexport async function satisfies(rbac: SubjectRbac, requirement: RbacRequirement): Promise<boolean> {\n for (const group of requirement.requirements) {\n let pass: boolean\n switch (requirement.kind) {\n case 'permission':\n pass = await rbac.canAny(group)\n break\n case 'role':\n pass = await rbac.hasAnyRole(group)\n break\n default:\n pass = (await rbac.hasAnyRole(group)) || (await rbac.canAny(group))\n }\n if (!pass) return false\n }\n return true\n}\n","/** Injection token for the resolved {@link RbacModuleOptions}. */\nexport const RBAC_MODULE_OPTIONS = Symbol.for('rbac-evolution:nestjs:options')\n\n/** Injection token for the `Rbac` engine passed to `RbacModule.forRoot({ rbac })`. */\nexport const RBAC = Symbol.for('rbac-evolution:nestjs:rbac')\n\n/** Metadata key under which `@Require*` decorators store their requirements. */\nexport const RBAC_REQUIREMENTS = 'rbac-evolution:requirements'\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport {\n type CanActivate,\n type ExecutionContext,\n ForbiddenException,\n Inject,\n Injectable,\n UnauthorizedException,\n} from '@nestjs/common'\nimport { Reflector } from '@nestjs/core'\nimport { getResolved, hasResolved, requestKey, setResolved } from './context'\nimport type { RbacModuleOptions } from './options'\nimport { MESSAGES, type RbacRequirement, satisfies, UNAUTHENTICATED_MESSAGE } from './requirements'\nimport { RBAC_MODULE_OPTIONS, RBAC_REQUIREMENTS } from './tokens'\n\n/** Handlers already enforced for a request — the guard may run twice (global + `@UseGuards`). */\nconst enforced = new WeakMap<object, Set<unknown>>()\n\n/**\n * Only HTTP requests and RPC messages get a fresh key object per call. A WebSocket client or a\n * GraphQL context lives across many calls, so caching or skipping checks by it would let a denied\n * client through on its next message.\n */\nconst isPerCall = (context: ExecutionContext): boolean => ['http', 'rpc'].includes(context.getType<string>())\n\n/**\n * Resolves the current subject (once per request) and enforces the `@RequirePermissions()`,\n * `@RequireRoles()` and `@RequireRoleOrPermission()` metadata of the class and the handler.\n *\n * - no subject → `UnauthorizedException` `401 { error: 'UNAUTHENTICATED', message }`\n * - missing access → `ForbiddenException` `403 { error: 'FORBIDDEN', reason, message }`\n *\n * Bodies are identical to `@anievo-id/rbac-evolution-express`.\n */\n@Injectable()\nexport class RbacGuard implements CanActivate {\n // Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.\n constructor(\n @Inject(Reflector) private readonly reflector: Reflector,\n @Inject(RBAC_MODULE_OPTIONS) private readonly options: RbacModuleOptions,\n ) {}\n\n async canActivate(context: ExecutionContext): Promise<boolean> {\n const key = requestKey(context)\n const perCall = isPerCall(context)\n const rbac = await this.resolve(context, key, perCall)\n\n const handler = context.getHandler()\n if (perCall && key !== undefined && enforced.get(key)?.has(handler)) return true\n\n const requirements = [\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, context.getClass()) ?? []),\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, handler) ?? []),\n ]\n if (requirements.length === 0) return true\n\n if (rbac === null) {\n throw new UnauthorizedException({ error: 'UNAUTHENTICATED', message: UNAUTHENTICATED_MESSAGE })\n }\n\n for (const requirement of requirements) {\n if (!(await satisfies(rbac, requirement))) {\n throw new ForbiddenException({\n error: 'FORBIDDEN',\n reason: requirement.kind,\n message: MESSAGES[requirement.kind],\n ...(this.options.exposeRequirements && { required: requirement.requirements }),\n })\n }\n }\n // Mark as enforced only once every requirement passed.\n if (perCall && key !== undefined) enforced.set(key, (enforced.get(key) ?? new Set<unknown>()).add(handler))\n return true\n }\n\n private async resolve(context: ExecutionContext, key: object | undefined, perCall: boolean): Promise<SubjectRbac | null> {\n if (perCall && key !== undefined && hasResolved(key)) return getResolved(key) ?? null\n\n const { rbac, getSubject, guard, team } = this.options\n const subject = await getSubject(context)\n let result: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(context) : undefined\n result = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n if (key !== undefined) setResolved(key, result)\n return result\n }\n}\n","import { type DynamicModule, Global, Module, type Provider } from '@nestjs/common'\nimport { APP_GUARD } from '@nestjs/core'\nimport { RbacGuard } from './guard'\nimport type { RbacModuleAsyncConfig, RbacModuleConfig, RbacModuleOptions } from './options'\nimport { RBAC, RBAC_MODULE_OPTIONS } from './tokens'\n\nfunction build(optionsProvider: Provider, globalGuard: boolean, imports: DynamicModule['imports'] = []): DynamicModule {\n return {\n module: RbacModule,\n global: true,\n imports,\n providers: [\n optionsProvider,\n { provide: RBAC, useFactory: (options: RbacModuleOptions) => options.rbac, inject: [RBAC_MODULE_OPTIONS] },\n RbacGuard,\n ...(globalGuard ? [{ provide: APP_GUARD, useClass: RbacGuard }] : []),\n ],\n exports: [RBAC_MODULE_OPTIONS, RBAC, RbacGuard],\n }\n}\n\n/**\n * Registers rbac-evolution in a Nest application (global module).\n *\n * ```ts\n * @Module({\n * imports: [\n * RbacModule.forRoot({\n * rbac,\n * getSubject: (ctx) => {\n * const user = ctx.switchToHttp().getRequest().user\n * return user ? { type: 'user', id: user.id } : null\n * },\n * }),\n * ],\n * })\n * export class AppModule {}\n * ```\n */\n@Global()\n@Module({})\nexport class RbacModule {\n static forRoot(config: RbacModuleConfig): DynamicModule {\n const { globalGuard = false, ...options } = config\n return build({ provide: RBAC_MODULE_OPTIONS, useValue: options }, globalGuard)\n }\n\n /** Like {@link forRoot}, with options built by a factory (e.g. from a `ConfigService`). */\n static forRootAsync(config: RbacModuleAsyncConfig): DynamicModule {\n return build(\n { provide: RBAC_MODULE_OPTIONS, useFactory: config.useFactory, inject: config.inject ?? [] },\n config.globalGuard ?? false,\n config.imports ?? [],\n )\n }\n}\n","import 'reflect-metadata'\nimport type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport { applyDecorators, createParamDecorator, type ExecutionContext, UseGuards } from '@nestjs/common'\nimport { getRbac } from './context'\nimport { RbacGuard } from './guard'\nimport {\n type PermissionRequirementOptions,\n permissionRequirement,\n type RbacRequirement,\n type RequirementNames,\n roleOrPermissionRequirement,\n roleRequirement,\n type RoleRequirementOptions,\n} from './requirements'\nimport { RBAC_REQUIREMENTS } from './tokens'\n\ntype ClassOrMethodDecorator = <T>(\n target: object,\n propertyKey?: string | symbol,\n descriptor?: TypedPropertyDescriptor<T>,\n) => void\n\n/** Appends a requirement (stacked decorators all apply), unlike `SetMetadata` which overwrites. */\nfunction appendRequirement(requirement: RbacRequirement): ClassOrMethodDecorator {\n return (target, _propertyKey, descriptor) => {\n const holder: object = descriptor?.value !== undefined ? (descriptor.value as object) : target\n const current = (Reflect.getMetadata(RBAC_REQUIREMENTS, holder) as RbacRequirement[] | undefined) ?? []\n Reflect.defineMetadata(RBAC_REQUIREMENTS, [...current, requirement], holder)\n }\n}\n\nconst requirementDecorator = (requirement: RbacRequirement) =>\n applyDecorators(appendRequirement(requirement), UseGuards(RbacGuard))\n\n/**\n * Requires permissions, like spatie's `permission:` middleware. Works on controllers and handlers.\n *\n * - `@RequirePermissions('edit articles')`\n * - `@RequirePermissions('edit articles|delete articles')` — any of them\n * - `@RequirePermissions('edit articles', 'publish articles')` — all of them\n * - `@RequirePermissions('a', 'b', { any: true })` — any of them\n */\nexport function RequirePermissions(...args: (RequirementNames | PermissionRequirementOptions)[]) {\n return requirementDecorator(permissionRequirement(args))\n}\n\n/**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `@RequireRoles('admin')`, `@RequireRoles('admin|editor')`, `@RequireRoles('admin', 'editor')` — any of them\n * - `@RequireRoles('admin', 'editor', { all: true })` — all of them\n */\nexport function RequireRoles(...args: (RequirementNames | RoleRequirementOptions)[]) {\n return requirementDecorator(roleRequirement(args))\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 */\nexport function RequireRoleOrPermission(...names: RequirementNames[]) {\n return requirementDecorator(roleOrPermissionRequirement(names))\n}\n\n/**\n * Injects the current subject's `SubjectRbac` (`null` for guests), as resolved by `RbacGuard`.\n *\n * ```ts\n * @Get('me/permissions')\n * @UseGuards(RbacGuard)\n * snapshot(@CurrentRbac() rbac: SubjectRbac | null) {\n * return rbac?.snapshot() ?? null\n * }\n * ```\n */\nexport const CurrentRbac: () => ParameterDecorator = createParamDecorator(\n (_data: unknown, context: ExecutionContext): SubjectRbac | null => getRbac(context),\n)\n"]}
|
package/dist/index.js
CHANGED
|
@@ -125,6 +125,7 @@ var RBAC_REQUIREMENTS = "rbac-evolution:requirements";
|
|
|
125
125
|
|
|
126
126
|
// src/guard.ts
|
|
127
127
|
var enforced = /* @__PURE__ */ new WeakMap();
|
|
128
|
+
var isPerCall = (context) => ["http", "rpc"].includes(context.getType());
|
|
128
129
|
var RbacGuard = class {
|
|
129
130
|
// Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.
|
|
130
131
|
constructor(reflector, options) {
|
|
@@ -135,13 +136,10 @@ var RbacGuard = class {
|
|
|
135
136
|
options;
|
|
136
137
|
async canActivate(context) {
|
|
137
138
|
const key = requestKey(context);
|
|
138
|
-
const
|
|
139
|
+
const perCall = isPerCall(context);
|
|
140
|
+
const rbac = await this.resolve(context, key, perCall);
|
|
139
141
|
const handler = context.getHandler();
|
|
140
|
-
if (key !== void 0)
|
|
141
|
-
const done = enforced.get(key) ?? /* @__PURE__ */ new Set();
|
|
142
|
-
if (done.has(handler)) return true;
|
|
143
|
-
enforced.set(key, done.add(handler));
|
|
144
|
-
}
|
|
142
|
+
if (perCall && key !== void 0 && enforced.get(key)?.has(handler)) return true;
|
|
145
143
|
const requirements = [
|
|
146
144
|
...this.reflector.get(RBAC_REQUIREMENTS, context.getClass()) ?? [],
|
|
147
145
|
...this.reflector.get(RBAC_REQUIREMENTS, handler) ?? []
|
|
@@ -160,10 +158,11 @@ var RbacGuard = class {
|
|
|
160
158
|
});
|
|
161
159
|
}
|
|
162
160
|
}
|
|
161
|
+
if (perCall && key !== void 0) enforced.set(key, (enforced.get(key) ?? /* @__PURE__ */ new Set()).add(handler));
|
|
163
162
|
return true;
|
|
164
163
|
}
|
|
165
|
-
async resolve(context, key) {
|
|
166
|
-
if (key !== void 0 && hasResolved(key)) return getResolved(key) ?? null;
|
|
164
|
+
async resolve(context, key, perCall) {
|
|
165
|
+
if (perCall && key !== void 0 && hasResolved(key)) return getResolved(key) ?? null;
|
|
167
166
|
const { rbac, getSubject, guard, team } = this.options;
|
|
168
167
|
const subject = await getSubject(context);
|
|
169
168
|
let result = null;
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/context.ts","../src/requirements.ts","../src/tokens.ts","../src/guard.ts","../src/module.ts","../src/decorators.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGO,IAAM,qBAAA,GAAN,cAAoC,KAAA,CAAM;AAAA,EACtC,IAAA,GAAO,oBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA;AAAA,MACE;AAAA,KAEF;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAGA,IAAM,QAAA,uBAAe,OAAA,EAAoC;AAMlD,SAAS,WAAW,OAAA,EAA+C;AACxE,EAAA,IAAI,GAAA;AACJ,EAAA,QAAQ,OAAA,CAAQ,SAAgB;AAAG,IACjC,KAAK,MAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,YAAA,EAAa,CAAE,UAAA,EAAW;AACxC,MAAA;AAAA,IACF,KAAK,KAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,WAAA,EAAY,CAAE,UAAA,EAAW;AACvC,MAAA;AAAA,IACF,KAAK,IAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,UAAA,EAAW,CAAE,SAAA,EAAU;AACrC,MAAA;AAAA,IACF;AACE,MAAA,GAAA,GAAM,OAAA,CAAQ,cAAc,CAAC,CAAA;AAAA;AAEjC,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,OAAO,GAAA,GAAM,MAAA;AACzD;AAEO,SAAS,YAAY,GAAA,EAAsB;AAChD,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,YAAY,GAAA,EAA6C;AACvE,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,WAAA,CAAY,KAAa,IAAA,EAAgC;AACvE,EAAA,QAAA,CAAS,GAAA,CAAI,KAAK,IAAI,CAAA;AACxB;AAMO,SAAS,QAAQ,OAAA,EAA+C;AACrE,EAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,EAAA,IAAI,GAAA,KAAQ,UAAa,CAAC,QAAA,CAAS,IAAI,GAAG,CAAA,EAAG,MAAM,IAAI,qBAAA,EAAsB;AAC7E,EAAA,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,IAAK,IAAA;AAC9B;;;ACnCO,IAAM,QAAA,GAA4C;AAAA,EACvD,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEO,IAAM,uBAAA,GAA0B,wBAAA;AAEvC,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,EAAgD;AAChE,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,EAAgG;AACnI,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,EAAyB,SAAS,IAAA,EAAU;AAAA,EAC9E;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAA4B,OAAA,EAAS,MAAA,EAAU;AACjE;AAEA,SAAS,OAAO,WAAA,EAA+C;AAC7D,EAAA,MAAM,EAAE,cAAa,GAAI,WAAA;AACzB,EAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,IAAK,YAAA,CAAa,IAAA,CAAK,CAAC,KAAA,KAAU,KAAA,CAAM,MAAA,KAAW,CAAC,CAAA,EAAG;AACjF,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,WAAA,CAAY,IAAI,CAAA,qCAAA,CAAuC,CAAA;AAAA,EACnG;AACA,EAAA,OAAO,WAAA;AACT;AAGO,SAAS,sBAAsB,IAAA,EAAqF;AACzH,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,YAAA,EAAc,YAAA,EAAc,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,QAAQ,CAAA;AAC5F;AAGO,SAAS,gBAAgB,IAAA,EAA+E;AAC7G,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,EAAA,OAAO,OAAO,EAAE,IAAA,EAAM,QAAQ,YAAA,EAAc,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;AACzF;AAGO,SAAS,4BAA4B,KAAA,EAAqD;AAC/F,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,oBAAA,EAAsB,YAAA,EAAc,CAAC,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAM,CAAA,EAAG,CAAA;AACtF;AAGA,eAAsB,SAAA,CAAU,MAAmB,WAAA,EAAgD;AACjG,EAAA,KAAA,MAAW,KAAA,IAAS,YAAY,YAAA,EAAc;AAC5C,IAAA,IAAI,IAAA;AACJ,IAAA,QAAQ,YAAY,IAAA;AAAM,MACxB,KAAK,YAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA;AAC9B,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA;AAClC,QAAA;AAAA,MACF;AACE,QAAA,IAAA,GAAQ,MAAM,KAAK,UAAA,CAAW,KAAK,KAAO,MAAM,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA;AAErE,IAAA,IAAI,CAAC,MAAM,OAAO,KAAA;AAAA,EACpB;AACA,EAAA,OAAO,IAAA;AACT;;;ACtGO,IAAM,mBAAA,mBAAsB,MAAA,CAAO,GAAA,CAAI,+BAA+B;AAGtE,IAAM,IAAA,mBAAO,MAAA,CAAO,GAAA,CAAI,4BAA4B;AAGpD,IAAM,iBAAA,GAAoB;;;ACSjC,IAAM,QAAA,uBAAe,OAAA,EAA8B;AAY5C,IAAM,YAAN,MAAuC;AAAA;AAAA,EAE5C,WAAA,CACsC,WACU,OAAA,EAC9C;AAFoC,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACU,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AAAA,EAC7C;AAAA,EAFmC,SAAA;AAAA,EACU,OAAA;AAAA,EAGhD,MAAM,YAAY,OAAA,EAA6C;AAC7D,IAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,SAAS,GAAG,CAAA;AAE5C,IAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,EAAW;AACnC,IAAA,IAAI,QAAQ,MAAA,EAAW;AACrB,MAAA,MAAM,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,wBAAS,GAAA,EAAa;AACnD,MAAA,IAAI,IAAA,CAAK,GAAA,CAAI,OAAO,CAAA,EAAG,OAAO,IAAA;AAC9B,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,EAAK,IAAA,CAAK,GAAA,CAAI,OAAO,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,YAAA,GAAe;AAAA,MACnB,GAAI,KAAK,SAAA,CAAU,GAAA,CAAmC,mBAAmB,OAAA,CAAQ,QAAA,EAAU,CAAA,IAAK,EAAC;AAAA,MACjG,GAAI,IAAA,CAAK,SAAA,CAAU,IAAmC,iBAAA,EAAmB,OAAO,KAAK;AAAC,KACxF;AACA,IAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,EAAG,OAAO,IAAA;AAEtC,IAAA,IAAI,SAAS,IAAA,EAAM;AACjB,MAAA,MAAM,IAAI,qBAAA,CAAsB,EAAE,OAAO,iBAAA,EAAmB,OAAA,EAAS,yBAAyB,CAAA;AAAA,IAChG;AAEA,IAAA,KAAA,MAAW,eAAe,YAAA,EAAc;AACtC,MAAA,IAAI,CAAE,MAAM,SAAA,CAAU,IAAA,EAAM,WAAW,CAAA,EAAI;AACzC,QAAA,MAAM,IAAI,kBAAA,CAAmB;AAAA,UAC3B,KAAA,EAAO,WAAA;AAAA,UACP,QAAQ,WAAA,CAAY,IAAA;AAAA,UACpB,OAAA,EAAS,QAAA,CAAS,WAAA,CAAY,IAAI,CAAA;AAAA,UAClC,GAAI,IAAA,CAAK,OAAA,CAAQ,sBAAsB,EAAE,QAAA,EAAU,YAAY,YAAA;AAAa,SAC7E,CAAA;AAAA,MACH;AAAA,IACF;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEA,MAAc,OAAA,CAAQ,OAAA,EAA2B,GAAA,EAAsD;AACrG,IAAA,IAAI,GAAA,KAAQ,UAAa,WAAA,CAAY,GAAG,GAAG,OAAO,WAAA,CAAY,GAAG,CAAA,IAAK,IAAA;AAEtE,IAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,IAAA,KAAS,IAAA,CAAK,OAAA;AAC/C,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,OAAO,CAAA;AACxC,IAAA,IAAI,MAAA,GAA6B,IAAA;AACjC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,OAAO,CAAA,GAAI,MAAA;AAC5C,MAAA,MAAA,GAAS,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACzB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACA,IAAA,IAAI,GAAA,KAAQ,MAAA,EAAW,WAAA,CAAY,GAAA,EAAK,MAAM,CAAA;AAC9C,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAzDa,SAAA,GAAN,eAAA,CAAA;AAAA,EADN,UAAA,EAAW;AAAA,EAIP,0BAAO,SAAS,CAAA,CAAA;AAAA,EAChB,0BAAO,mBAAmB,CAAA;AAAA,CAAA,EAJlB,SAAA,CAAA;;;ACtBb,SAAS,KAAA,CAAM,eAAA,EAA2B,WAAA,EAAsB,OAAA,GAAoC,EAAC,EAAkB;AACrH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,UAAA;AAAA,IACR,MAAA,EAAQ,IAAA;AAAA,IACR,OAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,eAAA;AAAA,MACA,EAAE,OAAA,EAAS,IAAA,EAAM,UAAA,EAAY,CAAC,OAAA,KAA+B,OAAA,CAAQ,IAAA,EAAM,MAAA,EAAQ,CAAC,mBAAmB,CAAA,EAAE;AAAA,MACzG,SAAA;AAAA,MACA,GAAI,WAAA,GAAc,CAAC,EAAE,OAAA,EAAS,WAAW,QAAA,EAAU,SAAA,EAAW,CAAA,GAAI;AAAC,KACrE;AAAA,IACA,OAAA,EAAS,CAAC,mBAAA,EAAqB,IAAA,EAAM,SAAS;AAAA,GAChD;AACF;AAsBO,IAAM,aAAN,MAAiB;AAAA,EACtB,OAAO,QAAQ,MAAA,EAAyC;AACtD,IAAA,MAAM,EAAE,WAAA,GAAc,KAAA,EAAO,GAAG,SAAQ,GAAI,MAAA;AAC5C,IAAA,OAAO,MAAM,EAAE,OAAA,EAAS,qBAAqB,QAAA,EAAU,OAAA,IAAW,WAAW,CAAA;AAAA,EAC/E;AAAA;AAAA,EAGA,OAAO,aAAa,MAAA,EAA8C;AAChE,IAAA,OAAO,KAAA;AAAA,MACL,EAAE,OAAA,EAAS,mBAAA,EAAqB,UAAA,EAAY,MAAA,CAAO,YAAY,MAAA,EAAQ,MAAA,CAAO,MAAA,IAAU,EAAC,EAAE;AAAA,MAC3F,OAAO,WAAA,IAAe,KAAA;AAAA,MACtB,MAAA,CAAO,WAAW;AAAC,KACrB;AAAA,EACF;AACF;AAda,UAAA,GAAN,eAAA,CAAA;AAAA,EAFN,MAAA,EAAO;AAAA,EACP,MAAA,CAAO,EAAE;AAAA,CAAA,EACG,UAAA,CAAA;AClBb,SAAS,kBAAkB,WAAA,EAAsD;AAC/E,EAAA,OAAO,CAAC,MAAA,EAAQ,YAAA,EAAc,UAAA,KAAe;AAC3C,IAAA,MAAM,MAAA,GAAiB,UAAA,EAAY,KAAA,KAAU,MAAA,GAAa,WAAW,KAAA,GAAmB,MAAA;AACxF,IAAA,MAAM,UAAW,OAAA,CAAQ,WAAA,CAAY,iBAAA,EAAmB,MAAM,KAAuC,EAAC;AACtG,IAAA,OAAA,CAAQ,eAAe,iBAAA,EAAmB,CAAC,GAAG,OAAA,EAAS,WAAW,GAAG,MAAM,CAAA;AAAA,EAC7E,CAAA;AACF;AAEA,IAAM,oBAAA,GAAuB,CAAC,WAAA,KAC5B,eAAA,CAAgB,kBAAkB,WAAW,CAAA,EAAG,SAAA,CAAU,SAAS,CAAC,CAAA;AAU/D,SAAS,sBAAsB,IAAA,EAA2D;AAC/F,EAAA,OAAO,oBAAA,CAAqB,qBAAA,CAAsB,IAAI,CAAC,CAAA;AACzD;AAQO,SAAS,gBAAgB,IAAA,EAAqD;AACnF,EAAA,OAAO,oBAAA,CAAqB,eAAA,CAAgB,IAAI,CAAC,CAAA;AACnD;AAQO,SAAS,2BAA2B,KAAA,EAA2B;AACpE,EAAA,OAAO,oBAAA,CAAqB,2BAAA,CAA4B,KAAK,CAAC,CAAA;AAChE;AAaO,IAAM,WAAA,GAAwC,oBAAA;AAAA,EACnD,CAAC,KAAA,EAAgB,OAAA,KAAkD,OAAA,CAAQ,OAAO;AACpF","file":"index.js","sourcesContent":["import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { ExecutionContext } from '@nestjs/common'\n\nexport class RbacGuardMissingError extends Error {\n readonly code = 'RBAC_GUARD_MISSING'\n\n constructor() {\n super(\n '`@CurrentRbac()` was used but `RbacGuard` did not run for this route. Add a `@Require*()` decorator, ' +\n '`@UseGuards(RbacGuard)`, or `RbacModule.forRoot({ globalGuard: true })`.',\n )\n this.name = 'RbacGuardMissingError'\n }\n}\n\n/** Per-request resolved `SubjectRbac` (`null` for guests), keyed by the request/client/context object. */\nconst resolved = new WeakMap<object, SubjectRbac | null>()\n\n/**\n * The object that identifies the current request: the HTTP request, the RPC context, the WebSocket client,\n * or (for GraphQL and other context types) the third handler argument.\n */\nexport function requestKey(context: ExecutionContext): object | undefined {\n let key: unknown\n switch (context.getType<string>()) {\n case 'http':\n key = context.switchToHttp().getRequest()\n break\n case 'rpc':\n key = context.switchToRpc().getContext()\n break\n case 'ws':\n key = context.switchToWs().getClient()\n break\n default:\n key = context.getArgByIndex(2)\n }\n return typeof key === 'object' && key !== null ? key : undefined\n}\n\nexport function hasResolved(key: object): boolean {\n return resolved.has(key)\n}\n\nexport function getResolved(key: object): SubjectRbac | null | undefined {\n return resolved.get(key)\n}\n\nexport function setResolved(key: object, rbac: SubjectRbac | null): void {\n resolved.set(key, rbac)\n}\n\n/**\n * Returns the `SubjectRbac` that `RbacGuard` resolved for this execution context (`null` for guests).\n * Throws {@link RbacGuardMissingError} when the guard has not run.\n */\nexport function getRbac(context: ExecutionContext): SubjectRbac | null {\n const key = requestKey(context)\n if (key === undefined || !resolved.has(key)) throw new RbacGuardMissingError()\n return resolved.get(key) ?? null\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\n\n/** Which kind of requirement failed — same values as the Express package. */\nexport type RequirementKind = 'permission' | 'role' | 'role_or_permission'\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type RequirementNames = string | readonly string[]\n\n/** One `@Require*` decorator, normalized. */\nexport interface RbacRequirement {\n kind: RequirementKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\nexport interface PermissionRequirementOptions {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleRequirementOptions {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport const MESSAGES: Record<RequirementKind, 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\nexport const UNAUTHENTICATED_MESSAGE = 'User is not logged in.'\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 RequirementNames[]): 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 (RequirementNames | O)[]): { names: RequirementNames[]; 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 RequirementNames[], options: last as O }\n }\n return { names: args as RequirementNames[], options: undefined }\n}\n\nfunction ensure(requirement: RbacRequirement): RbacRequirement {\n const { requirements } = requirement\n if (requirements.length === 0 || requirements.some((group) => group.length === 0)) {\n throw new TypeError(`[rbac-evolution] A ${requirement.kind} requirement needs at least one name.`)\n }\n return requirement\n}\n\n/** `'a', 'b'` = all; `'a|b'` = any; `{ any: true }` = any of everything. */\nexport function permissionRequirement(args: readonly (RequirementNames | PermissionRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<PermissionRequirementOptions>(args)\n const groups = toGroups(names)\n return ensure({ kind: 'permission', requirements: options.any ? [groups.flat()] : groups })\n}\n\n/** Any of the roles by default; `{ all: true }` = all of them. */\nexport function roleRequirement(args: readonly (RequirementNames | RoleRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<RoleRequirementOptions>(args)\n const all = toGroups(names).flat()\n return ensure({ kind: 'role', requirements: options.all ? all.map((r) => [r]) : [all] })\n}\n\n/** Any of the names, as a role OR as a permission. */\nexport function roleOrPermissionRequirement(names: readonly RequirementNames[]): RbacRequirement {\n return ensure({ kind: 'role_or_permission', requirements: [toGroups(names).flat()] })\n}\n\n/** `true` when every group of the requirement passes for the subject. */\nexport async function satisfies(rbac: SubjectRbac, requirement: RbacRequirement): Promise<boolean> {\n for (const group of requirement.requirements) {\n let pass: boolean\n switch (requirement.kind) {\n case 'permission':\n pass = await rbac.canAny(group)\n break\n case 'role':\n pass = await rbac.hasAnyRole(group)\n break\n default:\n pass = (await rbac.hasAnyRole(group)) || (await rbac.canAny(group))\n }\n if (!pass) return false\n }\n return true\n}\n","/** Injection token for the resolved {@link RbacModuleOptions}. */\nexport const RBAC_MODULE_OPTIONS = Symbol.for('rbac-evolution:nestjs:options')\n\n/** Injection token for the `Rbac` engine passed to `RbacModule.forRoot({ rbac })`. */\nexport const RBAC = Symbol.for('rbac-evolution:nestjs:rbac')\n\n/** Metadata key under which `@Require*` decorators store their requirements. */\nexport const RBAC_REQUIREMENTS = 'rbac-evolution:requirements'\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport {\n type CanActivate,\n type ExecutionContext,\n ForbiddenException,\n Inject,\n Injectable,\n UnauthorizedException,\n} from '@nestjs/common'\nimport { Reflector } from '@nestjs/core'\nimport { getResolved, hasResolved, requestKey, setResolved } from './context'\nimport type { RbacModuleOptions } from './options'\nimport { MESSAGES, type RbacRequirement, satisfies, UNAUTHENTICATED_MESSAGE } from './requirements'\nimport { RBAC_MODULE_OPTIONS, RBAC_REQUIREMENTS } from './tokens'\n\n/** Handlers already enforced for a request — the guard may run twice (global + `@UseGuards`). */\nconst enforced = new WeakMap<object, Set<unknown>>()\n\n/**\n * Resolves the current subject (once per request) and enforces the `@RequirePermissions()`,\n * `@RequireRoles()` and `@RequireRoleOrPermission()` metadata of the class and the handler.\n *\n * - no subject → `UnauthorizedException` `401 { error: 'UNAUTHENTICATED', message }`\n * - missing access → `ForbiddenException` `403 { error: 'FORBIDDEN', reason, message }`\n *\n * Bodies are identical to `@anievo-id/rbac-evolution-express`.\n */\n@Injectable()\nexport class RbacGuard implements CanActivate {\n // Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.\n constructor(\n @Inject(Reflector) private readonly reflector: Reflector,\n @Inject(RBAC_MODULE_OPTIONS) private readonly options: RbacModuleOptions,\n ) {}\n\n async canActivate(context: ExecutionContext): Promise<boolean> {\n const key = requestKey(context)\n const rbac = await this.resolve(context, key)\n\n const handler = context.getHandler()\n if (key !== undefined) {\n const done = enforced.get(key) ?? new Set<unknown>()\n if (done.has(handler)) return true\n enforced.set(key, done.add(handler))\n }\n\n const requirements = [\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, context.getClass()) ?? []),\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, handler) ?? []),\n ]\n if (requirements.length === 0) return true\n\n if (rbac === null) {\n throw new UnauthorizedException({ error: 'UNAUTHENTICATED', message: UNAUTHENTICATED_MESSAGE })\n }\n\n for (const requirement of requirements) {\n if (!(await satisfies(rbac, requirement))) {\n throw new ForbiddenException({\n error: 'FORBIDDEN',\n reason: requirement.kind,\n message: MESSAGES[requirement.kind],\n ...(this.options.exposeRequirements && { required: requirement.requirements }),\n })\n }\n }\n return true\n }\n\n private async resolve(context: ExecutionContext, key: object | undefined): Promise<SubjectRbac | null> {\n if (key !== undefined && hasResolved(key)) return getResolved(key) ?? null\n\n const { rbac, getSubject, guard, team } = this.options\n const subject = await getSubject(context)\n let result: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(context) : undefined\n result = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n if (key !== undefined) setResolved(key, result)\n return result\n }\n}\n","import { type DynamicModule, Global, Module, type Provider } from '@nestjs/common'\nimport { APP_GUARD } from '@nestjs/core'\nimport { RbacGuard } from './guard'\nimport type { RbacModuleAsyncConfig, RbacModuleConfig, RbacModuleOptions } from './options'\nimport { RBAC, RBAC_MODULE_OPTIONS } from './tokens'\n\nfunction build(optionsProvider: Provider, globalGuard: boolean, imports: DynamicModule['imports'] = []): DynamicModule {\n return {\n module: RbacModule,\n global: true,\n imports,\n providers: [\n optionsProvider,\n { provide: RBAC, useFactory: (options: RbacModuleOptions) => options.rbac, inject: [RBAC_MODULE_OPTIONS] },\n RbacGuard,\n ...(globalGuard ? [{ provide: APP_GUARD, useClass: RbacGuard }] : []),\n ],\n exports: [RBAC_MODULE_OPTIONS, RBAC, RbacGuard],\n }\n}\n\n/**\n * Registers rbac-evolution in a Nest application (global module).\n *\n * ```ts\n * @Module({\n * imports: [\n * RbacModule.forRoot({\n * rbac,\n * getSubject: (ctx) => {\n * const user = ctx.switchToHttp().getRequest().user\n * return user ? { type: 'user', id: user.id } : null\n * },\n * }),\n * ],\n * })\n * export class AppModule {}\n * ```\n */\n@Global()\n@Module({})\nexport class RbacModule {\n static forRoot(config: RbacModuleConfig): DynamicModule {\n const { globalGuard = false, ...options } = config\n return build({ provide: RBAC_MODULE_OPTIONS, useValue: options }, globalGuard)\n }\n\n /** Like {@link forRoot}, with options built by a factory (e.g. from a `ConfigService`). */\n static forRootAsync(config: RbacModuleAsyncConfig): DynamicModule {\n return build(\n { provide: RBAC_MODULE_OPTIONS, useFactory: config.useFactory, inject: config.inject ?? [] },\n config.globalGuard ?? false,\n config.imports ?? [],\n )\n }\n}\n","import 'reflect-metadata'\nimport type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport { applyDecorators, createParamDecorator, type ExecutionContext, UseGuards } from '@nestjs/common'\nimport { getRbac } from './context'\nimport { RbacGuard } from './guard'\nimport {\n type PermissionRequirementOptions,\n permissionRequirement,\n type RbacRequirement,\n type RequirementNames,\n roleOrPermissionRequirement,\n roleRequirement,\n type RoleRequirementOptions,\n} from './requirements'\nimport { RBAC_REQUIREMENTS } from './tokens'\n\ntype ClassOrMethodDecorator = <T>(\n target: object,\n propertyKey?: string | symbol,\n descriptor?: TypedPropertyDescriptor<T>,\n) => void\n\n/** Appends a requirement (stacked decorators all apply), unlike `SetMetadata` which overwrites. */\nfunction appendRequirement(requirement: RbacRequirement): ClassOrMethodDecorator {\n return (target, _propertyKey, descriptor) => {\n const holder: object = descriptor?.value !== undefined ? (descriptor.value as object) : target\n const current = (Reflect.getMetadata(RBAC_REQUIREMENTS, holder) as RbacRequirement[] | undefined) ?? []\n Reflect.defineMetadata(RBAC_REQUIREMENTS, [...current, requirement], holder)\n }\n}\n\nconst requirementDecorator = (requirement: RbacRequirement) =>\n applyDecorators(appendRequirement(requirement), UseGuards(RbacGuard))\n\n/**\n * Requires permissions, like spatie's `permission:` middleware. Works on controllers and handlers.\n *\n * - `@RequirePermissions('edit articles')`\n * - `@RequirePermissions('edit articles|delete articles')` — any of them\n * - `@RequirePermissions('edit articles', 'publish articles')` — all of them\n * - `@RequirePermissions('a', 'b', { any: true })` — any of them\n */\nexport function RequirePermissions(...args: (RequirementNames | PermissionRequirementOptions)[]) {\n return requirementDecorator(permissionRequirement(args))\n}\n\n/**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `@RequireRoles('admin')`, `@RequireRoles('admin|editor')`, `@RequireRoles('admin', 'editor')` — any of them\n * - `@RequireRoles('admin', 'editor', { all: true })` — all of them\n */\nexport function RequireRoles(...args: (RequirementNames | RoleRequirementOptions)[]) {\n return requirementDecorator(roleRequirement(args))\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 */\nexport function RequireRoleOrPermission(...names: RequirementNames[]) {\n return requirementDecorator(roleOrPermissionRequirement(names))\n}\n\n/**\n * Injects the current subject's `SubjectRbac` (`null` for guests), as resolved by `RbacGuard`.\n *\n * ```ts\n * @Get('me/permissions')\n * @UseGuards(RbacGuard)\n * snapshot(@CurrentRbac() rbac: SubjectRbac | null) {\n * return rbac?.snapshot() ?? null\n * }\n * ```\n */\nexport const CurrentRbac: () => ParameterDecorator = createParamDecorator(\n (_data: unknown, context: ExecutionContext): SubjectRbac | null => getRbac(context),\n)\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/context.ts","../src/requirements.ts","../src/tokens.ts","../src/guard.ts","../src/module.ts","../src/decorators.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGO,IAAM,qBAAA,GAAN,cAAoC,KAAA,CAAM;AAAA,EACtC,IAAA,GAAO,oBAAA;AAAA,EAEhB,WAAA,GAAc;AACZ,IAAA,KAAA;AAAA,MACE;AAAA,KAEF;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAGA,IAAM,QAAA,uBAAe,OAAA,EAAoC;AAMlD,SAAS,WAAW,OAAA,EAA+C;AACxE,EAAA,IAAI,GAAA;AACJ,EAAA,QAAQ,OAAA,CAAQ,SAAgB;AAAG,IACjC,KAAK,MAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,YAAA,EAAa,CAAE,UAAA,EAAW;AACxC,MAAA;AAAA,IACF,KAAK,KAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,WAAA,EAAY,CAAE,UAAA,EAAW;AACvC,MAAA;AAAA,IACF,KAAK,IAAA;AACH,MAAA,GAAA,GAAM,OAAA,CAAQ,UAAA,EAAW,CAAE,SAAA,EAAU;AACrC,MAAA;AAAA,IACF;AACE,MAAA,GAAA,GAAM,OAAA,CAAQ,cAAc,CAAC,CAAA;AAAA;AAEjC,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,OAAO,GAAA,GAAM,MAAA;AACzD;AAEO,SAAS,YAAY,GAAA,EAAsB;AAChD,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,YAAY,GAAA,EAA6C;AACvE,EAAA,OAAO,QAAA,CAAS,IAAI,GAAG,CAAA;AACzB;AAEO,SAAS,WAAA,CAAY,KAAa,IAAA,EAAgC;AACvE,EAAA,QAAA,CAAS,GAAA,CAAI,KAAK,IAAI,CAAA;AACxB;AAMO,SAAS,QAAQ,OAAA,EAA+C;AACrE,EAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,EAAA,IAAI,GAAA,KAAQ,UAAa,CAAC,QAAA,CAAS,IAAI,GAAG,CAAA,EAAG,MAAM,IAAI,qBAAA,EAAsB;AAC7E,EAAA,OAAO,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,IAAK,IAAA;AAC9B;;;ACnCO,IAAM,QAAA,GAA4C;AAAA,EACvD,UAAA,EAAY,2CAAA;AAAA,EACZ,IAAA,EAAM,qCAAA;AAAA,EACN,kBAAA,EAAoB;AACtB,CAAA;AAEO,IAAM,uBAAA,GAA0B,wBAAA;AAEvC,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,EAAgD;AAChE,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,EAAgG;AACnI,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,EAAyB,SAAS,IAAA,EAAU;AAAA,EAC9E;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAA4B,OAAA,EAAS,MAAA,EAAU;AACjE;AAEA,SAAS,OAAO,WAAA,EAA+C;AAC7D,EAAA,MAAM,EAAE,cAAa,GAAI,WAAA;AACzB,EAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,IAAK,YAAA,CAAa,IAAA,CAAK,CAAC,KAAA,KAAU,KAAA,CAAM,MAAA,KAAW,CAAC,CAAA,EAAG;AACjF,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,mBAAA,EAAsB,WAAA,CAAY,IAAI,CAAA,qCAAA,CAAuC,CAAA;AAAA,EACnG;AACA,EAAA,OAAO,WAAA;AACT;AAGO,SAAS,sBAAsB,IAAA,EAAqF;AACzH,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAwC,IAAI,CAAA;AAC5E,EAAA,MAAM,MAAA,GAAS,SAAS,KAAK,CAAA;AAC7B,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,YAAA,EAAc,YAAA,EAAc,OAAA,CAAQ,GAAA,GAAM,CAAC,MAAA,CAAO,IAAA,EAAM,CAAA,GAAI,QAAQ,CAAA;AAC5F;AAGO,SAAS,gBAAgB,IAAA,EAA+E;AAC7G,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,GAAU,EAAC,EAAE,GAAI,UAAkC,IAAI,CAAA;AACtE,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAK;AACjC,EAAA,OAAO,OAAO,EAAE,IAAA,EAAM,QAAQ,YAAA,EAAc,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAA,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;AACzF;AAGO,SAAS,4BAA4B,KAAA,EAAqD;AAC/F,EAAA,OAAO,MAAA,CAAO,EAAE,IAAA,EAAM,oBAAA,EAAsB,YAAA,EAAc,CAAC,QAAA,CAAS,KAAK,CAAA,CAAE,IAAA,EAAM,CAAA,EAAG,CAAA;AACtF;AAGA,eAAsB,SAAA,CAAU,MAAmB,WAAA,EAAgD;AACjG,EAAA,KAAA,MAAW,KAAA,IAAS,YAAY,YAAA,EAAc;AAC5C,IAAA,IAAI,IAAA;AACJ,IAAA,QAAQ,YAAY,IAAA;AAAM,MACxB,KAAK,YAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA;AAC9B,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,GAAO,MAAM,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA;AAClC,QAAA;AAAA,MACF;AACE,QAAA,IAAA,GAAQ,MAAM,KAAK,UAAA,CAAW,KAAK,KAAO,MAAM,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA;AAErE,IAAA,IAAI,CAAC,MAAM,OAAO,KAAA;AAAA,EACpB;AACA,EAAA,OAAO,IAAA;AACT;;;ACtGO,IAAM,mBAAA,mBAAsB,MAAA,CAAO,GAAA,CAAI,+BAA+B;AAGtE,IAAM,IAAA,mBAAO,MAAA,CAAO,GAAA,CAAI,4BAA4B;AAGpD,IAAM,iBAAA,GAAoB;;;ACSjC,IAAM,QAAA,uBAAe,OAAA,EAA8B;AAOnD,IAAM,SAAA,GAAY,CAAC,OAAA,KAAuC,CAAC,MAAA,EAAQ,KAAK,CAAA,CAAE,QAAA,CAAS,OAAA,CAAQ,OAAA,EAAiB,CAAA;AAYrG,IAAM,YAAN,MAAuC;AAAA;AAAA,EAE5C,WAAA,CACsC,WACU,OAAA,EAC9C;AAFoC,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AACU,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA;AAAA,EAC7C;AAAA,EAFmC,SAAA;AAAA,EACU,OAAA;AAAA,EAGhD,MAAM,YAAY,OAAA,EAA6C;AAC7D,IAAA,MAAM,GAAA,GAAM,WAAW,OAAO,CAAA;AAC9B,IAAA,MAAM,OAAA,GAAU,UAAU,OAAO,CAAA;AACjC,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,OAAA,EAAS,KAAK,OAAO,CAAA;AAErD,IAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,EAAW;AACnC,IAAA,IAAI,OAAA,IAAW,GAAA,KAAQ,MAAA,IAAa,QAAA,CAAS,GAAA,CAAI,GAAG,CAAA,EAAG,GAAA,CAAI,OAAO,CAAA,EAAG,OAAO,IAAA;AAE5E,IAAA,MAAM,YAAA,GAAe;AAAA,MACnB,GAAI,KAAK,SAAA,CAAU,GAAA,CAAmC,mBAAmB,OAAA,CAAQ,QAAA,EAAU,CAAA,IAAK,EAAC;AAAA,MACjG,GAAI,IAAA,CAAK,SAAA,CAAU,IAAmC,iBAAA,EAAmB,OAAO,KAAK;AAAC,KACxF;AACA,IAAA,IAAI,YAAA,CAAa,MAAA,KAAW,CAAA,EAAG,OAAO,IAAA;AAEtC,IAAA,IAAI,SAAS,IAAA,EAAM;AACjB,MAAA,MAAM,IAAI,qBAAA,CAAsB,EAAE,OAAO,iBAAA,EAAmB,OAAA,EAAS,yBAAyB,CAAA;AAAA,IAChG;AAEA,IAAA,KAAA,MAAW,eAAe,YAAA,EAAc;AACtC,MAAA,IAAI,CAAE,MAAM,SAAA,CAAU,IAAA,EAAM,WAAW,CAAA,EAAI;AACzC,QAAA,MAAM,IAAI,kBAAA,CAAmB;AAAA,UAC3B,KAAA,EAAO,WAAA;AAAA,UACP,QAAQ,WAAA,CAAY,IAAA;AAAA,UACpB,OAAA,EAAS,QAAA,CAAS,WAAA,CAAY,IAAI,CAAA;AAAA,UAClC,GAAI,IAAA,CAAK,OAAA,CAAQ,sBAAsB,EAAE,QAAA,EAAU,YAAY,YAAA;AAAa,SAC7E,CAAA;AAAA,MACH;AAAA,IACF;AAEA,IAAA,IAAI,OAAA,IAAW,GAAA,KAAQ,MAAA,EAAW,QAAA,CAAS,IAAI,GAAA,EAAA,CAAM,QAAA,CAAS,GAAA,CAAI,GAAG,qBAAK,IAAI,GAAA,EAAa,EAAG,GAAA,CAAI,OAAO,CAAC,CAAA;AAC1G,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAEA,MAAc,OAAA,CAAQ,OAAA,EAA2B,GAAA,EAAyB,OAAA,EAA+C;AACvH,IAAA,IAAI,OAAA,IAAW,QAAQ,MAAA,IAAa,WAAA,CAAY,GAAG,CAAA,EAAG,OAAO,WAAA,CAAY,GAAG,CAAA,IAAK,IAAA;AAEjF,IAAA,MAAM,EAAE,IAAA,EAAM,UAAA,EAAY,KAAA,EAAO,IAAA,KAAS,IAAA,CAAK,OAAA;AAC/C,IAAA,MAAM,OAAA,GAAU,MAAM,UAAA,CAAW,OAAO,CAAA;AACxC,IAAA,IAAI,MAAA,GAA6B,IAAA;AACjC,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,MAAM,MAAA,GAAS,IAAA,GAAO,MAAM,IAAA,CAAK,OAAO,CAAA,GAAI,MAAA;AAC5C,MAAA,MAAA,GAAS,IAAA,CAAK,IAAI,OAAA,EAAS;AAAA,QACzB,GAAI,KAAA,KAAU,MAAA,IAAa,EAAE,KAAA,EAAM;AAAA,QACnC,GAAI,MAAA,KAAW,MAAA,IAAa,EAAE,MAAM,MAAA;AAAO,OAC5C,CAAA;AAAA,IACH;AACA,IAAA,IAAI,GAAA,KAAQ,MAAA,EAAW,WAAA,CAAY,GAAA,EAAK,MAAM,CAAA;AAC9C,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAxDa,SAAA,GAAN,eAAA,CAAA;AAAA,EADN,UAAA,EAAW;AAAA,EAIP,0BAAO,SAAS,CAAA,CAAA;AAAA,EAChB,0BAAO,mBAAmB,CAAA;AAAA,CAAA,EAJlB,SAAA,CAAA;;;AC7Bb,SAAS,KAAA,CAAM,eAAA,EAA2B,WAAA,EAAsB,OAAA,GAAoC,EAAC,EAAkB;AACrH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,UAAA;AAAA,IACR,MAAA,EAAQ,IAAA;AAAA,IACR,OAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,eAAA;AAAA,MACA,EAAE,OAAA,EAAS,IAAA,EAAM,UAAA,EAAY,CAAC,OAAA,KAA+B,OAAA,CAAQ,IAAA,EAAM,MAAA,EAAQ,CAAC,mBAAmB,CAAA,EAAE;AAAA,MACzG,SAAA;AAAA,MACA,GAAI,WAAA,GAAc,CAAC,EAAE,OAAA,EAAS,WAAW,QAAA,EAAU,SAAA,EAAW,CAAA,GAAI;AAAC,KACrE;AAAA,IACA,OAAA,EAAS,CAAC,mBAAA,EAAqB,IAAA,EAAM,SAAS;AAAA,GAChD;AACF;AAsBO,IAAM,aAAN,MAAiB;AAAA,EACtB,OAAO,QAAQ,MAAA,EAAyC;AACtD,IAAA,MAAM,EAAE,WAAA,GAAc,KAAA,EAAO,GAAG,SAAQ,GAAI,MAAA;AAC5C,IAAA,OAAO,MAAM,EAAE,OAAA,EAAS,qBAAqB,QAAA,EAAU,OAAA,IAAW,WAAW,CAAA;AAAA,EAC/E;AAAA;AAAA,EAGA,OAAO,aAAa,MAAA,EAA8C;AAChE,IAAA,OAAO,KAAA;AAAA,MACL,EAAE,OAAA,EAAS,mBAAA,EAAqB,UAAA,EAAY,MAAA,CAAO,YAAY,MAAA,EAAQ,MAAA,CAAO,MAAA,IAAU,EAAC,EAAE;AAAA,MAC3F,OAAO,WAAA,IAAe,KAAA;AAAA,MACtB,MAAA,CAAO,WAAW;AAAC,KACrB;AAAA,EACF;AACF;AAda,UAAA,GAAN,eAAA,CAAA;AAAA,EAFN,MAAA,EAAO;AAAA,EACP,MAAA,CAAO,EAAE;AAAA,CAAA,EACG,UAAA,CAAA;AClBb,SAAS,kBAAkB,WAAA,EAAsD;AAC/E,EAAA,OAAO,CAAC,MAAA,EAAQ,YAAA,EAAc,UAAA,KAAe;AAC3C,IAAA,MAAM,MAAA,GAAiB,UAAA,EAAY,KAAA,KAAU,MAAA,GAAa,WAAW,KAAA,GAAmB,MAAA;AACxF,IAAA,MAAM,UAAW,OAAA,CAAQ,WAAA,CAAY,iBAAA,EAAmB,MAAM,KAAuC,EAAC;AACtG,IAAA,OAAA,CAAQ,eAAe,iBAAA,EAAmB,CAAC,GAAG,OAAA,EAAS,WAAW,GAAG,MAAM,CAAA;AAAA,EAC7E,CAAA;AACF;AAEA,IAAM,oBAAA,GAAuB,CAAC,WAAA,KAC5B,eAAA,CAAgB,kBAAkB,WAAW,CAAA,EAAG,SAAA,CAAU,SAAS,CAAC,CAAA;AAU/D,SAAS,sBAAsB,IAAA,EAA2D;AAC/F,EAAA,OAAO,oBAAA,CAAqB,qBAAA,CAAsB,IAAI,CAAC,CAAA;AACzD;AAQO,SAAS,gBAAgB,IAAA,EAAqD;AACnF,EAAA,OAAO,oBAAA,CAAqB,eAAA,CAAgB,IAAI,CAAC,CAAA;AACnD;AAQO,SAAS,2BAA2B,KAAA,EAA2B;AACpE,EAAA,OAAO,oBAAA,CAAqB,2BAAA,CAA4B,KAAK,CAAC,CAAA;AAChE;AAaO,IAAM,WAAA,GAAwC,oBAAA;AAAA,EACnD,CAAC,KAAA,EAAgB,OAAA,KAAkD,OAAA,CAAQ,OAAO;AACpF","file":"index.js","sourcesContent":["import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport type { ExecutionContext } from '@nestjs/common'\n\nexport class RbacGuardMissingError extends Error {\n readonly code = 'RBAC_GUARD_MISSING'\n\n constructor() {\n super(\n '`@CurrentRbac()` was used but `RbacGuard` did not run for this route. Add a `@Require*()` decorator, ' +\n '`@UseGuards(RbacGuard)`, or `RbacModule.forRoot({ globalGuard: true })`.',\n )\n this.name = 'RbacGuardMissingError'\n }\n}\n\n/** Per-request resolved `SubjectRbac` (`null` for guests), keyed by the request/client/context object. */\nconst resolved = new WeakMap<object, SubjectRbac | null>()\n\n/**\n * The object that identifies the current request: the HTTP request, the RPC context, the WebSocket client,\n * or (for GraphQL and other context types) the third handler argument.\n */\nexport function requestKey(context: ExecutionContext): object | undefined {\n let key: unknown\n switch (context.getType<string>()) {\n case 'http':\n key = context.switchToHttp().getRequest()\n break\n case 'rpc':\n key = context.switchToRpc().getContext()\n break\n case 'ws':\n key = context.switchToWs().getClient()\n break\n default:\n key = context.getArgByIndex(2)\n }\n return typeof key === 'object' && key !== null ? key : undefined\n}\n\nexport function hasResolved(key: object): boolean {\n return resolved.has(key)\n}\n\nexport function getResolved(key: object): SubjectRbac | null | undefined {\n return resolved.get(key)\n}\n\nexport function setResolved(key: object, rbac: SubjectRbac | null): void {\n resolved.set(key, rbac)\n}\n\n/**\n * Returns the `SubjectRbac` that `RbacGuard` resolved for this execution context (`null` for guests).\n * Throws {@link RbacGuardMissingError} when the guard has not run.\n */\nexport function getRbac(context: ExecutionContext): SubjectRbac | null {\n const key = requestKey(context)\n if (key === undefined || !resolved.has(key)) throw new RbacGuardMissingError()\n return resolved.get(key) ?? null\n}\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\n\n/** Which kind of requirement failed — same values as the Express package. */\nexport type RequirementKind = 'permission' | 'role' | 'role_or_permission'\n\n/** A name, a pipe-separated list (`'edit|delete'` = any of), or an array of names. */\nexport type RequirementNames = string | readonly string[]\n\n/** One `@Require*` decorator, normalized. */\nexport interface RbacRequirement {\n kind: RequirementKind\n /** Groups of names: every group must pass, a group passes when ANY of its names matches. */\n requirements: string[][]\n}\n\nexport interface PermissionRequirementOptions {\n /** Pass when the subject has ANY of the permissions (instead of all). Default: `false`. */\n any?: boolean\n}\n\nexport interface RoleRequirementOptions {\n /** Require ALL of the roles (instead of any). Default: `false`. */\n all?: boolean\n}\n\nexport const MESSAGES: Record<RequirementKind, 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\nexport const UNAUTHENTICATED_MESSAGE = 'User is not logged in.'\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 RequirementNames[]): 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 (RequirementNames | O)[]): { names: RequirementNames[]; 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 RequirementNames[], options: last as O }\n }\n return { names: args as RequirementNames[], options: undefined }\n}\n\nfunction ensure(requirement: RbacRequirement): RbacRequirement {\n const { requirements } = requirement\n if (requirements.length === 0 || requirements.some((group) => group.length === 0)) {\n throw new TypeError(`[rbac-evolution] A ${requirement.kind} requirement needs at least one name.`)\n }\n return requirement\n}\n\n/** `'a', 'b'` = all; `'a|b'` = any; `{ any: true }` = any of everything. */\nexport function permissionRequirement(args: readonly (RequirementNames | PermissionRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<PermissionRequirementOptions>(args)\n const groups = toGroups(names)\n return ensure({ kind: 'permission', requirements: options.any ? [groups.flat()] : groups })\n}\n\n/** Any of the roles by default; `{ all: true }` = all of them. */\nexport function roleRequirement(args: readonly (RequirementNames | RoleRequirementOptions)[]): RbacRequirement {\n const { names, options = {} } = parseArgs<RoleRequirementOptions>(args)\n const all = toGroups(names).flat()\n return ensure({ kind: 'role', requirements: options.all ? all.map((r) => [r]) : [all] })\n}\n\n/** Any of the names, as a role OR as a permission. */\nexport function roleOrPermissionRequirement(names: readonly RequirementNames[]): RbacRequirement {\n return ensure({ kind: 'role_or_permission', requirements: [toGroups(names).flat()] })\n}\n\n/** `true` when every group of the requirement passes for the subject. */\nexport async function satisfies(rbac: SubjectRbac, requirement: RbacRequirement): Promise<boolean> {\n for (const group of requirement.requirements) {\n let pass: boolean\n switch (requirement.kind) {\n case 'permission':\n pass = await rbac.canAny(group)\n break\n case 'role':\n pass = await rbac.hasAnyRole(group)\n break\n default:\n pass = (await rbac.hasAnyRole(group)) || (await rbac.canAny(group))\n }\n if (!pass) return false\n }\n return true\n}\n","/** Injection token for the resolved {@link RbacModuleOptions}. */\nexport const RBAC_MODULE_OPTIONS = Symbol.for('rbac-evolution:nestjs:options')\n\n/** Injection token for the `Rbac` engine passed to `RbacModule.forRoot({ rbac })`. */\nexport const RBAC = Symbol.for('rbac-evolution:nestjs:rbac')\n\n/** Metadata key under which `@Require*` decorators store their requirements. */\nexport const RBAC_REQUIREMENTS = 'rbac-evolution:requirements'\n","import type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport {\n type CanActivate,\n type ExecutionContext,\n ForbiddenException,\n Inject,\n Injectable,\n UnauthorizedException,\n} from '@nestjs/common'\nimport { Reflector } from '@nestjs/core'\nimport { getResolved, hasResolved, requestKey, setResolved } from './context'\nimport type { RbacModuleOptions } from './options'\nimport { MESSAGES, type RbacRequirement, satisfies, UNAUTHENTICATED_MESSAGE } from './requirements'\nimport { RBAC_MODULE_OPTIONS, RBAC_REQUIREMENTS } from './tokens'\n\n/** Handlers already enforced for a request — the guard may run twice (global + `@UseGuards`). */\nconst enforced = new WeakMap<object, Set<unknown>>()\n\n/**\n * Only HTTP requests and RPC messages get a fresh key object per call. A WebSocket client or a\n * GraphQL context lives across many calls, so caching or skipping checks by it would let a denied\n * client through on its next message.\n */\nconst isPerCall = (context: ExecutionContext): boolean => ['http', 'rpc'].includes(context.getType<string>())\n\n/**\n * Resolves the current subject (once per request) and enforces the `@RequirePermissions()`,\n * `@RequireRoles()` and `@RequireRoleOrPermission()` metadata of the class and the handler.\n *\n * - no subject → `UnauthorizedException` `401 { error: 'UNAUTHENTICATED', message }`\n * - missing access → `ForbiddenException` `403 { error: 'FORBIDDEN', reason, message }`\n *\n * Bodies are identical to `@anievo-id/rbac-evolution-express`.\n */\n@Injectable()\nexport class RbacGuard implements CanActivate {\n // Explicit tokens: the package is built with esbuild, which does not emit `design:paramtypes`.\n constructor(\n @Inject(Reflector) private readonly reflector: Reflector,\n @Inject(RBAC_MODULE_OPTIONS) private readonly options: RbacModuleOptions,\n ) {}\n\n async canActivate(context: ExecutionContext): Promise<boolean> {\n const key = requestKey(context)\n const perCall = isPerCall(context)\n const rbac = await this.resolve(context, key, perCall)\n\n const handler = context.getHandler()\n if (perCall && key !== undefined && enforced.get(key)?.has(handler)) return true\n\n const requirements = [\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, context.getClass()) ?? []),\n ...(this.reflector.get<RbacRequirement[] | undefined>(RBAC_REQUIREMENTS, handler) ?? []),\n ]\n if (requirements.length === 0) return true\n\n if (rbac === null) {\n throw new UnauthorizedException({ error: 'UNAUTHENTICATED', message: UNAUTHENTICATED_MESSAGE })\n }\n\n for (const requirement of requirements) {\n if (!(await satisfies(rbac, requirement))) {\n throw new ForbiddenException({\n error: 'FORBIDDEN',\n reason: requirement.kind,\n message: MESSAGES[requirement.kind],\n ...(this.options.exposeRequirements && { required: requirement.requirements }),\n })\n }\n }\n // Mark as enforced only once every requirement passed.\n if (perCall && key !== undefined) enforced.set(key, (enforced.get(key) ?? new Set<unknown>()).add(handler))\n return true\n }\n\n private async resolve(context: ExecutionContext, key: object | undefined, perCall: boolean): Promise<SubjectRbac | null> {\n if (perCall && key !== undefined && hasResolved(key)) return getResolved(key) ?? null\n\n const { rbac, getSubject, guard, team } = this.options\n const subject = await getSubject(context)\n let result: SubjectRbac | null = null\n if (subject) {\n const teamId = team ? await team(context) : undefined\n result = rbac.for(subject, {\n ...(guard !== undefined && { guard }),\n ...(teamId !== undefined && { team: teamId }),\n })\n }\n if (key !== undefined) setResolved(key, result)\n return result\n }\n}\n","import { type DynamicModule, Global, Module, type Provider } from '@nestjs/common'\nimport { APP_GUARD } from '@nestjs/core'\nimport { RbacGuard } from './guard'\nimport type { RbacModuleAsyncConfig, RbacModuleConfig, RbacModuleOptions } from './options'\nimport { RBAC, RBAC_MODULE_OPTIONS } from './tokens'\n\nfunction build(optionsProvider: Provider, globalGuard: boolean, imports: DynamicModule['imports'] = []): DynamicModule {\n return {\n module: RbacModule,\n global: true,\n imports,\n providers: [\n optionsProvider,\n { provide: RBAC, useFactory: (options: RbacModuleOptions) => options.rbac, inject: [RBAC_MODULE_OPTIONS] },\n RbacGuard,\n ...(globalGuard ? [{ provide: APP_GUARD, useClass: RbacGuard }] : []),\n ],\n exports: [RBAC_MODULE_OPTIONS, RBAC, RbacGuard],\n }\n}\n\n/**\n * Registers rbac-evolution in a Nest application (global module).\n *\n * ```ts\n * @Module({\n * imports: [\n * RbacModule.forRoot({\n * rbac,\n * getSubject: (ctx) => {\n * const user = ctx.switchToHttp().getRequest().user\n * return user ? { type: 'user', id: user.id } : null\n * },\n * }),\n * ],\n * })\n * export class AppModule {}\n * ```\n */\n@Global()\n@Module({})\nexport class RbacModule {\n static forRoot(config: RbacModuleConfig): DynamicModule {\n const { globalGuard = false, ...options } = config\n return build({ provide: RBAC_MODULE_OPTIONS, useValue: options }, globalGuard)\n }\n\n /** Like {@link forRoot}, with options built by a factory (e.g. from a `ConfigService`). */\n static forRootAsync(config: RbacModuleAsyncConfig): DynamicModule {\n return build(\n { provide: RBAC_MODULE_OPTIONS, useFactory: config.useFactory, inject: config.inject ?? [] },\n config.globalGuard ?? false,\n config.imports ?? [],\n )\n }\n}\n","import 'reflect-metadata'\nimport type { SubjectRbac } from '@anievo-id/rbac-evolution'\nimport { applyDecorators, createParamDecorator, type ExecutionContext, UseGuards } from '@nestjs/common'\nimport { getRbac } from './context'\nimport { RbacGuard } from './guard'\nimport {\n type PermissionRequirementOptions,\n permissionRequirement,\n type RbacRequirement,\n type RequirementNames,\n roleOrPermissionRequirement,\n roleRequirement,\n type RoleRequirementOptions,\n} from './requirements'\nimport { RBAC_REQUIREMENTS } from './tokens'\n\ntype ClassOrMethodDecorator = <T>(\n target: object,\n propertyKey?: string | symbol,\n descriptor?: TypedPropertyDescriptor<T>,\n) => void\n\n/** Appends a requirement (stacked decorators all apply), unlike `SetMetadata` which overwrites. */\nfunction appendRequirement(requirement: RbacRequirement): ClassOrMethodDecorator {\n return (target, _propertyKey, descriptor) => {\n const holder: object = descriptor?.value !== undefined ? (descriptor.value as object) : target\n const current = (Reflect.getMetadata(RBAC_REQUIREMENTS, holder) as RbacRequirement[] | undefined) ?? []\n Reflect.defineMetadata(RBAC_REQUIREMENTS, [...current, requirement], holder)\n }\n}\n\nconst requirementDecorator = (requirement: RbacRequirement) =>\n applyDecorators(appendRequirement(requirement), UseGuards(RbacGuard))\n\n/**\n * Requires permissions, like spatie's `permission:` middleware. Works on controllers and handlers.\n *\n * - `@RequirePermissions('edit articles')`\n * - `@RequirePermissions('edit articles|delete articles')` — any of them\n * - `@RequirePermissions('edit articles', 'publish articles')` — all of them\n * - `@RequirePermissions('a', 'b', { any: true })` — any of them\n */\nexport function RequirePermissions(...args: (RequirementNames | PermissionRequirementOptions)[]) {\n return requirementDecorator(permissionRequirement(args))\n}\n\n/**\n * Requires roles, like spatie's `role:` middleware.\n *\n * - `@RequireRoles('admin')`, `@RequireRoles('admin|editor')`, `@RequireRoles('admin', 'editor')` — any of them\n * - `@RequireRoles('admin', 'editor', { all: true })` — all of them\n */\nexport function RequireRoles(...args: (RequirementNames | RoleRequirementOptions)[]) {\n return requirementDecorator(roleRequirement(args))\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 */\nexport function RequireRoleOrPermission(...names: RequirementNames[]) {\n return requirementDecorator(roleOrPermissionRequirement(names))\n}\n\n/**\n * Injects the current subject's `SubjectRbac` (`null` for guests), as resolved by `RbacGuard`.\n *\n * ```ts\n * @Get('me/permissions')\n * @UseGuards(RbacGuard)\n * snapshot(@CurrentRbac() rbac: SubjectRbac | null) {\n * return rbac?.snapshot() ?? null\n * }\n * ```\n */\nexport const CurrentRbac: () => ParameterDecorator = createParamDecorator(\n (_data: unknown, context: ExecutionContext): SubjectRbac | null => getRbac(context),\n)\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@anievo-id/rbac-evolution-nestjs",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "NestJS module, guard & decorators for rbac-evolution.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "AniEvo-ID (https://github.com/AniEvo-ID)",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"access": "public"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@anievo-id/rbac-evolution": "^0.3.
|
|
51
|
+
"@anievo-id/rbac-evolution": "^0.3.1"
|
|
52
52
|
},
|
|
53
53
|
"peerDependencies": {
|
|
54
54
|
"@nestjs/common": "^10.0.0 || ^11.0.0 || ^12.0.0",
|