@andrewcaires/api 5.4.0 → 5.4.2

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /*!
- * @andrewcaires/api v5.4.0
+ * @andrewcaires/api v5.4.2
  * Simple api for small applications using express, jsonwebtoken, sequelize and websocket
  * (c) 2026 Andrew Caires
  * @license: MIT
@@ -174,6 +174,14 @@ declare enum LogLevels {
     ERROR = "error"
 }
 
+declare enum PageTypes {
+    PAGE = "page",
+    GROUP = "group",
+    DIVIDER = "divider",
+    HIDDEN = "hidden",
+    EXTERNAL = "external"
+}
+
 declare enum TenantStatus {
     ACTIVE = "active",
     PENDING = "pending",
@@ -190,6 +198,18 @@ declare enum UserStatus {
     ARCHIVED = "archived"
 }
 
+interface WorkerCliRequest {
+    name: string;
+}
+interface WorkerDeclaration {
+    name: string;
+}
+type WorkerHandlerResult = unknown | Promise<unknown>;
+type WorkerHandler = () => WorkerHandlerResult;
+interface WorkerRegistered extends WorkerDeclaration {
+    run: WorkerHandler;
+}
+
 declare class RegisterModel extends Model$1 {
     readonly id: string;
     hash: string;
@@ -215,6 +235,26 @@ declare class UserAuthModel extends Model$1 {
     user: UserModel;
 }
 
+declare class PageModel extends Model$1 {
+    readonly id: string;
+    type: PageTypes;
+    name: string;
+    description: string;
+    icon: string;
+    path: string;
+    position: number;
+    active: boolean;
+    metadata: TypeAnyObject;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    page_id: string;
+    page: PageModel;
+    pages: Array<PageModel>;
+    permission_id: string;
+    permission: PermissionModel;
+}
+
 declare class PermissionModel extends Model$1 {
     readonly id: string;
     name: string;
@@ -225,6 +265,7 @@ declare class PermissionModel extends Model$1 {
     readonly updated_at: Date;
     readonly deleted_at: Date | null;
     groups_permissions: Array<GroupPermissionModel>;
+    pages: Array<PageModel>;
 }
 
 declare class GroupPermissionModel extends Model$1 {
@@ -495,7 +536,9 @@ declare class ModelService<M extends Model<any>> extends Service {
 
 declare class UserService extends Service {
     private hashOptions;
-    createPassword(user_id: string, value: string, ctx?: Context): Promise<void>;
+    canAssignPassword(user_id: string, password: string): Promise<boolean>;
+    checkPassword(user_id: string, password: string): Promise<boolean>;
+    createPassword(user_id: string, value: string, ctx?: Context): Promise<boolean>;
     getGroups(user_id: string, tenant_id?: string | null): Promise<Array<string>>;
     getPermissions(user_id: string, tenant_id?: string | null): Promise<Array<string>>;
     getTenants(user_id: string): Promise<Array<{
@@ -508,10 +551,17 @@ declare class Application<T extends ApplicationEvents = ApplicationEvents> exten
     authService: AuthService;
     userService: UserService;
     private _webSocket?;
+    private _prepared;
     constructor(controllers: Array<object | TypeAnyConstructor<object>>, options?: ExpressOptions);
     error(error: any, source?: string): void;
     log(message: string, source?: string): void;
     listen(): Promise<void>;
+    prepare(): Promise<void>;
+    run(argv?: Array<string>): Promise<unknown>;
+    runWorker(name: string): Promise<unknown>;
+    workerCliRequest(argv?: Array<string>): WorkerCliRequest | undefined;
+    private getCliOption;
+    private writeWorkerResult;
     migrations(database: Sequelize): Promise<void>;
     websocket(): WebSocketServer | undefined;
 }
@@ -644,6 +694,16 @@ declare class McpController extends BaseController {
     private getAllowedOrigin;
 }
 
+declare class PagesController extends CrudController<PageModel> {
+    protected readonly model: typeof PageModel;
+    private schemaCreate;
+    private schemaUpdate;
+    CrudValidateCreate(): TypeObject<ValidationBase>;
+    CrudValidateUpdate(): TypeObject<ValidationBase>;
+    protected position(ctx: Context, pages: Array<TypeAnyObject>): Promise<void>;
+    private checkPages;
+}
+
 declare class PermissionsController extends CrudController<PermissionModel> {
     protected readonly model: typeof PermissionModel;
     protected groupModelService: ModelService<GroupModel>;
@@ -923,6 +983,9 @@ declare const discoverMcpTools: (controllers: Array<object>) => Array<McpRegiste
 
 declare class TestController extends BaseController {
     protected json(ctx: Context): Promise<void>;
+    protected workerSum(): Promise<{
+        value: number;
+    }>;
     protected sum(args: TypeAnyObject, _context: McpToolContext): Promise<{
         value: number;
     }>;
@@ -982,9 +1045,12 @@ declare class UsersController extends ModelController<UserModel> {
     protected readonly model: typeof UserModel;
     protected readonly permissions: string[];
     path: string;
+    protected readonly userService: UserService;
     constructor();
     protected avatar(ctx: Context, user: UserModel): Promise<void>;
     protected avatar_del(ctx: Context, user: UserModel): Promise<void>;
+    protected password(ctx: Context, oldPassword: string, newPassword: string, user: UserModel): Promise<void>;
+    protected password_admin(ctx: Context, password: string, user_id: string): Promise<void>;
     protected add(ctx: Context): Promise<void>;
     protected all(ctx: Context): Promise<void>;
     protected rows(ctx: Context): Promise<void>;
@@ -1068,6 +1134,15 @@ declare const McpTool: (options: McpToolOptions) => MethodDecorator;
 
 declare const Audit: (active?: boolean) => ClassDecorator;
 
+declare const WORKER_METADATA: unique symbol;
+interface WorkerMetadata extends WorkerDeclaration {
+    propertyKey: string | symbol;
+}
+declare const Worker: (name: string) => MethodDecorator;
+declare const getWorkerMetadata: (target: object | TypeAnyConstructor<object>) => Array<WorkerMetadata>;
+declare const discoverWorkers: (controllers: Array<object>) => Array<WorkerRegistered>;
+declare const runWorker: (controllers: Array<object>, name: string) => Promise<unknown>;
+
 declare class Env extends Env$1 {
     static readonly AUDIT_IGNORE: string[];
     static readonly BASE_NAME: string;
@@ -1095,6 +1170,7 @@ declare class Env extends Env$1 {
     static readonly PASSWORD_MEMORY_COST: number;
     static readonly PASSWORD_PARALLELISM: number;
     static readonly PASSWORD_PEPPER: string;
+    static readonly PASSWORD_REUSE: boolean;
     static readonly PASSWORD_TIME_COST: number;
     static readonly SLEEP_AUTH: number;
     static readonly SLEEP_FORGOT: number;
@@ -1117,9 +1193,8 @@ declare class Env extends Env$1 {
     static readonly API_SESSION_NAME: string;
     static readonly API_SESSION_LIFETIME: number;
     static readonly API_SESSION_SECRET: string;
-    static readonly API_USER_HISTORY: boolean;
     static readonly API_WEBSOCKET_START: boolean;
 }
 
-export { Application, Audit, AuditModel, AuditTypes, AuditsController, AuthController, AuthService, BaseController, CanCreate, CanDelete, CanRead, CanUpdate, Config, ConfigModel, CrudController, Env, FilesController, ForgotController, ForgotModel, GroupModel, GroupPermissionModel, GroupTypes, GroupsController, GroupsPermissionsController, HasGroups, HasPermissions, HasScope, HealthController, IsAuthenticated, Log, LogLevels, LogModel, Loggable, LogsController, MCP_DEFAULT_PROTOCOL_VERSION, MCP_HTTP_ALLOW, MCP_HTTP_ALLOWED_METHODS, MCP_HTTP_DEFAULT_ALLOWED_HEADERS, MCP_PROTOCOL_VERSION_HEADER, MCP_SESSION_ID_HEADER, MCP_SUPPORTED_PROTOCOL_VERSIONS, MCP_TOOL_METADATA, McpController, McpError, McpErrorCode, McpHttpHandler, McpInternalError, McpInvalidParamsError, McpInvalidRequestError, McpInvalidSessionError, McpMethodNotFoundError, McpParseError, McpServerError, McpSessionStore, McpTool, McpToolNotFoundError, McpToolRegistry, MigrationModel, ModelController, ModelService, PermissionModel, PermissionsController, RegisterController, RegisterModel, ReqAccess, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqTenant, ReqTenants, ReqUser, Secret, SecretModel, Service, SessionModel, SessionStore, SetupController, TenantModel, TenantStatus, TenantsController, TestController, UserAuthModel, UserGroupModel, UserKeyModel, UserModel, UserPasswordModel, UserService, UserStatus, UserTenantModel, UsersController, UsersGroupsController, UsersKeysController, UsersTenantsController, assertValidMcpToolDefinition, canFactory, discoverMcpTools, getMcpToolMetadata, isJsonParseError, isJsonRpcId, jsonParseErrorResponse, jsonRpcError, jsonRpcErrorFromCode, jsonRpcResult, parseJsonRpcRequest, sequelize };
-export type { ApplicationEvents, AuthEvents, AuthResult, ForgotEvents, McpCallToolResult, McpDecoratedToolHandler, McpHttpHandlerOptions, McpHttpResponse, McpJsonRpcErrorBody, McpJsonRpcErrorResult, McpJsonRpcId, McpJsonRpcRequest, McpJsonRpcResult, McpLogger, McpNormalizedValidation, McpProtocolVersion, McpRegisteredTool, McpSession, McpToolCallLog, McpToolContext, McpToolDeclaration, McpToolDefinition, McpToolHandlerResult, McpToolInput, McpToolMetadata, McpToolOptions, McpToolOutput, ModelArgumentsBase, ModelArgumentsCount, ModelArgumentsCreate, ModelArgumentsDelete, ModelArgumentsFindAll, ModelArgumentsFindOne, ModelArgumentsInclude, ModelArgumentsUpdate, ModelCallbackFindAll, ModelCallbackFindOne, ModelOptions, ModelResultFindAll, RegisterEvents };
+export { Application, Audit, AuditModel, AuditTypes, AuditsController, AuthController, AuthService, BaseController, CanCreate, CanDelete, CanRead, CanUpdate, Config, ConfigModel, CrudController, Env, FilesController, ForgotController, ForgotModel, GroupModel, GroupPermissionModel, GroupTypes, GroupsController, GroupsPermissionsController, HasGroups, HasPermissions, HasScope, HealthController, IsAuthenticated, Log, LogLevels, LogModel, Loggable, LogsController, MCP_DEFAULT_PROTOCOL_VERSION, MCP_HTTP_ALLOW, MCP_HTTP_ALLOWED_METHODS, MCP_HTTP_DEFAULT_ALLOWED_HEADERS, MCP_PROTOCOL_VERSION_HEADER, MCP_SESSION_ID_HEADER, MCP_SUPPORTED_PROTOCOL_VERSIONS, MCP_TOOL_METADATA, McpController, McpError, McpErrorCode, McpHttpHandler, McpInternalError, McpInvalidParamsError, McpInvalidRequestError, McpInvalidSessionError, McpMethodNotFoundError, McpParseError, McpServerError, McpSessionStore, McpTool, McpToolNotFoundError, McpToolRegistry, MigrationModel, ModelController, ModelService, PageModel, PageTypes, PagesController, PermissionModel, PermissionsController, RegisterController, RegisterModel, ReqAccess, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqTenant, ReqTenants, ReqUser, Secret, SecretModel, Service, SessionModel, SessionStore, SetupController, TenantModel, TenantStatus, TenantsController, TestController, UserAuthModel, UserGroupModel, UserKeyModel, UserModel, UserPasswordModel, UserService, UserStatus, UserTenantModel, UsersController, UsersGroupsController, UsersKeysController, UsersTenantsController, WORKER_METADATA, Worker, assertValidMcpToolDefinition, canFactory, discoverMcpTools, discoverWorkers, getMcpToolMetadata, getWorkerMetadata, isJsonParseError, isJsonRpcId, jsonParseErrorResponse, jsonRpcError, jsonRpcErrorFromCode, jsonRpcResult, parseJsonRpcRequest, runWorker, sequelize };
+export type { ApplicationEvents, AuthEvents, AuthResult, ForgotEvents, McpCallToolResult, McpDecoratedToolHandler, McpHttpHandlerOptions, McpHttpResponse, McpJsonRpcErrorBody, McpJsonRpcErrorResult, McpJsonRpcId, McpJsonRpcRequest, McpJsonRpcResult, McpLogger, McpNormalizedValidation, McpProtocolVersion, McpRegisteredTool, McpSession, McpToolCallLog, McpToolContext, McpToolDeclaration, McpToolDefinition, McpToolHandlerResult, McpToolInput, McpToolMetadata, McpToolOptions, McpToolOutput, ModelArgumentsBase, ModelArgumentsCount, ModelArgumentsCreate, ModelArgumentsDelete, ModelArgumentsFindAll, ModelArgumentsFindOne, ModelArgumentsInclude, ModelArgumentsUpdate, ModelCallbackFindAll, ModelCallbackFindOne, ModelOptions, ModelResultFindAll, RegisterEvents, WorkerCliRequest, WorkerDeclaration, WorkerHandler, WorkerHandlerResult, WorkerMetadata, WorkerRegistered };