@mahmoud-auth/common 0.0.0-stage → 0.1.0

package/LICENSE

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

package/README.md

@@ -1,3 +1,9 @@
-# Temporary Holding Version
+# @mahmoud-auth/common
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared authorization rules, resource tokens, and context types used by the Mahmoud NestJS packages.
+
+```sh
+npm install @mahmoud-auth/common
+```
+
+This package exposes its public API from the package root. It requires `@nestjs/common` as a peer dependency.

package/dist/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './utils';

package/dist/auth/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("./types"), exports);
+__exportStar(require("./utils"), exports);

package/dist/auth/types/and/index.d.ts

@@ -0,0 +1,6 @@
+import { RuleNode } from '../rule.type';
+export interface IAndRule extends RuleNode {
+    type: 'and';
+    children: RuleNode[];
+}
+export type ITreeAndNode = IAndRule;

package/dist/auth/types/and/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/condition/index.d.ts

@@ -0,0 +1,9 @@
+import { IAuthorizationContext } from "../context.type";
+import { RuleNode } from '../rule.type';
+export type IConditionExecute = (context: IAuthorizationContext) => boolean | Promise<boolean>;
+export interface IConditionRule extends RuleNode {
+    type: 'condition';
+    execute: IConditionExecute;
+    description?: string;
+}
+export type ITreeConditionNode = Pick<IConditionRule, 'type' | 'description'>;

package/dist/auth/types/condition/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/context.type.d.ts

@@ -0,0 +1,9 @@
+import { Type } from "@nestjs/common";
+export type ExtensionResolver = <TExtension>(extension: Type<TExtension>) => InstanceType<Type<TExtension>>;
+export interface IAuthorizationContext<TRequest = Request> {
+    user: unknown;
+    data?: unknown;
+    request: () => TRequest;
+    use: ExtensionResolver;
+    get<T>(resource: Type<T>): Promise<T | undefined>;
+}

package/dist/auth/types/context.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './rule.type';
+export * from './resource.type';
+export * from './context.type';
+export * from './tree-node.type';
+export * from './and';
+export * from './condition';
+export * from './not';
+export * from './or';
+export * from './permission';

package/dist/auth/types/index.js

@@ -0,0 +1,25 @@
+"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("./rule.type"), exports);
+__exportStar(require("./resource.type"), exports);
+__exportStar(require("./context.type"), exports);
+__exportStar(require("./tree-node.type"), exports);
+__exportStar(require("./and"), exports);
+__exportStar(require("./condition"), exports);
+__exportStar(require("./not"), exports);
+__exportStar(require("./or"), exports);
+__exportStar(require("./permission"), exports);

package/dist/auth/types/not/index.d.ts

@@ -0,0 +1,6 @@
+import { RuleNode } from '../rule.type';
+export interface INotRule extends RuleNode {
+    type: 'not';
+    child: RuleNode;
+}
+export type ITreeNotNode = INotRule;

package/dist/auth/types/not/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/or/index.d.ts

@@ -0,0 +1,6 @@
+import { RuleNode } from '../rule.type';
+export interface IOrRule extends RuleNode {
+    type: 'or';
+    children: RuleNode[];
+}
+export type ITreeOrNode = IOrRule;

package/dist/auth/types/or/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/permission/index.d.ts

@@ -0,0 +1,10 @@
+import { IResourceToken } from "../resource.type";
+import { RuleNode } from '../rule.type';
+export interface IPermissionRule<T = unknown> extends RuleNode {
+    type: 'permission';
+    resource: IResourceToken<T>;
+    action: string;
+}
+export type ITreePermissionNode = Pick<IPermissionRule, 'type'> & {
+    target: string;
+};

package/dist/auth/types/permission/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/resource.type.d.ts

@@ -0,0 +1,7 @@
+import { Type } from "@nestjs/common";
+export interface IResourceToken<T, TActions extends string[] = string[]> {
+    name: string;
+    model: Type<T>;
+    actions: TActions;
+    mahmoudId: string;
+}

package/dist/auth/types/resource.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/rule.type.d.ts

@@ -0,0 +1,4 @@
+export type RuleType = 'permission' | 'condition' | 'and' | 'or' | 'not';
+export interface RuleNode {
+    readonly type: RuleType;
+}

package/dist/auth/types/rule.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/auth/types/tree-node.type.d.ts

@@ -0,0 +1,16 @@
+import { RuleNode } from './rule.type';
+export interface ITreeNode {
+    id: string;
+    resource: string;
+    action: string;
+    rule: RuleNode;
+}
+export interface ITreeEdge {
+    from: string;
+    to: string;
+    type: 'requires';
+}
+export interface IAuthorizationGraphDto {
+    nodes: ITreeNode[];
+    edges: ITreeEdge[];
+}

package/dist/auth/types/tree-node.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/dist/auth/utils/and/index.d.ts

@@ -0,0 +1,3 @@
+import { IAndRule, ITreeAndNode, RuleNode } from "../../types";
+export declare const isAndRule: (rule: RuleNode) => rule is IAndRule;
+export declare const isTreeAndNode: (rule: RuleNode) => rule is ITreeAndNode;

package/dist/auth/utils/and/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTreeAndNode = exports.isAndRule = void 0;
+const isAndRule = (rule) => {
+    return rule.type === 'and';
+};
+exports.isAndRule = isAndRule;
+const isTreeAndNode = (rule) => (0, exports.isAndRule)(rule);
+exports.isTreeAndNode = isTreeAndNode;

package/dist/auth/utils/condition/index.d.ts

@@ -0,0 +1,3 @@
+import { IConditionRule, ITreeConditionNode, RuleNode } from "../../types";
+export declare const isConditionRule: (rule: RuleNode) => rule is IConditionRule;
+export declare const isTreeConditionNode: (rule: RuleNode) => rule is ITreeConditionNode;

package/dist/auth/utils/condition/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTreeConditionNode = exports.isConditionRule = void 0;
+const isConditionRule = (rule) => {
+    return rule.type === 'condition';
+};
+exports.isConditionRule = isConditionRule;
+const isTreeConditionNode = (rule) => (0, exports.isConditionRule)(rule);
+exports.isTreeConditionNode = isTreeConditionNode;

package/dist/auth/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './and';
+export * from './condition';
+export * from './not';
+export * from './or';
+export * from './permission';
+export * from './null';

package/dist/auth/utils/index.js

@@ -0,0 +1,22 @@
+"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("./and"), exports);
+__exportStar(require("./condition"), exports);
+__exportStar(require("./not"), exports);
+__exportStar(require("./or"), exports);
+__exportStar(require("./permission"), exports);
+__exportStar(require("./null"), exports);

package/dist/auth/utils/not/index.d.ts

@@ -0,0 +1,3 @@
+import { INotRule, ITreeNotNode, RuleNode } from "../../types";
+export declare const isNotRule: (rule: RuleNode) => rule is INotRule;
+export declare const isTreeNotNode: (rule: RuleNode) => rule is ITreeNotNode;

package/dist/auth/utils/not/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTreeNotNode = exports.isNotRule = void 0;
+const isNotRule = (rule) => {
+    return rule.type === 'not';
+};
+exports.isNotRule = isNotRule;
+const isTreeNotNode = (rule) => (0, exports.isNotRule)(rule);
+exports.isTreeNotNode = isTreeNotNode;

package/dist/auth/utils/null/index.d.ts

@@ -0,0 +1 @@
+export declare const isNotNull: <T>(arrayItem: T) => arrayItem is NonNullable<T>;

package/dist/auth/utils/null/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNotNull = void 0;
+const isNotNull = (arrayItem) => {
+    return arrayItem != null;
+};
+exports.isNotNull = isNotNull;

package/dist/auth/utils/or/index.d.ts

@@ -0,0 +1,3 @@
+import { IOrRule, ITreeOrNode, RuleNode } from "../../types";
+export declare const isOrRule: (rule: RuleNode) => rule is IOrRule;
+export declare const isTreeOrNode: (rule: RuleNode) => rule is ITreeOrNode;

package/dist/auth/utils/or/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTreeOrNode = exports.isOrRule = void 0;
+const isOrRule = (rule) => {
+    return rule.type === 'or';
+};
+exports.isOrRule = isOrRule;
+const isTreeOrNode = (rule) => (0, exports.isOrRule)(rule);
+exports.isTreeOrNode = isTreeOrNode;

package/dist/auth/utils/permission/index.d.ts

@@ -0,0 +1,3 @@
+import { IPermissionRule, ITreePermissionNode, RuleNode } from "../../types";
+export declare const isPermissionRule: (rule: RuleNode) => rule is IPermissionRule;
+export declare const isTreePermissionNode: (rule: RuleNode) => rule is ITreePermissionNode;

package/dist/auth/utils/permission/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTreePermissionNode = exports.isPermissionRule = void 0;
+const isPermissionRule = (rule) => {
+    return rule.type === 'permission';
+};
+exports.isPermissionRule = isPermissionRule;
+const isTreePermissionNode = (rule) => (0, exports.isPermissionRule)(rule);
+exports.isTreePermissionNode = isTreePermissionNode;

package/dist/index.d.ts

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

package/dist/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("./auth"), exports);

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@mahmoud-auth/common",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "license": "MIT",
+  "description": "Shared authorization and resource types for Mahmoud NestJS packages.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "prepack": "npm run build"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0"
+  },
+  "engines": {
+    "node": "^22.12.0 || ^24.0.0 || >=26.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shahariko-lab/nestjs-rebac.git",
+    "directory": "packages/mahmoud/common"
+  }
+}