Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion typescript/src/address/addressClient.integration.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { staticReferenceId, validTokenAddress, validTokenAddressWithEnrichment,
import { AddressClient, AddressConfiguration, Countries, Datasets, GlobalGeocodeAttribute, SearchType } from '../index';
import { LookupType } from './lookup/lookupType';
import { AusRegionalGeocodeAttribute } from './layout/attributes/ausRegionalGeocodeAttribute';
import { v4 as uuidv4 } from 'uuid';

describe('Address client tests', async () => {

Expand Down
2 changes: 1 addition & 1 deletion typescript/src/address/addressClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import { LookupResult, restApiResponseToLookupResult } from "./lookup/lookupResu
/**
* Interface defining the options for address searching.
*/
interface AddressSearchOptions {
export interface AddressSearchOptions {
/**
* The search input to use (e.g., what the user has typed in).
*/
Expand Down
2 changes: 1 addition & 1 deletion typescript/src/address/dataset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export namespace Datasets {
export const FiAddressEd: Dataset = { datasetCode: "fi-address-ed", country: Countries.Finland, searchTypes: [SearchType.Validate] , addressAccuracy: Accuracy.A, geocodeAccuracy: Accuracy.APlus};
export const FiAddressEh: Dataset = { datasetCode: "fi-address-eh", country: Countries.Finland, searchTypes: [SearchType.Autocomplete, SearchType.LookupV2], addressAccuracy: Accuracy.A, geocodeAccuracy: Accuracy.APlus };
export const FrAddress: Dataset = { datasetCode: "fr-address", country: Countries.France, searchTypes: [SearchType.Singleline, SearchType.Typedown, SearchType.Validate], addressAccuracy: Accuracy.A, geocodeAccuracy: Accuracy.APlus };
export const FrAddressHexaline3: Dataset = { datasetCode: "fr-address-hexaline3", country: Countries.France, searchTypes: [SearchType.Autocomplete, SearchType.Singleline, SearchType.Typedown], addressAccuracy: Accuracy.APlus, geocodeAccuracy: Accuracy.APlus };
export const FrAddressHexaline3: Dataset = { datasetCode: "fr-additional-hexaline3", country: Countries.France, searchTypes: [SearchType.Autocomplete, SearchType.Singleline, SearchType.Typedown], addressAccuracy: Accuracy.APlus, geocodeAccuracy: Accuracy.APlus };
export const FrAddressStreetLevel: Dataset = { datasetCode: "fr-address-streetlevel", country: Countries.France, searchTypes: [SearchType.Singleline, SearchType.Typedown, SearchType.Validate], addressAccuracy: Accuracy.AMinus, geocodeAccuracy: Accuracy.APlus };
export const GfAddressEd: Dataset = { datasetCode: "gf-address-ed", country: Countries.FrenchGuiana, searchTypes: [SearchType.Singleline, SearchType.Validate] , addressAccuracy: Accuracy.B, geocodeAccuracy: Accuracy.BMinus};
export const GfAddressEh: Dataset = { datasetCode: "gf-address-eh", country: Countries.FrenchGuiana, searchTypes: [SearchType.Autocomplete, SearchType.LookupV2] , addressAccuracy: Accuracy.AMinus, geocodeAccuracy: Accuracy.BMinus};
Expand Down
55 changes: 48 additions & 7 deletions typescript/src/address/index.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,61 @@
import { AddressConfiguration } from './addressConfiguration';
import { AddressClient } from './addressClient';
import { AddressConfiguration, AddressConfigurationOptions } from './addressConfiguration';
import { AddressClient, AddressSearchOptions } from './addressClient';
import { SearchType } from './searchType';
import { AddressConfidence } from './addressConfidence';
import { GlobalGeocodeAttribute } from './layout/attributes/globalGeocodeAttribute';
import { Accuracy } from './accuracy';
import { Datasets, Dataset } from './dataset';
import { Intensity } from './intensity';
import { LayoutFormat } from './layout/layoutFormat';
import { PremiumLocationInsightAttribute } from './layout/attributes/premiumLocationInsightAttribute';
import { What3WordsAttribute } from './layout/attributes/what3WordsAttribute';
import { AusRegionalGeocodeAttribute } from './layout/attributes/ausRegionalGeocodeAttribute';
import { GbrLocationEssentialAttribute } from './layout/attributes/gbrLocationEssentialAttribute';
import { GbrLocationCompleteAttribute } from './layout/attributes/gbrLocationCompleteAttribute';
import { GbrBusinessAttribute } from './layout/attributes/gbrBusinessAttribute';
import { GbrGovernmentAttribute } from './layout/attributes/gbrGovernmentAttribute';
import { GbrHealthAttribute } from './layout/attributes/gbrHealthAttribute';
import { NzlRegionalGeocodeAttribute } from './layout/attributes/nzlRegionalGeocodeAttribute';
import { UsaRegionalGeocodeAttribute } from './layout/attributes/usaRegionalGeocodeAttribute';
import { LookupLocality } from './lookup/lookupLocality';
import { LookupPostalCode } from './lookup/lookupPostalCode';
import { Countries, Country } from '../common/country';
import { LookupType } from './lookup/lookupType';
import { SearchResult } from './search/searchResult';
import { FormatResult } from './format/formatResult';

export {
AddressConfiguration,
AddressClient,
AddressConfiguration,
AddressClient,
Datasets,
Dataset,
SearchType,
AddressConfidence as Confidence,
GlobalGeocodeAttribute,
AddressConfidence,
GlobalGeocodeAttribute,
Accuracy,
Intensity,
LayoutFormat,
PremiumLocationInsightAttribute,
What3WordsAttribute,
AusRegionalGeocodeAttribute,
GbrLocationEssentialAttribute,
GbrLocationCompleteAttribute,
GbrBusinessAttribute,
GbrGovernmentAttribute,
GbrHealthAttribute,
NzlRegionalGeocodeAttribute,
UsaRegionalGeocodeAttribute,
LookupLocality,
LookupPostalCode,
Countries,
LookupType

}

export type {
AddressConfigurationOptions,
Dataset,
Country,
AddressSearchOptions,
SearchResult,
FormatResult
}
2 changes: 2 additions & 0 deletions typescript/src/address/lookup/lookupAddressSuggestionV2.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { RestApiAddressLookupSuggestionV2 } from "../../server/address/lookup/restApiAddressLookupSuggestionV2";

export type LookupAddressSuggestionV2 = {
text?: string;
matched?: number[];
Expand Down
2 changes: 2 additions & 0 deletions typescript/src/address/lookup/lookupLocalityItem.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { RestApiAddressLookupLocalityItem } from "../../server/address/lookup/restApiAddressLookupLocalityItem";

export type LookupLocalityItem = {
name?: string;
code?: string;
Expand Down
1 change: 1 addition & 0 deletions typescript/src/address/lookup/lookupSuggestion.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { RestApiAddressLookupSuggestion } from "../../server/address/lookup/restApiAddresslookupSuggestion";
import { LookupLocalityItem, restApiResponseToLookupLocalityItem } from "./lookupLocalityItem";


Expand Down
21 changes: 19 additions & 2 deletions typescript/src/email/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
import { EmailConfiguration } from './emailConfiguration';
import { EmailConfiguration, EmailConfigurationOptions } from './emailConfiguration';
import { EmailClient } from './emailClient';
import { ValidateResult } from './validate/validateResult';
import { ResponseError } from '../common/responseError';
import { EmailConfidence } from './emailConfidence';
import { VerboseOutput } from './validate/verboseOutput';
import { DomainType } from './validate/domainType';

export {EmailConfiguration, EmailClient};
export {
EmailConfiguration,
EmailClient,
EmailConfidence,
VerboseOutput,
DomainType
};

export type {
EmailConfigurationOptions,
ValidateResult,
ResponseError
}
3 changes: 1 addition & 2 deletions typescript/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

import {Countries, Country} from './common/country'

export * from './address/index';
export * from './email/index';
export * from './phone/index';
export {Countries, Country};

18 changes: 17 additions & 1 deletion typescript/src/phone/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
import { PhoneConfiguration } from './phoneConfiguration';
import { PhoneClient } from './phoneClient';
import { Country } from '../common/country';
import { PhoneValidateResult } from './validate/phoneValidateResult';
import { PhoneType } from './validate/phoneType';
import { PhoneConfidence } from './confidence';
import { Metadata } from './validate/metadata';

export { PhoneConfiguration, PhoneClient};
export {
PhoneConfiguration,
PhoneClient,
PhoneType,
PhoneConfidence
};

export type {
Country,
Metadata,
PhoneValidateResult
}
4 changes: 2 additions & 2 deletions typescript/src/phone/phoneClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { EDVSError } from "../exceptions/edvsException";
import { getPhoneValidateRequestFromConfig } from "../server/phone/restApiPhoneValidateRequest";
import { RestApiStubImpl } from "../server/restApiStub";
import { PhoneConfiguration } from "./phoneConfiguration";
import { ValidateResult, restApiResponseToPhoneValidateResult } from "./validate/validateResult";
import { PhoneValidateResult, restApiResponseToPhoneValidateResult } from "./validate/phoneValidateResult";

/**
* Client class for interacting with the phone-related APIs.
Expand Down Expand Up @@ -31,7 +31,7 @@ export class PhoneClient {
* @return A promise that resolves to the validation result.
* @throws EDVSError If the API response contains an error.
*/
public async validate(phoneNumber: string, referenceId?: string): Promise<ValidateResult> {
public async validate(phoneNumber: string, referenceId?: string): Promise<PhoneValidateResult> {
if (!referenceId) { referenceId=""; }
const headers = this.configuration.getCommonHeaders(referenceId, false);
const request = getPhoneValidateRequestFromConfig(this.configuration);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Metadata } from "./metadata";
import { restApiResponseToPhoneDetail } from "./phoneDetail";
import { lookupPhoneType, PhoneType } from "./phoneType";

export type ValidateResult = {
export type PhoneValidateResult = {
number: string;
validatedPhoneNumber: string;
formattedPhoneNumber: string;
Expand All @@ -16,12 +16,12 @@ export type ValidateResult = {
referenceId?: string;
};

export function restApiResponseToPhoneValidateResult(response: RestApiPhoneValidateResponse): ValidateResult {
export function restApiResponseToPhoneValidateResult(response: RestApiPhoneValidateResponse): PhoneValidateResult {

const apiResult = response.result;
const apiMetadata = response.metadata;

const result: ValidateResult = {
const result: PhoneValidateResult = {
number: "",
validatedPhoneNumber: "",
formattedPhoneNumber: "",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

type RestApiAddressLookupLocalityItem = {
export type RestApiAddressLookupLocalityItem = {
name?: string;
code?: string;
description?: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
type RestApiAddressLookupSuggestionV2 = {
export type RestApiAddressLookupSuggestionV2 = {
text?: string;
matched?: number[];
global_address_key?: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { RestApiAddressLookupSuggestion } from "./restApiAddresslookupSuggestion";
import { RestApiAddressLookupSuggestionV2 } from "./restApiAddressLookupSuggestionV2";
import { RestApiAddressLookupV2ResultAddressFormatted } from "./restApiAddressLookupV2ResultAddressFormatted";

export type RestApiAddressLookupV2Result = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
type RestApiAddressLookupSuggestion = {
import { RestApiAddressLookupLocalityItem } from "./restApiAddressLookupLocalityItem";

export type RestApiAddressLookupSuggestion = {
locality?: {
region?: RestApiAddressLookupLocalityItem;
sub_region?: RestApiAddressLookupLocalityItem;
Expand Down
2 changes: 1 addition & 1 deletion typescript/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,6 @@

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"skipLibCheck": false /* Skip type checking all .d.ts files. */
}
}
Loading