@andrewcaires/api 4.4.1 → 4.5.0

package/dist/index.d.ts

@@ -1,117 +1,60 @@
 /*!
- * @andrewcaires/api v4.4.1
+ * @andrewcaires/api v4.5.0
  * Simple api for small applications using express, jsonwebtoken, sequelize and websocket 
- * (c) 2025 Andrew Caires
+ * (c) 2026 Andrew Caires
  * @license: MIT
  */
-import { Env as Env$1, Hash } from '@andrewcaires/node';
-import { EventEmitter, TypeObjectAny, TypeObjectString, TypeObject, ValidationBase, TypeCallbackFunction } from '@andrewcaires/utils.js';
+import { EventEmitter, TypeAnyObject, TypeObjectString, TypeObject, ValidationBase, TypeAnyFunction } from '@andrewcaires/utils.js';
 import { Application as Application$1, Context, IStore, IUpload, IFile } from '@andrewcaires/express';
-import { WhereOptions, Model as Model$2, CreateOptions, Attributes, FindOptions, UpdateOptions, FindAttributeOptions, ModelStatic } from 'sequelize';
-import { Model as Model$1, Connection } from '@andrewcaires/sequelize';
+import { WhereOptions, Model as Model$1, CreateOptions, Attributes, FindOptions, UpdateOptions, FindAttributeOptions, ModelStatic } from 'sequelize';
+import { Model, Sequelize } from '@andrewcaires/sequelize';
+import { Hash, Env as Env$1 } from '@andrewcaires/node';
 import { WebSocketServer } from 'ws';
 import { Store as Store$1, SessionData } from 'express-session';
 
-declare class Env extends Env$1 {
-    static readonly API_BASE_NAME: 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_CONSOLE_ERROR: boolean;
-    static readonly API_DB_DATABASE: string;
-    static readonly API_DB_HOST: string;
-    static readonly API_DB_PASSWORD: string;
-    static readonly API_DB_PORT: number;
-    static readonly API_DB_TYPE: string;
-    static readonly API_DB_USERNAME: string;
-    static readonly API_DB_LOG: boolean;
-    static readonly API_DB_AUDIT: boolean;
-    static readonly API_DB_PREFIX: string;
-    static readonly API_DB_TIMEZONE: string;
-    static readonly API_HTTP_CRT: string;
-    static readonly API_HTTP_KEY: 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;
-    static readonly API_HTTP_REDIRECT: string;
-    static readonly API_KEY_HASH: string;
-    static readonly API_KEY_HEADER: string;
-    static readonly API_MODEL_LIMIT: number;
-    static readonly API_MODEL_LIMIT_MAX: number;
-    static readonly API_SLEEP_AUTH: number;
-    static readonly API_SLEEP_FORGOT: number;
-    static readonly API_SLEEP_REGISTRY: number;
-    static readonly API_SESSION_NAME: string;
-    static readonly API_SESSION_LIFETIME: number;
-    static readonly API_SESSION_SECRET: string;
-    static readonly API_TOKEN_CRT: string;
-    static readonly API_TOKEN_KEY: string;
-    static readonly API_TOKEN_FORGOT: number;
-    static readonly API_TOKEN_HEADER: string;
-    static readonly API_TOKEN_HEADER_KEY: string;
-    static readonly API_TOKEN_LIFETIME: number;
-    static readonly API_TOKEN_RENEW: number;
-    static readonly API_UPLOAD_COUNT: number;
-    static readonly API_UPLOAD_FIELD: string;
-    static readonly API_UPLOAD_SIZE: number;
-    static readonly API_UPLOAD_TEMP: string;
-    static readonly API_USER_HISTORY: boolean;
-    static readonly API_WEBSOCKET_START: boolean;
-}
-
 declare abstract class Controller extends EventEmitter {
     static readonly ATTRIBUTES: unique symbol;
     static readonly PERMISSIONS: unique symbol;
 }
 
-declare class Model extends Model$1 {
-    protected static error(error: any): void;
-}
-
-declare const database: Connection;
-
 declare class Auth extends Model {
-    id: number;
+    readonly id: number;
     secret: string;
     logout: Date | null;
     user_agent: string;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     user_id: number;
     user: User;
 }
 
 declare class Register extends Model {
-    id: number;
+    readonly id: number;
     token: string;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     user_id: number;
     user: User;
 }
 
 declare class Permission extends Model {
-    id: number;
+    readonly id: number;
     name: string;
     route: string;
     tag: string;
     description: string;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     groups_permissions: Array<GroupPermission>;
 }
 
 declare class GroupPermission extends Model {
-    created_at: Date;
+    readonly created_at: Date;
     group_id: number;
     group: Group;
     permission_id: number;
@@ -119,19 +62,19 @@ declare class GroupPermission extends Model {
 }
 
 declare class Group extends Model {
-    id: number;
+    readonly id: number;
     name: string;
     description: string;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     groups_routes: Array<GroupPermission>;
     users_groups: Array<UserGroup>;
 }
 
 declare class UserGroup extends Model {
-    created_at: Date;
+    readonly created_at: Date;
     group_id: number;
     group: Group;
     user_id: number;
@@ -140,13 +83,13 @@ declare class UserGroup extends Model {
 
 declare class UserHistory extends Model {
     password: string;
-    created_at: Date;
+    readonly created_at: Date;
     user_id: number;
     user: User;
 }
 
 declare class User extends Model {
-    id: number;
+    readonly id: number;
     name: string;
     email: string;
     username: string;
@@ -157,9 +100,9 @@ declare class User extends Model {
     date: string;
     description: string;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     audits: Array<Audit>;
     auths: Array<Auth>;
     registers: Array<Register>;
@@ -168,19 +111,19 @@ declare class User extends Model {
 }
 
 declare class Audit extends Model {
-    id: number;
+    readonly id: number;
     type: string;
     model: string;
     record: string;
-    data: TypeObjectAny;
-    previously: TypeObjectAny;
+    data: TypeAnyObject;
+    previously: TypeAnyObject;
     client: string;
     href: string;
     user_agent: string;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     user_id: number;
     user: User;
 }
@@ -188,8 +131,8 @@ declare class Audit extends Model {
 declare class Config extends Model {
     key: string;
     value: string;
-    created_at: Date;
-    updated_at: Date;
+    readonly created_at: Date;
+    readonly updated_at: Date;
     static all(): Promise<TypeObjectString>;
     static del(key: string, user?: User): Promise<boolean>;
     static get(key: string, value?: string): Promise<string>;
@@ -197,23 +140,23 @@ declare class Config extends Model {
 }
 
 declare class Forgot extends Model {
-    id: number;
+    readonly id: number;
     token: string;
     timestamp: number;
     state: boolean;
-    created_at: Date;
-    updated_at: Date;
-    deleted_at: Date | null;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
     user_id: number;
     user: User;
 }
 
 declare class Log extends Model {
-    id: number;
+    readonly id: number;
     type: string;
     source: string;
     message: string;
-    created_at: Date;
+    readonly created_at: Date;
     static write(message: string, source?: string, show?: boolean): Promise<void>;
     static error(message: string, source?: string, show?: boolean): Promise<void>;
     static info(message: string, source?: string, show?: boolean): Promise<void>;
@@ -225,16 +168,16 @@ declare class Log extends Model {
 declare class Migration extends Model {
     model: string;
     version: string;
-    created_at: Date;
-    updated_at: Date;
+    readonly created_at: Date;
+    readonly updated_at: Date;
 }
 
 declare class Session extends Model {
     session: string;
     json: string;
     expired: number;
-    created_at: Date;
-    updated_at: Date;
+    readonly created_at: Date;
+    readonly updated_at: Date;
 }
 
 declare class Application extends Application$1 {
@@ -244,7 +187,7 @@ declare class Application extends Application$1 {
     error(error: any, source?: string): void;
     log(message: string, source?: string): void;
     listen(): Promise<void>;
-    migrations(database: Connection): Promise<void>;
+    migrations(database: Sequelize): Promise<void>;
     websocket(): WebSocketServer | undefined;
 }
 
@@ -265,22 +208,22 @@ declare abstract class ControllerBase extends Controller {
     validation(ctx: Context, options: TypeObject<ValidationBase>): Promise<void>;
 }
 
-interface ArgumentsModel<M extends Model$2<M>> {
+interface ArgumentsModel<M extends Model$1<M>> {
     ctx: Context;
 }
 
-interface ArgumentsModelCreate<M extends Model$2<M>> extends ArgumentsModel<M> {
+interface ArgumentsModelCreate<M extends Model$1<M>> extends ArgumentsModel<M> {
     options?: CreateOptions<Attributes<M>>;
-    body?: TypeObjectAny;
+    body?: TypeAnyObject;
 }
 
-interface ArgumentsModelDelete<M extends Model$2<M>> extends ArgumentsModel<M> {
+interface ArgumentsModelDelete<M extends Model$1<M>> extends ArgumentsModel<M> {
     options?: FindOptions<Attributes<M>>;
 }
 
-type CallbackModelAll<M> = (records: Array<M>) => Array<any> | Promise<Array<any>>;
+type CallbackModelAll<M> = (_records: Array<M>) => Array<any> | Promise<Array<any>>;
 
-interface ArgumentsModelFindAll<M extends Model$2<M>> extends ArgumentsModel<M> {
+interface ArgumentsModelFindAll<M extends Model$1<any>> extends ArgumentsModel<M> {
     options?: FindOptions<Attributes<M>>;
     callback?: CallbackModelAll<M>;
     scope?: string;
@@ -289,46 +232,34 @@ interface ArgumentsModelFindAll<M extends Model$2<M>> extends ArgumentsModel<M>
     limited?: boolean;
 }
 
-type CallbackModelGet<M> = (records: M) => any | Promise<any>;
+type CallbackModelGet<M> = (_records: M) => any | Promise<any>;
 
-interface ArgumentsModelFindOne<M extends Model$2<M>> extends ArgumentsModel<M> {
+interface ArgumentsModelFindOne<M extends Model$1<M>> extends ArgumentsModel<M> {
     options?: FindOptions<Attributes<M>>;
     callback?: CallbackModelGet<M>;
     scope?: string;
 }
 
-interface ArgumentsModelUpdate<M extends Model$2<M>> extends ArgumentsModel<M> {
+interface ArgumentsModelUpdate<M extends Model$1<M>> extends ArgumentsModel<M> {
     options?: UpdateOptions<Attributes<M>>;
-    body?: TypeObjectAny;
+    body?: TypeAnyObject;
 }
 
 interface IAuthParameters {
     auth?: Auth;
-    decode?: TypeObjectAny;
+    decode?: TypeAnyObject;
     error?: string;
     forgot?: Forgot;
     token?: string;
     user?: User;
 }
 
-interface IDatabaseOptions {
-    database: string;
-    username: string;
-    password: string;
-    hostname: string;
-    hostport: number;
-}
-
-interface IMigrate {
-    version: string;
-}
-
-interface ResultModelAll<M extends Model$2<M>> {
+interface ResultModelAll<M extends Model$1<M>> {
     count: number;
     records: Array<M>;
 }
 
-declare abstract class ControllerModel<M extends Model$2<M>> extends ControllerBase {
+declare abstract class ControllerModel<M extends Model$1<any>> extends ControllerBase {
     protected [ControllerBase.ATTRIBUTES]: Array<string>;
     protected [ControllerBase.PERMISSIONS]: Array<string>;
     protected attributes(options: FindAttributeOptions): Array<string>;
@@ -345,7 +276,7 @@ declare abstract class ControllerModel<M extends Model$2<M>> extends ControllerB
     scope(name?: string): ModelStatic<M>;
 }
 
-declare abstract class ControllerCrud<M extends Model$2<M>> extends ControllerModel<M> {
+declare abstract class ControllerCrud<M extends Model$1<any>> extends ControllerModel<M> {
     private _crud;
     CrudArgumentsCreate(ctx: Context): ArgumentsModelUpdate<M>;
     CrudArgumentsFindAll(ctx: Context): ArgumentsModelFindAll<M>;
@@ -363,6 +294,52 @@ declare abstract class ControllerCrud<M extends Model$2<M>> extends ControllerMo
     protected validationUpdate(ctx: Context): Promise<void>;
 }
 
+declare class Env extends Env$1 {
+    static readonly API_BASE_NAME: 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_CONSOLE_ERROR: boolean;
+    static readonly API_DATABASE_URL: string;
+    static readonly API_DATABASE_LOG: boolean;
+    static readonly API_DATABASE_AUDIT: boolean;
+    static readonly API_DATABASE_PREFIX: string;
+    static readonly API_DATABASE_TIMEZONE: string;
+    static readonly API_HTTP_CRT: string;
+    static readonly API_HTTP_KEY: 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;
+    static readonly API_HTTP_REDIRECT: string;
+    static readonly API_KEY_HASH: string;
+    static readonly API_KEY_HEADER: string;
+    static readonly API_MODEL_LIMIT: number;
+    static readonly API_MODEL_LIMIT_MAX: number;
+    static readonly API_SLEEP_AUTH: number;
+    static readonly API_SLEEP_FORGOT: number;
+    static readonly API_SLEEP_REGISTRY: number;
+    static readonly API_SESSION_NAME: string;
+    static readonly API_SESSION_LIFETIME: number;
+    static readonly API_SESSION_SECRET: string;
+    static readonly API_TOKEN_CRT: string;
+    static readonly API_TOKEN_KEY: string;
+    static readonly API_TOKEN_FORGOT: number;
+    static readonly API_TOKEN_HEADER: string;
+    static readonly API_TOKEN_HEADER_KEY: string;
+    static readonly API_TOKEN_LIFETIME: number;
+    static readonly API_TOKEN_RENEW: number;
+    static readonly API_UPLOAD_COUNT: number;
+    static readonly API_UPLOAD_FIELD: string;
+    static readonly API_UPLOAD_SIZE: number;
+    static readonly API_UPLOAD_TEMP: string;
+    static readonly API_USER_HISTORY: boolean;
+    static readonly API_WEBSOCKET_START: boolean;
+}
+
 declare class AuditsController extends ControllerModel<Audit> {
     model(): typeof Audit;
     protected all(ctx: Context, type: string, table: string): Promise<void>;
@@ -379,7 +356,7 @@ declare class AuthController extends ControllerBase {
 declare class FilesController extends ControllerBase {
     protected [ControllerBase.PERMISSIONS]: Array<string>;
     directory(): string;
-    protected files(ctx: Context): Promise<TypeObjectAny | void>;
+    protected files(ctx: Context): Promise<TypeAnyObject | void>;
     protected access(ctx: Context, name: string, user: User): Promise<void>;
     private info;
     name(): string;
@@ -406,7 +383,7 @@ declare class GroupsPermissionsController extends ControllerModel<GroupPermissio
     model(): typeof GroupPermission;
     protected all(ctx: Context, group_id: string): Promise<void>;
     protected me(ctx: Context, user: User): Promise<void>;
-    protected set(ctx: Context, id: string, permissions: Array<number>, audit: TypeObjectAny): Promise<void>;
+    protected set(ctx: Context, id: string, permissions: Array<number>, audit: TypeAnyObject): Promise<void>;
 }
 
 declare class LogsController extends ControllerModel<Log> {
@@ -425,27 +402,27 @@ declare class PermissionsController extends ControllerCrud<Permission> {
 }
 
 declare class RegisterController extends ControllerBase {
-    protected register(ctx: Context, body: TypeObjectAny, app: Application): Promise<void>;
+    protected register(ctx: Context, body: TypeAnyObject, app: Application): Promise<void>;
     protected confirm(ctx: Context, token: string, app: Application): Promise<void>;
     protected send(ctx: Context, username: string, app: Application): Promise<void>;
     private getId;
 }
 
 declare class SetupController extends ControllerBase {
-    protected setup(ctx: Context, audit: TypeObjectAny): Promise<void>;
+    protected setup(ctx: Context, audit: TypeAnyObject): Promise<void>;
 }
 
 declare class UsersController extends ControllerModel<User> {
     path: string;
     model(): typeof User;
     constructor();
-    protected avatar(ctx: Context, files: Array<IFile>, user: User, audit: TypeObjectAny): Promise<void>;
-    protected avatar_del(ctx: Context, user: User, audit: TypeObjectAny): Promise<void>;
-    protected password(ctx: Context, oldPassword: string, newPassword: string, user: User, audit: TypeObjectAny): Promise<void>;
+    protected avatar(ctx: Context, files: Array<IFile>, user: User, audit: TypeAnyObject): Promise<void>;
+    protected avatar_del(ctx: Context, user: User, audit: TypeAnyObject): Promise<void>;
+    protected password(ctx: Context, oldPassword: string, newPassword: string, user: User, audit: TypeAnyObject): Promise<void>;
     protected token(ctx: Context, user: User, app: Application): Promise<void>;
-    protected token_del(ctx: Context, id: string, audit: TypeObjectAny): Promise<void>;
+    protected token_del(ctx: Context, id: string, audit: TypeAnyObject): Promise<void>;
     protected token_get(ctx: Context, id: string, app: Application): Promise<void>;
-    protected token_renew(ctx: Context, id: string, audit: TypeObjectAny, app: Application): Promise<void>;
+    protected token_renew(ctx: Context, id: string, audit: TypeAnyObject, app: Application): Promise<void>;
     private token_new;
     protected add(ctx: Context, password: string): Promise<void>;
     protected all(ctx: Context): Promise<void>;
@@ -458,9 +435,11 @@ declare class UsersGroupsController extends ControllerModel<UserGroup> {
     model(): typeof UserGroup;
     protected all(ctx: Context, user_id: string): Promise<void>;
     protected me(ctx: Context, user: User): Promise<void>;
-    protected set(ctx: Context, id: string, groups: Array<number>, audit: TypeObjectAny): Promise<void>;
+    protected set(ctx: Context, id: string, groups: Array<number>, audit: TypeAnyObject): Promise<void>;
 }
 
+declare const database: Sequelize;
+
 declare const ReqAudit: (key?: string) => ParameterDecorator;
 
 declare const ReqAuth: (key?: string) => ParameterDecorator;
@@ -476,13 +455,6 @@ declare global {
     }
 }
 
-declare const Migrate: (version: string) => ClassDecorator;
-
-declare class Metadata {
-    static readonly MIGRATE: unique symbol;
-    static migrations(target: any): IMigrate;
-}
-
 declare class AuthBase {
     protected static error(error: any): void;
 }
@@ -500,12 +472,12 @@ declare class AuthToken extends AuthBase {
     private static verify;
 }
 
-declare const audit: (ctx: Context) => TypeObjectAny;
+declare const audit: (ctx: Context) => TypeAnyObject;
 
 declare const hooks: {
-    afterCreate: (record: Model, options: TypeObjectAny) => Promise<void>;
-    afterUpdate: (record: Model, options: TypeObjectAny) => Promise<void>;
-    afterDestroy: (record: Model, options: TypeObjectAny) => Promise<void>;
+    afterCreate: (record: Model, options: TypeAnyObject) => Promise<void>;
+    afterUpdate: (record: Model, options: TypeAnyObject) => Promise<void>;
+    afterDestroy: (record: Model, options: TypeAnyObject) => Promise<void>;
 };
 
 declare const crt: {
@@ -520,14 +492,14 @@ declare const key: {
 declare class Store extends Store$1 {
     private loop;
     constructor();
-    all: (callback: TypeCallbackFunction) => Promise<void>;
-    clear: (callback: TypeCallbackFunction) => Promise<void>;
-    destroy: (session_id: string, callback: TypeCallbackFunction) => Promise<void>;
+    all: (callback: TypeAnyFunction) => Promise<void>;
+    clear: (callback: TypeAnyFunction) => Promise<void>;
+    destroy: (session_id: string, callback: TypeAnyFunction) => Promise<void>;
     expired: () => Promise<void>;
-    get: (session_id: string, callback: TypeCallbackFunction) => Promise<void>;
-    length: (callback: TypeCallbackFunction) => Promise<void>;
-    set: (session_id: any, session: SessionData, callback: TypeCallbackFunction) => Promise<void>;
+    get: (session_id: string, callback: TypeAnyFunction) => Promise<void>;
+    length: (callback: TypeAnyFunction) => Promise<void>;
+    set: (session_id: any, session: SessionData, callback: TypeAnyFunction) => Promise<void>;
 }
 
-export { Application, Audit, AuditsController, Auth, AuthBase, AuthController, AuthKey, AuthToken, Config, Controller, ControllerBase, ControllerCrud, ControllerModel, Env, FilesController, Forgot, ForgotController, Group, GroupPermission, GroupsController, GroupsPermissionsController, Log, LogsController, Metadata, Migrate, Migration, Model, Permission, PermissionsController, Register, RegisterController, ReqAudit, ReqAuth, ReqUser, Session, SetupController, Store, User, UserGroup, UserHistory, UsersController, UsersGroupsController, audit, crt, database, hooks, key };
-export type { ArgumentsModel, ArgumentsModelCreate, ArgumentsModelDelete, ArgumentsModelFindAll, ArgumentsModelFindOne, ArgumentsModelUpdate, CallbackModelAll, CallbackModelGet, IAuthParameters, IDatabaseOptions, IMigrate, ResultModelAll };
+export { Application, Audit, AuditsController, Auth, AuthBase, AuthController, AuthKey, AuthToken, Config, Controller, ControllerBase, ControllerCrud, ControllerModel, Env, FilesController, Forgot, ForgotController, Group, GroupPermission, GroupsController, GroupsPermissionsController, Log, LogsController, Migration, Permission, PermissionsController, Register, RegisterController, ReqAudit, ReqAuth, ReqUser, Session, SetupController, Store, User, UserGroup, UserHistory, UsersController, UsersGroupsController, audit, crt, database, hooks, key };
+export type { ArgumentsModel, ArgumentsModelCreate, ArgumentsModelDelete, ArgumentsModelFindAll, ArgumentsModelFindOne, ArgumentsModelUpdate, CallbackModelAll, CallbackModelGet, IAuthParameters, ResultModelAll };