diff --git a/typescript/src/address/addressClient.integration.test.ts b/typescript/src/address/addressClient.integration.test.ts index 5082cb7..21fa6dd 100644 --- a/typescript/src/address/addressClient.integration.test.ts +++ b/typescript/src/address/addressClient.integration.test.ts @@ -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 () => { diff --git a/typescript/src/address/addressClient.ts b/typescript/src/address/addressClient.ts index 230880e..c98359d 100644 --- a/typescript/src/address/addressClient.ts +++ b/typescript/src/address/addressClient.ts @@ -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). */ diff --git a/typescript/src/address/dataset.ts b/typescript/src/address/dataset.ts index f222717..89a3350 100644 --- a/typescript/src/address/dataset.ts +++ b/typescript/src/address/dataset.ts @@ -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}; diff --git a/typescript/src/address/index.ts b/typescript/src/address/index.ts index 85072f8..ab87ba7 100644 --- a/typescript/src/address/index.ts +++ b/typescript/src/address/index.ts @@ -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 } \ No newline at end of file diff --git a/typescript/src/address/lookup/lookupAddressSuggestionV2.ts b/typescript/src/address/lookup/lookupAddressSuggestionV2.ts index 8a68bda..cc89e86 100644 --- a/typescript/src/address/lookup/lookupAddressSuggestionV2.ts +++ b/typescript/src/address/lookup/lookupAddressSuggestionV2.ts @@ -1,3 +1,5 @@ +import { RestApiAddressLookupSuggestionV2 } from "../../server/address/lookup/restApiAddressLookupSuggestionV2"; + export type LookupAddressSuggestionV2 = { text?: string; matched?: number[]; diff --git a/typescript/src/address/lookup/lookupLocalityItem.ts b/typescript/src/address/lookup/lookupLocalityItem.ts index c4a0522..80e7b6e 100644 --- a/typescript/src/address/lookup/lookupLocalityItem.ts +++ b/typescript/src/address/lookup/lookupLocalityItem.ts @@ -1,3 +1,5 @@ +import { RestApiAddressLookupLocalityItem } from "../../server/address/lookup/restApiAddressLookupLocalityItem"; + export type LookupLocalityItem = { name?: string; code?: string; diff --git a/typescript/src/address/lookup/lookupSuggestion.ts b/typescript/src/address/lookup/lookupSuggestion.ts index 32c714b..0cc211c 100644 --- a/typescript/src/address/lookup/lookupSuggestion.ts +++ b/typescript/src/address/lookup/lookupSuggestion.ts @@ -1,3 +1,4 @@ +import { RestApiAddressLookupSuggestion } from "../../server/address/lookup/restApiAddresslookupSuggestion"; import { LookupLocalityItem, restApiResponseToLookupLocalityItem } from "./lookupLocalityItem"; diff --git a/typescript/src/email/index.ts b/typescript/src/email/index.ts index f726b6d..0dcc564 100644 --- a/typescript/src/email/index.ts +++ b/typescript/src/email/index.ts @@ -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}; \ No newline at end of file +export { + EmailConfiguration, + EmailClient, + EmailConfidence, + VerboseOutput, + DomainType +}; + +export type { + EmailConfigurationOptions, + ValidateResult, + ResponseError +} diff --git a/typescript/src/index.ts b/typescript/src/index.ts index b805bc2..0ff127d 100644 --- a/typescript/src/index.ts +++ b/typescript/src/index.ts @@ -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}; + diff --git a/typescript/src/phone/index.ts b/typescript/src/phone/index.ts index 0380e6b..4da7aaa 100644 --- a/typescript/src/phone/index.ts +++ b/typescript/src/phone/index.ts @@ -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}; \ No newline at end of file +export { + PhoneConfiguration, + PhoneClient, + PhoneType, + PhoneConfidence +}; + +export type { + Country, + Metadata, + PhoneValidateResult +} \ No newline at end of file diff --git a/typescript/src/phone/phoneClient.ts b/typescript/src/phone/phoneClient.ts index abee1e5..d24e3a1 100644 --- a/typescript/src/phone/phoneClient.ts +++ b/typescript/src/phone/phoneClient.ts @@ -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. @@ -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 { + public async validate(phoneNumber: string, referenceId?: string): Promise { if (!referenceId) { referenceId=""; } const headers = this.configuration.getCommonHeaders(referenceId, false); const request = getPhoneValidateRequestFromConfig(this.configuration); diff --git a/typescript/src/phone/validate/validateResult.ts b/typescript/src/phone/validate/phoneValidateResult.ts similarity index 93% rename from typescript/src/phone/validate/validateResult.ts rename to typescript/src/phone/validate/phoneValidateResult.ts index f793cd5..3c9ae9f 100644 --- a/typescript/src/phone/validate/validateResult.ts +++ b/typescript/src/phone/validate/phoneValidateResult.ts @@ -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; @@ -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: "", diff --git a/typescript/src/server/address/lookup/restApiAddressLookupLocalityItem.ts b/typescript/src/server/address/lookup/restApiAddressLookupLocalityItem.ts index e19e3b8..45cfeec 100644 --- a/typescript/src/server/address/lookup/restApiAddressLookupLocalityItem.ts +++ b/typescript/src/server/address/lookup/restApiAddressLookupLocalityItem.ts @@ -1,5 +1,5 @@ -type RestApiAddressLookupLocalityItem = { +export type RestApiAddressLookupLocalityItem = { name?: string; code?: string; description?: string; diff --git a/typescript/src/server/address/lookup/restApiAddressLookupSuggestionV2.ts b/typescript/src/server/address/lookup/restApiAddressLookupSuggestionV2.ts index 703447a..9cc7682 100644 --- a/typescript/src/server/address/lookup/restApiAddressLookupSuggestionV2.ts +++ b/typescript/src/server/address/lookup/restApiAddressLookupSuggestionV2.ts @@ -1,4 +1,4 @@ -type RestApiAddressLookupSuggestionV2 = { +export type RestApiAddressLookupSuggestionV2 = { text?: string; matched?: number[]; global_address_key?: string; diff --git a/typescript/src/server/address/lookup/restApiAddressLookupV2Result .ts b/typescript/src/server/address/lookup/restApiAddressLookupV2Result .ts index 893ebdf..8d00caf 100644 --- a/typescript/src/server/address/lookup/restApiAddressLookupV2Result .ts +++ b/typescript/src/server/address/lookup/restApiAddressLookupV2Result .ts @@ -1,3 +1,5 @@ +import { RestApiAddressLookupSuggestion } from "./restApiAddresslookupSuggestion"; +import { RestApiAddressLookupSuggestionV2 } from "./restApiAddressLookupSuggestionV2"; import { RestApiAddressLookupV2ResultAddressFormatted } from "./restApiAddressLookupV2ResultAddressFormatted"; export type RestApiAddressLookupV2Result = { diff --git a/typescript/src/server/address/lookup/restApiAddresslookupSuggestion.ts b/typescript/src/server/address/lookup/restApiAddresslookupSuggestion.ts index e172b08..349ba52 100644 --- a/typescript/src/server/address/lookup/restApiAddresslookupSuggestion.ts +++ b/typescript/src/server/address/lookup/restApiAddresslookupSuggestion.ts @@ -1,4 +1,6 @@ -type RestApiAddressLookupSuggestion = { +import { RestApiAddressLookupLocalityItem } from "./restApiAddressLookupLocalityItem"; + +export type RestApiAddressLookupSuggestion = { locality?: { region?: RestApiAddressLookupLocalityItem; sub_region?: RestApiAddressLookupLocalityItem; diff --git a/typescript/tsconfig.json b/typescript/tsconfig.json index b906e87..1ae9150 100644 --- a/typescript/tsconfig.json +++ b/typescript/tsconfig.json @@ -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. */ } }