/
fields.ts
273 lines (246 loc) · 7.35 KB
/
fields.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { BoundingRegion, DocumentSpan } from "..";
import { CurrencyValue, DocumentField as GeneratedDocumentField } from "../generated";
import { capitalize } from "../util";
/**
* Fields that are common to all DocumentField variants.
*/
export interface DocumentFieldCommon {
/**
* The verbatim extracted text content of the field.
*/
content?: string;
/**
* Bounding regions covering the field.
*/
boundingRegions?: BoundingRegion[];
/**
* Confidence of correctly extracting the field.
*/
confidence?: number;
/**
* Location of the field in the reading order concatenated content.
*/
spans?: DocumentSpan[];
}
/**
* A simple field that has a primitive value, such as a string, number etc.
*/
export interface DocumentValueField<T> extends DocumentFieldCommon {
/**
* The field's value, which has the type specified in the field's schema.
*/
value?: T;
}
/**
* An extracted field. The `kind` property identifies (discriminates) the type of the `DocumentField`.
*/
export type DocumentField =
| DocumentStringField
| DocumentDateField
| DocumentTimeField
| DocumentPhoneNumberField
| DocumentNumberField
| DocumentIntegerField
| DocumentSelectionMarkField
| DocumentCountryRegionField
| DocumentSignatureField
| DocumentCurrencyField
| DocumentArrayField
| DocumentObjectField;
/**
* A DocumentField that has a string value.
*/
export interface DocumentStringField<Value extends string = string>
extends DocumentValueField<Value> {
/** Field kind: "string". */
kind: "string";
}
/**
* A DocumentField that has a Date value.
*/
export interface DocumentDateField extends DocumentValueField<Date> {
/** Field kind: "date". */
kind: "date";
}
/**
* A DocumentField that has a time value, represented as a string.
*/
export interface DocumentTimeField extends DocumentFieldCommon {
/** Field kind: "time". */
kind: "time";
/**
* The field's value, which is a time in "HH:MM:SS" (ISO 8601) format.
*/
value?: string;
}
/**
* A DocumentField that has a phone number value, represented as a string.
*/
export interface DocumentPhoneNumberField extends DocumentFieldCommon {
/** Field kind: "phoneNumber". */
kind: "phoneNumber";
/**
* The field's value, which is a string containing the phone number.
*
* The phone number value is normalized to a standard format. If the value could not be normalized, this value may be
* undefined, and the `content` property will contain the verbatim text of the DocumentField as it appeared in the
* input.
*/
value?: string;
}
/**
* A DocumentField that has a number value.
*/
export interface DocumentNumberField extends DocumentValueField<number> {
/** Field kind: "number". */
kind: "number";
}
/**
* A DocumentField that has an integer value.
*/
export interface DocumentIntegerField extends DocumentValueField<number> {
/** Field kind: "integer". */
kind: "integer";
}
/**
* A DocumentField that is has a value indicating a selection mark state (such as a checkbox or radio button),
* represented as a string.
*/
export interface DocumentSelectionMarkField extends DocumentFieldCommon {
/** Field kind: "selectionMark". */
kind: "selectionMark";
/**
* The state of the selection mark. One of:
*
* - "selected"
* - "unselected"
*
* This value may be undefined, and other variants may be introduced in the future.
*/
value?: string;
}
/**
* A DocumentField that has a value indicating a country or region, represented as a string.
*/
export interface DocumentCountryRegionField extends DocumentFieldCommon {
/** Field kind: "countryRegion". */
kind: "countryRegion";
/**
* The 3-letter country/region code (ISO 3166-1 alpha-3) of the extracted country or region.
*/
value?: string;
}
/**
* A DocumentField that indicates the state of a signature, represented as a string.
*/
export interface DocumentSignatureField extends DocumentFieldCommon {
/** Field kind: "signature". */
kind: "signature";
/**
* The state of the signature field. One of:
*
* - "unsigned"
* - "signed"
*
* This value may be undefined, and other variants may be introduced in the future.
*/
value: "signed" | "unsigned";
}
/**
* A DocumentField that consists of an array of nested fields. All fields in the array will have the same type.
*/
export interface DocumentArrayField<T = DocumentField> extends DocumentFieldCommon {
/** Field kind: "array". */
kind: "array";
/**
* The extracted members of the array field.
*/
values: T[];
}
/**
* A DocumentField that describes an amount of a certain currency.
*/
export interface DocumentCurrencyField extends DocumentFieldCommon {
/** Field kind: "currency". */
kind: "currency";
/**
* The properties of the extracted currency.
*/
value?: CurrencyValue;
}
/**
* A DocumentField that consists of several named properties that have their own DocumentField values.
*/
export interface DocumentObjectField<Properties = { [k: string]: DocumentField | undefined }>
extends DocumentFieldCommon {
/** Field kind: "object". */
kind: "object";
/**
* The extracted object properties. Each property of this object is, itself, a nested DocumentField.
*/
properties: Properties;
}
/**
* Convert a record of generated fields to a record of strongly-typed fields.
* @internal
* @param fields - a map of field names to generated field values
* @returns - an object with the same keys, where all values have been mapped to DocumentFields
*/
export function toAnalyzedDocumentFieldsFromGenerated(fields: {
[k: string]: GeneratedDocumentField;
}): { [k: string]: DocumentField } {
return Object.entries(fields ?? {}).reduce((transformedFields, [name, value]) => {
transformedFields[name] = toDocumentField(value);
return transformedFields;
}, {} as { [k: string]: DocumentField });
}
/**
* Convert a generated document field into a strong TypeScriptified document field.
* @internal
*/
export function toDocumentField(field: GeneratedDocumentField): DocumentField {
const kind = field.type as DocumentField["kind"];
const value: Omit<DocumentField, keyof DocumentFieldCommon | "kind"> = (() => {
switch (kind) {
// Almost all value kinds are represented as simple elemental values
case "string":
case "date":
case "time":
case "phoneNumber":
case "number":
case "integer":
case "selectionMark":
case "countryRegion":
case "signature":
case "currency":
return {
value:
field[
("value" + capitalize(kind)) as Extract<
keyof GeneratedDocumentField,
`value${string}`
>
],
};
case "array":
return { values: field.valueArray?.map((v) => toDocumentField(v) ?? []) };
case "object":
return { properties: toAnalyzedDocumentFieldsFromGenerated(field.valueObject ?? {}) };
default:
// Exhaustiveness check
// eslint-disable-next-line no-case-declarations
const __exhaust: never = kind;
throw new Error(`Unrecognized DocumentField type: ${__exhaust}`);
}
})();
return {
kind,
...value,
boundingRegions: field.boundingRegions,
content: field.content,
spans: field.spans,
confidence: field.confidence,
} as DocumentField;
}