@tap-payments/os-micro-frontend-shared 0.3.109-test.2 → 0.3.109-test.3

package/build/types/accountWidget.d.ts

@@ -0,0 +1,80 @@
+import type { Brand, BrandDetails } from './brand';
+import type { Entity, EntityDetails } from './entity';
+import type { MerchantDetails } from './merchant';
+import type { SegmentUser } from './user';
+import type { ACCOUNT_SECTION } from './account';
+export type AccountWidgetChangeEvent = {
+    type: 'user.updated';
+    data: SegmentUser;
+} | {
+    type: 'entity.updated';
+    data: Entity | EntityDetails;
+} | {
+    type: 'brand.updated';
+    data: Brand | BrandDetails;
+} | {
+    type: 'wallet.updated';
+    data: MerchantDetails['wallet'];
+};
+/** Per-section widget config. `isAvailable`/`isEditable`/`isCreatable` are honored when set. */
+export type AccountWidgetSectionPayload = {
+    isAvailable?: boolean;
+    isEditable?: boolean;
+    isCreatable?: boolean;
+};
+/** Pre-selected account records the widget operates on (the "validation fields"). */
+export type AccountWidgetSelection = {
+    segmentId?: string;
+    walletId?: string;
+    bankAccountId?: string;
+    entityId?: string;
+    entityCountry?: string;
+    brandId?: string;
+    userId?: string;
+};
+/**
+ * Account Widget state/config owned by the Account App (`payload.accountWidget`).
+ * Selections are seeded from the opener (internal app or external app) and live
+ * under `selection`; `AccountWidgetPayload` carries no flat selection mirrors.
+ */
+export type AccountWidgetPayload = {
+    initialSection?: ACCOUNT_SECTION;
+    sections?: Partial<Record<ACCOUNT_SECTION, AccountWidgetSectionPayload>>;
+    /** Identifies the external application that opened the Account App for the widget. */
+    context?: AccountWidgetContext;
+    selection: AccountWidgetSelection;
+};
+/** How the Account App was reached. */
+export type AccountWidgetSource = 'internal' | 'external';
+/**
+ * Contract the opening application passes when it opens the Account App for the
+ * Account Widget. Carries the *external* application/service that consumes the
+ * widget (e.g. the Business app, or the Platform app) — not the Account app's
+ * own codes. Each opener inlines its own
+ * `{ appCode, serviceCode, applicationId, serviceId }` from its own app/service;
+ * the Account App uses it for cross-app scoping (e.g. the data-changed payload)
+ * and to detect the external mode.
+ *
+ * When no opener context is supplied (internal mode), the Account App backfills
+ * it with its own `app`/`service` codes — so consumers must check
+ * `appCode`/`serviceCode` rather than assuming it always carries the opener's.
+ */
+export type AccountWidgetContext = {
+    appCode?: string;
+    serviceCode?: string;
+    applicationId?: string;
+    serviceId?: string;
+};
+/**
+ * Cross-MFE data sync parameters published by the Account App after a widget
+ * mutation. Consumers (e.g. a board list in the opener application) use
+ * `context`/`selections` to scope and match the record that changed.
+ */
+export type AccountWidgetDataChangedParams = {
+    /** The external application/service the widget runs under. */
+    context: AccountWidgetContext;
+    /** The selected account records the mutation applies to. */
+    selections: AccountWidgetSelection;
+    /** The change events emitted by the widget (usually a single event). */
+    changes: AccountWidgetChangeEvent[];
+};

package/build/types/analytics.d.ts

@@ -0,0 +1,36 @@
+export interface AnalyticsDetails {
+    date?: string;
+    count: number;
+    hour?: number;
+    count_percentage: string;
+    amount: number;
+    trx_amount?: number;
+    amount_percentage: string;
+    min: number;
+    max: number;
+    median: number;
+    average: {
+        general: number;
+        weighted: {
+            below_500_msec: string;
+            below_1_second: string;
+            below_1_5_second: string;
+            below_2_second: string;
+            below_2_5_second: string;
+            below_3_second: string;
+            below_3_5_second: string;
+            below_4_second: string;
+            above_4_second: string;
+        };
+    };
+}
+export declare enum ChargeBreakDownType {
+    PaymentMethod = "PAYMENT_METHOD",
+    PaymentCurrency = "PAYMENT_CURRENCY",
+    PaymentScheme = "PAYMENT_SCHEME",
+    PaymentType = "PAYMENT_TYPE",
+    PaymentLocation = "PAYMENT_LOCATION",
+    PaymentIssuer = "PAYMENT_ISSUER",
+    PaymentAcquirer = "PAYMENT_ACQUIRER",
+    PaymentGateway = "PAYMENT_GATEWAY"
+}

package/build/types/api.d.ts

@@ -0,0 +1,30 @@
+export type { AxiosError } from 'axios';
+import { getHeaders } from '../utils/api';
+export interface HttpMethodConfig {
+    signal?: AbortSignal;
+    sandboxMode?: boolean;
+    applicationId?: string;
+    serviceId?: string;
+    functionId?: string;
+}
+export interface HttpMethodFilters {
+    dateFrom?: number;
+    dateTo?: number;
+    limit: number;
+    order?: string;
+    order_by?: string;
+    filteredIds?: string[];
+    columnFilters?: Record<string, any>;
+    startAfter?: string;
+    keyword?: string;
+    merchants?: string[];
+    merchantIds?: string[];
+    retailerIds?: string[];
+}
+export interface QueryConfig extends Omit<HttpMethodConfig, 'signal'> {
+}
+export type DefaultHttpHeaders = Partial<ReturnType<typeof getHeaders>>;
+export type RequestConfig = {
+    headers?: DefaultHttpHeaders;
+    signal?: AbortSignal;
+};

package/build/types/appConfig.d.ts

@@ -0,0 +1,31 @@
+export interface Country {
+    created: number;
+    updated: number;
+    countryId: string;
+    name: Record<string, string>;
+    iso2: string;
+    iso3: string;
+    numeric: number;
+    continent: string;
+    capital: string;
+    geoNameId: string;
+    idd_prefix: number;
+    logo: string;
+    digits: number;
+    supported_by_tap: boolean;
+    min_digits: number;
+    max_digits: number;
+    currencies: string[];
+}
+export interface Timezone {
+    countryCode: string;
+    label: string;
+    timezone: string;
+    offset: number;
+}
+export interface SourceFilter {
+    name: string;
+    type: string;
+    icon?: string;
+    options?: SourceFilter[];
+}

package/build/types/appEvents.d.ts

@@ -0,0 +1,67 @@
+import type { AccountWidgetDataChangedParams } from './accountWidget';
+import { CalenderMode, NavigateFunction, NavigateFunctionOptions, TableMode, Timezone, ToastEventPayload } from './index.js';
+import { DragControls } from 'framer-motion';
+export declare enum AppEvent {
+    OnClickTableAction = "on-click-table-action",
+    OnRightClickTableAction = "on-right-click-table-action",
+    OnToggleTableMode = "on-toggle-table-mode",
+    OnChangeTableMode = "on-change-table-mode",
+    OnChangeCalenderMode = "on-change-calender-mode",
+    OnChangeTimezone = "on-change-timezone",
+    OnNavigate = "on-navigate",
+    OnStartDrag = "on-start-drag",
+    OnChangeAppToolbar = "on-change-app-toolbar",
+    OnToast = "on-toast",
+    OnInvalidateQueries = "on-invalidate_queries",
+    OnCloseApp = "on-close-app",
+    OnModifyRemotePayload = "on-modify-remote-payload",
+    OnAccountDataChanged = "on-account-data-changed",
+    OnPreloadApps = "on-preload-apps"
+}
+/**
+ * Map event names to their corresponding payload types.
+ */
+export type AppEventMap = {
+    [AppEvent.OnClickTableAction]: (params: {
+        targetApp: {
+            appCode: string;
+            serviceCode: string;
+            sandboxMode?: boolean;
+            payload?: object;
+        };
+    }, options?: NavigateFunctionOptions) => void;
+    [AppEvent.OnRightClickTableAction]: (params: {
+        targetApp: {
+            appCode: string;
+            serviceCode: string;
+            sandboxMode?: boolean;
+            payload?: object;
+        };
+    }, options?: NavigateFunctionOptions) => void;
+    [AppEvent.OnToggleTableMode]: () => void;
+    [AppEvent.OnChangeTableMode]: (tableMode: TableMode) => void;
+    [AppEvent.OnChangeCalenderMode]: (calenderMode: CalenderMode) => void;
+    [AppEvent.OnChangeTimezone]: (timezone: Timezone) => void;
+    [AppEvent.OnNavigate]: NavigateFunction;
+    [AppEvent.OnStartDrag]: (...args: Parameters<DragControls['start']>) => void;
+    [AppEvent.OnChangeAppToolbar]: (params: {
+        windowId: string;
+        toolbarIconUrl: string;
+    }) => void;
+    [AppEvent.OnModifyRemotePayload]: (params: {
+        windowId: string;
+        payload: object;
+    }) => void;
+    [AppEvent.OnToast]: (params: ToastEventPayload) => void;
+    [AppEvent.OnInvalidateQueries]: () => void;
+    [AppEvent.OnCloseApp]: (params: {
+        windowId: string;
+        appCode: string;
+        serviceCode: string;
+        payload?: object;
+    }) => void;
+    [AppEvent.OnAccountDataChanged]: (params: AccountWidgetDataChangedParams) => void;
+    [AppEvent.OnPreloadApps]: (params: {
+        appCodes: string[];
+    }) => void;
+};

package/build/types/apps.d.ts

@@ -0,0 +1,172 @@
+import { ColumnsView } from './column';
+import { Segment, SegmentCountry, SegmentUser, SelectedBrand, SelectedCountry, User } from './user';
+import type { i18n } from 'i18next';
+import { Theme } from '@mui/material';
+import { CalenderMode } from './theme';
+import { Timezone } from './appConfig';
+import { Brand, Entity, Override, TableMode } from './index.js';
+import { TextAndLang } from './common';
+export type AppPayload<TServiceCodes extends string = string, TOverrides extends Partial<DefaultServicePayload> = object> = {
+    services: {
+        [key in TServiceCodes]?: ServicePayload<TOverrides>;
+    };
+};
+export type DefaultServicePayload = {
+    columnFilters?: Record<string, any>;
+    filteredIds?: string[];
+    dateRange?: [Date, Date];
+    filterStatus?: string;
+    scrollToId?: string;
+    isTextShown?: boolean;
+    tableViews?: ColumnsView[];
+    calendarTimezone?: number;
+    reportTypes?: string[];
+};
+export type ServicePayload<TOverrides extends Partial<DefaultServicePayload> = object> = Override<DefaultServicePayload, TOverrides>;
+export interface AppDetails {
+    id: string;
+    appCode: string;
+    appId: string;
+    segmentId: string;
+    serviceCode: string;
+    serviceId: string;
+    isMinimized: boolean;
+    isMaximized: boolean;
+    order: number;
+    openOrder?: number;
+    color: string;
+    sandboxMode: boolean;
+    dimensions: {
+        width: number | string;
+        height: number | string;
+        maxWidth: number | string;
+        maxHeight: number | string;
+        minWidth: number | string;
+        minHeight: number | string;
+    };
+    payload?: Record<string, any> & ServicePayload;
+    toolbarIconUrl?: string;
+    hideMaximizedApp?: boolean;
+    hideMinimizeApp?: boolean;
+    hideSandboxApp?: boolean;
+    hideHeader?: boolean;
+    servicesVisibility?: Record<string, boolean>;
+    /**
+     * When true, this window never drives the host URL: clicking/reordering it
+     * won't navigate the host to its app/service route, and the mount-time URL
+     * sync is skipped. Used when an app is opened as a sub-app whose opener
+     * keeps its own route (e.g. the Account Widget opened from Business).
+     */
+    isUrlNavigationDisabled?: boolean;
+    /**
+     * True when the window should render without the host's OS chrome — the app
+     * draws its own UI. Such windows are excluded from window
+     * ordering/reordering.
+     */
+    isAppWindowHidden?: boolean;
+}
+export interface ServiceFunction {
+    id: string;
+    code: string;
+    name: TextAndLang[];
+}
+export interface AppService {
+    id: string;
+    code: string;
+    name: TextAndLang[];
+    functions: ServiceFunction[];
+    visible?: boolean;
+}
+export interface UserApp {
+    id: string;
+    code: string;
+    iconUrl: string;
+    toolbarIconUrl: string;
+    name: TextAndLang[];
+    visible?: boolean;
+    app_services: AppService[];
+}
+export type NavigateFunctionOptions = {
+    /**
+     * If true, the app is opened from inside another app (nested navigation).
+     * Such windows draw their own floating chrome and must NOT drive the host
+     * URL — the opener keeps its own app/service route.
+     */
+    isNestedNavigation?: boolean;
+    /**
+     * Open the app without driving the host URL: reordering/clicking its window
+     * won't navigate the host to the app route (and the mount URL sync is
+     * skipped) — the opener keeps its own route.
+     */
+    isUrlNavigationDisabled?: boolean;
+    /**
+     * Open the app as a bare window with no main app window shell: the app draws
+     * its own chrome, and the window is excluded from window ordering/reordering.
+     */
+    isAppWindowHidden?: boolean;
+};
+export type NavigateFunction = (params: {
+    windowId?: string;
+    appCode: string;
+    serviceCode: string;
+    sandboxMode?: boolean;
+    state?: any;
+}, options?: NavigateFunctionOptions) => void;
+export interface WindowPreview {
+    id: string;
+    img: string;
+    status: 'idle' | 'completed' | 'error' | 'loading';
+    appCode: string;
+}
+export type MFWidgetBaseProps = {
+    windowId: string;
+    i18n?: i18n;
+    app: UserApp;
+    appWindow: {
+        isMinimized: boolean;
+        isMaximized: boolean;
+        order: number;
+        dimensions: Pick<AppDetails['dimensions'], 'width' | 'height'>;
+    };
+    features: {
+        calendarMode: CalenderMode;
+        tableMode: TableMode;
+        hasReportsApp: boolean;
+        hasHeader: boolean;
+        sandboxMode: boolean;
+        initialServiceCode?: string;
+        initialAppPayload?: AppPayload;
+    };
+    user: User;
+    segment: {
+        id: string;
+        name: TextAndLang[];
+        code: string;
+        type: string;
+        brands: Brand[];
+        countries: SegmentCountry[];
+        defaultCountry: SegmentCountry;
+        defaultEntity: Entity;
+        apps: UserApp[];
+        users: SegmentUser[];
+        operator: Segment['operator'];
+        organizationId: string;
+        isBusinessSegment: boolean;
+        isAnyMerchantHasMarketplace: boolean;
+        isSegmentHasMoreThanOneMerchant: boolean;
+        marketplaceMerchantsCount: number;
+    };
+    segments: Segment[];
+    selectedSegment: {
+        id: string;
+        selectedBrands: SelectedBrand[];
+        selectedCountries: SelectedCountry[];
+    };
+    ui: {
+        theme: Theme;
+    };
+    timezone: {
+        current: Timezone | null;
+        default: Timezone | null;
+    };
+};

package/build/types/authentication.d.ts

@@ -0,0 +1 @@
+export type AuthenticationStatus = 'AUTHENTICATED' | 'FAILED' | 'REJECTED';

package/build/types/brand.d.ts

@@ -0,0 +1,182 @@
+import { TextAndLang } from './common';
+import { DataStatus, DataVerificationStatus, Entity, EntityDetails } from './entity';
+export declare enum SalesChannelTypes {
+    MOBILE_APP = "mobile_app",
+    WEBSITE = "website",
+    CALL_CENTER = "call_center",
+    PHYSICAL_STORE = "physical_store",
+    SOCIAL_MEDIA = "social_media",
+    IOS = "ios",
+    ANDROID = "android",
+    LINKEDIN = "linkedin",
+    INSTAGRAM = "instagram",
+    TWITTER = "twitter"
+}
+export interface Channel {
+    id: string;
+    code: SalesChannelTypes;
+    name: Record<string, string>;
+    address?: string;
+    logo: string;
+    sub?: Channel[];
+    parentId?: string;
+    channel?: string;
+}
+export type BrandStatus = 'Active' | 'InActive' | 'Reviewed' | 'Verified' | 'Expired' | 'Archived' | 'Closed';
+export type BrandDataState = 'reviewed' | 'verified' | 'rejected' | 'completed' | 'incomplete' | 'complete';
+export interface Brand {
+    id: string;
+    status: BrandStatus;
+    created: number;
+    name: TextAndLang[];
+    logo: string;
+    entities: (EntityDetails & Entity)[];
+    business_id: string;
+}
+export interface BrandSegmentItem {
+    id: string;
+    name: Record<string, string>;
+}
+export interface BrandTerm {
+    term: string;
+    agree: boolean;
+    agreed_at: number;
+}
+export interface BrandTermByInfo {
+    id: string;
+    type: string;
+    names: Record<string, {
+        first?: string;
+        middle?: string;
+        last?: string;
+    }>;
+    created: string;
+    is_authorized: boolean;
+}
+export interface BrandBusinessVolume {
+    id: string;
+    indicator: {
+        type: string;
+    };
+    name: Array<{
+        currency: string;
+        ar?: string;
+        en?: string;
+    }>;
+}
+export interface BrandDataStatus {
+    status: DataStatus;
+    operations: {
+        business_start_date: DataStatus;
+        sales_range: DataStatus;
+        customer_base: DataStatus;
+        customer_base_location: DataStatus;
+    };
+    terms: DataStatus;
+    logo: DataStatus;
+    segment: {
+        type?: DataStatus;
+        teams?: DataStatus;
+        sale?: DataStatus;
+        location_type?: DataStatus;
+        profit_type?: DataStatus;
+        tech_type?: DataStatus;
+    };
+    name: {
+        ar?: DataStatus;
+        en?: DataStatus;
+        textId?: DataStatus;
+    };
+    activities: DataStatus;
+    channel_services: DataStatus;
+}
+export interface BrandDataVerification {
+    status: DataVerificationStatus;
+    operations: {
+        business_start_date: DataVerificationStatus;
+        sales_range: DataVerificationStatus;
+        customer_base: DataVerificationStatus;
+        customer_base_location: DataVerificationStatus;
+    };
+    terms: DataVerificationStatus;
+    logo: DataVerificationStatus;
+    segment: {
+        type?: DataVerificationStatus;
+        teams?: DataVerificationStatus;
+        sale?: DataVerificationStatus;
+        location_type?: DataVerificationStatus;
+        profit_type?: DataVerificationStatus;
+        tech_type?: DataVerificationStatus;
+    };
+    name: {
+        textId?: DataVerificationStatus;
+        ar?: DataVerificationStatus;
+        en?: DataVerificationStatus;
+    };
+    activities: Record<string, DataVerificationStatus>;
+    channel_services: Record<string, DataVerificationStatus>;
+}
+export interface BrandDetails {
+    id: string;
+    data_state: BrandDataState;
+    status: BrandStatus;
+    created: number;
+    name: Record<string, string>;
+    logo: string;
+    sector?: string[];
+    activities?: Array<{
+        id: string;
+        code: string;
+        name: Record<string, string>;
+        isic_code: string;
+        mcc_value: {
+            id: string;
+            mcc: string;
+            name: Record<string, string>;
+            description: string;
+            created: number;
+        };
+    }>;
+    operations?: {
+        sales?: {
+            id: string;
+            name: Record<string, string>;
+            period: string;
+            currency: string;
+            range: {
+                from: number;
+                to: number;
+            };
+            sub: Array<{
+                id: string;
+                name: Record<string, string>;
+                range: {
+                    from: number;
+                    to: number;
+                };
+            }>;
+        };
+        customer_base?: {
+            id: string;
+            name: Record<string, string>;
+            locations: Array<{
+                id: string;
+                code: string;
+                name: Record<string, string>;
+            }>;
+        };
+    };
+    segment?: {
+        team?: BrandSegmentItem;
+        location_type?: BrandSegmentItem;
+        profit_type?: BrandSegmentItem;
+        tech_type?: BrandSegmentItem;
+    };
+    terms?: BrandTerm[];
+    business_id: string;
+    channel_services?: Channel[];
+    data_status?: BrandDataStatus;
+    data_verification?: BrandDataVerification;
+    term_by_info?: BrandTermByInfo;
+    business_volume?: BrandBusinessVolume;
+}

package/build/types/cell.d.ts

@@ -0,0 +1,89 @@
+import { authenticationsTableCellWidth, authorizationTableCellWidth, walletTableCellWidth, walletStatementTableCellWidth, walletDetailsTableCellWidth, topupsTableCellWidth, tokensTableCellWidth, refundTableCellWidth, protectChargesTableCellWidth, payoutsTableCellWidth, ordersTableCellWidth, invoicesTableCellWidth, leadsTableCellWidth, intentsTableCellWidth, chargeTableCellWidth, protectAuthorizationsTableCellWidth, destinationsTableCellWidth, merchantsTableCellWidth, terminalsTableCellWidth, orchestrationTerminalsTableCellWidth, orchestrationRoutingTableCellWidth } from '../constants/index.js';
+import { IVirtualTable } from './index.js';
+export type AuthenticationsTableCellID = keyof typeof authenticationsTableCellWidth;
+export type AuthorizationTableCellID = keyof typeof authorizationTableCellWidth;
+export type WalletTableCellID = keyof typeof walletTableCellWidth;
+export type WalletStatementTableCellID = keyof typeof walletStatementTableCellWidth;
+export type WalletDetailsTableCellID = keyof typeof walletDetailsTableCellWidth;
+export type TopupsTableCellID = keyof typeof topupsTableCellWidth;
+export type TokensTableCellID = keyof typeof tokensTableCellWidth;
+export type RefundTableCellID = keyof typeof refundTableCellWidth;
+export type ProtectChargesTableCellID = keyof typeof protectChargesTableCellWidth;
+export type PayoutsTableCellID = keyof typeof payoutsTableCellWidth;
+export type OrdersTableCellID = keyof typeof ordersTableCellWidth;
+export type InvoicesTableCellID = keyof typeof invoicesTableCellWidth;
+export type LeadsTableCellID = keyof typeof leadsTableCellWidth;
+export type IntentsTableCellID = keyof typeof intentsTableCellWidth;
+export type ChargeTableCellID = keyof typeof chargeTableCellWidth;
+export type ProtectAuthorizationsTableCellID = keyof typeof protectAuthorizationsTableCellWidth;
+export type DestinationsTableCellID = keyof typeof destinationsTableCellWidth;
+export type MerchantsTableCellID = keyof typeof merchantsTableCellWidth;
+export type TerminalsTableCellID = keyof typeof terminalsTableCellWidth;
+export type OrchestrationTerminalsTableCellID = keyof typeof orchestrationTerminalsTableCellWidth;
+export type RoutingTableCellID = keyof typeof orchestrationRoutingTableCellWidth;
+export type TableCellWidthProps = {
+    tableMode: NonNullable<IVirtualTable['tableMode']>;
+} & ({
+    table: 'charge';
+    cellID: ChargeTableCellID;
+} | {
+    table: 'refund';
+    cellID: RefundTableCellID;
+} | {
+    table: 'authorization';
+    cellID: AuthorizationTableCellID;
+} | {
+    table: 'intents';
+    cellID: IntentsTableCellID;
+} | {
+    table: 'topups';
+    cellID: TopupsTableCellID;
+} | {
+    table: 'destinations';
+    cellID: DestinationsTableCellID;
+} | {
+    table: 'leads';
+    cellID: LeadsTableCellID;
+} | {
+    table: 'orders';
+    cellID: OrdersTableCellID;
+} | {
+    table: 'tokens';
+    cellID: TokensTableCellID;
+} | {
+    table: 'payouts';
+    cellID: PayoutsTableCellID;
+} | {
+    table: 'protectCharges';
+    cellID: ProtectChargesTableCellID;
+} | {
+    table: 'protectAuthorizations';
+    cellID: ProtectAuthorizationsTableCellID;
+} | {
+    table: 'wallet';
+    cellID: WalletTableCellID;
+} | {
+    table: 'invoices';
+    cellID: InvoicesTableCellID;
+} | {
+    table: 'authentications';
+    cellID: AuthenticationsTableCellID;
+} | {
+    table: 'walletDetails';
+    cellID: WalletDetailsTableCellID;
+} | {
+    table: 'walletStatement';
+    cellID: WalletStatementTableCellID;
+} | {
+    table: 'merchants';
+    cellID: MerchantsTableCellID;
+} | {
+    table: 'terminals';
+    cellID: TerminalsTableCellID;
+} | {
+    table: 'orchestrationTerminals';
+    cellID: OrchestrationTerminalsTableCellID;
+} | {
+    table: 'orchestrationRouting';
+    cellID: RoutingTableCellID;
+});