forked from experianplc/Experian-Address-Validation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class-types.ts
196 lines (181 loc) · 5.38 KB
/
class-types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
export class Picklist {
items: PicklistItem[];
what3wordsItems: What3WordsPickList[];
lookupItems: LookupAddress[];
currentItem;
list: HTMLDivElement;
container: HTMLElement;
size = 0;
maxSuggestions = 25;
show: (items: SearchResponse) => void;
showWhat3Words: (items: LookupW3WResponse) => void;
showLookup: (items: LookupV2Response) => void;
hide: () => void;
handleEmptyPicklist: (items: SearchResponse | LookupW3WResponse | LookupV2Response) => void;
handleEmptyPicklistCallback: () => void;
handleCommonShowPicklistLogic: () => void;
refine: Refinement;
useAddressEntered: UseAddressEntered;
createList: () => HTMLDivElement;
createListItem: (item: PicklistItem) => HTMLDivElement;
createLookupListItem: (item: LookupAddress) => HTMLDivElement;
createLookupSuggestionListItem: (item: LookupSuggestion) => HTMLDivElement;
createWhat3WordsListItem: (item: What3WordsPickList) => HTMLDivElement;
tabCount: number;
resetTabCount: () => void;
keyup: (event: KeyboardEvent) => void;
addMatchingEmphasis: (item) => string;
listen: (row) => void;
checkEnter: (event: KeyboardEvent) => void;
pick: (item) => void;
scrollIntoViewIfNeeded: () => void;
displaySuggestionsHeader: () => void;
displayUseAddressEnteredFooter: () => void;
}
export class AddressValidationResult {
formattedAddressContainer;
lastAddressField;
generateAddressLineRequired: boolean;
show: (data) => void;
hide: () => void;
createAddressLine: CreateAddressLine;
createFormattedAddressContainer: () => void;
createHeading: () => void;
updateHeading: (text: string) => void;
calculateIfAddressLineGenerationRequired: () => void;
updateAddressLine: (key: string, addressLineObject, className: string) => void;
updateLabel: (key: string) => string;
createSearchAgainLink: () => void;
renderInputList: (inputArray) => void;
handleValidateResponse: (response: SearchResponse) => void;
handleEnrichmentResponse: (response: EnrichmentResponse) => void;
}
class CreateAddressLine {
input: (key: string, value: string, className: string) => HTMLDivElement;
label: (key: string) => string;
}
export interface SearchResponse {
result?: {
suggestions: PicklistItem[];
suggestions_prompt?: string;
suggestions_key?: string;
confidence: string;
address?: { [key: string]: string };
components?: { [key: string]: string };
},
metadata? : { [key: string]: string };
}
export interface LookupW3WResponse {
result?: {
more_results_available: boolean;
suggestions: What3WordsPickList[];
confidence: string;
}
}
export interface LookupV2Response {
result?: {
more_results_available: boolean;
confidence: string;
suggestions: LookupSuggestion[];
addresses: LookupAddress[];
}
}
export interface LookupSuggestion {
locality: LocalityComponents;
postal_code: PostalCode;
postal_code_key: string;
locality_key: string;
}
export interface LocalityComponents {
region: LocalityItem,
sub_region: LocalityItem,
town: LocalityItem,
district: LocalityItem,
sub_district: LocalityItem
}
export interface LocalityItem {
name: string,
code: string
}
export interface PostalCode {
full_name: string,
primary: string,
secondary: string
}
export interface LookupAddress {
text: string;
global_address_key: string;
format: string;
}
export interface What3WordsPickList {
what3words: What3WordsSuggestion;
}
export interface What3WordsSuggestion {
name: string;
description: string
}
export interface PicklistItem {
text: string;
format?: string;
matched?: number[][];
global_address_key?: string;
additional_attributes?: { name: string, Value: string }[];
}
export class EnrichmentDetails {
title: string;
detailsMap = new Map<string, string>();
}
export interface EnrichmentResponse {
result?: {
aus_regional_geocodes?: { [key: string]: string };
aus_cv_household?: { [key: string]: string };
nzl_regional_geocodes?: { [key: string]: string };
nzl_cv_household?: { [key: string]: string };
usa_regional_geocodes?: { [key: string]: string };
uk_location_essential?: { [key: string]: string };
what3words?: What3Words;
geocodes?: { [key: string]: string };
premium_location_insight?: { [key: string]: string };
};
}
export interface What3Words {
latitude?: string;
longitude?: string;
name?: string;
description?: string;
}
export interface DatasetsResponse {
result? : DatasetsCountryResult[];
}
export interface DatasetsCountryResult {
country_iso_3?: string;
country_name?: string;
datasets?: Dataset[];
}
export interface Dataset{
id?: string;
name?: string;
}
export class UseAddressEntered {
element: HTMLElement;
create: (confidence: string) => HTMLDivElement;
destroy: () => void;
click: () => void;
formatManualAddressLine: (lines, i) => { [key: string]: string };
}
export class Refinement {
element: HTMLInputElement;
isNeeded: (response: SearchResponse) => boolean;
createInput: (prompt: string, key: string) => void;
enter: (event: Event) => void;
}
export class SearchSpinner {
show: () => void;
hide: () => void;
}
export class PoweredByLogo {
element: HTMLElement;
create: (picklist) => HTMLDivElement;
destroy: (picklist) => void;
svg: string;
}