@andrewcaires/api 5.6.0 → 5.7.1

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /*!
- * @andrewcaires/api v5.6.0
+ * @andrewcaires/api v5.7.1
  * Simple api for small applications using express, jsonwebtoken, sequelize and websocket
  * (c) 2026 Andrew Caires
  * @license: MIT
  */
-import { Context, Application as Application$1, ExpressOptions, ResponseError } from '@andrewcaires/express';
+import { Context, Application as Application$1, ExpressOptions, HttpError } from '@andrewcaires/express';
 import { ModelFindOptions, ModelUpdateOptions, Model as Model$1, Sequelize } from '@andrewcaires/sequelize';
 import { TypeAnyObject, TypeObjectString, TypeAnyFunction, TypeAnyConstructor, EventEmitter, TypeObject, ValidationBase, ValidationShape } from '@andrewcaires/utils.js';
 import { WebSocketServer } from 'ws';
@@ -198,16 +198,15 @@ declare enum UserStatus {
     ARCHIVED = "archived"
 }
 
-interface WorkerCliRequest {
-    name: string;
-}
-interface WorkerDeclaration {
+type WorkerInstance = {
+    handler: () => void | Promise<void>;
+};
+
+type WorkerConstructor = new () => WorkerInstance;
+
+interface WorkerDefinition {
     name: string;
-}
-type WorkerHandlerResult = unknown | Promise<unknown>;
-type WorkerHandler = () => WorkerHandlerResult;
-interface WorkerRegistered extends WorkerDeclaration {
-    run: WorkerHandler;
+    handler: () => void | Promise<void>;
 }
 
 declare class RegisterModel extends Model$1 {
@@ -587,11 +586,6 @@ declare class Application<T extends ApplicationEvents = ApplicationEvents> exten
     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;
 }
@@ -625,8 +619,9 @@ declare class AuditsController extends ModelController<AuditModel> {
     protected readonly model: typeof AuditModel;
     protected readonly permissions: string[];
     protected all(ctx: Context): Promise<void>;
-    protected record(ctx: Context, record: string): Promise<void>;
+    protected record(ctx: Context, id: string): Promise<void>;
     protected get(ctx: Context): Promise<void>;
+    private ensurePermission;
 }
 
 declare class AuthController extends BaseController<AuthEvents> {
@@ -639,8 +634,8 @@ declare class AuthController extends BaseController<AuthEvents> {
 
 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>;
+    CrudArgumentsCountAll(ctx: Context): ModelArgumentsCount<M>;
+    CrudArgumentsCreate(ctx: Context): ModelArgumentsCreate<M>;
     CrudArgumentsFindAll(ctx: Context): ModelArgumentsFindAll<M>;
     CrudArgumentsFindOne(ctx: Context): ModelArgumentsFindOne<M>;
     CrudArgumentsDelete(ctx: Context): ModelArgumentsDelete<M>;
@@ -683,13 +678,13 @@ declare class GroupsController extends CrudController<GroupModel> {
     CrudValidateUpdate(): TypeObject<ValidationBase>;
     sync(): Promise<void>;
     protected users(ctx: Context, group_id: string): Promise<void>;
-    private checkGroup;
+    private ensureGroup;
 }
 
 declare class GroupsPermissionsController extends BaseController {
     private readonly userService;
     protected all(ctx: Context, group_id: string): Promise<void>;
-    private checkGroup;
+    private ensureGroup;
 }
 
 declare class GroupsRolesController extends ModelController<RoleModel> {
@@ -700,8 +695,8 @@ declare class GroupsRolesController extends ModelController<RoleModel> {
     protected del(ctx: Context, group_id: string, roles: Array<string>): Promise<void>;
     protected set(ctx: Context, group_id: string, roles: Array<string>): Promise<void>;
     private addRoles;
-    private checkGroup;
-    private checkRoles;
+    private ensureGroup;
+    private ensureRoles;
 }
 
 declare class HealthController {
@@ -738,7 +733,7 @@ declare class PagesController extends CrudController<PageModel> {
     CrudValidateCreate(): TypeObject<ValidationBase>;
     CrudValidateUpdate(): TypeObject<ValidationBase>;
     protected position(ctx: Context, pages: Array<TypeAnyObject>): Promise<void>;
-    private checkPages;
+    private ensurePages;
 }
 
 declare class PermissionsController extends CrudController<PermissionModel> {
@@ -750,7 +745,7 @@ declare class PermissionsController extends CrudController<PermissionModel> {
     CrudValidateUpdate(): TypeObject<ValidationBase>;
     sync(): Promise<void>;
     protected groups(ctx: Context, permission_id: string): Promise<void>;
-    private checkPermission;
+    private ensurePermission;
 }
 
 declare class ProfileController extends ModelController<UserModel> {
@@ -781,7 +776,7 @@ declare class RolesController extends CrudController<RoleModel> {
     CrudValidateUpdate(): TypeObject<ValidationBase>;
     sync(): Promise<void>;
     protected groups(ctx: Context, role_id: string): Promise<void>;
-    private checkRole;
+    private ensureRole;
 }
 
 declare class RolesPermissionsController extends ModelController<PermissionModel> {
@@ -792,8 +787,8 @@ declare class RolesPermissionsController extends ModelController<PermissionModel
     protected del(ctx: Context, role_id: string, permissions: Array<string>): Promise<void>;
     protected set(ctx: Context, role_id: string, permissions: Array<string>): Promise<void>;
     private addPermissions;
-    private checkPermissions;
-    private checkRole;
+    private ensurePermissions;
+    private ensureRole;
 }
 
 declare class SetupController extends BaseController {
@@ -810,7 +805,7 @@ declare class TenantsController extends CrudController<TenantModel> {
     CrudValidateUpdate(): TypeObject<ValidationBase>;
     sync(): Promise<void>;
     protected users(ctx: Context, tenant_id: string): Promise<void>;
-    private checkTenant;
+    private ensureTenant;
 }
 
 declare const McpErrorCode: {
@@ -823,7 +818,7 @@ declare const McpErrorCode: {
     readonly InvalidSession: -32001;
 };
 type McpErrorCode = typeof McpErrorCode[keyof typeof McpErrorCode];
-declare class McpError extends ResponseError {
+declare class McpError extends HttpError {
     readonly code: McpErrorCode;
     readonly data?: unknown;
     constructor(message: string, code?: McpErrorCode, status?: number, data?: unknown);
@@ -1134,8 +1129,8 @@ declare class UsersGroupsController extends ModelController<GroupModel> {
     protected del(ctx: Context, user_id: string, groups: Array<string>): Promise<void>;
     protected set(ctx: Context, user_id: string, groups: Array<string>): Promise<void>;
     private addGroups;
-    private checkGroups;
-    private checkUser;
+    private ensureGroups;
+    private ensureUser;
 }
 
 declare class UsersKeysController extends ModelController<UserKeyModel> {
@@ -1151,7 +1146,7 @@ declare class UsersKeysController extends ModelController<UserKeyModel> {
     protected get(ctx: Context, user: UserModel): Promise<void>;
     protected all_admin(ctx: Context, id: string): Promise<void>;
     protected get_admin(ctx: Context, id: string): Promise<void>;
-    private checkUser;
+    private ensureUser;
 }
 
 declare class UsersTenantsController extends ModelController<TenantModel> {
@@ -1162,8 +1157,8 @@ declare class UsersTenantsController extends ModelController<TenantModel> {
     protected del(ctx: Context, user_id: string, tenants: Array<string>): Promise<void>;
     protected set(ctx: Context, user_id: string, tenants: Array<string>): Promise<void>;
     private addTenants;
-    private checkTenants;
-    private checkUser;
+    private ensureTenants;
+    private ensureUser;
 }
 
 declare const sequelize: Sequelize;
@@ -1207,14 +1202,7 @@ 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 const RegisterWorker: (name: string) => ClassDecorator & MethodDecorator;
 
 declare class Env extends Env$1 {
     static readonly AUDIT_IGNORE: string[];
@@ -1254,6 +1242,7 @@ declare class Env extends Env$1 {
     static readonly TOKEN_HEADER: string;
     static readonly TOKEN_PEPPER: string;
     static readonly TOKEN_PREFIX: string;
+    static readonly TOKEN_QUERY: string;
     static readonly TOKEN_SECRET: string;
     static readonly TOKEN_TTL: number;
     static readonly TOKEN_TTL_FORGOT: number;
@@ -1269,5 +1258,20 @@ declare class Env extends Env$1 {
     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, GroupRoleModel, GroupTypes, GroupsController, GroupsPermissionsController, GroupsRolesController, 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, ProfileController, RegisterController, RegisterModel, ReqAccess, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqTenant, ReqTenants, ReqUser, RoleModel, RolePermissionModel, RolesController, RolesPermissionsController, 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 };
+declare class WorkerRegistry {
+    private static workers;
+    static register(name: string, handler: () => void | Promise<void>): void;
+    static registerClass(name: string, target: WorkerConstructor): void;
+    static registerMethod(name: string, target: object, propertyKey: string | symbol): void;
+    static start(name: string): Promise<void>;
+    static list(): Array<{
+        name: string;
+    }>;
+    static names(): Array<string>;
+    private static get;
+    private static normalizeStartName;
+    private static normalizeWorkerName;
+}
+
+export { Application, Audit, AuditModel, AuditTypes, AuditsController, AuthController, AuthService, BaseController, CanCreate, CanDelete, CanRead, CanUpdate, Config, ConfigModel, CrudController, Env, FilesController, ForgotController, ForgotModel, GroupModel, GroupRoleModel, GroupTypes, GroupsController, GroupsPermissionsController, GroupsRolesController, 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, ProfileController, RegisterController, RegisterModel, RegisterWorker, ReqAccess, ReqGroup, ReqGroups, ReqPermission, ReqPermissions, ReqTenant, ReqTenants, ReqUser, RoleModel, RolePermissionModel, RolesController, RolesPermissionsController, Secret, SecretModel, Service, SessionModel, SessionStore, SetupController, TenantModel, TenantStatus, TenantsController, TestController, UserAuthModel, UserGroupModel, UserKeyModel, UserModel, UserPasswordModel, UserService, UserStatus, UserTenantModel, UsersController, UsersGroupsController, UsersKeysController, UsersTenantsController, WorkerRegistry, 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, WorkerConstructor, WorkerDefinition, WorkerInstance };