@tap-payments/os-micro-frontend-shared 0.1.366 → 0.1.367

package/build/constants/reports.d.ts

@@ -1,6 +1,23 @@
-export declare const filtersTypeMap: {
+/**
+ * Maps report **source codes** (app or service)
+ * to the corresponding **backend report filter types**.
+ *
+ * Used as a translation layer between UI report grouping
+ * and backend report filtering.
+ *
+ * - Key: App code or service code
+ * - Value: One or more backend filter types
+ */
+export declare const reportFilterTypesMap: {
     [x: string]: string[];
 };
+/**
+ * Reports apps
+ *
+ * Defines apps shown in the reports app, with each service linked
+ * to its backend filter type (REPORT_FILTER_TYPES).
+ *
+ */
 export declare const REPORTS_APPS: {
     code: string;
     name: string;

package/build/constants/reports.js

@@ -1,39 +1,89 @@
 import { APP_CODES } from './apps';
 import { acceptanceAppIcon, billingAppIcon, payoutsAppIcon, walletAppIcon } from './assets';
-export const filtersTypeMap = {
-    [APP_CODES.acceptance.services.charges.code]: ['CHARGE'],
-    [APP_CODES.acceptance.services.authorization.code]: ['AUTHORIZE'],
-    [APP_CODES.acceptance.services.refunds.code]: ['REFUND'],
-    [APP_CODES.acceptance.services.chargeback.code]: ['CHARGEBACKS'],
-    [APP_CODES.acceptance.services.destinations.code]: ['DESTINATIONS'],
-    [APP_CODES.acceptance.code]: ['CHARGE', 'AUTHORIZE', 'REFUND', 'CHARGEBACKS', 'DESTINATIONS'],
-    [APP_CODES.payouts.code]: ['PAYOUT', 'RETAILER_PAYOUT', 'MERCHANT_PAYOUT'],
-    [APP_CODES.wallet.code]: ['STATEMENT', 'STATEMENT_SUMMARY'],
-    [APP_CODES.billing.code]: ['INVOICE'],
-    [APP_CODES.payouts.services.payouts.code]: ['PAYOUT'],
-    [APP_CODES.wallet.services.merchants.functions.statement.code]: ['STATEMENT'],
-    [APP_CODES.wallet.services.merchants.functions.summary.code]: ['STATEMENT_SUMMARY'],
-    [APP_CODES.billing.services.invoices.code]: ['INVOICE'],
-    [APP_CODES.payouts.services.merchantPayout.code]: ['MERCHANT_PAYOUT'],
-    [APP_CODES.payouts.services.retailerPayout.code]: ['RETAILER_PAYOUT'],
+/**
+ * Backend report filter types (used by reports APIs)
+ *
+ * Maps frontend report identifiers to the backend API filter types.
+ * Acts as the source of truth for all report types across apps/services
+ */
+const REPORT_FILTER_TYPES = {
+    // Acceptance
+    CHARGE: 'CHARGE',
+    AUTHORIZE: 'AUTHORIZE',
+    REFUND: 'REFUND',
+    CHARGEBACKS: 'CHARGEBACKS',
+    DESTINATIONS: 'DESTINATIONS',
+    // Wallet
+    STATEMENT: 'STATEMENT',
+    STATEMENT_SUMMARY: 'STATEMENT_SUMMARY',
+    // Billing
+    INVOICE: 'INVOICE',
+    // Payouts
+    PAYOUT: 'PAYOUT',
+    MERCHANT_PAYOUT: 'MERCHANT_PAYOUT',
+    RETAILER_PAYOUT: 'RETAILER_PAYOUT',
 };
+/**
+ * Maps report **source codes** (app or service)
+ * to the corresponding **backend report filter types**.
+ *
+ * Used as a translation layer between UI report grouping
+ * and backend report filtering.
+ *
+ * - Key: App code or service code
+ * - Value: One or more backend filter types
+ */
+export const reportFilterTypesMap = {
+    // Acceptance
+    [APP_CODES.acceptance.services.charges.code]: [REPORT_FILTER_TYPES.CHARGE],
+    [APP_CODES.acceptance.services.authorization.code]: [REPORT_FILTER_TYPES.AUTHORIZE],
+    [APP_CODES.acceptance.services.refunds.code]: [REPORT_FILTER_TYPES.REFUND],
+    [APP_CODES.acceptance.services.chargeback.code]: [REPORT_FILTER_TYPES.CHARGEBACKS],
+    [APP_CODES.acceptance.services.destinations.code]: [REPORT_FILTER_TYPES.DESTINATIONS],
+    [APP_CODES.acceptance.code]: [
+        REPORT_FILTER_TYPES.CHARGE,
+        REPORT_FILTER_TYPES.AUTHORIZE,
+        REPORT_FILTER_TYPES.REFUND,
+        REPORT_FILTER_TYPES.CHARGEBACKS,
+        REPORT_FILTER_TYPES.DESTINATIONS,
+    ],
+    // Wallet
+    [APP_CODES.wallet.services.merchants.functions.statement.code]: [REPORT_FILTER_TYPES.STATEMENT],
+    [APP_CODES.wallet.services.merchants.functions.summary.code]: [REPORT_FILTER_TYPES.STATEMENT_SUMMARY],
+    [APP_CODES.wallet.code]: [REPORT_FILTER_TYPES.STATEMENT, REPORT_FILTER_TYPES.STATEMENT_SUMMARY],
+    // Billing
+    [APP_CODES.billing.services.invoices.code]: [REPORT_FILTER_TYPES.INVOICE],
+    [APP_CODES.billing.code]: [REPORT_FILTER_TYPES.INVOICE],
+    // Payouts
+    [APP_CODES.payouts.services.payouts.code]: [REPORT_FILTER_TYPES.PAYOUT],
+    [APP_CODES.payouts.services.merchantPayout.code]: [REPORT_FILTER_TYPES.MERCHANT_PAYOUT],
+    [APP_CODES.payouts.services.retailerPayout.code]: [REPORT_FILTER_TYPES.RETAILER_PAYOUT],
+    [APP_CODES.payouts.code]: [REPORT_FILTER_TYPES.PAYOUT, REPORT_FILTER_TYPES.MERCHANT_PAYOUT, REPORT_FILTER_TYPES.RETAILER_PAYOUT],
+};
+/**
+ * Reports apps
+ *
+ * Defines apps shown in the reports app, with each service linked
+ * to its backend filter type (REPORT_FILTER_TYPES).
+ *
+ */
 export const REPORTS_APPS = [
     {
         code: APP_CODES.billing.code,
         name: 'Billing',
         icon: billingAppIcon,
-        services: [{ name: 'Invoices', code: 'INVOICE' }],
+        services: [{ name: 'Invoices', code: REPORT_FILTER_TYPES.INVOICE }],
     },
     {
         code: APP_CODES.acceptance.code,
         name: 'Acceptance',
         icon: acceptanceAppIcon,
         services: [
-            { name: 'Authorisations', code: 'AUTHORIZE' },
-            { name: 'Charges', code: 'CHARGE' },
-            { name: 'Refunds', code: 'REFUND' },
-            { name: 'Chargebacks', code: 'CHARGEBACKS' },
-            { name: 'Destinations', code: 'DESTINATIONS' },
+            { name: 'Authorisations', code: REPORT_FILTER_TYPES.AUTHORIZE },
+            { name: 'Charges', code: REPORT_FILTER_TYPES.CHARGE },
+            { name: 'Refunds', code: REPORT_FILTER_TYPES.REFUND },
+            { name: 'Chargebacks', code: REPORT_FILTER_TYPES.CHARGEBACKS },
+            { name: 'Destinations', code: REPORT_FILTER_TYPES.DESTINATIONS },
         ],
     },
     {
@@ -41,8 +91,8 @@ export const REPORTS_APPS = [
         name: 'Wallet',
         icon: walletAppIcon,
         services: [
-            { name: 'Aggregated Statement', code: 'STATEMENT_SUMMARY' },
-            { name: 'Detailed Statement', code: 'STATEMENT' },
+            { name: 'Aggregated Statement', code: REPORT_FILTER_TYPES.STATEMENT_SUMMARY },
+            { name: 'Detailed Statement', code: REPORT_FILTER_TYPES.STATEMENT },
         ],
     },
     {
@@ -50,9 +100,9 @@ export const REPORTS_APPS = [
         name: 'Payouts',
         icon: payoutsAppIcon,
         services: [
-            { name: 'Payouts', code: 'PAYOUT' },
-            { name: 'Merchant Payouts', code: 'MERCHANT_PAYOUT' },
-            { name: 'Retailer Payouts', code: 'RETAILER_PAYOUT' },
+            { name: 'Payouts', code: REPORT_FILTER_TYPES.PAYOUT },
+            { name: 'Merchant Payouts', code: REPORT_FILTER_TYPES.MERCHANT_PAYOUT },
+            { name: 'Retailer Payouts', code: REPORT_FILTER_TYPES.RETAILER_PAYOUT },
         ],
     },
 ];

package/build/types/apps.d.ts

@@ -1,18 +1,17 @@
 import { ColumnsView } from './column';
 import { Segment, SegmentCountry, SegmentUser, SelectedBrand, SelectedCountry, User } from './user';
-import { BusinessMerchant } from './merchant';
 import type { i18n } from 'i18next';
 import { Theme } from '@mui/material';
 import { CalenderMode } from './theme';
 import { Timezone } from './appConfig';
 import { Brand, Entity, TableMode } from './index.js';
 import { TextAndLang } from './common';
-export interface AccountAppPayload {
-    disabledAccountDataFetching?: boolean;
-    isAccountDetailsOpen: boolean;
-    selectedMerchant?: BusinessMerchant;
-}
-export interface AppPayload extends Partial<AccountAppPayload> {
+export type AppPayload<TServiceCodes extends string = string> = {
+    services: {
+        [key in TServiceCodes]?: ServicePayload;
+    };
+};
+export interface ServicePayload {
     columnFilters?: Record<string, any>;
     filteredIds?: string[];
     dateRange?: [Date, Date];
@@ -21,6 +20,7 @@ export interface AppPayload extends Partial<AccountAppPayload> {
     isTextShown?: boolean;
     tableViews?: ColumnsView[];
     calendarTimezone?: number;
+    reportTypes?: string[];
 }
 export interface AppDetails {
     id: string;
@@ -43,7 +43,7 @@ export interface AppDetails {
         minWidth: number | string;
         minHeight: number | string;
     };
-    payload?: Record<string, any> & AppPayload;
+    payload?: Record<string, any> & ServicePayload;
     toolbarIconUrl?: string;
     hideMaximizedApp?: boolean;
     hideMinimizeApp?: boolean;
@@ -99,7 +99,7 @@ export type MFWidgetBaseProps = {
         hasHeader: boolean;
         sandboxMode: boolean;
         initialServiceCode?: string;
-        initialPayload?: Record<string, any> & AppPayload;
+        initialAppPayload?: AppPayload;
     };
     user: User;
     segment: {

package/build/utils/navigation.d.ts

@@ -6,7 +6,7 @@ export declare const openNewAppAttrs: ({ appCode, serviceCode, sandboxMode, payl
     numberOfOpenedApps: number;
     segmentId: string;
 }) => {
-    payload?: (Record<string, any> & import("../types/index.js").AppPayload) | undefined;
+    payload?: (Record<string, any> & import("../types/index.js").ServicePayload) | undefined;
     segmentId: string;
     appCode: string;
     serviceCode: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tap-payments/os-micro-frontend-shared",
   "description": "Shared components and utilities for Tap Payments micro frontends",
-  "version": "0.1.366",
+  "version": "0.1.367",
   "testVersion": 0,
   "type": "module",
   "main": "build/index.js",