@andrewcaires/api 5.0.6 → 5.1.1

package/dist/index.d.ts

@@ -1,200 +1,17 @@
 /*!
- * @andrewcaires/api v5.0.6
+ * @andrewcaires/api v5.1.1
  * Simple api for small applications using express, jsonwebtoken, sequelize and websocket
  * (c) 2026 Andrew Caires
  * @license: MIT
  */
 import { Context, Application as Application$1, IOptions, IStore } from '@andrewcaires/express';
 import { Hash, Env as Env$1 } from '@andrewcaires/node';
-import { Model, ModelFindOptions, ModelUpdateOptions, Sequelize } from '@andrewcaires/sequelize';
+import { ModelFindOptions, ModelUpdateOptions, Model as Model$1, Sequelize } from '@andrewcaires/sequelize';
 import { TypeAnyObject, TypeObjectString, TypeAnyFunction, TypeAnyConstructor, EventEmitter, TypeObject, ValidationBase } from '@andrewcaires/utils.js';
 import { WebSocketServer } from 'ws';
-import { Model as Model$1, CreateOptions, Attributes, FindOptions, IncludeOptions, FindAttributeOptions, ModelStatic } from 'sequelize';
+import { Model, CreateOptions, Attributes, FindOptions, IncludeOptions, FindAttributeOptions, ModelStatic } from 'sequelize';
 import { Store, SessionData } from 'express-session';
 
-declare class RegisterModel extends Model {
-    readonly id: string;
-    secret: string;
-    expired_at: number;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class UserAuthModel extends Model {
-    readonly id: string;
-    secret: string;
-    ip_address: string;
-    user_agent: string;
-    revoked_at: Date | null;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class PermissionModel extends Model {
-    readonly id: string;
-    name: string;
-    key: string;
-    tags: string;
-    description: string;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    groups_permissions: Array<GroupPermissionModel>;
-}
-
-declare class GroupPermissionModel extends Model {
-    readonly id: string;
-    readonly created_at: Date;
-    group_id: string;
-    group: GroupModel;
-    permission_id: string;
-    permission: PermissionModel;
-}
-
-declare class GroupModel extends Model {
-    readonly id: string;
-    name: string;
-    key: string;
-    tags: string;
-    description: string;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    users_groups: Array<UserGroupModel>;
-    groups_Permission: Array<GroupPermissionModel>;
-}
-
-declare class UserGroupModel extends Model {
-    readonly id: string;
-    readonly created_at: Date;
-    group_id: string;
-    group: GroupModel;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class UserPasswordModel extends Model {
-    readonly id: string;
-    value: string;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class UserProfileModel extends Model {
-    readonly id: string;
-    data: TypeAnyObject;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class UserModel extends Model {
-    readonly id: string;
-    name: string;
-    email: string;
-    username: string;
-    description: string;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    audits: Array<AuditModel>;
-    users_auths: Array<UserAuthModel>;
-    registers: Array<RegisterModel>;
-    users_groups: Array<UserGroupModel>;
-    users_passwords: Array<UserPasswordModel>;
-    users_profiles: Array<UserProfileModel>;
-}
-
-declare class AuditModel extends Model {
-    readonly id: string;
-    type: "CREATE" | "DELETE" | "UPDATE";
-    model: string;
-    record: string;
-    data: TypeAnyObject;
-    previously: TypeAnyObject;
-    full_url: string;
-    ip_address: string;
-    user_agent: string;
-    app_name: string;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class ConfigModel extends Model {
-    readonly id: string;
-    key: string;
-    value: string;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-}
-
-declare class ForgotModel extends Model {
-    readonly id: string;
-    secret: string;
-    expired_at: number;
-    state: boolean;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
-declare class LogModel extends Model {
-    readonly id: string;
-    level: "info" | "warn" | "error";
-    message: string;
-    source: string;
-    readonly created_at: Date;
-}
-
-declare class MigrationModel extends Model {
-    readonly id: string;
-    model: string;
-    version: string;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-}
-
-declare class SessionModel extends Model {
-    readonly id: string;
-    session: string;
-    json: string;
-    expired: number;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-}
-
-declare class UserMetadataModel extends Model {
-    readonly id: string;
-    data: TypeAnyObject;
-    readonly created_at: Date;
-    readonly updated_at: Date;
-    readonly deleted_at: Date | null;
-    user_id: string;
-    user: UserModel;
-}
-
 interface IAuthParameters {
     auth?: UserAuthModel;
     decode?: TypeAnyObject;
@@ -292,36 +109,35 @@ declare module "express-serve-static-core" {
     }
 }
 
-interface ModelArgumentsBase<M extends Model$1<M>> {
+interface ModelArgumentsBase<M extends Model<M>> {
     ctx?: Context;
 }
 
-interface ModelArgumentsCount<M extends Model$1<any>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsCount<M extends Model<any>> extends ModelArgumentsBase<M> {
     options?: ModelFindOptions<M>;
 }
 
-interface ModelArgumentsCreate<M extends Model$1<M>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsCreate<M extends Model<M>> extends ModelArgumentsBase<M> {
     body?: TypeAnyObject;
     options?: CreateOptions<Attributes<M>>;
 }
 
-interface ModelArgumentsDelete<M extends Model$1<M>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsDelete<M extends Model<M>> extends ModelArgumentsBase<M> {
     id?: string | number;
     options?: FindOptions<Attributes<M>>;
 }
 
 type ModelCallbackFindAll<M> = (_records: Array<M>) => Array<any> | Promise<Array<any>>;
 
-interface ModelArgumentsFindAll<M extends Model$1<any>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsFindAll<M extends Model<any>> extends ModelArgumentsBase<M> {
     callback?: ModelCallbackFindAll<M>;
-    limited?: boolean;
     options?: FindOptions<Attributes<M>>;
     query?: boolean;
 }
 
 type ModelCallbackFindOne<M> = (_records: M) => any | Promise<any>;
 
-interface ModelArgumentsFindOne<M extends Model$1<M>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsFindOne<M extends Model<M>> extends ModelArgumentsBase<M> {
     callback?: ModelCallbackFindOne<M>;
     id?: string | number;
     options?: FindOptions<Attributes<M>>;
@@ -332,7 +148,7 @@ interface ModelArgumentsInclude extends Omit<IncludeOptions, "model">, ModelArgu
     name?: string;
 }
 
-interface ModelArgumentsUpdate<M extends Model$1<M>> extends ModelArgumentsBase<M> {
+interface ModelArgumentsUpdate<M extends Model<M>> extends ModelArgumentsBase<M> {
     body?: TypeAnyObject;
     id?: string | number;
     options?: ModelUpdateOptions<M>;
@@ -344,11 +160,188 @@ interface ModelOptions {
     search?: Array<string>;
 }
 
-interface ModelResultFindAll<M extends Model<M>> {
+interface ModelResultFindAll<M extends Model$1<M>> {
     count: number;
     records: Array<M>;
 }
 
+declare enum AuditTypes {
+    CREATE = "CREATE",
+    DELETE = "DELETE",
+    UPDATE = "UPDATE"
+}
+
+declare enum Loglevels {
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+
+declare enum UserStatus {
+    ACTIVE = "active",
+    PENDING = "pending",
+    DISABLED = "disabled",
+    LOCKED = "locked",
+    ARCHIVED = "archived"
+}
+
+declare class RegisterModel extends Model$1 {
+    readonly id: string;
+    secret: string;
+    expired_at: number;
+    active: boolean;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class UserAuthModel extends Model$1 {
+    readonly id: string;
+    secret: string;
+    ip_address: string;
+    user_agent: string;
+    revoked_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class PermissionModel extends Model$1 {
+    readonly id: string;
+    name: string;
+    description: string;
+    active: boolean;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    groups_permissions: Array<GroupPermissionModel>;
+}
+
+declare class GroupPermissionModel extends Model$1 {
+    readonly id: string;
+    readonly created_at: Date;
+    group_id: string;
+    group: GroupModel;
+    permission_id: string;
+    permission: PermissionModel;
+}
+
+declare class GroupModel extends Model$1 {
+    readonly id: string;
+    name: string;
+    description: string;
+    active: boolean;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    users_groups: Array<UserGroupModel>;
+    groups_Permission: Array<GroupPermissionModel>;
+}
+
+declare class UserGroupModel extends Model$1 {
+    readonly id: string;
+    readonly created_at: Date;
+    group_id: string;
+    group: GroupModel;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class UserPasswordModel extends Model$1 {
+    readonly id: string;
+    hash: string;
+    revoked_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class UserModel extends Model$1 {
+    readonly id: string;
+    name: string;
+    username: string;
+    email: string;
+    notes: string;
+    status: UserStatus;
+    metadata: TypeAnyObject;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    audits: Array<AuditModel>;
+    users_auths: Array<UserAuthModel>;
+    registers: Array<RegisterModel>;
+    users_groups: Array<UserGroupModel>;
+    users_passwords: Array<UserPasswordModel>;
+}
+
+declare class AuditModel extends Model$1 {
+    readonly id: string;
+    type: AuditTypes;
+    model: string;
+    record: string;
+    currently: TypeAnyObject;
+    previously: TypeAnyObject;
+    full_url: string;
+    ip_address: string;
+    user_agent: string;
+    source: string;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class ConfigModel extends Model$1 {
+    readonly id: string;
+    key: string;
+    value: string;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+}
+
+declare class ForgotModel extends Model$1 {
+    readonly id: string;
+    secret: string;
+    expired_at: number;
+    state: boolean;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    user_id: string;
+    user: UserModel;
+}
+
+declare class LogModel extends Model$1 {
+    readonly id: string;
+    level: Loglevels;
+    message: string;
+    source: string;
+    readonly created_at: Date;
+}
+
+declare class MigrationModel extends Model$1 {
+    readonly id: string;
+    model: string;
+    version: string;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+}
+
+declare class SessionModel extends Model$1 {
+    readonly id: string;
+    data: TypeAnyObject;
+    expired_at: Date;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+}
+
 declare class Loggable {
     get log(): (message: string) => void;
     static get log(): (message: string) => void;
@@ -375,15 +368,14 @@ declare class Log {
 }
 
 declare class SessionStore extends Store {
-    private loop;
     constructor();
     all: (callback: TypeAnyFunction) => Promise<void>;
     clear: (callback: TypeAnyFunction) => Promise<void>;
-    destroy: (session_id: string, callback: TypeAnyFunction) => Promise<void>;
+    destroy: (id: string, callback: TypeAnyFunction) => Promise<void>;
     expired: () => Promise<void>;
-    get: (session_id: string, callback: TypeAnyFunction) => Promise<void>;
+    get: (id: string, callback: TypeAnyFunction) => Promise<void>;
     length: (callback: TypeAnyFunction) => Promise<void>;
-    set: (session_id: any, session: SessionData, callback: TypeAnyFunction) => Promise<void>;
+    set: (id: any, data: SessionData, callback: TypeAnyFunction) => Promise<void>;
 }
 
 interface Service extends Loggable {
@@ -392,6 +384,7 @@ declare abstract class Service {
 }
 
 declare class AuthService extends Service {
+    private readonly userAttributes;
     create(user: UserModel): Promise<IAuthParameters>;
     destroy(auth?: UserAuthModel): Promise<boolean>;
     renew(token: string): Promise<IAuthParameters>;
@@ -401,7 +394,7 @@ declare class AuthService extends Service {
     key(value: string): Promise<IAuthParameters>;
 }
 
-declare class ModelService<M extends Model$1<any>> extends Service {
+declare class ModelService<M extends Model<any>> extends Service {
     protected model: ModelStatic<M>;
     protected attributes: Array<string>;
     protected permissions: Array<string>;
@@ -426,9 +419,11 @@ declare class ModelService<M extends Model$1<any>> extends Service {
 }
 
 declare class UserService extends Service {
-    getMetadata(user_id: string): Promise<TypeObjectString>;
-    getProfile(user_id: string): Promise<TypeObjectString>;
+    private hashOptions;
+    createPassword(user_id: string, value: string, ctx?: Context): Promise<void>;
+    private findAllPermission;
     getGroups(user_id: string): Promise<Array<string>>;
+    getGroupsPermissions(user_id: string): Promise<TypeAnyObject>;
     getPermissions(user_id: string): Promise<Array<string>>;
 }
 
@@ -454,7 +449,7 @@ declare abstract class BaseController<T extends TypeAnyObject = TypeAnyObject> e
     sync(): Promise<void>;
 }
 
-declare abstract class ModelController<M extends Model$1<any>, T extends TypeAnyObject = TypeAnyObject> extends BaseController<T> {
+declare abstract class ModelController<M extends Model<any>, T extends TypeAnyObject = TypeAnyObject> extends BaseController<T> {
     protected readonly attributes: Array<string>;
     protected abstract readonly model: ModelStatic<M>;
     protected readonly permissions: Array<string>;
@@ -480,14 +475,13 @@ declare class AuditsController extends ModelController<AuditModel> {
 
 declare class AuthController extends BaseController<AuthEvents> {
     protected readonly authService: AuthService;
-    constructor(authService: AuthService);
     protected login(ctx: Context, user_agent: string, username: string, password: string, remember: boolean, app: Application): Promise<void>;
     protected logout(ctx: Context, auth: UserAuthModel, user: UserModel, app: Application): Promise<void>;
     protected renew(ctx: Context, user_agent: string, old: string, app: Application): Promise<void>;
     protected user(ctx: Context, user: UserModel): Promise<void>;
 }
 
-declare abstract class CrudController<M extends Model$1<any>, T extends TypeAnyObject = TypeAnyObject> extends ModelController<M, T> {
+declare abstract class CrudController<M extends Model<any>, T extends TypeAnyObject = TypeAnyObject> extends ModelController<M, T> {
     private _crud;
     CrudArgumentsCountAll(ctx: Context): ModelArgumentsUpdate<M>;
     CrudArgumentsCreate(ctx: Context): ModelArgumentsUpdate<M>;
@@ -529,7 +523,7 @@ declare class GroupsController extends CrudController<GroupModel> {
     private schemaCreate;
     private schemaUpdate;
     CrudValidateCreate(): TypeObject<ValidationBase>;
-    CrudalidateUpdate(): TypeObject<ValidationBase>;
+    CrudValidateUpdate(): TypeObject<ValidationBase>;
 }
 
 declare class GroupsPermissionsController extends ModelController<GroupPermissionModel> {
@@ -539,6 +533,10 @@ declare class GroupsPermissionsController extends ModelController<GroupPermissio
     protected set(ctx: Context, id: string, permissions: Array<string>): Promise<void>;
 }
 
+declare class HealthController {
+    protected ping(ctx: Context): Promise<void>;
+}
+
 declare class LogsController extends ModelController<LogModel> {
     protected readonly model: typeof LogModel;
     protected readonly permissions: Array<string>;
@@ -561,6 +559,7 @@ declare class RegisterController extends BaseController<RegisterEvents> {
 }
 
 declare class SetupController extends BaseController {
+    protected readonly userService: UserService;
     protected setup(ctx: Context): Promise<void>;
 }
 
@@ -585,21 +584,13 @@ declare class UsersGroupsController extends ModelController<UserGroupModel> {
     protected set(ctx: Context, id: string, groups: Array<string>): Promise<void>;
 }
 
-declare class UsersProfilesController extends ModelController<UserProfileModel> {
-    protected readonly model: typeof UserProfileModel;
-    protected readonly permissions: never[];
-    protected all(ctx: Context): Promise<void>;
-    protected get(ctx: Context, user_id: string): Promise<void>;
-    protected set(ctx: Context, id: string, body: TypeAnyObject): Promise<void>;
-}
-
 declare const sequelize: Sequelize;
 
 declare const CanCreate: (name?: string) => MethodDecorator;
 
 declare const CanDelete: (name?: string) => MethodDecorator;
 
-declare const canFactory: (key: string) => (name?: string) => MethodDecorator;
+declare const canFactory: (permission: string) => (name?: string) => MethodDecorator;
 
 declare const CanRead: (name?: string) => MethodDecorator;
 
@@ -633,23 +624,29 @@ declare class Env extends Env$1 {
     static readonly DATABASE_AUDIT: boolean;
     static readonly DATABASE_PREFIX: string;
     static readonly DATABASE_TIMEZONE: string;
+    static readonly HTTP_CROSS: string;
     static readonly HTTP_CRT: Buffer<ArrayBufferLike> | null;
     static readonly HTTP_KEY: Buffer<ArrayBufferLike> | null;
     static readonly MODEL_LIMIT: number;
     static readonly MODEL_LIMIT_MAX: number;
+    static readonly PASSWORD_ALGORITHM: number;
+    static readonly PASSWORD_MEMORY_COST: number;
+    static readonly PASSWORD_PARALLELISM: number;
+    static readonly PASSWORD_PEPPER: string;
+    static readonly PASSWORD_TIME_COST: number;
     static readonly SLEEP_AUTH: number;
     static readonly SLEEP_FORGOT: number;
     static readonly SLEEP_REGISTRY: number;
     static readonly TOKEN_CRT: Buffer<ArrayBufferLike> | null;
     static readonly TOKEN_KEY: Buffer<ArrayBufferLike> | null;
     static readonly TOKEN_TTL: number;
+    static readonly TOKEN_TYPE: string;
     static readonly API_BODYPARSER_STRICT: boolean;
     static readonly API_BODYPARSER_INFLATE: boolean;
     static readonly API_BODYPARSER_LIMIT: string;
     static readonly API_BODYPARSER_TYPE: string;
     static readonly API_HTTP_PORT: number;
     static readonly API_HTTP_PUBLIC: string;
-    static readonly API_HTTP_CROSS: boolean;
     static readonly API_HTTP_HYBRID: boolean;
     static readonly API_HTTP_NOTFOUND: string;
     static readonly API_HTTP_PATH: string;
@@ -663,11 +660,10 @@ declare class Env extends Env$1 {
     static readonly API_TOKEN_COOKIE_SET: boolean;
     static readonly API_TOKEN_FORGOT: number;
     static readonly API_TOKEN_HEADER: string;
-    static readonly API_TOKEN_HEADER_KEY: string;
     static readonly API_TOKEN_RENEW: number;
     static readonly API_USER_HISTORY: boolean;
     static readonly API_WEBSOCKET_START: boolean;
 }
 
-export { Application, Audit, AuditModel, AuditsController, AuthController, AuthService, BaseController, CanCreate, CanDelete, CanRead, CanUpdate, Config, ConfigModel, CrudController, Env, FilesController, ForgotController, ForgotModel, GroupModel, GroupPermissionModel, GroupsController, GroupsPermissionsController, HasGroups, HasPermissions, IsAuthenticated, Log, LogModel, Loggable, LogsController, MigrationModel, ModelController, ModelService, PermissionModel, PermissionsController, RegisterController, RegisterModel, ReqAuth, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqUser, Service, SessionModel, SessionStore, SetupController, UserAuthModel, UserGroupModel, UserMetadataModel, UserModel, UserPasswordModel, UserProfileModel, UserService, UsersController, UsersGroupsController, UsersProfilesController, canFactory, sequelize };
+export { Application, Audit, AuditModel, AuditTypes, AuditsController, AuthController, AuthService, BaseController, CanCreate, CanDelete, CanRead, CanUpdate, Config, ConfigModel, CrudController, Env, FilesController, ForgotController, ForgotModel, GroupModel, GroupPermissionModel, GroupsController, GroupsPermissionsController, HasGroups, HasPermissions, HealthController, IsAuthenticated, Log, LogModel, Loggable, Loglevels, LogsController, MigrationModel, ModelController, ModelService, PermissionModel, PermissionsController, RegisterController, RegisterModel, ReqAuth, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqUser, Service, SessionModel, SessionStore, SetupController, UserAuthModel, UserGroupModel, UserModel, UserPasswordModel, UserService, UserStatus, UsersController, UsersGroupsController, canFactory, sequelize };
 export type { ApplicationEvents, AuthEvents, ForgotEvents, IAuthParameters, ModelArgumentsBase, ModelArgumentsCount, ModelArgumentsCreate, ModelArgumentsDelete, ModelArgumentsFindAll, ModelArgumentsFindOne, ModelArgumentsInclude, ModelArgumentsUpdate, ModelCallbackFindAll, ModelCallbackFindOne, ModelOptions, ModelResultFindAll, RegisterEvents };