sass-cms-template-common 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -91,6 +91,13 @@ export declare type CmsMuiProviderProps = {
     children: ReactNode;
 };
 
+/** Envelope común de respuesta de los webservices de OpenCms. */
+export declare interface CmsResponse {
+    status: 'ok' | 'fail' | 'error';
+    errorCode?: string;
+    error?: string;
+}
+
 export declare type CmsTranslator = {
     messages: CmsMessages;
     navigation: (module: NavigationModule | string) => string;
@@ -102,6 +109,47 @@ export declare type CmsTranslator = {
     }) => string;
 };
 
+/** Usuario del CMS. Los campos presentes dependen del formato `fields`. */
+export declare interface CmsUser {
+    username?: string;
+    firstname?: string;
+    lastname?: string;
+    fullName?: string;
+    email?: string;
+    datecreated?: string;
+    status?: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Servicios HTTP del módulo `users` del CMS.
+ *
+ * Se construye igual que `CmsCommonServices`, con `{ axiosApi, authentication }`.
+ */
+export declare class CmsUsersServices {
+    protected props: IUsersServices;
+    protected authentication: Authentication;
+    constructor(props: IUsersServices);
+    /** POST /users/get — lista paginada de usuarios con filtros. */
+    getUsers: (filters?: UsersGetFilters) => Promise<UsersGetResponse>;
+    /** POST /users/publication — usuarios asociados a la publicación. */
+    getPublicationUsers: (filters?: UsersPublicationFilters) => Promise<UsersPublicationResponse>;
+    /** POST /users/groups/get — grupos disponibles del sistema. */
+    getGroups: (ou?: string) => Promise<UserGroupsResponse>;
+    /** POST /users/pin/get — pins del usuario autenticado. */
+    getPins: () => Promise<UserPinsGetResponse>;
+    /** POST /users/pin/add — agrega un pin de recurso. */
+    addPin: (pin: string) => Promise<UserPinAddResponse>;
+    /** POST /users/pin/delete — elimina uno o más pins por ID. */
+    deletePins: (ids: number[]) => Promise<CmsResponse>;
+    /** POST /users/action/setStatus — activa o desactiva un usuario. */
+    setUserStatus: (username: string, action: UserStatusAction) => Promise<CmsResponse>;
+    /** POST /users/action/resetPass — restablece la contraseña de un usuario. */
+    resetPassword: (username: string) => Promise<CmsResponse>;
+    /** POST /users/action/resetMfa — resetea la configuración MFA de un usuario. */
+    resetMfa: (username: string, reason: string) => Promise<CmsResponse>;
+}
+
 /** POST /dashboard/countNotificatio */
 export declare interface CountNotificationsResponse {
     status: string;
@@ -300,6 +348,11 @@ export declare const ITEM_DEFAULT_BG = "#FFFFFF";
 
 export declare const ITEM_HOVER_BG = "#D8E2FF";
 
+declare interface IUsersServices {
+    axiosApi: AxiosInstance;
+    authentication: Authentication;
+}
+
 export declare const LIB_VERSION: "0.0.0";
 
 export declare type Locale = (typeof SUPPORTED_LOCALES)[number];
@@ -521,6 +574,12 @@ export declare interface PublicationPermissions {
     [key: string]: boolean;
 }
 
+/**
+ * Ámbito de publicación: `"pub"` (solo publicación), `"admin"` (solo admins
+ * globales) o cualquier otro valor (ambos).
+ */
+export declare type PublicationScope = 'pub' | 'admin' | (string & {});
+
 /** Cuerpo de la respuesta de POST /publications/get */
 export declare interface PublicationsGetResponse {
     status: string;
@@ -634,4 +693,110 @@ export declare type UseCmsTranslationOptions = {
     catalog?: LocaleCatalog;
 };
 
+/** Grupo del sistema devuelto por POST /users/groups/get. */
+export declare interface UserGroup {
+    id: string;
+    name: string;
+}
+
+/** Cuerpo de la respuesta de POST /users/groups/get. */
+export declare interface UserGroupsResponse extends CmsResponse {
+    groups: UserGroup[];
+}
+
+/** Pin (recurso fijado) de un usuario. */
+export declare interface UserPin {
+    id: number;
+    [key: string]: unknown;
+}
+
+/** Cuerpo de la respuesta de POST /users/pin/add. */
+export declare interface UserPinAddResponse extends CmsResponse {
+    /** ID del pin creado. */
+    id?: number;
+}
+
+/** Pin a eliminar en POST /users/pin/delete. */
+export declare interface UserPinDeleteInput {
+    id: number;
+}
+
+/** Cuerpo de la respuesta de POST /users/pin/get. */
+export declare interface UserPinsGetResponse extends CmsResponse {
+    pins: UserPin[];
+    total?: number;
+}
+
+/** Filtro sobre campos adicionales del usuario (`filters.advance`). */
+export declare interface UsersAdvanceFilter {
+    name: string;
+    value: string;
+}
+
+/** Formato de respuesta soportado por POST /users/get. */
+export declare type UsersFieldsFormat = 'all' | 'FullName' | 'detail' | '';
+
+/** Filtros de POST /users/get. */
+export declare interface UsersGetFilters {
+    /** Cantidad de resultados por página (default: 100). */
+    size?: number;
+    /** Número de página (default: 1). */
+    page?: number;
+    /** Fuerza búsqueda global (default: false). */
+    searchGlobal?: boolean;
+    /**
+     * Campo + dirección. Campos válidos: `username`, `firstname`, `lastname`,
+     * `email`, `datecreated`. Ej: `"datecreated desc"`.
+     */
+    order?: string;
+    /** Nombre del grupo para filtrar usuarios. */
+    grupo?: string;
+    /** Organizational Unit (default: "/"). */
+    ou?: string;
+    /** Estado del usuario. */
+    status?: UserStatus;
+    /** Timestamp en milisegundos (inicio del rango de fecha de creación). */
+    fromDate?: string;
+    /** Timestamp en milisegundos (fin del rango de fecha de creación). */
+    toDate?: string;
+    /** Filtra por ámbito de publicación. */
+    publicationScope?: PublicationScope;
+    /** Formato de respuesta. */
+    fields?: UsersFieldsFormat;
+    /** Búsqueda libre por email, username, apellido o nombre (LIKE). */
+    text?: string;
+    /** Filtros sobre campos adicionales del usuario. */
+    advance?: UsersAdvanceFilter[];
+}
+
+/** Cuerpo de la respuesta de POST /users/get. */
+export declare interface UsersGetResponse extends CmsResponse {
+    users: CmsUser[];
+    total?: number;
+    page?: number;
+    size?: number;
+}
+
+/** Formato de respuesta soportado por POST /users/publication. */
+export declare type UsersPublicationFieldsFormat = 'all' | 'summary' | 'FullName' | '';
+
+/** Filtros de POST /users/publication. */
+export declare interface UsersPublicationFilters {
+    /** Texto libre para búsqueda de usuario. */
+    text?: string;
+    /** Formato de respuesta. */
+    fields?: UsersPublicationFieldsFormat;
+}
+
+/** Cuerpo de la respuesta de POST /users/publication. */
+export declare interface UsersPublicationResponse extends CmsResponse {
+    users: CmsUser[];
+}
+
+/** Estado posible de un usuario del sistema. */
+export declare type UserStatus = 'active' | 'block' | 'pending';
+
+/** Acción soportada por POST /users/action/setStatus. */
+export declare type UserStatusAction = 'activate' | 'deactivate';
+
 export { }