@yuno-payments/dashboard-api-mfe 0.39.6 → 0.40.0

package/build/esm/types/api/api.types.d.ts

@@ -0,0 +1,199 @@
+export interface GetPaymentsParams {
+    start_date?: string | Date;
+    end_date?: string | Date;
+    page?: number;
+    size?: number;
+    enabled?: boolean;
+    account_code?: string;
+    payment_link_code?: string;
+}
+export interface GetPaymentsEvaluatedParams {
+    start_date: string | Date;
+    end_date: string | Date;
+    page: number;
+    size: number;
+    enabled?: boolean;
+    account_code?: string;
+    date: string;
+    statuses: [];
+    sub_statuses: [];
+    account_codes: [];
+    countries: [];
+    payment_method_types: [];
+    currency_codes: [];
+    provider_ids: [];
+    skip: number;
+    payment_code?: string;
+    order_id?: string;
+    transaction_code?: string;
+    provider_transaction_id?: string;
+    merchant_reference?: string;
+    customer_payer_email?: string;
+    customer_payer_document?: string;
+}
+export interface GetPaymentParams {
+    payment_code: string;
+    enabled?: boolean;
+}
+export interface GetPaymentTransactionsParams {
+    payment_code: string;
+}
+export interface GetTransactionDetailsParams {
+    payment_code: string;
+    transaction_code: string;
+    enabled?: boolean;
+    size?: number;
+}
+export interface GetTransactionDetailsV2Params {
+    payment_code?: string;
+    transaction_code?: string;
+    enabled?: boolean;
+}
+export interface IChangePassword {
+    user_id: string;
+    payload: IPayloadChangePassword;
+}
+interface IPayloadChangePassword {
+    password: string;
+    connection: string;
+}
+export interface GetPaymentMethodsByProviderParams {
+    provider: string;
+}
+export interface GetApiLogsParams {
+    page: number;
+    size: number;
+    periodicity?: string;
+    account_code?: string;
+    status_codes?: string;
+    methods?: string;
+    start_date?: string;
+    end_date?: string;
+    search?: string;
+    organizationCode?: string;
+    time_zone?: number;
+    now?: string;
+}
+export interface GetReconciliationMetricParams {
+    key_metric: string;
+    start_date?: string;
+    end_date?: string;
+    account_code?: string;
+    provider_id?: string;
+    country?: string;
+    currency?: string;
+    payment_method?: string;
+    metric_type?: string;
+}
+export interface FirebaseUserSubscribe {
+    token?: string;
+    topic?: string;
+}
+export interface PathNotification {
+    type: string;
+}
+export interface TimeZoneCatalog {
+    identifier: string;
+    utc_offset: {
+        dst: string;
+        std: string;
+    };
+    abbreviation: {
+        dst: string;
+        std: string;
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    publishedAt: Date;
+}
+export interface MfaUserSubscribe {
+    mfaToken?: string;
+    otp: string;
+}
+export interface MfaUserPayload {
+    mfa_token?: string;
+    otp: string;
+}
+export interface AccountRoles {
+    account_code: string;
+    role_id: string;
+}
+export interface UserInviteMultiaccountPayload {
+    emails: string[];
+    account_roles: AccountRoles[];
+    organizationCode: string;
+}
+export interface GetTransactionsParams {
+    page?: number;
+    size?: number;
+    account_code?: string;
+}
+export interface GetPayoutDetail {
+    payout_code: string;
+    enabled?: boolean;
+    organization_code?: string;
+}
+export interface GetPayoutTransactionDetail {
+    enabled?: boolean;
+    payout_code: string;
+    transaction_code: string;
+    organization_code: string;
+}
+interface Country {
+    country_name: string;
+    country_code: string;
+    prefix_phone: {
+        prefix: string;
+        regex: string;
+    };
+    icon: string;
+}
+interface CountryCurrencies {
+    [country: string]: Ar[];
+}
+interface Ar {
+    currency_code: string;
+    decimals: number;
+}
+interface DocumentType {
+    country: string;
+    code: string;
+    description: string;
+    regex: string;
+}
+export interface Countries {
+    countries?: Country[];
+    document_types?: DocumentType[];
+    link?: {
+        payment_terms_and_conditions: string;
+        payment_privacy: string;
+    };
+    country_currencies?: CountryCurrencies;
+}
+export interface InsightMetricParams {
+    account_code?: string;
+    periodicity: string;
+    organization_code: string;
+    start_date: string;
+    end_date: string;
+    currency_code: string;
+    source: string;
+    timezone: string;
+}
+export interface PaymentsSettings {
+    columns: {
+        hide: string[];
+    };
+}
+export interface ThemeSettings {
+    theme: {
+        mode: string;
+        [key: string]: string;
+    };
+}
+export interface PinnedSections {
+    pinned_sections: {
+        sections: string[];
+    };
+}
+export {};

package/build/esm/types/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './api.singleton';
+export * from './api.types';

package/build/esm/types/api-provider.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+export declare function ApiProvider({ children, }: {
+    children: React.ReactNode;
+}): JSX.Element;

package/build/esm/types/common/config.d.ts

@@ -0,0 +1,13 @@
+export declare const environment: {
+    ENVIRONMENT: string | undefined;
+    BFF_URL_PROD: string | undefined;
+    BFF_URL_SBX: string | undefined;
+    BFF_URL_STG: string | undefined;
+    BFF_URL_DEV: string | undefined;
+    BFF_URL_LOCAL: string | undefined;
+    WS_URL_LOCAL: string | undefined;
+    WS_URL_PROD: string | undefined;
+    WS_URL_SBX: string | undefined;
+    WS_URL_STG: string | undefined;
+    WS_URL_DEV: string | undefined;
+};

package/build/esm/types/constants/errors-code.constant.d.ts

@@ -0,0 +1,5 @@
+export declare enum ApiErrorCodes {
+    ECONNABORTED = "ECONNABORTED",
+    ETIMEDOUT = "ETIMEDOUT",
+    ERR_BAD_REQUEST = "ERR_BAD_REQUEST"
+}

package/build/esm/types/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './errors-code.constant';

package/build/esm/types/lib/http-client/__tests__/http-client.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/esm/types/lib/http-client/api.config.d.ts

@@ -0,0 +1,2 @@
+import { AxiosRequestConfig } from 'axios';
+export declare const apiConfig: AxiosRequestConfig;

package/build/esm/types/lib/http-client/axios.d.ts

@@ -0,0 +1,19 @@
+import { AxiosInterceptorManager, AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
+export declare class Axios {
+    interceptors?: {
+        /**
+         * The **Request** interceptor will be call rigth before the `http request`
+         * @summary
+         * This a useful method especially if you need to send a token on each request.
+         */
+        request: AxiosInterceptorManager<AxiosRequestConfig>;
+        /**
+         * The **Response** interceptor will be call rigth before the `http request` is received.
+         * @summary
+         * This a useful method especially if you need to send a token on each request.
+         */
+        response: AxiosInterceptorManager<AxiosResponse>;
+    };
+    protected instance: AxiosInstance;
+    constructor(config: AxiosRequestConfig);
+}

package/build/esm/types/lib/http-client/http-client.d.ts

@@ -0,0 +1,168 @@
+import { Axios } from './axios';
+import { AxiosRequestConfig, AxiosResponse, AxiosError, CancelTokenSource } from 'axios';
+/**
+ * @class Api Class is a fancy es6 wrapper class for axios.
+ *
+ * @param {import("axios").AxiosRequestConfig} config - axios Request Config.
+ * @link [AxiosRequestConfig](https://github.com/axios/axios#request-config)
+ */
+export declare class HttpClient extends Axios {
+    private token;
+    private cancelToken;
+    /**
+     * Creates an instance of api.
+     * @param {import("axios").AxiosRequestConfig} conf
+     */
+    constructor(conf: AxiosRequestConfig);
+    /**
+     * Gets Token.
+     *
+     * @returns {string} token.
+     * @memberof Api
+     */
+    getToken(): string;
+    /**
+     * Sets Token.
+     *
+     * @param {string} token - token.
+     * @memberof Api
+     */
+    setToken(token: string): void;
+    /**
+     * Get Uri
+     *
+     * @param {import("axios").AxiosRequestConfig} [config]
+     * @returns {string}
+     * @memberof Api
+     */
+    getUri(config?: AxiosRequestConfig): string;
+    getCancelTokenSource(): CancelTokenSource;
+    /**
+     * Generic request.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP axios response payload.
+     * @memberof Api
+     *
+     * @example
+     * api.request({
+     *   method: "GET|POST|DELETE|PUT|PATCH"
+     *   baseUrl: "http://www.domain.com",
+     *   url: "/api/v1/users",
+     *   headers: {
+     *     "Content-Type": "application/json"
+     *  }
+     * }).then((response: AxiosResponse<User>) => response.data)
+     *
+     */
+    request<T, R = AxiosResponse<T>>(config: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP GET method, used to fetch data `statusCode`: 200.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} HTTP `axios` response payload.
+     * @memberof Api
+     */
+    get<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP OPTIONS method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} HTTP `axios` response payload.
+     * @memberof Api
+     */
+    options<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP DELETE method, `statusCode`: 204 No Content.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    delete<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP HEAD method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    head<T, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP POST method `statusCode`: 201 Created.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    post<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP PUT method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    put<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     * HTTP PATCH method.
+     *
+     * @access public
+     * @template T - `TYPE`: expected object.
+     * @template B - `BODY`: body request object.
+     * @template R - `RESPONSE`: expected object inside a axios response format.
+     * @param {string} url - endpoint you want to reach.
+     * @param {B} data - payload to be send as the `request body`,
+     * @param {import("axios").AxiosRequestConfig} [config] - axios request configuration.
+     * @returns {Promise<R>} - HTTP [axios] response payload.
+     * @memberof Api
+     */
+    patch<T, B, R = AxiosResponse<T>>(url: string, data?: B, config?: AxiosRequestConfig): Promise<R>;
+    /**
+     *
+     * @template T - type.
+     * @param {import("axios").AxiosResponse<T>} response - axios response.
+     * @returns {T} - expected object.
+     * @memberof Api
+     */
+    success<T>(response: AxiosResponse<T>): T;
+    /**
+     *
+     *
+     * @template T type.
+     * @param {AxiosError<T>} error
+     * @memberof Api
+     */
+    error<T>(error: AxiosError<T>): void;
+}

package/build/esm/types/lib/http-client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './http-client';
+export * from './api.config';

package/build/esm/types/msw/browser.d.ts

@@ -0,0 +1 @@
+export declare const worker: import("msw/browser").SetupWorker;

package/build/esm/types/msw/handlers/index.d.ts

@@ -0,0 +1 @@
+export declare const handlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/esm/types/msw/handlers/insights.d.ts

@@ -0,0 +1 @@
+export declare const insightsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/esm/types/msw/handlers/organizations.d.ts

@@ -0,0 +1 @@
+export declare const organizationsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/esm/types/msw/handlers/payments.d.ts

@@ -0,0 +1 @@
+export declare const paymentsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/esm/types/msw/index.d.ts

@@ -0,0 +1 @@
+export declare function enableMocking(): Promise<void>;

package/build/esm/types/msw/mocks/insights/conversion-rate/overview-fraud-3ds.mock.d.ts

@@ -0,0 +1,14 @@
+export declare const conversionRateOverviewFraud3dsMock: {
+    fraud: {
+        conversion_rate_fraud_transactions: number;
+        conversion_fraud_transactions_periodicity: null;
+    };
+    '3ds': {
+        conversion_rate_card_transactions3ds: number;
+        conversion_rate_card_transactions3ds_periodicity: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+};

package/build/esm/types/msw/mocks/insights/conversion-rate/overview.mock.d.ts

@@ -0,0 +1,34 @@
+export declare const conversionRateOverviewMock: {
+    total: {
+        total_conversion_rate: number;
+        insight_payment_total_conversion_rate_periodicity: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    cards: {
+        cards_approvals_rate: number;
+        insight_payment_total_conversion_rate_periodicity_for_card: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    apms: {
+        apms_conversion_rate: number;
+        insight_payment_total_conversion_rate_periodicity_for_apm: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+    cards_without_insufficient_funds: {
+        without_insufficient_funds_conversion_rate: number;
+        insight_conversion_rate_without_insufficient_funds: {
+            '2025-05-05': number;
+            '2025-05-06': number;
+            '2025-05-07': number;
+        };
+    };
+};

package/build/esm/types/msw/mocks/insights/overview/overview-metrics.mock.d.ts

@@ -0,0 +1,9 @@
+export declare enum OverviewMetricType {
+    GENERAL = "volume-and-total-payments",
+    LATENCY = "provider-latency",
+    STATUS = "status",
+    SUBSCRIPTIONS = "subscriptions"
+}
+export declare const oldOverviewMetricsHandler: import("msw/lib/core/handlers/HttpHandler").HttpHandler;
+export declare const newOverviewMetricsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];
+export declare const overviewMetricsHandlers: import("msw/lib/core/handlers/HttpHandler").HttpHandler[];

package/build/esm/types/msw/mocks/insights/overview/overview.mock.d.ts

@@ -0,0 +1,139 @@
+export declare const OVERVIEW_MOCK: {
+    sales_volume_metric_group: {
+        distribution: {
+            key: string;
+            total: number;
+        }[];
+        total: number;
+        average: number;
+    };
+    total_payments: {
+        distribution: {
+            key: string;
+            total: number;
+        }[];
+        total: number;
+        average: number;
+    };
+    average_ticket: {
+        distribution: {
+            key: string;
+            total: number;
+            min_ticket: number;
+            max_ticket: number;
+        }[];
+        total: number;
+        min_ticket: number;
+        max_ticket: number;
+    };
+    conversion_rate: null;
+    total_payments_and_conversion_rate: {
+        payments: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        conversion_rate: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+    };
+    quantity_status_distribution: ({
+        SUCCEEDED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        DECLINED?: undefined;
+    } | {
+        DECLINED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        SUCCEEDED?: undefined;
+    })[];
+    volume_successful_payments: number;
+    volume_successful_payments_by_periodicity: {
+        key: string;
+        total: number;
+    }[];
+    quantity_successful_payments: number;
+    quantity_successful_payments_by_periodicity: {
+        key: string;
+        total: number;
+    }[];
+    average_provider_latency: ({
+        PAYMENTEZ: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        NUVEI?: undefined;
+        WOMPI?: undefined;
+    } | {
+        NUVEI: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        PAYMENTEZ?: undefined;
+        WOMPI?: undefined;
+    } | {
+        WOMPI: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        PAYMENTEZ?: undefined;
+        NUVEI?: undefined;
+    })[];
+    total_subscriptions_and_conversion_rate: {
+        subscriptions: {
+            distribution: null;
+            total: number;
+        };
+        subscriptions_succeeded: {
+            distribution: null;
+            total: number;
+        };
+        conversion_rate: {
+            distribution: null;
+            total: number;
+        };
+    };
+    total_status_distribution: ({
+        SUCCEEDED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        DECLINED?: undefined;
+    } | {
+        DECLINED: {
+            distribution: {
+                key: string;
+                total: number;
+            }[];
+            total: number;
+        };
+        SUCCEEDED?: undefined;
+    })[];
+};