@experteam-mx/ngx-services 18.4.2 → 18.4.4

package/lib/apis/api-security.service.d.ts

@@ -1,5 +1,5 @@
 import { QueryParams } from './models/api.models';
-import { AuthLoginIn, AuthLoginOut, AuthMeOut, ChangeLanguageIn, GetUserOut, ModulesOut, RoleIn, RoleOut, RolesOut, RoleTypesOut, SessionIn, SessionOut } from './models/api-security.types';
+import { AuthLoginIn, AuthLoginOut, AuthMeOut, AuthUserLoginIn, ChangeLanguageIn, GetUserOut, GetUsersOut, ModulesOut, PutUsersIn, PutUsersOut, RoleIn, RoleOut, RolesOut, RoleTypesOut, SessionIn, SessionOut } from './models/api-security.types';
 import { HttpClient } from '@angular/common/http';
 import { Environment } from '../ngx-services.models';
 import { Observable } from 'rxjs';
@@ -17,17 +17,19 @@ export declare class ApiSecurityService {
      */
     get url(): string;
     /**
-     * Performs user authentication by sending login credentials to the server.
+     * Handles the login authentication request by sending the login data to the authentication endpoint.
      *
-     * @param {Object} params - An object containing the user's login credentials and system details.
-     * @param {string} params.username - The username of the user attempting to log in.
-     * @param {string} params.password - The user's password.
-     * @param {string} params.role - The role of the user (e.g., admin, user).
-     * @param {string} params.system_name - The name of the system the user is logging into.
+     * @param {AuthLoginIn} body The payload containing login credentials.
+     * @return {Observable<AuthLoginOut>} An observable emitting the authentication response data.
+     */
+    postAuthLogin(body: AuthLoginIn): Observable<AuthLoginOut>;
+    /**
+     * Handles the user login process by sending user credentials to the authentication endpoint.
      *
-     * @return {Observable<AuthLoginOut>} An observable that emits the authentication result, including tokens and user information.
+     * @param {AuthUserLoginIn} body - The request payload containing user login details such as username and password.
+     * @return {Observable<AuthLoginOut>} An observable that emits the authenticated user's login data upon successful login.
      */
-    postAuthLogin({ username, password, role, system_name }: AuthLoginIn): Observable<AuthLoginOut>;
+    postAuthUserLogin(body: AuthUserLoginIn): Observable<AuthLoginOut>;
     /**
      * Logs out the current user by making a POST request to the logout endpoint.
      *
@@ -69,6 +71,23 @@ export declare class ApiSecurityService {
      * @return {Observable<GetUserOut>} An observable containing the user information.
      */
     getUser(id: number): Observable<GetUserOut>;
+    /**
+     * Fetches a list of users from the server based on the specified query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the list of users.
+     * @return {Observable<GetUsersOut>} An observable that emits the list of users retrieved from the server.
+     */
+    getUsers(params: QueryParams): Observable<GetUsersOut>;
+    /**
+     * Updates the information of a specified user on the server.
+     *
+     * @param {Object} params - The parameter object.
+     * @param {Object} params.user - The user object containing updated data.
+     * @param {string} params.user.id - The unique identifier of the user to be updated.
+     *
+     * @return {void} This method does not return a value.
+     */
+    putUsers({ user }: PutUsersIn): Observable<PutUsersOut>;
     /**
      * Changes the language for the authenticated user.
      *

package/lib/apis/models/api-catalog.interfaces.d.ts

@@ -1,4 +1,4 @@
-import { SymfonyModel } from './api.models';
+import { SymfonyModel, Translations } from './api.models';
 export interface Country extends SymfonyModel {
     name: string;
     code: string;
@@ -75,3 +75,8 @@ export interface IdentificationType extends SymfonyModel {
     identificationType: number | null;
     name: string;
 }
+export interface OperationType extends SymfonyModel {
+    code: string;
+    name: string;
+    translations?: Translations;
+}

package/lib/apis/models/api-catalog.types.d.ts

@@ -0,0 +1,5 @@
+import { OperationType } from './api-catalog.interfaces';
+export interface OperationTypesOut {
+    total: number;
+    operationTypes: OperationType[];
+}

package/lib/apis/models/api-reports.interfaces.d.ts

@@ -1,5 +1,6 @@
 import { LaravelModel, Translations } from './api.models';
 import { DocumentPayment } from './api-invoices.interfaces';
+import { OperationType } from './api-catalog.interfaces';
 export interface CollectionPayment extends LaravelModel {
     _id: number;
     country_code: string;
@@ -20,14 +21,14 @@ export interface CollectionPayment extends LaravelModel {
     document_type: DocumentType;
     document_category_id: number;
     document_category: DocumentCategory;
-    collection_origin: string;
-    collection_type: string;
     receipt_number: string;
     customer_name: string;
     account: string;
     amount: number;
     currency_id: number;
     currency_code: string;
+    operation_type_id: number;
+    operation_type: OperationType;
 }
 export interface DocumentType extends LaravelModel {
     _id: number;

package/lib/apis/models/api-security.interfaces.d.ts

@@ -1,5 +1,4 @@
 import { LaravelModel } from './api.models';
-import { Language } from './api-catalog.interfaces';
 import { Pivot } from './api-security.types';
 export interface Session extends LaravelModel {
     name: string;
@@ -43,15 +42,12 @@ export interface Permission extends LaravelModel {
 export interface User extends LaravelModel {
     name: string;
     username: string;
-    email: string;
     model_type: string;
     model_id: number;
     auth_type: string;
     language_id: number;
-    permissions: string[];
-    role: Role;
-    session: Session;
-    language: Language;
+    email: string;
+    roles: Role[];
 }
 export interface Module extends LaravelModel {
     name: string;

package/lib/apis/models/api-security.types.d.ts

@@ -1,8 +1,8 @@
-import { Module, Role, RoleType, Session, User } from './api-security.interfaces';
+import { Module, Permission, Role, RoleType, Session, User } from './api-security.interfaces';
 export type AuthLoginIn = {
     username: string;
     password: string;
-    role?: string;
+    role?: number;
     system_name?: string;
 };
 export type AuthLoginOut = {
@@ -10,6 +10,9 @@ export type AuthLoginOut = {
     token_type: string;
     expires_in: number;
 };
+export type AuthUserLoginIn = {
+    username: string;
+};
 export type SessionIn = {
     modelType: string;
     modelId: number;
@@ -18,11 +21,37 @@ export type SessionIn = {
 export type SessionOut = {
     session: Session;
 };
+export type PutUsersIn = {
+    user: User;
+};
+export type PutUsersOut = {
+    user: User;
+};
 export type GetUserOut = {
     user: User;
 };
-export interface AuthMeOut extends GetUserOut {
-}
+export type GetUsersOut = {
+    users: User[];
+    total: number;
+};
+export type AuthMeOut = {
+    user: {
+        id: number;
+        name: string;
+        username: string;
+        model_type: string;
+        model_id: number;
+        is_active: boolean;
+        created_at: string;
+        updated_at: string;
+        auth_type: string;
+        language_id: number;
+        email: string;
+        role: Role;
+        permissions: Permission[];
+        session: Session | null;
+    };
+};
 export type ChangeLanguageIn = {
     languageId: number;
 };

package/lib/apis/models/api.models.d.ts

@@ -24,5 +24,5 @@ export type QueryParams = {
 export interface Translations {
     [key: string]: {
         [langCode: string]: string;
-    }[];
+    };
 }

package/lib/ngx-services.models.d.ts

@@ -17,6 +17,7 @@ import { InjectionToken } from '@angular/core';
 export type Environment = {
     apiBillingDO?: string;
     apiBillingMX?: string;
+    apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@experteam-mx/ngx-services",
-  "version": "18.4.2",
+  "version": "18.4.4",
   "description": "Angular common services for Experteam apps",
   "author": "Experteam Cía. Ltda.",
   "keywords": [

package/public-api.d.ts

@@ -2,6 +2,7 @@ export * from './lib/ngx-services.models';
 export * from './lib/ngx-services.module';
 export * from './lib/apis/api-billing-do.service';
 export * from './lib/apis/api-billing-mx.service';
+export * from './lib/apis/api-catalogs.service';
 export * from './lib/apis/api-companies.service';
 export * from './lib/apis/api-external-pickups.service';
 export * from './lib/apis/api-invoices.service';
@@ -10,6 +11,8 @@ export * from './lib/apis/api-reports.service';
 export * from './lib/apis/api-security.service';
 export * from './lib/apis/api-shipments.service';
 export * from './lib/apis/models/api-billing.types';
+export * from './lib/apis/models/api-catalog.interfaces';
+export * from './lib/apis/models/api-catalog.types';
 export * from './lib/apis/models/api-companies.interfaces';
 export * from './lib/apis/models/api-companies.types';
 export * from './lib/apis/models/api-external-pickups.types';