@tap-payments/auth-jsconnect 2.3.99-test → 2.4.0

package/README.md

@@ -158,10 +158,10 @@ const App = () => {
 | publicKey `required` - `string`           | merchant public key                                                     |
 | appInfo `required`                        | it's an object from type `AppInfo`                                      |
 | businessCountryCode `required` - `string` | merchant country code and it should be the ISO2 of the country          |
+| scope `required` - `string`               | it's an string                                                          |
 | language `required` - `string`            | it can be `en`or `ar`                                                   |
 | onError `required` - `function`           | callback function will call in case of any error happened               |
 | onFlowCompleted `required` - `function`   | callback function will called after completing the flow                 |
 | onReady `required` - `function`           | callback function will call after loading library configuration         |
 | onStepError `required` - `function`       | callback function will call in case if any error happened in the screen |
 | onStepStarted `required` - `function`     | callback function will call in the begging of each step                 |
-| scope `required` - `string`               | it's an string                                                          |

package/build/@types/app.d.ts

@@ -116,6 +116,10 @@ export interface License {
 export interface EntityLicense extends License {
     id: string;
 }
+export interface EntityLicenseAuth extends EntityLicense {
+    id: string;
+    country: string;
+}
 export interface Activity {
     id: string;
     name: {
@@ -145,10 +149,21 @@ export interface SourceOfIncome {
 }
 export interface Occupation {
     id: string;
+    code: string;
     name: {
         ar: string;
         en: string;
     };
+    section_code?: string;
+    sub?: Array<{
+        id: string;
+        code: string;
+        name: {
+            ar: string;
+            en: string;
+        };
+        part_code: string;
+    }>;
 }
 export interface TeamSize {
     id: string;
@@ -191,6 +206,7 @@ interface LibCallbacks {
     onBoardButtonClick?: (data: Record<string, any>) => void;
     onCreated?: (res: Record<string, any>) => void;
     onBoardCompleted?: () => void;
+    onMaturityChanged?: (maturity: 'full' | 'express') => void;
 }
 export interface LibConfig extends LibCallbacks {
     publicKey: string;
@@ -198,8 +214,12 @@ export interface LibConfig extends LibCallbacks {
     merchantDomain: string;
     language: LanguageMode;
     appInfo: AppInfo;
-    businessCountryCode: string;
+    businessCountryCode?: string;
     scope: string;
+    postURL?: string;
+    redirectUrl?: string;
+    data?: Array<string>;
+    mode?: 'popup' | 'page';
     boardMaturity?: boolean;
 }
 export interface OSDetails {
@@ -255,7 +275,7 @@ export interface LocalProps {
         };
     };
 }
-export declare type BrandInfo = {
+export type BrandInfo = {
     segment?: {
         type: {
             id: string;
@@ -263,6 +283,15 @@ export declare type BrandInfo = {
         team: {
             id: string;
         };
+        location_type: {
+            id: string;
+        };
+        profit_type: {
+            id: string;
+        };
+        tech_type: {
+            id: string;
+        };
     };
     id: string;
     name: {
@@ -282,9 +311,10 @@ export declare enum FlowsTypes {
     ENTITY = "entity",
     OTP = "otp",
     AUTH = "auth",
-    BRAND = "brand"
+    BRAND = "brand",
+    BOARD = "board"
 }
-export declare type FlowInfo = {
+export type FlowInfo = {
     name: string;
     status: string;
     url: string;
@@ -292,14 +322,15 @@ export declare type FlowInfo = {
 export declare enum AuthForType {
     MOBILE = "mobile",
     EMAIL = "email",
-    NATIONAL_ID = "national_id"
+    NATIONAL_ID = "national_id",
+    NATIONAL_ID_MISSED = "national_id_missed"
 }
 export declare enum AddressFormateType {
     SELECT = "select",
     NUMBER = "number",
     TEXT = "text"
 }
-export declare type AddressFormat = {
+export type AddressFormat = {
     code: string;
     name: {
         ar: string;
@@ -310,14 +341,14 @@ export declare type AddressFormat = {
     sort: number;
     type: AddressFormateType;
 };
-export declare type AddressType = {
+export type AddressType = {
     code: string;
     name: {
         ar: string;
         en: string;
     };
 };
-export declare type AddressProps = {
+export type AddressProps = {
     format: AddressFormat[];
     type: AddressType;
 };
@@ -349,7 +380,7 @@ export declare enum DocumentPurpose {
     TAX_DOCUMENT = "tax_document_user_upload",
     BRAND_LOGO = "business_logo"
 }
-export declare type FileDetails = {
+export type FileDetails = {
     created: string;
     id: string;
     object: string;
@@ -364,7 +395,7 @@ export declare enum VerificationStatus {
     ENTERED = "entered",
     NOT_ENTERED = "not_entered"
 }
-export declare type BankDataStatus = {
+export type BankDataStatus = {
     iban: FieldType;
     account_number: FieldType;
     swift_code: FieldType;
@@ -373,7 +404,7 @@ export declare type BankDataStatus = {
     bank_statement_file_id: FieldType;
     is_acknowledged: FieldType;
 };
-export declare type EntityDataStatus = {
+export type EntityDataStatus = {
     type: FieldType;
     'license.status': FieldType;
     'license.provider': FieldType;
@@ -402,9 +433,10 @@ export declare type EntityDataStatus = {
     billing_address: FieldType;
     AOA_file_id: FieldType;
 };
-export declare type IndividualDataStatus = {
+export type IndividualDataStatus = {
     status: FieldType;
-    name: FieldType;
+    'name.en': FieldType;
+    'name.ar': FieldType;
     'contact.email': FieldType;
     'contact.phone.number': FieldType;
     'contact.phone.country_code': FieldType;
@@ -425,10 +457,12 @@ export declare type IndividualDataStatus = {
     monthly_income: FieldType;
     is_relative_PEP: FieldType;
     is_influencer: FieldType;
+    gender: FieldType;
 };
-export declare type BrandDataStatus = {
+export type BrandDataStatus = {
     status: FieldType;
-    name: FieldType;
+    'name.en': FieldType;
+    'name.ar': FieldType;
     'operations.business_start_date': FieldType;
     'operations.sales_range': FieldType;
     'operations.customer_base': FieldType;
@@ -437,8 +471,12 @@ export declare type BrandDataStatus = {
     'segment.type': FieldType;
     'segment.teams': FieldType;
     'segment.sale': FieldType;
+    'segment.location_type': FieldType;
+    'segment.profit_type': FieldType;
+    'segment.tech_type': FieldType;
     activities: FieldType;
     channel_services: FieldType;
+    logo: FieldType;
 };
 export interface MerchantInfo {
     id: string;
@@ -497,4 +535,217 @@ export interface ActivitiesIsIc {
     created: string;
     divisions?: Array<ActivityDivision>;
 }
+export type BankDataVerification = {
+    account_number: string;
+    bank_name: string;
+    bank_statement_file_id: string;
+    beneficiary_name: string;
+    document: string;
+    iban: string;
+    is_acknowledged: string;
+    swift_code: string;
+};
+export type BrandDataVerification = {
+    logo: string;
+    'name.en': string;
+    'name.ar': string;
+    'name.textId': string;
+    'name.zh': string;
+    'operations.business_start_date': string;
+    'operations.customer_base': string;
+    'operations.customer_base_location': string;
+    'operations.sales_range': string;
+    'segment.sale': string;
+    'segment.teams': string;
+    'segment.type': string;
+    'segment.location_type': string;
+    'segment.profit_type': string;
+    'segment.tech_type': string;
+    terms: string;
+};
+export type EntityDataVerification = {
+    AOA_file_id: string;
+    billing_address: string;
+    'capital.announced': string;
+    'capital.paid': string;
+    'capital.shares.count': string;
+    'capital.shares.value': string;
+    'capital.subscribed': string;
+    country: string;
+    is_licensed: string;
+    is_vat_acknowledged: string;
+    'legal_name.ar': string;
+    'legal_name.en': string;
+    'license.additional_info': string;
+    'license.expiry_date': string;
+    'license.issuing_date': string;
+    'license.number': string;
+    'license.provider': string;
+    'license.status': string;
+    'license.type': string;
+    location: string;
+    not_for_profit: string;
+    settlement_by: string;
+    tax_number: string;
+    taxable: string;
+    type: string;
+};
+export type IndividualDataVerification = {
+    'birth.city': string;
+    'birth.country': string;
+    'birth.date': string;
+    'contact.email': string;
+    'contact.phone.country_code': string;
+    'contact.phone.number': string;
+    employer_city: string;
+    employer_country: string;
+    employer_name: string;
+    gender: string;
+    'identification.expiry': string;
+    'identification.id': string;
+    'identification.issuer_country': string;
+    'identification.type': string;
+    is_authorized: string;
+    is_influencer: string;
+    is_relative_PEP: string;
+    'name.en': string;
+    'name.ar': string;
+    nationality: string;
+    occupation: string;
+    relation: string;
+    status: string;
+};
+export interface CommonDataLayer {
+    event: string;
+}
+export interface DataLayer extends CommonDataLayer {
+    event_category: string;
+    event_action: string;
+    event_label?: string;
+    event_value?: number | string;
+    event_noninteraction?: number;
+}
+export interface CountryTrackingData extends CommonDataLayer {
+    website_country?: string;
+}
+export interface LeadIdentificationData extends CommonDataLayer {
+    lead_ID?: string;
+}
+export interface EventPageTrackingData extends CommonDataLayer {
+    title?: string;
+}
+export interface PageTrackingData {
+    title?: string;
+}
+export type VerifyExpressTokenParams = {
+    public_key: string;
+    post: {
+        url: string;
+    };
+    lead_id: string;
+};
+export type ConfigExpressTokenParams = {
+    post: {
+        url: string;
+    };
+    lead_id: string;
+    board: boolean;
+    platform_redirect_url: string;
+    data: Array<string>;
+};
+export declare enum MerchantStatus {
+    DISABLED = "disabled",
+    ENABLED = "enabled"
+}
+export interface AuthMerchantInfo {
+    id: string;
+    status: string;
+    created: number;
+    display_name: string;
+    business_id: string;
+    business_entity_id: string;
+    brand_id: string;
+    wallet_id: string;
+    base_currency: string;
+    charge_currenices: string[];
+    country: string;
+    is_acceptance_allowed: boolean;
+    is_payout_allowed: boolean;
+    legacy_id: string;
+    marketplace: boolean;
+    post: {
+        url: string;
+    };
+    metadata: {
+        MerchantRefrenceId: string;
+    };
+    terminal_id: string;
+    acceptance_status: string;
+    payout_status: string;
+}
+export interface AuthTerminalInfo {
+    id: string;
+    object: string;
+    live_mode: boolean;
+    api_version: string;
+    feature_version: string;
+    name: TerminalName;
+    merchant: TerminalMerchant;
+    authorizes: TerminalAuthorizes;
+    charges: TerminalAuthorizes;
+    refunds: TerminalAuthorizes;
+    wallet: TerminalWallet;
+    virtual: boolean;
+    operator: TerminalOperator;
+    acceptance_status: string;
+    data_status: TerminalDataStatus;
+    data_verification: TerminalDataStatus;
+    data_state: string;
+    brand: TerminalWallet;
+}
+interface TerminalDataStatus {
+    name: TerminalName;
+    charge_last_transaction: string;
+    charge_flag: string;
+    authorize_last_transaction: string;
+    refund_last_transaction: string;
+    acceptance_status: string;
+}
+interface TerminalName {
+    ar: string;
+    en: string;
+}
+interface TerminalWallet {
+    id: string;
+}
+interface TerminalOperator {
+    id: string;
+    is_merchant: boolean;
+}
+interface TerminalMerchant {
+    id: string;
+    base_currency: string;
+    country: string;
+}
+interface TerminalAuthorizes {
+    status: string;
+    status_message: string;
+}
+export type CountryInfo = {
+    id: number;
+    label: string;
+    country: {
+        name_en: string;
+        name_ar: string;
+        iso2: string;
+        iso3: string;
+        idd_prefix: string;
+        logo: string;
+    };
+};
+export type BusinessCountryInfo = {
+    id: number;
+    title: string;
+    countries: Array<CountryInfo>;
+};
 export {};

package/build/@types/app.js

@@ -33,12 +33,14 @@ export var FlowsTypes;
     FlowsTypes["OTP"] = "otp";
     FlowsTypes["AUTH"] = "auth";
     FlowsTypes["BRAND"] = "brand";
+    FlowsTypes["BOARD"] = "board";
 })(FlowsTypes || (FlowsTypes = {}));
 export var AuthForType;
 (function (AuthForType) {
     AuthForType["MOBILE"] = "mobile";
     AuthForType["EMAIL"] = "email";
     AuthForType["NATIONAL_ID"] = "national_id";
+    AuthForType["NATIONAL_ID_MISSED"] = "national_id_missed";
 })(AuthForType || (AuthForType = {}));
 export var AddressFormateType;
 (function (AddressFormateType) {
@@ -80,3 +82,8 @@ export var VerificationStatus;
     VerificationStatus["ENTERED"] = "entered";
     VerificationStatus["NOT_ENTERED"] = "not_entered";
 })(VerificationStatus || (VerificationStatus = {}));
+export var MerchantStatus;
+(function (MerchantStatus) {
+    MerchantStatus["DISABLED"] = "disabled";
+    MerchantStatus["ENABLED"] = "enabled";
+})(MerchantStatus || (MerchantStatus = {}));

package/build/@types/form.d.ts

@@ -1,43 +1,47 @@
-import { Activity, BrandInfo, CountryCode, CustomerLocation, ExpectedCustomer, ExpectedSaleRange, License, MonthlyIncome, Occupation, SaleChannel, Segment, SourceOfIncome, TeamSize, City, EntityLicense } from './app';
-export declare type MobileFormValues = {
+import { Activity, BrandInfo, CountryCode, CustomerLocation, ExpectedCustomer, ExpectedSaleRange, License, MonthlyIncome, Occupation, SaleChannel, Segment, SourceOfIncome, TeamSize, City, EntityLicense, EntityLicenseAuth, AuthMerchantInfo } from './app';
+export type MobileFormValues = {
     mobile: string;
     countryCode: CountryCode;
     termAndConditionChecked?: boolean;
 };
-export declare type EmailFormValues = {
+export type EmailFormValues = {
     email: string | null;
 };
-export declare type OTPFormValues = {
+export type OTPFormValues = {
     otp: string;
 };
-export declare type PasswordFormValues = {
+export type PasswordFormValues = {
     password: string;
 };
-export declare type NIDFormValues = {
+export type NIDFormValues = {
     nid: string;
     dob: string;
     termAndConditionChecked?: boolean;
 };
-export declare type CivilFormValues = {
+export type CivilFormValues = {
     civilId: string;
     termAndConditionChecked?: boolean;
 };
-export declare type IndividualFormValues = {
+export type IndividualFormValues = {
     name: string;
     email: string;
     mobile: string | null;
     countryCode: CountryCode;
 };
-export declare type BrandFormValues = {
+export type BrandFormValues = {
     brandName: string;
     brandLogoId?: string;
-    segment?: Segment | undefined;
-    teamSize?: TeamSize | undefined;
     salesChannels: Array<SaleChannel>;
     termAndConditionChecked?: boolean;
     selectedBrandItem: BrandInfo;
 };
-export declare type BrandActivitiesFormValues = {
+export type BrandSegmentFormValues = {
+    segmentLocation?: Segment | undefined;
+    segmentProfit?: Segment | undefined;
+    segmentTech?: Segment | undefined;
+    teamSize?: TeamSize | undefined;
+};
+export type BrandActivitiesFormValues = {
     activities: Array<Activity>;
     customerLocations: Array<CustomerLocation>;
     expectedCustomer: ExpectedCustomer | undefined;
@@ -46,7 +50,7 @@ export declare type BrandActivitiesFormValues = {
     refundPolicy: boolean;
     transactionPolicy: boolean;
 };
-export declare type BusinessTypeFormValues = {
+export type BusinessTypeFormValues = {
     licenseNumber: string;
     entityLegalName?: string;
     selectedEntityLicense?: EntityLicense;
@@ -54,18 +58,18 @@ export declare type BusinessTypeFormValues = {
     certificateId?: Array<string>;
     articleId?: string;
 };
-export declare type ActivitiesFormValues = {
+export type ActivitiesFormValues = {
     activities: Array<Activity> | undefined;
     operationStartDate: string;
 };
-export declare type CustomersFormValues = {
+export type CustomersFormValues = {
     customerLocations: Array<CustomerLocation>;
     expectedCustomer: ExpectedCustomer | undefined;
     expectedSale: ExpectedSaleRange | undefined;
     refundPolicy: boolean;
     transactionPolicy: boolean;
 };
-export declare type BankFormValues = {
+export type BankFormValues = {
     iban: string;
     beneficiaryName: string;
     bankName: string;
@@ -73,7 +77,7 @@ export declare type BankFormValues = {
     uploading?: boolean;
     confirmPolicy: boolean;
 };
-export declare type TaxFormValues = {
+export type TaxFormValues = {
     vatId: string;
     confirmPolicy: boolean;
     documentId?: Array<string>;
@@ -101,23 +105,22 @@ export interface IndividualExtraFormValues extends IndividualAttachmentsFormValu
     sourceIncome: SourceOfIncome | undefined;
     monthlyIncome: MonthlyIncome | undefined;
     employerName: string;
-    employerLocation: CountryCode | undefined;
     isPEP: boolean | null;
     isInfluencer: boolean | null;
     shareCount: string;
     shareValue: string;
 }
-export declare type IndividualAttachmentsFormValues = {
+export type IndividualAttachmentsFormValues = {
     civilID?: Array<string>;
     signatureFileId?: Array<string>;
     civilIDUploading?: boolean;
     signatureFileUploading?: boolean;
 };
-export declare type PasswordCreateFormValues = {
+export type PasswordCreateFormValues = {
     password: string;
     confirmPassword: string;
 };
-export declare type EntityNameFormValues = {
+export type EntityNameFormValues = {
     legalName: string;
     licenseNumber: string;
     licenseType: string;
@@ -128,15 +131,20 @@ export declare type EntityNameFormValues = {
     certificateId?: Array<string>;
     articleId?: string;
 };
-export declare type EntityCapitalFormValues = {
+export type EntityCapitalFormValues = {
     activities: Array<Activity>;
     capitalPaid: string;
     capitalShareCount: string;
     capitalShareValue: string;
 };
-export declare type BusinessDataFormValues = {
+export type BusinessDataFormValues = {
     brandName: string;
     licenseNumber: string;
     selectedLicense?: License;
     termAndConditionChecked?: boolean;
 };
+export type AuthenticationListFormValues = {
+    brandInfo?: BrandInfo;
+    entityInfo?: EntityLicenseAuth;
+    merchantInfo?: AuthMerchantInfo;
+};

package/build/@types/theme.d.ts

@@ -11,4 +11,4 @@ export declare enum DirectionMode {
     RTL = "rtl",
     LTR = "ltr"
 }
-export declare type ThemContext = Partial<Theme> | ((outerTheme: Theme) => Theme);
+export type ThemContext = Partial<Theme> | ((outerTheme: Theme) => Theme);

package/build/@types/user.d.ts

@@ -1,6 +1,5 @@
 export interface User {
     id: string;
-    type: string;
     status: string;
     created: number;
     names: Names;
@@ -13,7 +12,7 @@ export interface User {
     is_authorized: boolean;
     verification: Verification;
     source_income: Role[];
-    occupation: Role;
+    occupation: UserOccupation;
     entities: Entity[];
     documents: string[];
     monthly_income: Role;
@@ -24,8 +23,34 @@ export interface User {
     individual_id: string;
     data_status: DataStatus;
     data_verification: DataVerification;
+    data_state: string;
+    object: string;
+    shares: {
+        count: string;
+        value: string;
+    };
+    ids: Array<string>;
+    individual_data_state: string;
+    objects: Array<string>;
     isRequestedEmail?: boolean;
 }
+interface UserOccupation {
+    chapter: OccupationData & {
+        section_code: string;
+    };
+    part: OccupationData & {
+        type_code: string;
+    };
+    section: OccupationData & {
+        part_code: string;
+    };
+    type: OccupationData;
+}
+interface OccupationData {
+    code: string;
+    id: string;
+    name: Name;
+}
 interface DataVerification {
     status: string;
     name: string;
@@ -110,8 +135,19 @@ interface Identification {
 }
 interface Birth {
     date: number;
-    city: string;
+    city: BirthCity;
+    country: string;
+}
+interface BirthCity {
+    cityId: string;
     country: string;
+    name: {
+        arabic: string;
+        english: string;
+        textId: string;
+    };
+    state: string;
+    un_locode: string;
 }
 interface Contact {
     email: string;

package/build/api/account.d.ts

@@ -1,4 +1,4 @@
-export declare type CreateAccountBody = {
+export type CreateAccountBody = {
     lead_id: string;
     notify: {
         email: boolean;
@@ -8,7 +8,7 @@ export declare type CreateAccountBody = {
     is_acknowledged: boolean;
     step_name: string;
 };
-export declare type ExpressCreateAccountBody = {
+export type ExpressCreateAccountBody = {
     post_url: string;
     lead_id: string;
 };