@adyen/kyc-components 2.7.0 → 2.8.0

package/dist/types/core/Services/http.d.ts

@@ -1,4 +1,4 @@
-import { HttpOptions } from './types';
+import type { HttpOptions } from './types';
 export declare const http: <T>(options: HttpOptions, data?: any, responseType?: XMLHttpRequestResponseType) => Promise<T>;
 export declare const httpGet: <T>(options: HttpOptions, data?: any) => Promise<T>;
 export declare const httpPost: <T>(options: HttpOptions, data?: any) => Promise<T>;

package/dist/types/core/Services/kycExternalApi/company-deep-search.d.ts

@@ -0,0 +1,5 @@
+import type { CompanyDeepSearchRequest, CompanyDeepSearchResponse } from '../../models/api/company-search';
+export declare const companyDeepSearch: (context: {
+    loadingContext: string;
+    clientKey: string;
+}, data: CompanyDeepSearchRequest) => Promise<CompanyDeepSearchResponse>;

package/dist/types/core/Services/kycExternalApi/company-index-search.d.ts

@@ -0,0 +1,5 @@
+import type { CompanyIndexSearchRequest, CompanyIndexSearchResponse } from '../../models/api/company-search';
+export declare const companyIndexSearch: (context: {
+    loadingContext: string;
+    clientKey: string;
+}, data: CompanyIndexSearchRequest) => Promise<CompanyIndexSearchResponse>;

package/dist/types/core/Services/kycExternalApi/get-company-data.d.ts

@@ -0,0 +1,5 @@
+import type { CompanyDataResponse, GetCompanyDataRequest } from '../../models/api/company-search';
+export declare const getCompanyData: (context: {
+    loadingContext: string;
+    clientKey: string;
+}, data: GetCompanyDataRequest) => Promise<CompanyDataResponse>;

package/dist/types/core/Services/kycExternalApi/index.d.ts

@@ -1,7 +1,12 @@
+export * from './company-deep-search';
+export * from './company-index-search';
 export * from './get-account-format';
 export * from './get-allowed-countries';
 export * from './get-allowed-locales';
+export * from './get-company-data';
 export * from './get-configuration';
 export * from './get-dataset';
+export * from './refresh-company-data';
 export * from './validate-phone-number';
 export * from './verify-id-number';
+export * from './verify-tin';

package/dist/types/core/Services/kycExternalApi/refresh-company-data.d.ts

@@ -0,0 +1,5 @@
+import type { CompanyDataResponse, RefreshCompanyDataRequest } from '../../models/api/company-search';
+export declare const refreshCompanyData: (context: {
+    loadingContext: string;
+    clientKey: string;
+}, data: RefreshCompanyDataRequest) => Promise<CompanyDataResponse>;

package/dist/types/core/Services/kycExternalApi/verify-tin.d.ts

@@ -0,0 +1,5 @@
+import type { TinVerificationRequest, TinVerificationResponse } from '../../models/api/company-search';
+export declare const verifyTin: (context: {
+    loadingContext: string;
+    clientKey: string;
+}, data: TinVerificationRequest) => Promise<TinVerificationResponse>;

package/dist/types/core/Services/types.d.ts

@@ -1,4 +1,4 @@
-import { NonEmbeddedAuthContextType } from '../Context/AuthContext/AuthContext';
+import type { NonEmbeddedAuthContextType } from '../Context/AuthContext/AuthContext';
 export type FetchErrorLevel = 'silent' | 'info' | 'warn' | 'error' | 'fatal';
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'OPTIONS' | 'PATCH';
 export type RequestContext = Partial<NonEmbeddedAuthContextType> & Required<Pick<NonEmbeddedAuthContextType, 'clientKey'>> & {

package/dist/types/core/hooks/useAllowedLocales.d.ts

@@ -0,0 +1 @@
+export declare const useAllowedLocales: () => string[] | undefined;

package/dist/types/core/hooks/useComponentApi.d.ts

@@ -1,4 +1,5 @@
 import { DropinAPIHandlers } from '../../components/Dropins/types';
+import { BankVerificationErrorResponse, CreateTrustedTransferInstrumentResponse } from '../models/api/trusted-transferInstrument';
 export type ComponentApi = {
     getLegalEntity: Required<DropinAPIHandlers>['handleGetLegalEntity'];
     getTransferInstrument: Required<DropinAPIHandlers>['handleGetTransferInstrument'];
@@ -8,6 +9,8 @@ export type ComponentApi = {
     updateDocument: Required<DropinAPIHandlers>['handleUpdateDocument'];
     createTransferInstrument: Required<DropinAPIHandlers>['handleCreateTransferInstrument'];
     updateTransferInstrument: Required<DropinAPIHandlers>['handleUpdateTransferInstrument'];
+    createTrustedTransferInstrument: (code: string, state: string) => Promise<CreateTrustedTransferInstrumentResponse>;
+    handleBankVerificationError: (errorCode: string, errorMessage: string, state: string, metadata?: Map<string, string>) => Promise<BankVerificationErrorResponse>;
 };
 export declare const COMPONENTS_API_VERSION = "v1";
 /**

package/dist/types/core/hooks/useLocalStorage.d.ts

@@ -0,0 +1,11 @@
+import { StateUpdater } from 'preact/hooks';
+type Serializer<T> = (object: T | undefined) => string;
+type Parser<T> = (val: string) => T | undefined;
+type Setter<T> = StateUpdater<T | undefined>;
+type Options<T> = Partial<{
+    serializer: Serializer<T>;
+    parser: Parser<T>;
+    syncData: boolean;
+}>;
+export declare function useLocalStorage<T>(key: string, defaultValue: T, options?: Options<T>): [T, Setter<T>];
+export {};

package/dist/types/core/hooks/useSalesChannelsSettings.d.ts

@@ -0,0 +1 @@
+export declare function useSalesChannelsSettings(): string[];

package/dist/types/core/hooks/useShouldShowGuidanceIntros.d.ts

@@ -0,0 +1,7 @@
+import { ExistingLegalEntity } from '../models/api/legal-entity';
+export declare const useHasSeenIntro: (legalEntityId: string) => {
+    hasSeenIntro: boolean;
+    setHasSeenIntro: (value: boolean | ((prevState: boolean) => boolean)) => void;
+};
+export declare const guidanceAvailableForGivenLE: (legalEntity: ExistingLegalEntity) => boolean;
+export declare const useShouldShowGuidanceIntros: (legalEntity: ExistingLegalEntity) => boolean;

package/dist/types/core/hooks/useTranslations.d.ts

@@ -0,0 +1,10 @@
+import { Translations } from '../../language/types';
+interface LoadedTranslationsState {
+    translations: Translations;
+    locale: string;
+}
+export declare const useTranslations: ({ locale, allowedLocales, }: {
+    locale: string;
+    allowedLocales: string[] | undefined;
+}) => LoadedTranslationsState;
+export {};

package/dist/types/core/models/api/company-search.d.ts

@@ -0,0 +1,80 @@
+import type { CountryCode } from '../country-code';
+import type { StateCodeUS } from '../state-code';
+export interface CompanySearchRequest {
+    /**
+     * @description A free-form value representing a partial company name
+     */
+    text: string;
+    /**
+     * @description Country code to limit the search within - two character format
+     */
+    country: CountryCode;
+    /**
+     * @description State code if the country is US (currently only enabled for US) - two character format
+     */
+    state: StateCodeUS;
+    /**
+     * @description (optional) Limit number of results
+     */
+    limit?: number;
+}
+/**
+ * @description Index search for company ID within kompany datastore using their current company data cache
+ */
+export type CompanyIndexSearchRequest = CompanySearchRequest;
+/**
+ * @description Deep search for company ID requesting new data from the external datastore (e.g. Secretary of State) that kompany uses to fetch results
+ */
+export type CompanyDeepSearchRequest = CompanySearchRequest;
+export interface CompanySearchResult {
+    id: string;
+    name: string;
+    registrationNumber: string;
+    requestTime: string;
+    lastUpdate: string;
+}
+export type CompanyIndexSearchResponse = {
+    results: Array<CompanySearchResult>;
+};
+export type CompanyDeepSearchResponse = {
+    results: Array<CompanySearchResult>;
+};
+export interface TinVerificationRequest {
+    /**
+     * @description Nine letter Tax Identification Number with or without hyphens
+     */
+    tin: string;
+    /**
+     * @description Company name
+     */
+    name: string;
+}
+export interface TinVerificationResponse {
+    matched: boolean;
+}
+export interface CompanyDataRequest {
+    /**
+     * @description Company Id returned from index search
+     */
+    companyId: string;
+    /**
+     * @description (optional) Country code
+     */
+    country?: CountryCode;
+}
+export type GetCompanyDataRequest = CompanyDataRequest;
+export type RefreshCompanyDataRequest = CompanyDataRequest;
+export interface CompanyDataResponse {
+    id: string;
+    name: string;
+    country: CountryCode;
+    registrationNumber: string;
+    organizationType: string;
+    address: string;
+    requestTime: string;
+    lastUpdate: string;
+    street?: string;
+    city?: string;
+    state?: StateCodeUS;
+    zipcode?: string;
+}

package/dist/types/core/models/api/contracts.d.ts

@@ -1,6 +1,10 @@
-import { ServiceAgreementAcceptanceInfo, ServiceAgreementType } from '../../../components/Dropins/ServiceAgreementDropinComponent/types';
+import type { ServiceAgreementAcceptanceInfo, ServiceAgreementType } from '../../../components/Dropins/ServiceAgreementDropinComponent/types';
 export interface PciTemplateRequest {
     language: string;
+    additionalSalesChannels?: string[];
+}
+export interface PciStatusRequest {
+    additionalSalesChannels?: string[];
 }
 export interface PciTemplateResponse extends PciTemplateRequest {
     pciTemplateReferences: PciTemplateReferences;

package/dist/types/core/models/api/legal-arrangement.d.ts

@@ -1,5 +1,5 @@
 import { Address } from './address';
-import { TaxInformation, VatAbsenceReason } from './organization';
+import { TaxInformation, TaxInformationType, VatAbsenceReason } from './organization';
 export interface LegalArrangement {
     name: string;
     countryOfGoverningLaw: string;
@@ -11,5 +11,6 @@ export interface LegalArrangement {
     vatAbsenceReason?: VatAbsenceReason;
     registrationNumber?: string;
     principalPlaceOfBusiness?: Address;
+    uenOrGst?: TaxInformationType;
 }
 export type LegalArrangementType = 'trust' | 'soleProprietorship';

package/dist/types/core/models/api/organization.d.ts

@@ -1,3 +1,4 @@
+import { CountryCode } from '../country-code';
 import { Address } from './address';
 import { CompanyTypesValue } from './company-types-value';
 import { Phone } from './phone';
@@ -19,12 +20,13 @@ export interface Organization {
     vatNumber?: string;
     vatAbsenceReason?: VatAbsenceReason;
     type?: CompanyTypesValue;
+    uenOrGst?: TaxInformationType;
 }
 export declare const vatAbsenceReasons: readonly ["industryExemption", "belowTaxThreshold"];
 export type VatAbsenceReason = (typeof vatAbsenceReasons)[number];
 export type TaxInformation = {
-    country: string;
+    country: CountryCode;
     number: string;
     type: TaxInformationType;
 };
-export type TaxInformationType = 'SSN' | 'EIN' | 'ITIN' | 'ABN' | 'UEN';
+export type TaxInformationType = 'SSN' | 'EIN' | 'ITIN' | 'ABN' | 'UEN' | 'GST';

package/dist/types/core/models/api/trusted-transferInstrument.d.ts

@@ -0,0 +1,8 @@
+import { AccountVerificationResponse } from '../../../components/BankVerification/types';
+export type CreateTrustedTransferInstrumentResponse = {
+    accounts: AccountVerificationResponse[];
+};
+export type BankVerificationErrorResponse = {
+    error: string;
+    message: string;
+};

package/dist/types/core/models/currency.d.ts

@@ -8,6 +8,7 @@ export declare enum Currency {
     DKK = "DKK",
     EUR = "EUR",
     GBP = "GBP",
+    HKD = "HKD",
     HUF = "HUF",
     HRK = "HRK",
     PLN = "PLN",

package/dist/types/core/models/errors/capability-problems.d.ts

@@ -1,5 +1,5 @@
-import { EntityType } from '../api/entity-type';
-import { EntityProblems } from './entity-problems';
+import type { EntityType } from '../api/entity-type';
+import type { EntityProblems } from './entity-problems';
 export type CapabilityProblems = {
     [entityType in EntityType]: {
         [entityId: string]: EntityProblems;

package/dist/types/core/models/errors/entity-problems.d.ts

@@ -1,4 +1,4 @@
-import { TaskStatus } from '../../../components/TaskList/types';
+import type { TaskStatus } from '../../../components/TaskList/types';
 import { EntityType } from '../api/entity-type';
 import { LegalEntityType } from '../api/legal-entity-type';
 import { VerificationError } from '../api/verification-error';

package/dist/types/core/models/state-code.d.ts

@@ -0,0 +1,54 @@
+export declare const enum StateCodesUS {
+    Alabama = "AL",
+    Alaska = "AK",
+    Arizona = "AZ",
+    Arkansas = "AR",
+    California = "CA",
+    Colorado = "CO",
+    Connecticut = "CT",
+    Delaware = "DE",
+    DistrictOfColumbia = "DC",
+    Florida = "FL",
+    Georgia = "GA",
+    Hawaii = "HI",
+    Idaho = "ID",
+    Illinois = "IL",
+    Indiana = "IN",
+    Iowa = "IA",
+    Kansas = "KS",
+    Kentucky = "KY",
+    Louisiana = "LA",
+    Maine = "ME",
+    Maryland = "MD",
+    Massachusetts = "MA",
+    Michigan = "MI",
+    Minnesota = "MN",
+    Mississippi = "MS",
+    Missouri = "MO",
+    Montana = "MT",
+    Nebraska = "NE",
+    Nevada = "NV",
+    NewHampshire = "NH",
+    NewJersey = "NJ",
+    NewMexico = "NM",
+    NewYork = "NY",
+    NorthCarolina = "NC",
+    NorthDakota = "ND",
+    Ohio = "OH",
+    Oklahoma = "OK",
+    Oregon = "OR",
+    Pennsylvania = "PA",
+    RhodeIsland = "RI",
+    SouthCarolina = "SC",
+    SouthDakota = "SD",
+    Tennessee = "TN",
+    Texas = "TX",
+    Utah = "UT",
+    Vermont = "VT",
+    Virginia = "VA",
+    Washington = "WA",
+    WestVirginia = "WV",
+    Wisconsin = "WI",
+    Wyoming = "WY"
+}
+export type StateCodeUS = `${StateCodesUS}`;

package/dist/types/language/Language.d.ts

@@ -1,11 +1,17 @@
 import { CustomTranslations, TranslationKey, Translations } from './types';
 import { GetTranslationOptions } from './utils';
 declare class Language {
-    private supportedLocales;
-    customTranslations: CustomTranslations;
-    languageCode: string;
-    locale: string;
-    translations: Translations;
+    private readonly supportedLocales;
+    readonly translations: Translations;
+    readonly customTranslations: CustomTranslations;
+    readonly languageCode: string;
+    readonly locale: string;
+    constructor({ locale, translations, customTranslations, allowedLocales, }: {
+        customTranslations?: CustomTranslations;
+        locale?: string;
+        translations?: Translations;
+        allowedLocales?: string[];
+    });
     /**
      * Returns a translated string from a key in the current {@link Language.locale}
      * @param key - Translation key
@@ -19,29 +25,5 @@ declare class Language {
      * @param options - Options for {@link Intl.DateTimeFormatOptions}
      */
     date(date: string, options?: Intl.DateTimeFormatOptions): string;
-    /**
-     * initialize the i18n language -- setting local, supported locales and translations
-     * @param customTranslations - translation passed to the SDK to override some keys
-     * @param locale - passed to the SDK locale or fallback
-     * @param allowedLocales - allowed locales listed from the KYC external API that we can switch to
-     *
-     */
-    initialize({ customTranslations, locale, allowedLocales, loadingContext, clientKey, }: {
-        customTranslations?: {};
-        locale?: string;
-        allowedLocales?: string[];
-        loadingContext: any;
-        clientKey: any;
-    }): Promise<void>;
-    /**
-     * Returns the translations according to the selected locale
-     * @param locale - Currently selected locale
-     * @returns Translations
-     */
-    loadTranslations({ locale, loadingContext, clientKey }: {
-        locale?: string;
-        loadingContext: any;
-        clientKey: any;
-    }): Promise<any>;
 }
 export default Language;

package/dist/types/language/config.d.ts

@@ -300,7 +300,9 @@ export declare const defaultTranslation: {
     provideAllDirectors: string;
     addDecisionMaker: string;
     decisionMakers: string;
+    goToIntro: string;
     goToOverview: string;
+    goToOverviewFromIntro: string;
     saveAndGoToOverview: string;
     pleaseEnsureTheFollowing: string;
     edit: string;
@@ -422,6 +424,8 @@ export declare const defaultTranslation: {
     numerodeIVA: string;
     NIF: string;
     uen: string;
+    gst: string;
+    number: string;
     nric: string;
     hkid: string;
     NIFdeIVA: string;
@@ -712,6 +716,7 @@ export declare const defaultTranslation: {
     businessRegistrationNumber__HK: string;
     doNotHaveBusinessNumber: string;
     "UEN/GST": string;
+    UEN: string;
     "IRD/GST": string;
     enterNameExactlyAsAppearInID: string;
     enterLastNameExactlyAsAppearInID: string;
@@ -1027,4 +1032,33 @@ export declare const defaultTranslation: {
     lastNameOfSettlor: string;
     enterSettlorsFirstNameExactlyAsItAppearsInID: string;
     enterSettlorsLastNameExactlyAsItAppearsInID: string;
+    taskIntroPrologueTitle: string;
+    taskIntroPrologueDescriptionP1: string;
+    taskIntroPrologueDescriptionP2: string;
+    taskIntroCompanyTitle: string;
+    taskIntroCompanyDescriptionP1: string;
+    taskIntroCompanyDescriptionP2: string;
+    taskIntroDecisionMakerOverviewTitle: string;
+    taskIntroDecisionMakerOverviewDescriptionP1: string;
+    taskIntroDecisionMakerOverviewDescriptionP2: string;
+    taskIntroDecisionMakerOverviewDescriptionP3: string;
+    taskIntroDecisionMakerOverviewDescriptionLI1: string;
+    taskIntroDecisionMakerOverviewDescriptionLI2: string;
+    taskIntroDecisionMakerOverviewDescriptionLI3: string;
+    taskIntroIndividualTitle: string;
+    taskIntroIndividualDescriptionP1: string;
+    taskIntroIndividualDescriptionP2: string;
+    taskIntroIndividualDescriptionP3: string;
+    taskIntroIndividualDescriptionLI1: string;
+    taskIntroIndividualDescriptionLI2: string;
+    taskIntroIndividualDescriptionLI3: string;
+    taskIntroPayoutTitle: string;
+    taskIntroPayoutOrganizationDescriptionP1: string;
+    taskIntroPayoutOrganizationDescriptionP2: string;
+    taskIntroPayoutIndividualDescriptionP1: string;
+    taskIntroPayoutIndividualDescriptionP2: string;
+    taskIntroEpilogueTitle: string;
+    taskIntroEpilogueDescriptionP1: string;
+    taskIntroEpilogueDescriptionP2: string;
+    taskIntroEpilogueDescriptionP3: string;
 };

package/dist/types/language/types.d.ts

@@ -3,7 +3,7 @@ export type TranslationKey = keyof typeof translations;
 export type TranslationItem = string;
 export type Translations = Record<TranslationKey, TranslationItem>;
 export type CustomTranslations = {
-    [key: string]: {
-        [message: string]: string;
+    [locale: string]: {
+        [translationKey: string]: string;
     };
 };

package/dist/types/language/utils.d.ts

@@ -1,54 +1,41 @@
 import { CountryCode } from '../core/models/country-code';
-import { CustomTranslations } from './types';
+import { CustomTranslations, TranslationItem, TranslationKey, Translations } from './types';
 /**
  * Matches a string with one of the locales
- * @param locale -
- * @param supportedLocales -
 
  * @example
  * matchLocale('en-GB');
  * // 'en-US'
  */
-export declare function matchLocale(locale: string, supportedLocales: any): string;
+export declare const matchLocale: (locale: string, supportedLocales: string[]) => string | null;
 /**
  * Returns a locale with the proper format
- * @param localeParam -
  *
  * @example
  * formatLocale('En_us');
  * // 'en-US'
  */
-export declare function formatLocale(localeParam: string): string;
+export declare function formatLocale(localeParam: string): string | null;
 /**
  * Checks the locale format.
  * Also checks if it's on the locales array.
  * If it is not, tries to match it with one.
- * @param locale -
- * @param supportedLocales -
  */
-export declare function parseLocale(locale: string, supportedLocales?: string[]): string;
+export declare function parseLocale(locale: string, supportedLocales?: string[]): string | null;
 /**
  * Formats the locales inside the customTranslations object against the supportedLocales
- * @param customTranslations -
- * @param supportedLocales -
  */
-export declare function formatCustomTranslations(supportedLocales: string[], customTranslations?: object): CustomTranslations;
-export declare const replaceTranslationValues: (translation: string, values: Record<string, string | number>) => string;
+export declare const formatCustomTranslations: (supportedLocales: string[], customTranslations?: CustomTranslations) => CustomTranslations;
+export declare const replaceTranslationValues: (translation: string, values?: Record<string, string | number>) => string;
 export interface GetTranslationOptions {
     localizeFor?: CountryCode;
     values?: Record<string, string | number>;
 }
 /**
- * Returns an array with all the locales
- * @param locale - The locale the user wants to use
- * @param customTranslations -
+ * Returns a translation string by key
  */
-export declare const getTranslations: ({ locale, loadingContext, clientKey, customTranslations, }: {
-    locale: any;
-    loadingContext: any;
-    clientKey: any;
-    customTranslations?: {};
-}) => Promise<any>;
+export declare const getTranslationByKey: (translations: Translations, key: TranslationKey, options?: GetTranslationOptions) => TranslationItem | null;
+export declare const getTranslationKeysByPrefix: (translations: Translations, keyPrefix: string) => TranslationKey[];
 /**
  * Returns a LanguageCode from locale
  * @param locale - The locale the user wants to use

package/dist/types/openbankingsdk/OpenBankingSDK.d.ts

@@ -0,0 +1,14 @@
+import './OpenBankingSDKStyles.scss';
+import { OpenBankingParameters } from './types';
+export declare class OpenBankingSDK {
+    private readonly divElement;
+    private readonly link;
+    private readonly successHandler;
+    private readonly errorHandler;
+    private iframe?;
+    private listener?;
+    private constructor();
+    static create(parameters: OpenBankingParameters): OpenBankingSDK;
+    open(): void;
+    destroy(): void;
+}

package/dist/types/openbankingsdk/types.d.ts

@@ -0,0 +1,22 @@
+export type OpenBankingParameters = {
+    divElement: HTMLDivElement;
+    link: string;
+    successHandler: SuccessHandler;
+    errorHandler: ErrorHandler;
+};
+interface AccountVerificationReportMessage {
+    type: 'account_verification_report';
+    code: string;
+    state: string;
+}
+interface ErrorMessage {
+    type: 'error';
+    error_code: string;
+    error_message: string;
+    state: string;
+    metadata?: Map<string, string>;
+}
+export type OpenBankingMessage = AccountVerificationReportMessage | ErrorMessage;
+export type SuccessHandler = (code: string, state: string) => void;
+export type ErrorHandler = (errorCode: string, errorMessage: string, state: string, metadata?: Map<string, string>) => void;
+export {};

package/dist/types/utils/company-util.d.ts

@@ -1,8 +1,9 @@
 import { Organization } from '../core/models/api/organization';
 import { Trust } from '../core/models/api/trust';
+import { CountryCode } from '../core/models/country-code';
 export declare const updateTaxInformation: <T extends Organization | import("../core/models/api/legal-arrangement").LegalArrangement | Trust>({ taxId, country, exemptedFromTax, entity, }: {
     taxId: string;
-    country: string;
+    country: CountryCode;
     exemptedFromTax?: boolean;
     entity: T;
 }) => T;