read-excel-file 9.0.3 → 9.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -3
- package/README.md +23 -16
- package/browser/index.cjs +5 -5
- package/browser/index.d.ts +20 -20
- package/browser/index.js +5 -5
- package/commonjs/parseSheetData/InvalidError.js.map +1 -0
- package/commonjs/{parseData/parseData.js → parseSheetData/parseSheetData.js} +6 -6
- package/commonjs/parseSheetData/parseSheetData.js.map +1 -0
- package/commonjs/parseSheetData/parseSheetData.test.js.map +1 -0
- package/commonjs/parseSheetData/types/Boolean.js.map +1 -0
- package/commonjs/parseSheetData/types/Date.js.map +1 -0
- package/commonjs/parseSheetData/types/Number.js.map +1 -0
- package/commonjs/parseSheetData/types/String.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/Email.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/Email.test.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/Integer.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/Integer.test.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/URL.js.map +1 -0
- package/commonjs/parseSheetData/types/additional/URL.test.js.map +1 -0
- package/modules/parseSheetData/InvalidError.js.map +1 -0
- package/modules/{parseData/parseData.js → parseSheetData/parseSheetData.js} +4 -4
- package/modules/parseSheetData/parseSheetData.js.map +1 -0
- package/modules/parseSheetData/parseSheetData.test.js.map +1 -0
- package/modules/parseSheetData/types/Boolean.js.map +1 -0
- package/modules/parseSheetData/types/Date.js.map +1 -0
- package/modules/parseSheetData/types/Number.js.map +1 -0
- package/modules/parseSheetData/types/String.js.map +1 -0
- package/modules/parseSheetData/types/additional/Email.js.map +1 -0
- package/modules/parseSheetData/types/additional/Email.test.js.map +1 -0
- package/modules/parseSheetData/types/additional/Integer.js.map +1 -0
- package/modules/parseSheetData/types/additional/Integer.test.js.map +1 -0
- package/modules/parseSheetData/types/additional/URL.js.map +1 -0
- package/modules/parseSheetData/types/additional/URL.test.js.map +1 -0
- package/node/index.cjs +5 -5
- package/node/index.d.ts +20 -20
- package/node/index.js +5 -5
- package/package.json +1 -1
- package/types/{parseData/parseData.d.ts → parseSheetData/parseSheetData.d.ts} +9 -9
- package/types/parseSheetData/parseSheetDataError.d.ts +292 -0
- package/types/{parseData/parseDataSchema.d.ts → parseSheetData/parseSheetDataSchema.d.ts} +2 -2
- package/types/{parseData/parseDataValueType.d.ts → parseSheetData/parseSheetDataValueType.d.ts} +7 -7
- package/universal/index.cjs +5 -5
- package/universal/index.d.ts +20 -20
- package/universal/index.js +5 -5
- package/web-worker/index.cjs +5 -5
- package/web-worker/index.d.ts +20 -20
- package/web-worker/index.js +5 -5
- package/commonjs/parseData/InvalidError.js.map +0 -1
- package/commonjs/parseData/parseData.js.map +0 -1
- package/commonjs/parseData/parseData.test.js.map +0 -1
- package/commonjs/parseData/types/Boolean.js.map +0 -1
- package/commonjs/parseData/types/Date.js.map +0 -1
- package/commonjs/parseData/types/Number.js.map +0 -1
- package/commonjs/parseData/types/String.js.map +0 -1
- package/commonjs/parseData/types/additional/Email.js.map +0 -1
- package/commonjs/parseData/types/additional/Email.test.js.map +0 -1
- package/commonjs/parseData/types/additional/Integer.js.map +0 -1
- package/commonjs/parseData/types/additional/Integer.test.js.map +0 -1
- package/commonjs/parseData/types/additional/URL.js.map +0 -1
- package/commonjs/parseData/types/additional/URL.test.js.map +0 -1
- package/modules/parseData/InvalidError.js.map +0 -1
- package/modules/parseData/parseData.js.map +0 -1
- package/modules/parseData/parseData.test.js.map +0 -1
- package/modules/parseData/types/Boolean.js.map +0 -1
- package/modules/parseData/types/Date.js.map +0 -1
- package/modules/parseData/types/Number.js.map +0 -1
- package/modules/parseData/types/String.js.map +0 -1
- package/modules/parseData/types/additional/Email.js.map +0 -1
- package/modules/parseData/types/additional/Email.test.js.map +0 -1
- package/modules/parseData/types/additional/Integer.js.map +0 -1
- package/modules/parseData/types/additional/Integer.test.js.map +0 -1
- package/modules/parseData/types/additional/URL.js.map +0 -1
- package/modules/parseData/types/additional/URL.test.js.map +0 -1
- package/types/parseData/parseDataError.d.ts +0 -292
- /package/commonjs/{parseData → parseSheetData}/InvalidError.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/Boolean.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/Date.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/Number.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/String.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/additional/Email.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/additional/Integer.js +0 -0
- /package/commonjs/{parseData → parseSheetData}/types/additional/URL.js +0 -0
- /package/modules/{parseData → parseSheetData}/InvalidError.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/Boolean.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/Date.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/Number.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/String.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/additional/Email.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/additional/Integer.js +0 -0
- /package/modules/{parseData → parseSheetData}/types/additional/URL.js +0 -0
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
import { CellValue } from '../types.d.js'
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
StringType,
|
|
5
|
+
DateType,
|
|
6
|
+
NumberType,
|
|
7
|
+
BooleanType,
|
|
8
|
+
Integer,
|
|
9
|
+
Email,
|
|
10
|
+
URL,
|
|
11
|
+
ParseSheetDataCustomType,
|
|
12
|
+
ParseSheetDataValueType
|
|
13
|
+
} from './parseSheetDataValueType.d.js'
|
|
14
|
+
|
|
15
|
+
export interface ParseSheetDataValueRequiredError<
|
|
16
|
+
ColumnTitle extends string = string,
|
|
17
|
+
CustomType extends ParseSheetDataCustomType<unknown> = never
|
|
18
|
+
> {
|
|
19
|
+
row: number;
|
|
20
|
+
column: ColumnTitle;
|
|
21
|
+
// `type: undefined` is treated as `type: String`.
|
|
22
|
+
type?: ParseSheetDataValueType<CustomType>;
|
|
23
|
+
error: 'required';
|
|
24
|
+
reason: undefined;
|
|
25
|
+
// When `error` is `"required"`, `value` could only be `null` or `undefined`.
|
|
26
|
+
// * `null` means "cell is empty"
|
|
27
|
+
// * `undefined` means "column is missing"
|
|
28
|
+
value: null | undefined;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
interface ParseSheetDataError_<
|
|
32
|
+
ColumnTitle extends string,
|
|
33
|
+
// ` | undefined` is added to support `parseSheetData()` errors that originate
|
|
34
|
+
// on properties that have no `type` property specified. In such cases,
|
|
35
|
+
// `type` defaults to `String`.
|
|
36
|
+
//
|
|
37
|
+
// One could ask: "Why is then the `type` not simply marked as optional?".
|
|
38
|
+
// The answer is that `type` could only be `undefined` in case of `parseSheetData()` errors
|
|
39
|
+
// that originate from `type: String` parser while other type parsers can't have `type` be `undefined`.
|
|
40
|
+
//
|
|
41
|
+
Type extends ParseSheetDataValueType<unknown> | undefined,
|
|
42
|
+
ErrorMessage extends string,
|
|
43
|
+
ErrorReason extends string | undefined
|
|
44
|
+
> {
|
|
45
|
+
row: number;
|
|
46
|
+
column: ColumnTitle;
|
|
47
|
+
type: Type;
|
|
48
|
+
error: ErrorMessage;
|
|
49
|
+
reason: ErrorReason;
|
|
50
|
+
// When `error` is not `"required"`, `value` is known to not be `null` or `undefined`
|
|
51
|
+
// because when `value` is `null` or `undefined`, it won't be parsed at all,
|
|
52
|
+
// so there can't be any error thrown during parsing phase.
|
|
53
|
+
value: CellValue;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export type ParseSheetDataCustomTypeErrorMessage<
|
|
57
|
+
CustomType extends ParseSheetDataCustomType<unknown>
|
|
58
|
+
> = string
|
|
59
|
+
|
|
60
|
+
export type ParseSheetDataCustomTypeErrorReason<
|
|
61
|
+
CustomType extends ParseSheetDataCustomType<unknown>,
|
|
62
|
+
ErrorMessage extends ParseSheetDataCustomTypeErrorMessage<CustomType>
|
|
63
|
+
> = string | undefined
|
|
64
|
+
|
|
65
|
+
// This is just a public export. It's not used internally.
|
|
66
|
+
interface ParseSheetDataErrorCustomType<
|
|
67
|
+
ColumnTitle extends string = string,
|
|
68
|
+
CustomType extends ParseSheetDataCustomType<unknown> = never,
|
|
69
|
+
ErrorMessage extends ParseSheetDataCustomTypeErrorMessage<CustomType> = string,
|
|
70
|
+
ErrorReason extends ParseSheetDataCustomTypeErrorReason<CustomType, ErrorMessage> = string | undefined
|
|
71
|
+
> extends ParseSheetDataError_<
|
|
72
|
+
ColumnTitle,
|
|
73
|
+
CustomType,
|
|
74
|
+
ErrorMessage,
|
|
75
|
+
ErrorReason
|
|
76
|
+
> {}
|
|
77
|
+
|
|
78
|
+
interface ParseSheetDataErrorNotABoolean<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
79
|
+
ColumnTitle,
|
|
80
|
+
BooleanType,
|
|
81
|
+
'not_a_boolean',
|
|
82
|
+
undefined
|
|
83
|
+
> {
|
|
84
|
+
value: Exclude<CellValue, boolean>;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
interface ParseSheetDataErrorNotADate<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
88
|
+
ColumnTitle,
|
|
89
|
+
DateType,
|
|
90
|
+
'not_a_date',
|
|
91
|
+
undefined
|
|
92
|
+
> {
|
|
93
|
+
value: Exclude<CellValue, typeof Date | number>;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
interface ParseSheetDataErrorDateOutOfBounds<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
97
|
+
ColumnTitle,
|
|
98
|
+
DateType,
|
|
99
|
+
'out_of_bounds',
|
|
100
|
+
undefined
|
|
101
|
+
> {
|
|
102
|
+
value: typeof Date;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
interface ParseSheetDataErrorNotAString<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
106
|
+
ColumnTitle,
|
|
107
|
+
StringType | undefined,
|
|
108
|
+
'not_a_string',
|
|
109
|
+
undefined
|
|
110
|
+
> {
|
|
111
|
+
value: Exclude<CellValue, string | number>;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
interface ParseSheetDataErrorStringInvalidNumber<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
115
|
+
ColumnTitle,
|
|
116
|
+
StringType | undefined,
|
|
117
|
+
'invalid_number',
|
|
118
|
+
undefined
|
|
119
|
+
> {
|
|
120
|
+
value: number;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
interface ParseSheetDataErrorStringNumberOutOfBounds<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
124
|
+
ColumnTitle,
|
|
125
|
+
StringType | undefined,
|
|
126
|
+
'out_of_bounds',
|
|
127
|
+
undefined
|
|
128
|
+
> {
|
|
129
|
+
value: number;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
interface ParseSheetDataErrorNotANumber<
|
|
133
|
+
ColumnTitle extends string = string,
|
|
134
|
+
Type extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
135
|
+
> extends ParseSheetDataError_<
|
|
136
|
+
ColumnTitle,
|
|
137
|
+
Type,
|
|
138
|
+
'not_a_number',
|
|
139
|
+
undefined
|
|
140
|
+
> {
|
|
141
|
+
value: Exclude<CellValue, number | string>;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
interface ParseSheetDataErrorNotANumberString<
|
|
145
|
+
ColumnTitle extends string = string,
|
|
146
|
+
Type extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
147
|
+
> extends ParseSheetDataError_<
|
|
148
|
+
ColumnTitle,
|
|
149
|
+
Type,
|
|
150
|
+
'not_a_number',
|
|
151
|
+
undefined
|
|
152
|
+
> {
|
|
153
|
+
value: string;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
interface ParseSheetDataErrorNumberInvalid<
|
|
157
|
+
ColumnTitle extends string = string,
|
|
158
|
+
Type extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
159
|
+
> extends ParseSheetDataError_<
|
|
160
|
+
ColumnTitle,
|
|
161
|
+
Type,
|
|
162
|
+
'invalid_number',
|
|
163
|
+
undefined
|
|
164
|
+
> {
|
|
165
|
+
value: number | string;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
interface ParseSheetDataErrorNumberOutOfBounds<
|
|
169
|
+
ColumnTitle extends string = string,
|
|
170
|
+
Type extends ParseSheetDataCustomType<unknown> | undefined = NumberType
|
|
171
|
+
> extends ParseSheetDataError_<
|
|
172
|
+
ColumnTitle,
|
|
173
|
+
Type,
|
|
174
|
+
'out_of_bounds',
|
|
175
|
+
undefined
|
|
176
|
+
> {
|
|
177
|
+
value: number | string;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
type ParseSheetDataBaseValueTypeError<ColumnTitle extends string = string> =
|
|
181
|
+
| ParseSheetDataErrorNotABoolean<ColumnTitle>
|
|
182
|
+
| ParseSheetDataErrorNotADate<ColumnTitle>
|
|
183
|
+
| ParseSheetDataErrorDateOutOfBounds<ColumnTitle>
|
|
184
|
+
| ParseSheetDataErrorNotAString<ColumnTitle>
|
|
185
|
+
| ParseSheetDataErrorStringInvalidNumber<ColumnTitle>
|
|
186
|
+
| ParseSheetDataErrorStringNumberOutOfBounds<ColumnTitle>
|
|
187
|
+
| ParseSheetDataErrorNotANumber<ColumnTitle, NumberType>
|
|
188
|
+
| ParseSheetDataErrorNotANumberString<ColumnTitle, NumberType>
|
|
189
|
+
| ParseSheetDataErrorNumberInvalid<ColumnTitle, NumberType>
|
|
190
|
+
| ParseSheetDataErrorNumberOutOfBounds<ColumnTitle, NumberType>;
|
|
191
|
+
|
|
192
|
+
interface ParseSheetDataErrorNotAnInteger<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
193
|
+
ColumnTitle,
|
|
194
|
+
typeof Integer,
|
|
195
|
+
'not_an_integer',
|
|
196
|
+
undefined
|
|
197
|
+
> {
|
|
198
|
+
value: number | string;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
interface ParseSheetDataErrorIntegerNotANumber<ColumnTitle extends string = string> extends ParseSheetDataErrorNotANumber<ColumnTitle, typeof Integer> {}
|
|
202
|
+
interface ParseSheetDataErrorIntegerNotANumberString<ColumnTitle extends string = string> extends ParseSheetDataErrorNotANumberString<ColumnTitle, typeof Integer> {}
|
|
203
|
+
interface ParseSheetDataErrorIntegerNumberInvalid<ColumnTitle extends string = string> extends ParseSheetDataErrorNumberInvalid<ColumnTitle, typeof Integer> {}
|
|
204
|
+
interface ParseSheetDataErrorIntegerNumberOutOfBounds<ColumnTitle extends string = string> extends ParseSheetDataErrorNumberOutOfBounds<ColumnTitle, typeof Integer> {}
|
|
205
|
+
|
|
206
|
+
interface ParseSheetDataErrorNotAUrl<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
207
|
+
ColumnTitle,
|
|
208
|
+
typeof URL,
|
|
209
|
+
'not_a_url',
|
|
210
|
+
undefined
|
|
211
|
+
> {
|
|
212
|
+
value: string;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
interface ParseSheetDataErrorUrlNotAString<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
216
|
+
ColumnTitle,
|
|
217
|
+
typeof URL,
|
|
218
|
+
'not_a_string',
|
|
219
|
+
undefined
|
|
220
|
+
> {
|
|
221
|
+
value: Exclude<CellValue, string>;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
interface ParseSheetDataErrorNotAnEmail<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
225
|
+
ColumnTitle,
|
|
226
|
+
typeof Email,
|
|
227
|
+
'not_an_email',
|
|
228
|
+
undefined
|
|
229
|
+
> {
|
|
230
|
+
value: string;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
interface ParseSheetDataErrorEmailNotAString<ColumnTitle extends string = string> extends ParseSheetDataError_<
|
|
234
|
+
ColumnTitle,
|
|
235
|
+
typeof Email,
|
|
236
|
+
'not_a_string',
|
|
237
|
+
undefined
|
|
238
|
+
> {
|
|
239
|
+
value: Exclude<CellValue, string>;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
type ParseSheetDataAdditionalValueTypeError<ColumnTitle extends string = string> =
|
|
243
|
+
| ParseSheetDataErrorNotAnInteger<ColumnTitle>
|
|
244
|
+
| ParseSheetDataErrorIntegerNotANumber<ColumnTitle>
|
|
245
|
+
| ParseSheetDataErrorIntegerNotANumberString<ColumnTitle>
|
|
246
|
+
| ParseSheetDataErrorIntegerNumberInvalid<ColumnTitle>
|
|
247
|
+
| ParseSheetDataErrorIntegerNumberOutOfBounds<ColumnTitle>
|
|
248
|
+
| ParseSheetDataErrorNotAUrl<ColumnTitle>
|
|
249
|
+
| ParseSheetDataErrorUrlNotAString<ColumnTitle>
|
|
250
|
+
| ParseSheetDataErrorNotAnEmail<ColumnTitle>
|
|
251
|
+
| ParseSheetDataErrorEmailNotAString<ColumnTitle>;
|
|
252
|
+
|
|
253
|
+
type ParseSheetDataBuiltInValueTypeError<ColumnTitle extends string = string> =
|
|
254
|
+
| ParseSheetDataBaseValueTypeError<ColumnTitle>
|
|
255
|
+
| ParseSheetDataAdditionalValueTypeError<ColumnTitle>;
|
|
256
|
+
|
|
257
|
+
interface ParseSheetDataArrayValueNotAStringError<
|
|
258
|
+
ColumnTitle extends string = string,
|
|
259
|
+
ParseSheetDataCustomType_ extends ParseSheetDataCustomType<unknown> = ParseSheetDataCustomType<unknown>
|
|
260
|
+
> extends ParseSheetDataError_<
|
|
261
|
+
ColumnTitle,
|
|
262
|
+
ParseSheetDataValueType<ParseSheetDataCustomType_>,
|
|
263
|
+
'not_a_string',
|
|
264
|
+
undefined
|
|
265
|
+
> {}
|
|
266
|
+
|
|
267
|
+
interface ParseSheetDataArrayValueSyntaxError<
|
|
268
|
+
ColumnTitle extends string = string,
|
|
269
|
+
ParseSheetDataCustomType_ extends ParseSheetDataCustomType<unknown> = ParseSheetDataCustomType<unknown>
|
|
270
|
+
> extends ParseSheetDataError_<
|
|
271
|
+
ColumnTitle,
|
|
272
|
+
ParseSheetDataValueType<ParseSheetDataCustomType_>,
|
|
273
|
+
'invalid',
|
|
274
|
+
'syntax'
|
|
275
|
+
> {}
|
|
276
|
+
|
|
277
|
+
export type ParseSheetDataError<
|
|
278
|
+
ColumnTitle extends string = string,
|
|
279
|
+
CustomType extends ParseSheetDataCustomType<unknown> = never,
|
|
280
|
+
ErrorMessage extends ParseSheetDataCustomTypeErrorMessage<CustomType> = string,
|
|
281
|
+
ErrorReason extends ParseSheetDataCustomTypeErrorReason<CustomType, ErrorMessage> = string | undefined
|
|
282
|
+
> =
|
|
283
|
+
| ParseSheetDataBuiltInValueTypeError<ColumnTitle>
|
|
284
|
+
| ParseSheetDataValueRequiredError<ColumnTitle, ParseSheetDataValueType<CustomType>>
|
|
285
|
+
| ParseSheetDataArrayValueNotAStringError<ColumnTitle, ParseSheetDataValueType<CustomType>>
|
|
286
|
+
| ParseSheetDataArrayValueSyntaxError<ColumnTitle, ParseSheetDataValueType<CustomType>>
|
|
287
|
+
| ParseSheetDataErrorCustomType<
|
|
288
|
+
ColumnTitle,
|
|
289
|
+
ParseSheetDataValueType<CustomType>,
|
|
290
|
+
ErrorMessage,
|
|
291
|
+
ErrorReason
|
|
292
|
+
>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ParseSheetDataValueType, ParseSheetDataCustomType } from './parseSheetDataValueType.d.js'
|
|
2
2
|
|
|
3
3
|
type SchemaEntryRequiredOrNot<Object> = boolean | ((row: Object) => boolean);
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@ interface SchemaEntryForValue<
|
|
|
9
9
|
ColumnTitle extends string
|
|
10
10
|
> {
|
|
11
11
|
column: ColumnTitle;
|
|
12
|
-
type?:
|
|
12
|
+
type?: ParseSheetDataValueType<ParseSheetDataCustomType<Object[Key]>>;
|
|
13
13
|
oneOf?: Object[Key][];
|
|
14
14
|
required?: SchemaEntryRequiredOrNot<TopLevelObject>;
|
|
15
15
|
validate?(value: Object[Key]): void;
|
package/types/{parseData/parseDataValueType.d.ts → parseSheetData/parseSheetDataValueType.d.ts}
RENAMED
|
@@ -21,7 +21,7 @@ export type NumberType = Constructor<Number>;
|
|
|
21
21
|
export type BooleanType = Constructor<Boolean>;
|
|
22
22
|
|
|
23
23
|
// Parsed value `type` (foundational ones).
|
|
24
|
-
type
|
|
24
|
+
type ParseSheetDataBaseType =
|
|
25
25
|
Constructor<String> |
|
|
26
26
|
Constructor<Date> |
|
|
27
27
|
Constructor<Number> |
|
|
@@ -32,7 +32,7 @@ export function Integer(value: CellValue): number;
|
|
|
32
32
|
export function URL(value: CellValue): string;
|
|
33
33
|
export function Email(value: CellValue): string;
|
|
34
34
|
|
|
35
|
-
type
|
|
35
|
+
type ParseSheetDataAdditionalType =
|
|
36
36
|
| typeof Integer
|
|
37
37
|
| typeof URL
|
|
38
38
|
| typeof Email;
|
|
@@ -41,10 +41,10 @@ type ParseDataAdditionalType =
|
|
|
41
41
|
// A function that receives a cell `value` and returns a "parsed" value.
|
|
42
42
|
// Returning `undefined` will have same effect as returning `null`.
|
|
43
43
|
// When cell value is `undefined` or `null`, its `type` is completely ignored (skipped).
|
|
44
|
-
export type
|
|
44
|
+
export type ParseSheetDataCustomType<ParsedValue> = (value: CellValue) => ParsedValue | undefined;
|
|
45
45
|
|
|
46
46
|
// Schema entry `type`: foundational ones, additional ones, custom ones.
|
|
47
|
-
export type
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
47
|
+
export type ParseSheetDataValueType<ParseSheetDataCustomType> =
|
|
48
|
+
| ParseSheetDataBaseType
|
|
49
|
+
| ParseSheetDataAdditionalType
|
|
50
|
+
| ParseSheetDataCustomType;
|
package/universal/index.cjs
CHANGED
|
@@ -3,8 +3,8 @@ exports['default'] = require('../commonjs/export/readXlsxFileUniversal.js').defa
|
|
|
3
3
|
|
|
4
4
|
exports.readSheet = require('../commonjs/export/readSheetUniversal.js').default
|
|
5
5
|
|
|
6
|
-
// `
|
|
7
|
-
exports.
|
|
8
|
-
exports.Integer = require('../commonjs/
|
|
9
|
-
exports.Email = require('../commonjs/
|
|
10
|
-
exports.URL = require('../commonjs/
|
|
6
|
+
// `parseSheetData()`
|
|
7
|
+
exports.parseSheetData = require('../commonjs/parseSheetData/parseSheetData.js').default
|
|
8
|
+
exports.Integer = require('../commonjs/parseSheetData/types/additional/Integer.js').default
|
|
9
|
+
exports.Email = require('../commonjs/parseSheetData/types/additional/Email.js').default
|
|
10
|
+
exports.URL = require('../commonjs/parseSheetData/types/additional/URL.js').default
|
package/universal/index.d.ts
CHANGED
|
@@ -10,17 +10,17 @@ import {
|
|
|
10
10
|
} from '../types/types.d.js';
|
|
11
11
|
|
|
12
12
|
import {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
} from '../types/
|
|
13
|
+
ParseSheetDataOptions,
|
|
14
|
+
ParseSheetDataResult
|
|
15
|
+
} from '../types/parseSheetData/parseSheetData.d.js';
|
|
16
16
|
|
|
17
17
|
import {
|
|
18
18
|
Schema
|
|
19
|
-
} from '../types/
|
|
19
|
+
} from '../types/parseSheetData/parseSheetDataSchema.d.js';
|
|
20
20
|
|
|
21
21
|
import {
|
|
22
|
-
|
|
23
|
-
} from '../types/
|
|
22
|
+
ParseSheetDataError
|
|
23
|
+
} from '../types/parseSheetData/parseSheetDataError.d.js';
|
|
24
24
|
|
|
25
25
|
export {
|
|
26
26
|
CellValue,
|
|
@@ -30,7 +30,7 @@ export {
|
|
|
30
30
|
} from '../types/types.d.js';
|
|
31
31
|
|
|
32
32
|
export {
|
|
33
|
-
|
|
33
|
+
ParseSheetDataCustomType,
|
|
34
34
|
// Base `type`s when parsing data.
|
|
35
35
|
StringType as String,
|
|
36
36
|
DateType as Date,
|
|
@@ -40,22 +40,22 @@ export {
|
|
|
40
40
|
Integer,
|
|
41
41
|
Email,
|
|
42
42
|
URL
|
|
43
|
-
} from '../types/
|
|
43
|
+
} from '../types/parseSheetData/parseSheetDataValueType.d.js';
|
|
44
44
|
|
|
45
45
|
export {
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
} from '../types/
|
|
46
|
+
ParseSheetDataCustomTypeErrorMessage,
|
|
47
|
+
ParseSheetDataCustomTypeErrorReason,
|
|
48
|
+
ParseSheetDataError,
|
|
49
|
+
ParseSheetDataValueRequiredError
|
|
50
|
+
} from '../types/parseSheetData/parseSheetDataError.d.js';
|
|
51
51
|
|
|
52
52
|
export {
|
|
53
|
-
|
|
54
|
-
} from '../types/
|
|
53
|
+
ParseSheetDataResult
|
|
54
|
+
} from '../types/parseSheetData/parseSheetData.d.js';
|
|
55
55
|
|
|
56
56
|
export {
|
|
57
57
|
Schema
|
|
58
|
-
} from '../types/
|
|
58
|
+
} from '../types/parseSheetData/parseSheetDataSchema.d.js';
|
|
59
59
|
|
|
60
60
|
export default function readXlsxFile<ParsedNumber = number>(
|
|
61
61
|
input: Input,
|
|
@@ -73,12 +73,12 @@ export function readSheet<ParsedNumber = number>(
|
|
|
73
73
|
options?: ReadOptions<ParsedNumber>
|
|
74
74
|
): Promise<SheetData<ParsedNumber>>;
|
|
75
75
|
|
|
76
|
-
export function
|
|
76
|
+
export function parseSheetData<
|
|
77
77
|
Object extends object,
|
|
78
78
|
ColumnTitle extends string,
|
|
79
|
-
Error extends
|
|
79
|
+
Error extends ParseSheetDataError
|
|
80
80
|
>(
|
|
81
81
|
data: SheetData,
|
|
82
82
|
schema: Schema<Object, ColumnTitle>,
|
|
83
|
-
options?:
|
|
84
|
-
):
|
|
83
|
+
options?: ParseSheetDataOptions
|
|
84
|
+
): ParseSheetDataResult<Object, Error>;
|
package/universal/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export { default as default } from '../modules/export/readXlsxFileUniversal.js'
|
|
2
2
|
export { default as readSheet } from '../modules/export/readSheetUniversal.js'
|
|
3
3
|
|
|
4
|
-
// `
|
|
5
|
-
export { default as
|
|
6
|
-
export { default as Integer } from '../modules/
|
|
7
|
-
export { default as Email } from '../modules/
|
|
8
|
-
export { default as URL } from '../modules/
|
|
4
|
+
// `parseSheetData()`
|
|
5
|
+
export { default as parseSheetData } from '../modules/parseSheetData/parseSheetData.js'
|
|
6
|
+
export { default as Integer } from '../modules/parseSheetData/types/additional/Integer.js'
|
|
7
|
+
export { default as Email } from '../modules/parseSheetData/types/additional/Email.js'
|
|
8
|
+
export { default as URL } from '../modules/parseSheetData/types/additional/URL.js'
|
package/web-worker/index.cjs
CHANGED
|
@@ -3,8 +3,8 @@ exports['default'] = require('../commonjs/export/readXlsxFileWebWorker.js').defa
|
|
|
3
3
|
|
|
4
4
|
exports.readSheet = require('../commonjs/export/readSheetWebWorker.js').default
|
|
5
5
|
|
|
6
|
-
// `
|
|
7
|
-
exports.
|
|
8
|
-
exports.Integer = require('../commonjs/
|
|
9
|
-
exports.Email = require('../commonjs/
|
|
10
|
-
exports.URL = require('../commonjs/
|
|
6
|
+
// `parseSheetData()`
|
|
7
|
+
exports.parseSheetData = require('../commonjs/parseSheetData/parseSheetData.js').default
|
|
8
|
+
exports.Integer = require('../commonjs/parseSheetData/types/additional/Integer.js').default
|
|
9
|
+
exports.Email = require('../commonjs/parseSheetData/types/additional/Email.js').default
|
|
10
|
+
exports.URL = require('../commonjs/parseSheetData/types/additional/URL.js').default
|
package/web-worker/index.d.ts
CHANGED
|
@@ -10,17 +10,17 @@ import {
|
|
|
10
10
|
} from '../types/types.d.js';
|
|
11
11
|
|
|
12
12
|
import {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
} from '../types/
|
|
13
|
+
ParseSheetDataOptions,
|
|
14
|
+
ParseSheetDataResult
|
|
15
|
+
} from '../types/parseSheetData/parseSheetData.d.js';
|
|
16
16
|
|
|
17
17
|
import {
|
|
18
18
|
Schema
|
|
19
|
-
} from '../types/
|
|
19
|
+
} from '../types/parseSheetData/parseSheetDataSchema.d.js';
|
|
20
20
|
|
|
21
21
|
import {
|
|
22
|
-
|
|
23
|
-
} from '../types/
|
|
22
|
+
ParseSheetDataError
|
|
23
|
+
} from '../types/parseSheetData/parseSheetDataError.d.js';
|
|
24
24
|
|
|
25
25
|
export {
|
|
26
26
|
CellValue,
|
|
@@ -30,7 +30,7 @@ export {
|
|
|
30
30
|
} from '../types/types.d.js';
|
|
31
31
|
|
|
32
32
|
export {
|
|
33
|
-
|
|
33
|
+
ParseSheetDataCustomType,
|
|
34
34
|
// Base `type`s when parsing data.
|
|
35
35
|
StringType as String,
|
|
36
36
|
DateType as Date,
|
|
@@ -40,22 +40,22 @@ export {
|
|
|
40
40
|
Integer,
|
|
41
41
|
Email,
|
|
42
42
|
URL
|
|
43
|
-
} from '../types/
|
|
43
|
+
} from '../types/parseSheetData/parseSheetDataValueType.d.js';
|
|
44
44
|
|
|
45
45
|
export {
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
} from '../types/
|
|
46
|
+
ParseSheetDataCustomTypeErrorMessage,
|
|
47
|
+
ParseSheetDataCustomTypeErrorReason,
|
|
48
|
+
ParseSheetDataError,
|
|
49
|
+
ParseSheetDataValueRequiredError
|
|
50
|
+
} from '../types/parseSheetData/parseSheetDataError.d.js';
|
|
51
51
|
|
|
52
52
|
export {
|
|
53
|
-
|
|
54
|
-
} from '../types/
|
|
53
|
+
ParseSheetDataResult
|
|
54
|
+
} from '../types/parseSheetData/parseSheetData.d.js';
|
|
55
55
|
|
|
56
56
|
export {
|
|
57
57
|
Schema
|
|
58
|
-
} from '../types/
|
|
58
|
+
} from '../types/parseSheetData/parseSheetDataSchema.d.js';
|
|
59
59
|
|
|
60
60
|
export default function readXlsxFile<ParsedNumber = number>(
|
|
61
61
|
input: Input,
|
|
@@ -73,12 +73,12 @@ export function readSheet<ParsedNumber = number>(
|
|
|
73
73
|
options?: ReadOptions<ParsedNumber>
|
|
74
74
|
): Promise<SheetData<ParsedNumber>>;
|
|
75
75
|
|
|
76
|
-
export function
|
|
76
|
+
export function parseSheetData<
|
|
77
77
|
Object extends object,
|
|
78
78
|
ColumnTitle extends string,
|
|
79
|
-
Error extends
|
|
79
|
+
Error extends ParseSheetDataError
|
|
80
80
|
>(
|
|
81
81
|
data: SheetData,
|
|
82
82
|
schema: Schema<Object, ColumnTitle>,
|
|
83
|
-
options?:
|
|
84
|
-
):
|
|
83
|
+
options?: ParseSheetDataOptions
|
|
84
|
+
): ParseSheetDataResult<Object, Error>;
|
package/web-worker/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export { default as default } from '../modules/export/readXlsxFileWebWorker.js'
|
|
2
2
|
export { default as readSheet } from '../modules/export/readSheetWebWorker.js'
|
|
3
3
|
|
|
4
|
-
// `
|
|
5
|
-
export { default as
|
|
6
|
-
export { default as Integer } from '../modules/
|
|
7
|
-
export { default as Email } from '../modules/
|
|
8
|
-
export { default as URL } from '../modules/
|
|
4
|
+
// `parseSheetData()`
|
|
5
|
+
export { default as parseSheetData } from '../modules/parseSheetData/parseSheetData.js'
|
|
6
|
+
export { default as Integer } from '../modules/parseSheetData/types/additional/Integer.js'
|
|
7
|
+
export { default as Email } from '../modules/parseSheetData/types/additional/Email.js'
|
|
8
|
+
export { default as URL } from '../modules/parseSheetData/types/additional/URL.js'
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"InvalidError.js","names":["InvalidError","exports","_Error","_inherits","_super","_createSuper","reason","_this","_classCallCheck","call","_createClass","_wrapNativeSuper","Error"],"sources":["../../source/parseData/InvalidError.js"],"sourcesContent":["export default class InvalidError extends Error {\r\n constructor(reason) {\r\n super('invalid')\r\n this.reason = reason\r\n }\r\n}"],"mappings":";;;;;;;;;;;;;;;;;;;;;;IAAqBA,YAAY,GAAAC,OAAA,qCAAAC,MAAA;EAAAC,SAAA,CAAAH,YAAA,EAAAE,MAAA;EAAA,IAAAE,MAAA,GAAAC,YAAA,CAAAL,YAAA;EAC/B,SAAAA,aAAYM,MAAM,EAAE;IAAA,IAAAC,KAAA;IAAAC,eAAA,OAAAR,YAAA;IAClBO,KAAA,GAAAH,MAAA,CAAAK,IAAA,OAAM,SAAS;IACfF,KAAA,CAAKD,MAAM,GAAGA,MAAM;IAAA,OAAAC,KAAA;EACtB;EAAC,OAAAG,YAAA,CAAAV,YAAA;AAAA,gBAAAW,gBAAA,CAJuCC,KAAK"}
|