@nestjs-kitchen/authz 2.0.3 → 2.0.5

package/dist/authz.provider.d.ts

@@ -1,10 +1,11 @@
+import type { Request } from 'express';
 /**
  * Abstract base class for implementing custom authorization logic.
  *
  * @template Payload - The type representing the payload used for authentication.
  * @template User - The type representing the user entity involved in authentication and authorization.
  */
-declare abstract class AuthzProviderClass<Payload, User> {
+export declare abstract class AuthzProviderClass<Payload, User> {
     /**
      * Creates a payload from the given user.
      *
@@ -25,7 +26,7 @@ declare abstract class AuthzProviderClass<Payload, User> {
      * @param {Payload} payload - The payload to authenticate.
      * @returns {User | Promise<User>} The authenticated user, or a promise resolving to the user.
      */
-    abstract authenticate(payload: Payload): User | Promise<User>;
+    abstract authenticate(payload: Payload, req?: Request): User | Promise<User>;
     /**
      * (**Optional**: Implement this method only if authorization is required.)
      *
@@ -42,5 +43,3 @@ declare abstract class AuthzProviderClass<Payload, User> {
      */
     authorize(_user: User, _metaData?: unknown): boolean | Promise<boolean>;
 }
-
-export { AuthzProviderClass };

package/dist/authz.provider.js

@@ -1,45 +1,29 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var authz_provider_exports = {};
-__export(authz_provider_exports, {
-  AuthzProviderClass: () => AuthzProviderClass
-});
-module.exports = __toCommonJS(authz_provider_exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthzProviderClass = void 0;
+/**
+ * Abstract base class for implementing custom authorization logic.
+ *
+ * @template Payload - The type representing the payload used for authentication.
+ * @template User - The type representing the user entity involved in authentication and authorization.
+ */
 class AuthzProviderClass {
-  /**
-   * (**Optional**: Implement this method only if authorization is required.)
-   *
-   * Authorizes a user based on the provided metadata.
-   *
-   * This method checks if the given user is authorized to perform a specific action based on
-   * the provided metadata. If implemented, this method enables the authorization check; otherwise,
-   * only authentication will be performed.
-   *
-   * @param {User} _user - The user entity that needs to be authorized.
-   * @param {unknown} [_metaData] - Optional metadata that can influence the authorization decision.
-   * @returns {boolean | Promise<boolean>} `true` if the user is authorized, `false` otherwise,
-   * or a promise that resolves to the authorization result.
-   */
-  authorize(_user, _metaData) {
-    return true;
-  }
+    /**
+     * (**Optional**: Implement this method only if authorization is required.)
+     *
+     * Authorizes a user based on the provided metadata.
+     *
+     * This method checks if the given user is authorized to perform a specific action based on
+     * the provided metadata. If implemented, this method enables the authorization check; otherwise,
+     * only authentication will be performed.
+     *
+     * @param {User} _user - The user entity that needs to be authorized.
+     * @param {unknown} [_metaData] - Optional metadata that can influence the authorization decision.
+     * @returns {boolean | Promise<boolean>} `true` if the user is authorized, `false` otherwise,
+     * or a promise that resolves to the authorization result.
+     */
+    authorize(_user, _metaData) {
+        return true; // Default implementation always returns true.
+    }
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  AuthzProviderClass
-});
+exports.AuthzProviderClass = AuthzProviderClass;

package/dist/constants.d.ts

@@ -1,11 +1,9 @@
-declare const DEFAULT_PASSPORT_PROPERTY_VALUE = "user";
-declare const PASSPORT_PROPERTY: unique symbol;
-declare const PREFIX = "`<`:";
-declare const ROUTES_OPTIONS: unique symbol;
-declare enum JwtValidationType {
+export declare const DEFAULT_PASSPORT_PROPERTY_VALUE = "user";
+export declare const PASSPORT_PROPERTY: unique symbol;
+export declare const PREFIX = "`<`:";
+export declare const ROUTES_OPTIONS: unique symbol;
+export declare enum JwtValidationType {
     JWT = 0,
     REFRESH = 1
 }
-declare const SESSION_PASSPORT_KEY = "passport";
-
-export { DEFAULT_PASSPORT_PROPERTY_VALUE, JwtValidationType, PASSPORT_PROPERTY, PREFIX, ROUTES_OPTIONS, SESSION_PASSPORT_KEY };
+export declare const SESSION_PASSPORT_KEY = "passport";

package/dist/constants.js

@@ -1,46 +1,13 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var constants_exports = {};
-__export(constants_exports, {
-  DEFAULT_PASSPORT_PROPERTY_VALUE: () => DEFAULT_PASSPORT_PROPERTY_VALUE,
-  JwtValidationType: () => JwtValidationType,
-  PASSPORT_PROPERTY: () => PASSPORT_PROPERTY,
-  PREFIX: () => PREFIX,
-  ROUTES_OPTIONS: () => ROUTES_OPTIONS,
-  SESSION_PASSPORT_KEY: () => SESSION_PASSPORT_KEY
-});
-module.exports = __toCommonJS(constants_exports);
-const DEFAULT_PASSPORT_PROPERTY_VALUE = "user";
-const PASSPORT_PROPERTY = Symbol("PASSPORT_PROPERTY");
-const PREFIX = "`<`:";
-const ROUTES_OPTIONS = Symbol("ROUTES_OPTIONS");
-var JwtValidationType = /* @__PURE__ */ ((JwtValidationType2) => {
-  JwtValidationType2[JwtValidationType2["JWT"] = 0] = "JWT";
-  JwtValidationType2[JwtValidationType2["REFRESH"] = 1] = "REFRESH";
-  return JwtValidationType2;
-})(JwtValidationType || {});
-const SESSION_PASSPORT_KEY = "passport";
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  DEFAULT_PASSPORT_PROPERTY_VALUE,
-  JwtValidationType,
-  PASSPORT_PROPERTY,
-  PREFIX,
-  ROUTES_OPTIONS,
-  SESSION_PASSPORT_KEY
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SESSION_PASSPORT_KEY = exports.JwtValidationType = exports.ROUTES_OPTIONS = exports.PREFIX = exports.PASSPORT_PROPERTY = exports.DEFAULT_PASSPORT_PROPERTY_VALUE = void 0;
+exports.DEFAULT_PASSPORT_PROPERTY_VALUE = 'user';
+exports.PASSPORT_PROPERTY = Symbol('PASSPORT_PROPERTY');
+exports.PREFIX = '`<`:';
+exports.ROUTES_OPTIONS = Symbol('ROUTES_OPTIONS');
+var JwtValidationType;
+(function (JwtValidationType) {
+    JwtValidationType[JwtValidationType["JWT"] = 0] = "JWT";
+    JwtValidationType[JwtValidationType["REFRESH"] = 1] = "REFRESH";
+})(JwtValidationType || (exports.JwtValidationType = JwtValidationType = {}));
+exports.SESSION_PASSPORT_KEY = 'passport';

package/dist/errors.d.ts

@@ -1,21 +1,19 @@
 /**
  * Internal error type.
  */
-declare class AuthzError extends Error {
+export declare class AuthzError extends Error {
     cause?: unknown;
     constructor(message?: string, cause?: unknown);
 }
 /**
  * Internal error type for verification error.
  */
-declare class AuthzVerificationError extends AuthzError {
+export declare class AuthzVerificationError extends AuthzError {
     constructor(message?: string, cause?: unknown);
 }
 /**
  * Internal error type for anonymous error.
  */
-declare class AuthzAnonymousError extends AuthzError {
+export declare class AuthzAnonymousError extends AuthzError {
     constructor(message?: string, cause?: unknown);
 }
-
-export { AuthzAnonymousError, AuthzError, AuthzVerificationError };

package/dist/errors.js

@@ -1,50 +1,35 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var errors_exports = {};
-__export(errors_exports, {
-  AuthzAnonymousError: () => AuthzAnonymousError,
-  AuthzError: () => AuthzError,
-  AuthzVerificationError: () => AuthzVerificationError
-});
-module.exports = __toCommonJS(errors_exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthzAnonymousError = exports.AuthzVerificationError = exports.AuthzError = void 0;
+/**
+ * Internal error type.
+ */
 class AuthzError extends Error {
-  constructor(message, cause) {
-    super(message);
-    this.name = "AuthzError";
-    this.cause = cause;
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
+    constructor(message, cause) {
+        super(message);
+        this.name = 'AuthzError';
+        this.cause = cause;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
 }
+exports.AuthzError = AuthzError;
+/**
+ * Internal error type for verification error.
+ */
 class AuthzVerificationError extends AuthzError {
-  constructor(message, cause) {
-    super(message, cause);
-    this.name = "AuthzVerificationError";
-  }
+    constructor(message, cause) {
+        super(message, cause);
+        this.name = 'AuthzVerificationError';
+    }
 }
+exports.AuthzVerificationError = AuthzVerificationError;
+/**
+ * Internal error type for anonymous error.
+ */
 class AuthzAnonymousError extends AuthzError {
-  constructor(message, cause) {
-    super(message, cause);
-    this.name = "AuthzAnonymousError";
-  }
+    constructor(message, cause) {
+        super(message, cause);
+        this.name = 'AuthzAnonymousError';
+    }
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  AuthzAnonymousError,
-  AuthzError,
-  AuthzVerificationError
-});
+exports.AuthzAnonymousError = AuthzAnonymousError;

package/dist/index.d.ts

@@ -1,21 +1,5 @@
-export { AuthzProviderClass } from './authz.provider.js';
-export { User } from './user.decorator.js';
-export { AuthzAnonymousError, AuthzError, AuthzVerificationError } from './errors.js';
-export { ExtractJwt, JwtFromRequestFunction } from './jwt/extract-jwt.js';
-export { createJwtAuthzModule } from './jwt/jwt-authz.module.js';
-export { cereateSessionAuthzModule } from './session/session-authz.module.js';
-import '@nestjs/common';
-import 'cookie';
-import '@nestjs/core';
-import './jwt/jwt-authz.interface.js';
-import 'crypto';
-import 'jsonwebtoken';
-import './utils/types.js';
-import '@nestjs/common/interfaces';
-import 'express';
-import 'node:async_hooks';
-import './jwt/jwt-authz-als.middleware.js';
-import './constants.js';
-import './session/session-authz.interface.js';
-import 'express-session';
-import './session/session-authz-als.middleware.js';
+export { AuthzProviderClass } from './authz.provider';
+export { User } from './user.decorator';
+export { AuthzError, AuthzVerificationError, AuthzAnonymousError } from './errors';
+export { ExtractJwt, type JwtFromRequestFunction, createJwtAuthzModule } from './jwt';
+export { cereateSessionAuthzModule } from './session';

package/dist/index.js

@@ -1,45 +1,16 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var index_exports = {};
-__export(index_exports, {
-  AuthzAnonymousError: () => import_errors.AuthzAnonymousError,
-  AuthzError: () => import_errors.AuthzError,
-  AuthzProviderClass: () => import_authz.AuthzProviderClass,
-  AuthzVerificationError: () => import_errors.AuthzVerificationError,
-  ExtractJwt: () => import_jwt.ExtractJwt,
-  User: () => import_user.User,
-  cereateSessionAuthzModule: () => import_session.cereateSessionAuthzModule,
-  createJwtAuthzModule: () => import_jwt.createJwtAuthzModule
-});
-module.exports = __toCommonJS(index_exports);
-var import_authz = require("./authz.provider");
-var import_user = require("./user.decorator");
-var import_errors = require("./errors");
-var import_jwt = require("./jwt");
-var import_session = require("./session");
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  AuthzAnonymousError,
-  AuthzError,
-  AuthzProviderClass,
-  AuthzVerificationError,
-  ExtractJwt,
-  User,
-  cereateSessionAuthzModule,
-  createJwtAuthzModule
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cereateSessionAuthzModule = exports.createJwtAuthzModule = exports.ExtractJwt = exports.AuthzAnonymousError = exports.AuthzVerificationError = exports.AuthzError = exports.User = exports.AuthzProviderClass = void 0;
+var authz_provider_1 = require("./authz.provider");
+Object.defineProperty(exports, "AuthzProviderClass", { enumerable: true, get: function () { return authz_provider_1.AuthzProviderClass; } });
+var user_decorator_1 = require("./user.decorator");
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return user_decorator_1.User; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "AuthzError", { enumerable: true, get: function () { return errors_1.AuthzError; } });
+Object.defineProperty(exports, "AuthzVerificationError", { enumerable: true, get: function () { return errors_1.AuthzVerificationError; } });
+Object.defineProperty(exports, "AuthzAnonymousError", { enumerable: true, get: function () { return errors_1.AuthzAnonymousError; } });
+var jwt_1 = require("./jwt");
+Object.defineProperty(exports, "ExtractJwt", { enumerable: true, get: function () { return jwt_1.ExtractJwt; } });
+Object.defineProperty(exports, "createJwtAuthzModule", { enumerable: true, get: function () { return jwt_1.createJwtAuthzModule; } });
+var session_1 = require("./session");
+Object.defineProperty(exports, "cereateSessionAuthzModule", { enumerable: true, get: function () { return session_1.cereateSessionAuthzModule; } });

package/dist/jwt/extract-jwt.d.ts

@@ -1,10 +1,9 @@
-import { ParseOptions } from 'cookie';
-
-declare const parseAuthHeader: (hdrValue: unknown) => {
+import type { ParseOptions } from 'cookie';
+export declare const parseAuthHeader: (hdrValue: unknown) => {
     scheme: string;
     value: string;
 } | null;
-interface JwtFromRequestFunction<T = any> {
+export interface JwtFromRequestFunction<T = any> {
     (req: T): string | null;
 }
 /**
@@ -12,7 +11,7 @@ interface JwtFromRequestFunction<T = any> {
  *
  * Same as `passportjs` [jwt extractors](https://www.passportjs.org/packages/passport-jwt/#included-extractors)
  */
-declare const ExtractJwt: {
+export declare const ExtractJwt: {
     /**
      * Creates an extractor function to retrieve a token from the request header.
      *
@@ -72,5 +71,3 @@ declare const ExtractJwt: {
      */
     fromExtractors: (extractors: JwtFromRequestFunction[]) => JwtFromRequestFunction;
 };
-
-export { ExtractJwt, type JwtFromRequestFunction, parseAuthHeader };