@spinajs/rbac 2.0.180 → 2.0.182

package/lib/cjs/interfaces.d.ts

@@ -1,260 +1,260 @@
-import { User } from './models/User.js';
-import { AsyncService } from '@spinajs/di';
-import { IDeleteQueryBuilder, IModelDescriptor, IQueryBuilder, ISelectQueryBuilder, IUpdateQueryBuilder, ModelBase } from '@spinajs/orm';
-import { DateTime } from 'luxon';
-declare module '@spinajs/orm' {
-    interface IModelStatic {
-        /**
-         *
-         * Alters query to check ownership of queried resource. Ensures that query returns/modify/delete only owned user data
-         *
-         * @param query query to alter
-         * @param user user to check againts ownership
-         * @param modelDescriptor resource model descriptor
-         */
-        ensureOwnership(query: ISelectQueryBuilder<any> | IUpdateQueryBuilder<any> | IDeleteQueryBuilder<any>, user: User): IQueryBuilder;
-        /**
-         * Checks ownership of retrieved model by user
-         * @param model model
-         * @param user user to check against ownership
-         */
-        checkOwnership<M>(model: ModelBase<M>, user: User): Promise<boolean>;
-        /**
-         * Checks ownership of model by its primary key
-         * @param model primary key to check
-         * @param user user to check against ownership
-         */
-        checkOwnership<M>(primaryKey: string | number, user: User): Promise<boolean>;
-        /**
-         * Checks ownership of retrieved model by user
-         * @param model model / primary key to check
-         * @param user user to check against ownership
-         */
-        checkOwnership<M>(modelOrPrimaryKey: ModelBase<M> | string | number, user: User): Promise<boolean>;
-    }
-}
-export interface ISession {
-    /**
-     * Session identifier
-     */
-    SessionId: string;
-    /**
-     * Expiration date. After that date session is invalid
-     */
-    Expiration?: DateTime;
-    /**
-     * Session creation date. After that date session is invalid
-     */
-    Creation: DateTime;
-    /**
-     * Data holds by session
-     */
-    Data: Map<string, unknown>;
-    /**
-     *
-     * Extends session lifetime
-     *
-     * @param seconds  - how mutch to extend, if value not provided, default value from config is used
-     */
-    extend(seconds?: number): void;
-}
-/**
- * Service used for generating random password & for hash raw string
- */
-export declare abstract class PasswordProvider {
-    /**
-     *
-     * Checks if hash is valid for given password
-     *
-     * @param hash - hasth to validate
-     * @param password - password to validate
-     */
-    abstract verify(hash: string, password: string): Promise<boolean>;
-    /**
-     *
-     * Generate hashed string from user password
-     *
-     * @param input - string to hash
-     */
-    abstract hash(input: string): Promise<string>;
-    /**
-     * Generates random user password
-     */
-    abstract generate(): string;
-}
-/**
- * Provides standard authentication based on login & password
- *
- * Unlike federated auth providers, it check local db for user,
- * or some kind of other source
- */
-export declare abstract class AuthProvider<U = User> {
-    /**
-     *
-     * Checks if user is already exists with given email
-     *
-     * @param emailOrUser - email or user object
-     */
-    abstract exists(emailOrUser: U | string): Promise<boolean>;
-    /**
-     *
-     * Authenticate user with login and pass, if succeded auth result contains user object
-     *
-     * @param login - user login
-     * @param password  - user password
-     */
-    abstract authenticate(login: string, password: string): Promise<IAuthenticationResult<U>>;
-    /**
-     *
-     * Checks if user is banned
-     *
-     * @param login - user login
-     */
-    abstract isBanned(login: string): Promise<boolean>;
-    /**
-     * Checks if user is active
-     *
-     * @param login - user login
-     */
-    abstract isActive(login: string): Promise<boolean>;
-    /**
-     *
-     * Cheks if user is deleted
-     *
-     * @param login - user login
-     */
-    abstract isDeleted(login: string): Promise<boolean>;
-    /**
-     *
-     * Gets user from auth store
-     *
-     * @param login - user login
-     */
-    abstract getByLogin(login: string): Promise<U>;
-    /**
-     *
-     * Gets user from auth store
-     *
-     * @param email - user email
-     */
-    abstract getByEmail(email: string): Promise<U>;
-    /**
-     *
-     * Gets user from auth store
-     *
-     * @param uuid - user uuid
-     */
-    abstract getByUUID(uuid: string): Promise<U>;
-}
-/**
- * Used for implementign authentication with external services
- * eg. slack or facebook that uses openid or similar auth
- *
- * NOTE: it should only authorize user, it should not register new one if
- * not exists in use DB.
- */
-export declare abstract class FederatedAuthProvider<C, U = User> {
-    /**
-     * Name of strategy
-     */
-    abstract get Name(): string;
-    /**
-     *
-     * login service provides Host header for check
-     * whitch service is trying to authenticate
-     *
-     * Base on host adress we choose auth provider
-     *
-     * @param caller - caller url
-     */
-    abstract callerCheck(caller: string): boolean;
-    /**
-     *
-     * Authenticates user based on response from external auth service
-     *
-     * @param credentials - provided credentials eg. data with token
-     */
-    abstract authenticate(credentials: C): Promise<IAuthenticationResult<U>>;
-}
-export declare abstract class SessionProvider<T = ISession> extends AsyncService {
-    /**
-     *
-     * Load session from store. If not exists or expired returns null
-     *
-     * @param sessionId - session identifier
-     */
-    abstract restore(sessionId: string): Promise<T>;
-    /**
-     *
-     * Deletes session from store
-     *
-     * @param sessionId - session to delete
-     */
-    abstract delete(sessionId: string): Promise<void>;
-    /**
-     *
-     * Adds or updates session in store
-     *
-     * @param session - session to update / insert
-     */
-    abstract save(session: ISession): Promise<void>;
-    /**
-     *
-     * Updates session data for given id
-     *
-     * @param id - session id
-     * @param data  - key - value pair of data
-     */
-    abstract save(id: string, data: object): Promise<void>;
-    /**
-     *
-     * Updates only EXPIRATION TIME of session, not changing other data
-     *
-     * @param session - session to update
-     */
-    abstract touch(session: ISession): Promise<void>;
-    /**
-     *
-     * Deletes all session table data
-     *
-     */
-    abstract truncate(): Promise<void>;
-}
-export declare enum AthenticationErrorCodes {
-    E_USER_BANNED = "E_USER_BANNED",
-    E_USER_NOT_ACTIVE = "E_USER_NOT_ACTIVE",
-    E_INVALID_CREDENTIALS = "E_INVALID_CREDENTIALS",
-    E_LOGIN_ATTEMPTS_EXCEEDED = "E_LOGIN_ATTEMPTS_EXCEEDED"
-}
-export interface IRbacModelDescriptor extends IModelDescriptor {
-    RbacResource: string;
-}
-/**
- * Authentication result
- */
-export interface IAuthenticationResult<U = User> {
-    /**
-     * If auth is succeded, user field is not null
-     */
-    User?: U;
-    /**
-     * If result failed, Error field is not null
-     */
-    Error?: {
-        /**
-         * Error code eg E_IS_BANNED
-         */
-        Code: string | AthenticationErrorCodes;
-        /**
-         * Optional message
-         */
-        Message?: string;
-    };
-}
-/**
- * Interface to provide implementation of password rule validation
- */
-export declare abstract class PasswordValidationProvider {
-    abstract check(password: string): boolean;
-}
+import { User } from './models/User.js';
+import { AsyncService } from '@spinajs/di';
+import { IDeleteQueryBuilder, IModelDescriptor, IQueryBuilder, ISelectQueryBuilder, IUpdateQueryBuilder, ModelBase } from '@spinajs/orm';
+import { DateTime } from 'luxon';
+declare module '@spinajs/orm' {
+    interface IModelStatic {
+        /**
+         *
+         * Alters query to check ownership of queried resource. Ensures that query returns/modify/delete only owned user data
+         *
+         * @param query query to alter
+         * @param user user to check againts ownership
+         * @param modelDescriptor resource model descriptor
+         */
+        ensureOwnership(query: ISelectQueryBuilder<any> | IUpdateQueryBuilder<any> | IDeleteQueryBuilder<any>, user: User): IQueryBuilder;
+        /**
+         * Checks ownership of retrieved model by user
+         * @param model model
+         * @param user user to check against ownership
+         */
+        checkOwnership<M>(model: ModelBase<M>, user: User): Promise<boolean>;
+        /**
+         * Checks ownership of model by its primary key
+         * @param model primary key to check
+         * @param user user to check against ownership
+         */
+        checkOwnership<M>(primaryKey: string | number, user: User): Promise<boolean>;
+        /**
+         * Checks ownership of retrieved model by user
+         * @param model model / primary key to check
+         * @param user user to check against ownership
+         */
+        checkOwnership<M>(modelOrPrimaryKey: ModelBase<M> | string | number, user: User): Promise<boolean>;
+    }
+}
+export interface ISession {
+    /**
+     * Session identifier
+     */
+    SessionId: string;
+    /**
+     * Expiration date. After that date session is invalid
+     */
+    Expiration?: DateTime;
+    /**
+     * Session creation date. After that date session is invalid
+     */
+    Creation: DateTime;
+    /**
+     * Data holds by session
+     */
+    Data: Map<string, unknown>;
+    /**
+     *
+     * Extends session lifetime
+     *
+     * @param seconds  - how mutch to extend, if value not provided, default value from config is used
+     */
+    extend(seconds?: number): void;
+}
+/**
+ * Service used for generating random password & for hash raw string
+ */
+export declare abstract class PasswordProvider {
+    /**
+     *
+     * Checks if hash is valid for given password
+     *
+     * @param hash - hasth to validate
+     * @param password - password to validate
+     */
+    abstract verify(hash: string, password: string): Promise<boolean>;
+    /**
+     *
+     * Generate hashed string from user password
+     *
+     * @param input - string to hash
+     */
+    abstract hash(input: string): Promise<string>;
+    /**
+     * Generates random user password
+     */
+    abstract generate(): string;
+}
+/**
+ * Provides standard authentication based on login & password
+ *
+ * Unlike federated auth providers, it check local db for user,
+ * or some kind of other source
+ */
+export declare abstract class AuthProvider<U = User> {
+    /**
+     *
+     * Checks if user is already exists with given email
+     *
+     * @param emailOrUser - email or user object
+     */
+    abstract exists(emailOrUser: U | string): Promise<boolean>;
+    /**
+     *
+     * Authenticate user with login and pass, if succeded auth result contains user object
+     *
+     * @param login - user login
+     * @param password  - user password
+     */
+    abstract authenticate(login: string, password: string): Promise<IAuthenticationResult<U>>;
+    /**
+     *
+     * Checks if user is banned
+     *
+     * @param login - user login
+     */
+    abstract isBanned(login: string): Promise<boolean>;
+    /**
+     * Checks if user is active
+     *
+     * @param login - user login
+     */
+    abstract isActive(login: string): Promise<boolean>;
+    /**
+     *
+     * Cheks if user is deleted
+     *
+     * @param login - user login
+     */
+    abstract isDeleted(login: string): Promise<boolean>;
+    /**
+     *
+     * Gets user from auth store
+     *
+     * @param login - user login
+     */
+    abstract getByLogin(login: string): Promise<U>;
+    /**
+     *
+     * Gets user from auth store
+     *
+     * @param email - user email
+     */
+    abstract getByEmail(email: string): Promise<U>;
+    /**
+     *
+     * Gets user from auth store
+     *
+     * @param uuid - user uuid
+     */
+    abstract getByUUID(uuid: string): Promise<U>;
+}
+/**
+ * Used for implementign authentication with external services
+ * eg. slack or facebook that uses openid or similar auth
+ *
+ * NOTE: it should only authorize user, it should not register new one if
+ * not exists in use DB.
+ */
+export declare abstract class FederatedAuthProvider<C, U = User> {
+    /**
+     * Name of strategy
+     */
+    abstract get Name(): string;
+    /**
+     *
+     * login service provides Host header for check
+     * whitch service is trying to authenticate
+     *
+     * Base on host adress we choose auth provider
+     *
+     * @param caller - caller url
+     */
+    abstract callerCheck(caller: string): boolean;
+    /**
+     *
+     * Authenticates user based on response from external auth service
+     *
+     * @param credentials - provided credentials eg. data with token
+     */
+    abstract authenticate(credentials: C): Promise<IAuthenticationResult<U>>;
+}
+export declare abstract class SessionProvider<T = ISession> extends AsyncService {
+    /**
+     *
+     * Load session from store. If not exists or expired returns null
+     *
+     * @param sessionId - session identifier
+     */
+    abstract restore(sessionId: string): Promise<T>;
+    /**
+     *
+     * Deletes session from store
+     *
+     * @param sessionId - session to delete
+     */
+    abstract delete(sessionId: string): Promise<void>;
+    /**
+     *
+     * Adds or updates session in store
+     *
+     * @param session - session to update / insert
+     */
+    abstract save(session: ISession): Promise<void>;
+    /**
+     *
+     * Updates session data for given id
+     *
+     * @param id - session id
+     * @param data  - key - value pair of data
+     */
+    abstract save(id: string, data: object): Promise<void>;
+    /**
+     *
+     * Updates only EXPIRATION TIME of session, not changing other data
+     *
+     * @param session - session to update
+     */
+    abstract touch(session: ISession): Promise<void>;
+    /**
+     *
+     * Deletes all session table data
+     *
+     */
+    abstract truncate(): Promise<void>;
+}
+export declare enum AthenticationErrorCodes {
+    E_USER_BANNED = "E_USER_BANNED",
+    E_USER_NOT_ACTIVE = "E_USER_NOT_ACTIVE",
+    E_INVALID_CREDENTIALS = "E_INVALID_CREDENTIALS",
+    E_LOGIN_ATTEMPTS_EXCEEDED = "E_LOGIN_ATTEMPTS_EXCEEDED"
+}
+export interface IRbacModelDescriptor extends IModelDescriptor {
+    RbacResource: string;
+}
+/**
+ * Authentication result
+ */
+export interface IAuthenticationResult<U = User> {
+    /**
+     * If auth is succeded, user field is not null
+     */
+    User?: U;
+    /**
+     * If result failed, Error field is not null
+     */
+    Error?: {
+        /**
+         * Error code eg E_IS_BANNED
+         */
+        Code: string | AthenticationErrorCodes;
+        /**
+         * Optional message
+         */
+        Message?: string;
+    };
+}
+/**
+ * Interface to provide implementation of password rule validation
+ */
+export declare abstract class PasswordValidationProvider {
+    abstract check(password: string): boolean;
+}
 //# sourceMappingURL=interfaces.d.ts.map

package/lib/cjs/interfaces.js

@@ -1,46 +1,46 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PasswordValidationProvider = exports.AthenticationErrorCodes = exports.SessionProvider = exports.FederatedAuthProvider = exports.AuthProvider = exports.PasswordProvider = void 0;
-const di_1 = require("@spinajs/di");
-/**
- * Service used for generating random password & for hash raw string
- */
-class PasswordProvider {
-}
-exports.PasswordProvider = PasswordProvider;
-/**
- * Provides standard authentication based on login & password
- *
- * Unlike federated auth providers, it check local db for user,
- * or some kind of other source
- */
-class AuthProvider {
-}
-exports.AuthProvider = AuthProvider;
-/**
- * Used for implementign authentication with external services
- * eg. slack or facebook that uses openid or similar auth
- *
- * NOTE: it should only authorize user, it should not register new one if
- * not exists in use DB.
- */
-class FederatedAuthProvider {
-}
-exports.FederatedAuthProvider = FederatedAuthProvider;
-class SessionProvider extends di_1.AsyncService {
-}
-exports.SessionProvider = SessionProvider;
-var AthenticationErrorCodes;
-(function (AthenticationErrorCodes) {
-    AthenticationErrorCodes["E_USER_BANNED"] = "E_USER_BANNED";
-    AthenticationErrorCodes["E_USER_NOT_ACTIVE"] = "E_USER_NOT_ACTIVE";
-    AthenticationErrorCodes["E_INVALID_CREDENTIALS"] = "E_INVALID_CREDENTIALS";
-    AthenticationErrorCodes["E_LOGIN_ATTEMPTS_EXCEEDED"] = "E_LOGIN_ATTEMPTS_EXCEEDED";
-})(AthenticationErrorCodes = exports.AthenticationErrorCodes || (exports.AthenticationErrorCodes = {}));
-/**
- * Interface to provide implementation of password rule validation
- */
-class PasswordValidationProvider {
-}
-exports.PasswordValidationProvider = PasswordValidationProvider;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PasswordValidationProvider = exports.AthenticationErrorCodes = exports.SessionProvider = exports.FederatedAuthProvider = exports.AuthProvider = exports.PasswordProvider = void 0;
+const di_1 = require("@spinajs/di");
+/**
+ * Service used for generating random password & for hash raw string
+ */
+class PasswordProvider {
+}
+exports.PasswordProvider = PasswordProvider;
+/**
+ * Provides standard authentication based on login & password
+ *
+ * Unlike federated auth providers, it check local db for user,
+ * or some kind of other source
+ */
+class AuthProvider {
+}
+exports.AuthProvider = AuthProvider;
+/**
+ * Used for implementign authentication with external services
+ * eg. slack or facebook that uses openid or similar auth
+ *
+ * NOTE: it should only authorize user, it should not register new one if
+ * not exists in use DB.
+ */
+class FederatedAuthProvider {
+}
+exports.FederatedAuthProvider = FederatedAuthProvider;
+class SessionProvider extends di_1.AsyncService {
+}
+exports.SessionProvider = SessionProvider;
+var AthenticationErrorCodes;
+(function (AthenticationErrorCodes) {
+    AthenticationErrorCodes["E_USER_BANNED"] = "E_USER_BANNED";
+    AthenticationErrorCodes["E_USER_NOT_ACTIVE"] = "E_USER_NOT_ACTIVE";
+    AthenticationErrorCodes["E_INVALID_CREDENTIALS"] = "E_INVALID_CREDENTIALS";
+    AthenticationErrorCodes["E_LOGIN_ATTEMPTS_EXCEEDED"] = "E_LOGIN_ATTEMPTS_EXCEEDED";
+})(AthenticationErrorCodes || (exports.AthenticationErrorCodes = AthenticationErrorCodes = {}));
+/**
+ * Interface to provide implementation of password rule validation
+ */
+class PasswordValidationProvider {
+}
+exports.PasswordValidationProvider = PasswordValidationProvider;
 //# sourceMappingURL=interfaces.js.map

package/lib/cjs/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;AACA,oCAA2C;AAqE3C;;GAEG;AACH,MAAsB,gBAAgB;CAsBrC;AAtBD,4CAsBC;AAED;;;;;GAKG;AACH,MAAsB,YAAY;CAgEjC;AAhED,oCAgEC;AAED;;;;;;GAMG;AACH,MAAsB,qBAAqB;CAwB1C;AAxBD,sDAwBC;AAED,MAAsB,eAA8B,SAAQ,iBAAY;CAgDvE;AAhDD,0CAgDC;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,0DAA+B,CAAA;IAC/B,kEAAuC,CAAA;IACvC,0EAA+C,CAAA;IAC/C,kFAAuD,CAAA;AACzD,CAAC,EALW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAKlC;AA+BD;;GAEG;AACH,MAAsB,0BAA0B;CAE/C;AAFD,gEAEC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;AACA,oCAA2C;AAqE3C;;GAEG;AACH,MAAsB,gBAAgB;CAsBrC;AAtBD,4CAsBC;AAED;;;;;GAKG;AACH,MAAsB,YAAY;CAgEjC;AAhED,oCAgEC;AAED;;;;;;GAMG;AACH,MAAsB,qBAAqB;CAwB1C;AAxBD,sDAwBC;AAED,MAAsB,eAA8B,SAAQ,iBAAY;CAgDvE;AAhDD,0CAgDC;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,0DAA+B,CAAA;IAC/B,kEAAuC,CAAA;IACvC,0EAA+C,CAAA;IAC/C,kFAAuD,CAAA;AACzD,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AA+BD;;GAEG;AACH,MAAsB,0BAA0B;CAE/C;AAFD,gEAEC"}

package/lib/cjs/jobs/UnbanUser.d.ts

@@ -1,10 +1,10 @@
-import { Log } from '@spinajs/log';
-import { QueueService, QueueJob } from '@spinajs/queue';
-export declare class UnbanUser extends QueueJob {
-    UserUUID: string;
-    protected Log: Log;
-    protected Queue: QueueService;
-    constructor(UserUUID: string);
-    execute(): Promise<void>;
-}
+import { Log } from '@spinajs/log';
+import { QueueService, QueueJob } from '@spinajs/queue';
+export declare class UnbanUser extends QueueJob {
+    UserUUID: string;
+    protected Log: Log;
+    protected Queue: QueueService;
+    constructor(UserUUID: string);
+    execute(): Promise<void>;
+}
 //# sourceMappingURL=UnbanUser.d.ts.map