@andrewcaires/api 5.5.0 → 5.6.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /*!
- * @andrewcaires/api v5.5.0
+ * @andrewcaires/api v5.6.0
  * Simple api for small applications using express, jsonwebtoken, sequelize and websocket
  * (c) 2026 Andrew Caires
  * @license: MIT
@@ -258,28 +258,53 @@ declare class PageModel extends Model$1 {
 declare class PermissionModel extends Model$1 {
     readonly id: string;
     name: string;
+    permission: string;
     description: string;
     active: boolean;
     metadata: TypeAnyObject;
     readonly created_at: Date;
     readonly updated_at: Date;
     readonly deleted_at: Date | null;
-    groups_permissions: Array<GroupPermissionModel>;
+    roles_permissions: Array<RolePermissionModel>;
     pages: Array<PageModel>;
 }
 
-declare class GroupPermissionModel extends Model$1 {
+declare class RolePermissionModel extends Model$1 {
     readonly id: string;
     readonly created_at: Date;
-    group_id: string;
-    group: GroupModel;
     permission_id: string;
     permission: PermissionModel;
+    role_id: string;
+    role: RoleModel;
+}
+
+declare class RoleModel extends Model$1 {
+    readonly id: string;
+    name: string;
+    role: string;
+    description: string;
+    active: boolean;
+    metadata: TypeAnyObject;
+    readonly created_at: Date;
+    readonly updated_at: Date;
+    readonly deleted_at: Date | null;
+    groups_roles: Array<GroupRoleModel>;
+    roles_permissions: Array<RolePermissionModel>;
+}
+
+declare class GroupRoleModel extends Model$1 {
+    readonly id: string;
+    readonly created_at: Date;
+    group_id: string;
+    group: GroupModel;
+    role_id: string;
+    role: RoleModel;
 }
 
 declare class GroupModel extends Model$1 {
     readonly id: string;
     name: string;
+    group: string;
     description: string;
     type: GroupTypes;
     active: boolean;
@@ -288,7 +313,7 @@ declare class GroupModel extends Model$1 {
     readonly updated_at: Date;
     readonly deleted_at: Date | null;
     users_groups: Array<UserGroupModel>;
-    groups_permissions: Array<GroupPermissionModel>;
+    groups_roles: Array<GroupRoleModel>;
 }
 
 declare class UserTenantModel extends Model$1 {
@@ -494,17 +519,21 @@ declare class AuthService extends Service {
     private readonly options;
     private readonly userAttributes;
     private readonly userService;
-    constructor();
-    createApiKey(ctx: Context, name: string, expires_at: Date, user: UserModel): Promise<string>;
+    apiAuth(ctx: Context): Promise<AuthResult>;
+    apiKeyAuth(key: string): Promise<AuthResult>;
+    apiTokenAuth(token: string): Promise<AuthResult>;
+    createApiKey(ctx: Context, name: string, expires_at: Date, user: UserModel): Promise<{
+        id: string;
+        key: string;
+    }>;
     createApiToken(ctx: Context, user: UserModel): Promise<{
         token: string;
     }>;
+    deleteApiKey(ctx: Context, id: string, user: UserModel): Promise<boolean>;
     renewApiToken(token: string): Promise<{
         token: string;
     }>;
-    apiAuth(ctx: Context): Promise<AuthResult>;
-    apiKeyAuth(key: string): Promise<AuthResult>;
-    apiTokenAuth(token: string): Promise<AuthResult>;
+    revokeApiKey(ctx: Context, id: string, user: UserModel): Promise<boolean>;
     private attachAuthContext;
     private safeEqual;
     private verifyJwt;
@@ -541,6 +570,7 @@ declare class UserService extends Service {
     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>>;
+    getGroupPermissions(group_id: string): Promise<Array<string>>;
     getTenants(user_id: string): Promise<Array<{
         id: string;
         name: string;
@@ -595,6 +625,7 @@ 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 get(ctx: Context): Promise<void>;
 }
 
@@ -655,16 +686,22 @@ declare class GroupsController extends CrudController<GroupModel> {
     private checkGroup;
 }
 
-declare class GroupsPermissionsController extends ModelController<PermissionModel> {
-    protected readonly model: typeof PermissionModel;
+declare class GroupsPermissionsController extends BaseController {
+    private readonly userService;
+    protected all(ctx: Context, group_id: string): Promise<void>;
+    private checkGroup;
+}
+
+declare class GroupsRolesController extends ModelController<RoleModel> {
+    protected readonly model: typeof RoleModel;
     protected readonly permissions: never[];
-    protected add(ctx: Context, group_id: string, permissions: Array<string>): Promise<void>;
+    protected add(ctx: Context, group_id: string, roles: Array<string>): Promise<void>;
     protected all(ctx: Context, group_id: string): Promise<void>;
-    protected del(ctx: Context, group_id: string, permissions: Array<string>): Promise<void>;
-    protected set(ctx: Context, group_id: string, permissions: Array<string>): Promise<void>;
-    private addPermissions;
+    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 checkPermissions;
+    private checkRoles;
 }
 
 declare class HealthController {
@@ -735,6 +772,30 @@ declare class RegisterController extends BaseController<RegisterEvents> {
     private getId;
 }
 
+declare class RolesController extends CrudController<RoleModel> {
+    protected readonly model: typeof RoleModel;
+    protected groupModelService: ModelService<GroupModel>;
+    private schemaCreate;
+    private schemaUpdate;
+    CrudValidateCreate(): TypeObject<ValidationBase>;
+    CrudValidateUpdate(): TypeObject<ValidationBase>;
+    sync(): Promise<void>;
+    protected groups(ctx: Context, role_id: string): Promise<void>;
+    private checkRole;
+}
+
+declare class RolesPermissionsController extends ModelController<PermissionModel> {
+    protected readonly model: typeof PermissionModel;
+    protected readonly permissions: never[];
+    protected add(ctx: Context, role_id: string, permissions: Array<string>): Promise<void>;
+    protected all(ctx: Context, role_id: string): Promise<void>;
+    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;
+}
+
 declare class SetupController extends BaseController {
     protected readonly userService: UserService;
     protected setup(ctx: Context): Promise<void>;
@@ -1082,8 +1143,14 @@ declare class UsersKeysController extends ModelController<UserKeyModel> {
     protected readonly permissions: string[];
     protected add(ctx: Context, user: UserModel, body: TypeAnyObject, app: Application): Promise<void>;
     protected add_admin(ctx: Context, id: string, body: TypeAnyObject, app: Application): Promise<void>;
+    protected revoke(ctx: Context, id: string, user: UserModel, app: Application): Promise<void>;
+    protected revoke_admin(ctx: Context, id: string, key: string, app: Application): Promise<void>;
+    protected del(ctx: Context, id: string, user: UserModel, app: Application): Promise<void>;
+    protected del_admin(ctx: Context, id: string, key: string, app: Application): Promise<void>;
     protected all(ctx: Context, user: UserModel): Promise<void>;
+    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;
 }
 
@@ -1202,5 +1269,5 @@ 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, 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, ProfileController, 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 { 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 };