@gzl10/nexus-sdk 0.1.7 → 0.1.9

package/dist/index.d.ts

@@ -19,6 +19,38 @@ interface AuthRequest<TUser = unknown, TAbility = unknown> extends Request {
     user: TUser;
     ability: TAbility;
 }
+/**
+ * Usuario base sin contraseña para uso en plugins
+ * Usado para tipar relaciones con usuarios (ej: author, created_by)
+ */
+interface BaseUser {
+    id: string;
+    name: string;
+    email: string;
+    role_id: string;
+    created_at: Date;
+    updated_at: Date;
+    created_by: string | null;
+    updated_by: string | null;
+}
+/**
+ * Parámetros de paginación para queries
+ */
+interface PaginationParams {
+    page: number;
+    limit: number;
+}
+/**
+ * Resultado paginado genérico
+ */
+interface PaginatedResult<T> {
+    items: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNext: boolean;
+}
 /**
  * Tipo de campo para formularios dinámicos
  */
@@ -76,6 +108,58 @@ interface ModuleRequirements {
     env?: string[];
     modules?: string[];
 }
+/**
+ * Interfaz genérica para ability CASL
+ * Permite verificar permisos sin depender directamente de @casl/ability
+ */
+interface AbilityLike {
+    can: (action: string, subject: unknown) => boolean;
+    cannot: (action: string, subject: unknown) => boolean;
+}
+/**
+ * Error de forbidden con método throwUnlessCan
+ */
+interface ForbiddenErrorInstance {
+    throwUnlessCan: (action: string, subject: unknown) => void;
+}
+/**
+ * Constructor de ForbiddenError con método from()
+ */
+interface ForbiddenErrorConstructor {
+    from: (ability: AbilityLike) => ForbiddenErrorInstance;
+}
+/**
+ * Abilities CASL disponibles en el contexto
+ * Permite usar CASL en plugins sin importar @casl/ability directamente
+ */
+interface ModuleAbilities {
+    /** Wrapper para verificar permisos contra instancias */
+    subject: (type: string, object: unknown) => unknown;
+    /** Error de CASL para throwUnlessCan */
+    ForbiddenError: ForbiddenErrorConstructor;
+    /** Otros métodos que el backend pueda añadir */
+    [key: string]: unknown;
+}
+/**
+ * AuthRequest pre-tipado para uso en plugins
+ * Usa BaseUser y AbilityLike para tipado básico sin depender del backend
+ */
+type PluginAuthRequest = AuthRequest<BaseUser, AbilityLike>;
+/**
+ * Resolver de usuarios para plugins
+ * Permite acceder a usuarios sin conocer la implementación interna
+ */
+interface UsersResolver {
+    findById: (id: string) => Promise<BaseUser | null>;
+    findByIds: (ids: string[]) => Promise<BaseUser[]>;
+}
+/**
+ * Servicios core inyectados por el backend
+ * Los plugins acceden a estos servicios via ctx.services
+ */
+interface CoreServices {
+    users?: UsersResolver;
+}
 /**
  * Helpers para migraciones de base de datos
  */
@@ -110,12 +194,12 @@ interface ModuleContext {
     config: Record<string, unknown>;
     errors: {
         AppError: new (message: string, statusCode?: number) => Error;
-        NotFoundError: new (message: string) => Error;
-        UnauthorizedError: new (message: string) => Error;
-        ForbiddenError: new (message: string) => Error;
-        ConflictError: new (message: string) => Error;
+        NotFoundError: new (message?: string) => Error;
+        UnauthorizedError: new (message?: string) => Error;
+        ForbiddenError: new (message?: string) => Error;
+        ConflictError: new (message?: string) => Error;
     };
-    abilities: Record<string, unknown>;
+    abilities: ModuleAbilities;
     events: {
         emit: (event: string, ...args: unknown[]) => boolean;
         on: (event: string, listener: (...args: unknown[]) => void) => unknown;
@@ -130,6 +214,8 @@ interface ModuleContext {
             data?: Record<string, unknown>;
         }) => Promise<void>;
     };
+    /** Servicios de módulos core (users, etc.) */
+    services: CoreServices & Record<string, unknown>;
 }
 /**
  * Manifest de un módulo Nexus
@@ -192,4 +278,4 @@ interface PluginManifest {
     modules: ModuleManifest[];
 }
 
-export type { AuthRequest, FieldValidation, FormField, FormFieldType, ListType, MigrationHelpers, ModuleContext, ModuleEntity, ModuleManifest, ModuleMiddlewares, ModuleRequirements, PluginCategory, PluginManifest };
+export type { AbilityLike, AuthRequest, BaseUser, CoreServices, FieldValidation, ForbiddenErrorConstructor, ForbiddenErrorInstance, FormField, FormFieldType, ListType, MigrationHelpers, ModuleAbilities, ModuleContext, ModuleEntity, ModuleManifest, ModuleMiddlewares, ModuleRequirements, PaginatedResult, PaginationParams, PluginAuthRequest, PluginCategory, PluginManifest, UsersResolver };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gzl10/nexus-sdk",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "SDK types for creating Nexus plugins and modules",
   "type": "module",
   "main": "./dist/index.js",