@mahmoud-auth/auth 0.0.0-stage → 0.1.1-beta.0

package/dist/policy/validator.js

@@ -0,0 +1,61 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolicyValidator = void 0;
+const common_1 = require("@mahmoud-auth/common");
+const common_2 = require("@nestjs/common");
+const core_1 = require("../core");
+const errors_1 = require("../errors");
+const registry_1 = require("./registry");
+let PolicyValidator = class PolicyValidator {
+    policies;
+    constructor(policies) {
+        this.policies = policies;
+    }
+    validatePolicies() {
+        this.policies
+            .getValues()
+            .forEach(entry => this.validateCycles(entry.resource, entry.action));
+    }
+    validateCycles(resourceToken, action, path = []) {
+        const key = (0, core_1.createResourceKey)(resourceToken, action);
+        if (path.includes(key)) {
+            throw new errors_1.CircularPolicyException(path);
+        }
+        const entry = this.policies.getEntry(resourceToken, action);
+        if (!entry) {
+            return;
+        }
+        const nextPath = [...path, key,];
+        this.getPermissionDependencies(entry.rule).forEach(permission => {
+            this.validateCycles(permission.resource, permission.action, nextPath);
+        });
+    }
+    getPermissionDependencies(rule) {
+        if (!rule)
+            return [];
+        if ((0, common_1.isPermissionRule)(rule)) {
+            return [rule];
+        }
+        if ((0, common_1.isAndRule)(rule) || (0, common_1.isOrRule)(rule)) {
+            return rule.children.flatMap(child => this.getPermissionDependencies(child));
+        }
+        if ((0, common_1.isNotRule)(rule)) {
+            return this.getPermissionDependencies(rule.child);
+        }
+        return [];
+    }
+};
+exports.PolicyValidator = PolicyValidator;
+exports.PolicyValidator = PolicyValidator = __decorate([
+    (0, common_2.Injectable)(),
+    __metadata("design:paramtypes", [registry_1.PolicyRegistry])
+], PolicyValidator);

package/dist/policy/visualizer/controller.d.ts

@@ -0,0 +1,6 @@
+import { PolicyRegistry } from "../registry";
+export declare class VisualizerController {
+    private readonly graph;
+    constructor(graph: PolicyRegistry);
+    getGraph(): import("packages/mahmoud/common/dist").IAuthorizationGraphDto;
+}

package/dist/policy/visualizer/controller.js

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualizerController = void 0;
+const common_1 = require("@nestjs/common");
+const registry_1 = require("../registry");
+let VisualizerController = class VisualizerController {
+    graph;
+    constructor(graph) {
+        this.graph = graph;
+    }
+    getGraph() {
+        return this.graph.toVisualizationDto();
+    }
+};
+exports.VisualizerController = VisualizerController;
+__decorate([
+    (0, common_1.Get)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], VisualizerController.prototype, "getGraph", null);
+exports.VisualizerController = VisualizerController = __decorate([
+    (0, common_1.Controller)('mahmoudAuth/visual'),
+    __metadata("design:paramtypes", [registry_1.PolicyRegistry])
+], VisualizerController);

package/dist/policy/visualizer/index.d.ts

@@ -0,0 +1 @@
+export * from './controller';

package/dist/policy/visualizer/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./controller"), exports);

package/dist/tracing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './service';
+export * from './module';

package/dist/tracing/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./service"), exports);
+__exportStar(require("./module"), exports);

package/dist/tracing/module.d.ts

@@ -0,0 +1,8 @@
+import { DynamicModule } from "@nestjs/common";
+interface TraceModuleRootOptions {
+    activateTrace?: boolean;
+}
+export declare class TraceModule {
+    static forRoot({ activateTrace }: TraceModuleRootOptions): DynamicModule;
+}
+export {};

package/dist/tracing/module.js

@@ -0,0 +1,35 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var TraceModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TraceModule = void 0;
+const common_1 = require("@nestjs/common");
+const utils_1 = require("@mahmoud-auth/utils");
+const service_1 = require("./service");
+const tokens_1 = require("./tokens");
+let TraceModule = TraceModule_1 = class TraceModule {
+    static forRoot({ activateTrace = false }) {
+        return {
+            module: TraceModule_1,
+            providers: [
+                {
+                    provide: common_1.Logger,
+                    useFactory: () => new common_1.Logger(service_1.AuthorizationTraceService.name),
+                },
+                (0, tokens_1.useValueActivateTrace)(activateTrace),
+                (0, tokens_1.useFactoryEvaluationId)(() => (0, utils_1.nanoid)(10), { scope: common_1.Scope.REQUEST }),
+                service_1.AuthorizationTraceService
+            ],
+            exports: [service_1.AuthorizationTraceService],
+        };
+    }
+};
+exports.TraceModule = TraceModule;
+exports.TraceModule = TraceModule = TraceModule_1 = __decorate([
+    (0, common_1.Module)({})
+], TraceModule);

package/dist/tracing/service.d.ts

@@ -0,0 +1,17 @@
+import { Logger } from "@nestjs/common";
+import { RuleType } from '@mahmoud-auth/common';
+export declare class AuthorizationTraceService {
+    private readonly logger;
+    private readonly activateTrace;
+    private readonly evaluationId;
+    constructor(logger: Logger, activateTrace: boolean, evaluationId: string);
+    private upperCaseBoolean;
+    ruleEntered(type: RuleType, details?: (string | undefined)[]): string;
+    ruleResolved(type: RuleType, ruleId: string, result: boolean): void;
+    policyEntered(resource: string, action: string, route?: string): void;
+    policyLeft(resource: string, action: string, result: boolean, route?: string): void;
+    policyFailed(resource: string, action: string, error: unknown, route?: string): void;
+    ruleFailed(type: RuleType, ruleId: string, error: unknown): void;
+    resourceResolved(resource: string, outcome: 'skipped' | 'missing_id' | 'found' | 'not_found' | 'error', error?: unknown): void;
+    private format;
+}

package/dist/tracing/service.js

@@ -0,0 +1,126 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationTraceService = void 0;
+const common_1 = require("@nestjs/common");
+const utils_1 = require("@mahmoud-auth/utils");
+const tokens_1 = require("./tokens");
+let AuthorizationTraceService = class AuthorizationTraceService {
+    logger;
+    activateTrace;
+    evaluationId;
+    constructor(logger, activateTrace, evaluationId) {
+        this.logger = logger;
+        this.activateTrace = activateTrace;
+        this.evaluationId = evaluationId;
+    }
+    upperCaseBoolean(result) {
+        return `${result}`.toUpperCase();
+    }
+    ruleEntered(type, details = []) {
+        const ruleId = (0, utils_1.nanoid)(8);
+        if (!this.activateTrace) {
+            return ruleId;
+        }
+        const lines = [
+            `Entering ${type.toUpperCase()} rule [${ruleId}]`,
+            ...(details.filter(line => line != null))
+        ].filter(Boolean);
+        this.logger.debug(this.format(lines));
+        return ruleId;
+    }
+    ruleResolved(type, ruleId, result) {
+        if (!this.activateTrace) {
+            return;
+        }
+        const lines = [
+            type !== 'condition' && 'Leaving ',
+            `${type.toUpperCase()} rule [${ruleId}]`,
+            `resolved as ${this.upperCaseBoolean(result)}`
+        ];
+        this.logger.debug(this.format(lines));
+    }
+    policyEntered(resource, action, route) {
+        if (!this.activateTrace) {
+            return;
+        }
+        this.logger.debug(this.format([
+            'event policy.enter',
+            `Entering policy ${resource} |`,
+            `action ${action}`,
+            !!route && `route ${route}`,
+        ]));
+    }
+    policyLeft(resource, action, result, route) {
+        if (!this.activateTrace) {
+            return;
+        }
+        this.logger.debug(this.format([
+            'event policy.leave',
+            `Leaving policy ${resource} |`,
+            `action ${action} |`,
+            !!route && `route ${route} |`,
+            `resolved as ${this.upperCaseBoolean(result)}`
+        ]));
+    }
+    policyFailed(resource, action, error, route) {
+        if (!this.activateTrace) {
+            return;
+        }
+        this.logger.warn(this.format([
+            'event policy.error',
+            `resource ${resource}`,
+            `action ${action}`,
+            !!route && `route ${route}`,
+            `error ${(error instanceof Error ? error.name : 'UnknownError')}`,
+        ]));
+    }
+    ruleFailed(type, ruleId, error) {
+        if (!this.activateTrace) {
+            return;
+        }
+        this.logger.warn(this.format([
+            'event rule.error',
+            `${type.toUpperCase()} rule [${ruleId}]`,
+            `error ${(error instanceof Error ? error.name : 'UnknownError')}`,
+        ]));
+    }
+    resourceResolved(resource, outcome, error) {
+        if (!this.activateTrace) {
+            return;
+        }
+        this.logger.debug(this.format([
+            'event resource.resolve',
+            `resource ${resource}`,
+            `outcome ${outcome}`,
+            outcome === 'error' && `error ${error instanceof Error ? error.name : 'UnknownError'}`,
+        ]));
+    }
+    format(lines) {
+        return [
+            `[TRACE ${this.evaluationId}]:`,
+            ...(lines.filter(line => line != null)),
+        ]
+            .filter(Boolean)
+            .join(" ");
+    }
+};
+exports.AuthorizationTraceService = AuthorizationTraceService;
+exports.AuthorizationTraceService = AuthorizationTraceService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(common_1.Logger)),
+    __param(1, (0, tokens_1.InjectActivateTrace)()),
+    __param(2, (0, tokens_1.InjectEvaluationId)()),
+    __metadata("design:paramtypes", [common_1.Logger, Boolean, String])
+], AuthorizationTraceService);

package/dist/tracing/tokens/activate-trace.token.d.ts

@@ -0,0 +1,3 @@
+import { IUseValueWithToken } from "@mahmoud-auth/utils";
+export declare const InjectActivateTrace: () => PropertyDecorator & ParameterDecorator;
+export declare const useValueActivateTrace: IUseValueWithToken;

package/dist/tracing/tokens/activate-trace.token.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useValueActivateTrace = exports.InjectActivateTrace = void 0;
+const common_1 = require("@nestjs/common");
+const utils_1 = require("@mahmoud-auth/utils");
+const ACTIVATE_TRACE_TOKEN = Symbol('TRACE_TOKEN');
+const InjectActivateTrace = () => (0, common_1.Inject)(ACTIVATE_TRACE_TOKEN);
+exports.InjectActivateTrace = InjectActivateTrace;
+const useValueActivateTrace = (activateTrace, ...rest) => (0, utils_1.useValue)(ACTIVATE_TRACE_TOKEN, activateTrace, ...rest);
+exports.useValueActivateTrace = useValueActivateTrace;

package/dist/tracing/tokens/evaluation-id.token.d.ts

@@ -0,0 +1,4 @@
+import { IUseFactoryWithToken } from "@mahmoud-auth/utils";
+export declare const EVALUATION_ID: unique symbol;
+export declare const InjectEvaluationId: () => PropertyDecorator & ParameterDecorator;
+export declare const useFactoryEvaluationId: IUseFactoryWithToken;

package/dist/tracing/tokens/evaluation-id.token.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFactoryEvaluationId = exports.InjectEvaluationId = exports.EVALUATION_ID = void 0;
+const common_1 = require("@nestjs/common");
+const utils_1 = require("@mahmoud-auth/utils");
+exports.EVALUATION_ID = Symbol('EVALUATION_ID');
+const InjectEvaluationId = () => (0, common_1.Inject)(exports.EVALUATION_ID);
+exports.InjectEvaluationId = InjectEvaluationId;
+const useFactoryEvaluationId = (...props) => (0, utils_1.useFactory)(exports.EVALUATION_ID, ...props);
+exports.useFactoryEvaluationId = useFactoryEvaluationId;

package/dist/tracing/tokens/index.d.ts

@@ -0,0 +1,2 @@
+export * from './activate-trace.token';
+export * from './evaluation-id.token';

package/dist/tracing/tokens/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./activate-trace.token"), exports);
+__exportStar(require("./evaluation-id.token"), exports);

package/package.json

@@ -1,6 +1,46 @@
-{
-  "name": "@mahmoud-auth/auth",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+    "name":  "@mahmoud-auth/auth",
+    "version":  "0.1.1-beta.0",
+    "license":  "MIT",
+    "description":  "Policy-based authorization for NestJS applications.",
+    "main":  "./dist/index.js",
+    "types":  "./dist/index.d.ts",
+    "exports":  {
+                    ".":  {
+                              "types":  "./dist/index.d.ts",
+                              "default":  "./dist/index.js"
+                          }
+                },
+    "files":  [
+                  "dist",
+                  "README.md",
+                  "LICENSE",
+                  "public"
+              ],
+    "scripts":  {
+                    "clean":  "rimraf dist",
+                    "build":  "rimraf dist \u0026\u0026 tsc -p tsconfig.build.json",
+                    "prepack":  "npm run build"
+                },
+    "dependencies":  {
+                         "@mahmoud-auth/common":  "*",
+                         "@mahmoud-auth/model-climbers":  "*",
+                         "@mahmoud-auth/utils":  "*"
+                     },
+    "peerDependencies":  {
+                             "@nestjs/common":  "^11.0.0",
+                             "@nestjs/core":  "^11.0.0",
+                             "reflect-metadata":  "^0.1.13 || ^0.2.0"
+                         },
+    "engines":  {
+                    "node":  "^22.12.0 || ^24.0.0 || \u003e=26.0.0"
+                },
+    "publishConfig":  {
+                          "access":  "public"
+                      },
+    "repository":  {
+                       "type":  "git",
+                       "url":  "git+https://github.com/shahariko-lab/nestjs-rebac.git",
+                       "directory":  "packages/mahmoud/auth"
+                   }
+}