@internetarchive/metadata-service 0.0.1-alpha.1 → 0.1.1
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/.editorconfig +29 -29
- package/.github/workflows/ci.yml +27 -26
- package/LICENSE +661 -661
- package/README.md +64 -64
- package/demo/index.html +27 -27
- package/dist/demo/app-root.d.ts +11 -11
- package/dist/demo/app-root.js +41 -41
- package/dist/index.d.ts +18 -18
- package/dist/index.js +16 -16
- package/dist/src/backend/default-metadata-backend.d.ts +27 -27
- package/dist/src/backend/default-metadata-backend.js +100 -100
- package/dist/src/backend/metadata-backend-interface.d.ts +20 -20
- package/dist/src/backend/metadata-backend-interface.js +1 -1
- package/dist/src/metadata-service-error.d.ts +11 -11
- package/dist/src/metadata-service-error.js +17 -17
- package/dist/src/metadata-service-interface.d.ts +44 -44
- package/dist/src/metadata-service-interface.js +1 -1
- package/dist/src/metadata-service.d.ts +18 -18
- package/dist/src/metadata-service.js +42 -42
- package/dist/src/models/file.d.ts +29 -29
- package/dist/src/models/file.js +94 -94
- package/dist/src/models/metadata-fields/field-types/boolean.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/boolean.js +7 -7
- package/dist/src/models/metadata-fields/field-types/byte.d.ts +13 -13
- package/dist/src/models/metadata-fields/field-types/byte.js +15 -15
- package/dist/src/models/metadata-fields/field-types/date.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/date.js +7 -7
- package/dist/src/models/metadata-fields/field-types/duration.d.ts +14 -14
- package/dist/src/models/metadata-fields/field-types/duration.js +16 -16
- package/dist/src/models/metadata-fields/field-types/list.d.ts +25 -25
- package/dist/src/models/metadata-fields/field-types/list.js +33 -33
- package/dist/src/models/metadata-fields/field-types/mediatype.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/mediatype.js +7 -7
- package/dist/src/models/metadata-fields/field-types/number.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/number.js +7 -7
- package/dist/src/models/metadata-fields/field-types/page-progression.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/page-progression.js +7 -7
- package/dist/src/models/metadata-fields/field-types/string.d.ts +5 -5
- package/dist/src/models/metadata-fields/field-types/string.js +7 -7
- package/dist/src/models/metadata-fields/metadata-field.d.ts +70 -70
- package/dist/src/models/metadata-fields/metadata-field.js +66 -66
- package/dist/src/models/metadata.d.ts +169 -168
- package/dist/src/models/metadata.js +626 -617
- package/dist/src/models/metadata.js.map +1 -1
- package/dist/src/models/review.d.ts +10 -10
- package/dist/src/models/review.js +42 -42
- package/dist/src/models/speech-music-asr-entry.d.ts +10 -10
- package/dist/src/models/speech-music-asr-entry.js +1 -1
- package/dist/src/responses/metadata-response.d.ts +28 -28
- package/dist/src/responses/metadata-response.js +30 -30
- package/dist/test/default-metadata-backend.test.d.ts +1 -1
- package/dist/test/default-metadata-backend.test.js +90 -90
- package/dist/test/metadata-service.test.d.ts +1 -1
- package/dist/test/metadata-service.test.js +98 -98
- package/dist/test/mock-response-generator.d.ts +3 -3
- package/dist/test/mock-response-generator.js +61 -61
- package/dist/test/models/file.test.d.ts +1 -1
- package/dist/test/models/file.test.js +8 -8
- package/dist/test/models/metadata-fields/list-field.test.d.ts +1 -1
- package/dist/test/models/metadata-fields/list-field.test.js +51 -51
- package/dist/test/models/metadata-fields/metadata-field.test.d.ts +1 -1
- package/dist/test/models/metadata-fields/metadata-field.test.js +120 -120
- package/dist/test/models/metadata.test.d.ts +1 -1
- package/dist/test/models/metadata.test.js +9 -9
- package/package.json +1 -1
- package/src/models/metadata.ts +6 -0
- package/tsconfig.json +22 -22
- package/web-test-runner.config.mjs +7 -7
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { ByteParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
/**
|
|
4
|
-
* ByteField is a unit-specific number field that
|
|
5
|
-
* returns a value in bytes
|
|
6
|
-
*
|
|
7
|
-
* @export
|
|
8
|
-
* @class ByteField
|
|
9
|
-
* @extends {MetadataField<Byte, ByteParser>}
|
|
10
|
-
*/
|
|
11
|
-
export class ByteField extends MetadataField {
|
|
12
|
-
constructor(rawValue) {
|
|
13
|
-
super(ByteParser.shared, rawValue);
|
|
14
|
-
}
|
|
15
|
-
}
|
|
1
|
+
import { ByteParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
/**
|
|
4
|
+
* ByteField is a unit-specific number field that
|
|
5
|
+
* returns a value in bytes
|
|
6
|
+
*
|
|
7
|
+
* @export
|
|
8
|
+
* @class ByteField
|
|
9
|
+
* @extends {MetadataField<Byte, ByteParser>}
|
|
10
|
+
*/
|
|
11
|
+
export class ByteField extends MetadataField {
|
|
12
|
+
constructor(rawValue) {
|
|
13
|
+
super(ByteParser.shared, rawValue);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
16
|
//# sourceMappingURL=byte.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { DateParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
export declare class DateField extends MetadataField<Date, DateParser> {
|
|
4
|
-
constructor(rawValue: MetadataRawValue);
|
|
5
|
-
}
|
|
1
|
+
import { DateParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
export declare class DateField extends MetadataField<Date, DateParser> {
|
|
4
|
+
constructor(rawValue: MetadataRawValue);
|
|
5
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { DateParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
export class DateField extends MetadataField {
|
|
4
|
-
constructor(rawValue) {
|
|
5
|
-
super(DateParser.shared, rawValue);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
1
|
+
import { DateParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
export class DateField extends MetadataField {
|
|
4
|
+
constructor(rawValue) {
|
|
5
|
+
super(DateParser.shared, rawValue);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
8
|
//# sourceMappingURL=date.js.map
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { Duration, DurationParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
/**
|
|
4
|
-
* The DurationField parses different duration formats
|
|
5
|
-
* and returns a `Duration`, which is a number in seconds
|
|
6
|
-
* with decimals.
|
|
7
|
-
*
|
|
8
|
-
* @export
|
|
9
|
-
* @class DurationField
|
|
10
|
-
* @extends {MetadataField<Duration, DurationParser>}
|
|
11
|
-
*/
|
|
12
|
-
export declare class DurationField extends MetadataField<Duration, DurationParser> {
|
|
13
|
-
constructor(rawValue: MetadataRawValue);
|
|
14
|
-
}
|
|
1
|
+
import { Duration, DurationParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
/**
|
|
4
|
+
* The DurationField parses different duration formats
|
|
5
|
+
* and returns a `Duration`, which is a number in seconds
|
|
6
|
+
* with decimals.
|
|
7
|
+
*
|
|
8
|
+
* @export
|
|
9
|
+
* @class DurationField
|
|
10
|
+
* @extends {MetadataField<Duration, DurationParser>}
|
|
11
|
+
*/
|
|
12
|
+
export declare class DurationField extends MetadataField<Duration, DurationParser> {
|
|
13
|
+
constructor(rawValue: MetadataRawValue);
|
|
14
|
+
}
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
import { DurationParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
/**
|
|
4
|
-
* The DurationField parses different duration formats
|
|
5
|
-
* and returns a `Duration`, which is a number in seconds
|
|
6
|
-
* with decimals.
|
|
7
|
-
*
|
|
8
|
-
* @export
|
|
9
|
-
* @class DurationField
|
|
10
|
-
* @extends {MetadataField<Duration, DurationParser>}
|
|
11
|
-
*/
|
|
12
|
-
export class DurationField extends MetadataField {
|
|
13
|
-
constructor(rawValue) {
|
|
14
|
-
super(DurationParser.shared, rawValue);
|
|
15
|
-
}
|
|
16
|
-
}
|
|
1
|
+
import { DurationParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
/**
|
|
4
|
+
* The DurationField parses different duration formats
|
|
5
|
+
* and returns a `Duration`, which is a number in seconds
|
|
6
|
+
* with decimals.
|
|
7
|
+
*
|
|
8
|
+
* @export
|
|
9
|
+
* @class DurationField
|
|
10
|
+
* @extends {MetadataField<Duration, DurationParser>}
|
|
11
|
+
*/
|
|
12
|
+
export class DurationField extends MetadataField {
|
|
13
|
+
constructor(rawValue) {
|
|
14
|
+
super(DurationParser.shared, rawValue);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
17
|
//# sourceMappingURL=duration.js.map
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
import { FieldParserInterface, ListParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
/**
|
|
4
|
-
* The ListField handles parsing of a list of values.
|
|
5
|
-
*
|
|
6
|
-
* Certain fields in the metadata, like `subject` typically have a
|
|
7
|
-
* comma or semicolon-separated list of values. The `ListField`
|
|
8
|
-
* parses the list values independently and aggregates them into
|
|
9
|
-
* the main `.values` array.
|
|
10
|
-
*/
|
|
11
|
-
export declare class ListField<T, FieldParserInterfaceType extends FieldParserInterface<T[]>> extends MetadataField<T, FieldParserInterfaceType> {
|
|
12
|
-
constructor(rawValue: MetadataRawValue, parser: FieldParserInterfaceType);
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* The StringListField handles parsing of a list of strings.
|
|
16
|
-
*/
|
|
17
|
-
export declare class StringListField extends ListField<string, ListParser<string>> {
|
|
18
|
-
constructor(rawValue: MetadataRawValue);
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* The NumberListField handles parsing of a list of numbers.
|
|
22
|
-
*/
|
|
23
|
-
export declare class NumberListField extends ListField<number, ListParser<number>> {
|
|
24
|
-
constructor(rawValue: MetadataRawValue);
|
|
25
|
-
}
|
|
1
|
+
import { FieldParserInterface, ListParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
/**
|
|
4
|
+
* The ListField handles parsing of a list of values.
|
|
5
|
+
*
|
|
6
|
+
* Certain fields in the metadata, like `subject` typically have a
|
|
7
|
+
* comma or semicolon-separated list of values. The `ListField`
|
|
8
|
+
* parses the list values independently and aggregates them into
|
|
9
|
+
* the main `.values` array.
|
|
10
|
+
*/
|
|
11
|
+
export declare class ListField<T, FieldParserInterfaceType extends FieldParserInterface<T[]>> extends MetadataField<T, FieldParserInterfaceType> {
|
|
12
|
+
constructor(rawValue: MetadataRawValue, parser: FieldParserInterfaceType);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* The StringListField handles parsing of a list of strings.
|
|
16
|
+
*/
|
|
17
|
+
export declare class StringListField extends ListField<string, ListParser<string>> {
|
|
18
|
+
constructor(rawValue: MetadataRawValue);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* The NumberListField handles parsing of a list of numbers.
|
|
22
|
+
*/
|
|
23
|
+
export declare class NumberListField extends ListField<number, ListParser<number>> {
|
|
24
|
+
constructor(rawValue: MetadataRawValue);
|
|
25
|
+
}
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
import { ListParser, NumberParser, StringParser, } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
/**
|
|
4
|
-
* The ListField handles parsing of a list of values.
|
|
5
|
-
*
|
|
6
|
-
* Certain fields in the metadata, like `subject` typically have a
|
|
7
|
-
* comma or semicolon-separated list of values. The `ListField`
|
|
8
|
-
* parses the list values independently and aggregates them into
|
|
9
|
-
* the main `.values` array.
|
|
10
|
-
*/
|
|
11
|
-
export class ListField extends MetadataField {
|
|
12
|
-
constructor(rawValue, parser) {
|
|
13
|
-
super(parser, rawValue);
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* The StringListField handles parsing of a list of strings.
|
|
18
|
-
*/
|
|
19
|
-
export class StringListField extends ListField {
|
|
20
|
-
constructor(rawValue) {
|
|
21
|
-
const parser = new ListParser(StringParser.shared);
|
|
22
|
-
super(rawValue, parser);
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* The NumberListField handles parsing of a list of numbers.
|
|
27
|
-
*/
|
|
28
|
-
export class NumberListField extends ListField {
|
|
29
|
-
constructor(rawValue) {
|
|
30
|
-
const parser = new ListParser(NumberParser.shared);
|
|
31
|
-
super(rawValue, parser);
|
|
32
|
-
}
|
|
33
|
-
}
|
|
1
|
+
import { ListParser, NumberParser, StringParser, } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
/**
|
|
4
|
+
* The ListField handles parsing of a list of values.
|
|
5
|
+
*
|
|
6
|
+
* Certain fields in the metadata, like `subject` typically have a
|
|
7
|
+
* comma or semicolon-separated list of values. The `ListField`
|
|
8
|
+
* parses the list values independently and aggregates them into
|
|
9
|
+
* the main `.values` array.
|
|
10
|
+
*/
|
|
11
|
+
export class ListField extends MetadataField {
|
|
12
|
+
constructor(rawValue, parser) {
|
|
13
|
+
super(parser, rawValue);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* The StringListField handles parsing of a list of strings.
|
|
18
|
+
*/
|
|
19
|
+
export class StringListField extends ListField {
|
|
20
|
+
constructor(rawValue) {
|
|
21
|
+
const parser = new ListParser(StringParser.shared);
|
|
22
|
+
super(rawValue, parser);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* The NumberListField handles parsing of a list of numbers.
|
|
27
|
+
*/
|
|
28
|
+
export class NumberListField extends ListField {
|
|
29
|
+
constructor(rawValue) {
|
|
30
|
+
const parser = new ListParser(NumberParser.shared);
|
|
31
|
+
super(rawValue, parser);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
34
|
//# sourceMappingURL=list.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { MediaType, MediaTypeParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
export declare class MediaTypeField extends MetadataField<MediaType, MediaTypeParser> {
|
|
4
|
-
constructor(rawValue: MetadataRawValue);
|
|
5
|
-
}
|
|
1
|
+
import { MediaType, MediaTypeParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
export declare class MediaTypeField extends MetadataField<MediaType, MediaTypeParser> {
|
|
4
|
+
constructor(rawValue: MetadataRawValue);
|
|
5
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { MediaTypeParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
export class MediaTypeField extends MetadataField {
|
|
4
|
-
constructor(rawValue) {
|
|
5
|
-
super(MediaTypeParser.shared, rawValue);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
1
|
+
import { MediaTypeParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
export class MediaTypeField extends MetadataField {
|
|
4
|
+
constructor(rawValue) {
|
|
5
|
+
super(MediaTypeParser.shared, rawValue);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
8
|
//# sourceMappingURL=mediatype.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { NumberParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
export declare class NumberField extends MetadataField<number, NumberParser> {
|
|
4
|
-
constructor(rawValue: MetadataRawValue);
|
|
5
|
-
}
|
|
1
|
+
import { NumberParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
export declare class NumberField extends MetadataField<number, NumberParser> {
|
|
4
|
+
constructor(rawValue: MetadataRawValue);
|
|
5
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { NumberParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
export class NumberField extends MetadataField {
|
|
4
|
-
constructor(rawValue) {
|
|
5
|
-
super(NumberParser.shared, rawValue);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
1
|
+
import { NumberParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
export class NumberField extends MetadataField {
|
|
4
|
+
constructor(rawValue) {
|
|
5
|
+
super(NumberParser.shared, rawValue);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
8
|
//# sourceMappingURL=number.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { PageProgression, PageProgressionParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
export declare class PageProgressionField extends MetadataField<PageProgression, PageProgressionParser> {
|
|
4
|
-
constructor(rawValue: MetadataRawValue);
|
|
5
|
-
}
|
|
1
|
+
import { PageProgression, PageProgressionParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
export declare class PageProgressionField extends MetadataField<PageProgression, PageProgressionParser> {
|
|
4
|
+
constructor(rawValue: MetadataRawValue);
|
|
5
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { PageProgressionParser, } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
export class PageProgressionField extends MetadataField {
|
|
4
|
-
constructor(rawValue) {
|
|
5
|
-
super(PageProgressionParser.shared, rawValue);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
1
|
+
import { PageProgressionParser, } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
export class PageProgressionField extends MetadataField {
|
|
4
|
+
constructor(rawValue) {
|
|
5
|
+
super(PageProgressionParser.shared, rawValue);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
8
|
//# sourceMappingURL=page-progression.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { StringParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
-
export declare class StringField extends MetadataField<string, StringParser> {
|
|
4
|
-
constructor(rawValue: MetadataRawValue);
|
|
5
|
-
}
|
|
1
|
+
import { StringParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField, MetadataRawValue } from '../metadata-field';
|
|
3
|
+
export declare class StringField extends MetadataField<string, StringParser> {
|
|
4
|
+
constructor(rawValue: MetadataRawValue);
|
|
5
|
+
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { StringParser } from '@internetarchive/field-parsers';
|
|
2
|
-
import { MetadataField } from '../metadata-field';
|
|
3
|
-
export class StringField extends MetadataField {
|
|
4
|
-
constructor(rawValue) {
|
|
5
|
-
super(StringParser.shared, rawValue);
|
|
6
|
-
}
|
|
7
|
-
}
|
|
1
|
+
import { StringParser } from '@internetarchive/field-parsers';
|
|
2
|
+
import { MetadataField } from '../metadata-field';
|
|
3
|
+
export class StringField extends MetadataField {
|
|
4
|
+
constructor(rawValue) {
|
|
5
|
+
super(StringParser.shared, rawValue);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
8
|
//# sourceMappingURL=string.js.map
|
|
@@ -1,70 +1,70 @@
|
|
|
1
|
-
import { FieldParserInterface } from '@internetarchive/field-parsers';
|
|
2
|
-
/**
|
|
3
|
-
* The MetadataRawValue is all of the possible raw types we can get for a field.
|
|
4
|
-
*
|
|
5
|
-
* This allows the parsers to know if they can handle the raw value or not and
|
|
6
|
-
* how to handle it if they can.
|
|
7
|
-
*/
|
|
8
|
-
export declare type MetadataRawValue = string | string[] | number | boolean;
|
|
9
|
-
export interface MetadataFieldInterface<T> {
|
|
10
|
-
/**
|
|
11
|
-
* The raw value received from the API response
|
|
12
|
-
*
|
|
13
|
-
* @type {MetadataRawValue}
|
|
14
|
-
* @memberof MetadataField
|
|
15
|
-
*/
|
|
16
|
-
rawValue?: MetadataRawValue;
|
|
17
|
-
/**
|
|
18
|
-
* The first value if there are multiple or the only value if there is one
|
|
19
|
-
*
|
|
20
|
-
* @readonly
|
|
21
|
-
* @type {(T | undefined)}
|
|
22
|
-
* @memberof MetadataField
|
|
23
|
-
*/
|
|
24
|
-
value?: T;
|
|
25
|
-
/**
|
|
26
|
-
* The array of all values for the field.
|
|
27
|
-
*
|
|
28
|
-
* Many fields only contain a single value and
|
|
29
|
-
* can be accessed via the `.value` getter
|
|
30
|
-
*
|
|
31
|
-
* @type {T[]}
|
|
32
|
-
* @memberof MetadataField
|
|
33
|
-
*/
|
|
34
|
-
values: T[];
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* The MetadataField is responsible for three things:
|
|
38
|
-
* 1. Take in some raw data (strings, arrays, numbers, etc)
|
|
39
|
-
* 2. Normalize the input to an array of the input,
|
|
40
|
-
* ie. [string, string], [number, number], [Date, Date], etc
|
|
41
|
-
* 3. Cast the values to their expected `Type`
|
|
42
|
-
*
|
|
43
|
-
* This class gets instiated with a `Type` and a parser of that type. For instance, the
|
|
44
|
-
* `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
|
|
45
|
-
*
|
|
46
|
-
* When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
|
|
47
|
-
* ie:
|
|
48
|
-
*
|
|
49
|
-
* ```
|
|
50
|
-
* const dateField = new DateField('2020-02-13')
|
|
51
|
-
* dateField.value = Date(2020-02-13) // native javascript Date object
|
|
52
|
-
* dateField.values = [Date(2020-02-13)] // the normalized array of values
|
|
53
|
-
* dateField.rawValue = '2020-02-13' // the raw string that was passed in
|
|
54
|
-
* ```
|
|
55
|
-
*
|
|
56
|
-
* @class MetadataField
|
|
57
|
-
* @template Type The type of metadata this is (string, number, Date, etc)
|
|
58
|
-
* @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
|
|
59
|
-
*/
|
|
60
|
-
export declare class MetadataField<Type, FieldParserInterfaceType extends FieldParserInterface<Type | Type[]>> implements MetadataFieldInterface<Type> {
|
|
61
|
-
/** @inheritdoc */
|
|
62
|
-
rawValue?: MetadataRawValue;
|
|
63
|
-
/** @inheritdoc */
|
|
64
|
-
get values(): Type[];
|
|
65
|
-
/** @inheritdoc */
|
|
66
|
-
get value(): Type | undefined;
|
|
67
|
-
constructor(parser: FieldParserInterfaceType, rawValue?: MetadataRawValue);
|
|
68
|
-
private parser;
|
|
69
|
-
private parseRawValue;
|
|
70
|
-
}
|
|
1
|
+
import { FieldParserInterface } from '@internetarchive/field-parsers';
|
|
2
|
+
/**
|
|
3
|
+
* The MetadataRawValue is all of the possible raw types we can get for a field.
|
|
4
|
+
*
|
|
5
|
+
* This allows the parsers to know if they can handle the raw value or not and
|
|
6
|
+
* how to handle it if they can.
|
|
7
|
+
*/
|
|
8
|
+
export declare type MetadataRawValue = string | string[] | number | boolean;
|
|
9
|
+
export interface MetadataFieldInterface<T> {
|
|
10
|
+
/**
|
|
11
|
+
* The raw value received from the API response
|
|
12
|
+
*
|
|
13
|
+
* @type {MetadataRawValue}
|
|
14
|
+
* @memberof MetadataField
|
|
15
|
+
*/
|
|
16
|
+
rawValue?: MetadataRawValue;
|
|
17
|
+
/**
|
|
18
|
+
* The first value if there are multiple or the only value if there is one
|
|
19
|
+
*
|
|
20
|
+
* @readonly
|
|
21
|
+
* @type {(T | undefined)}
|
|
22
|
+
* @memberof MetadataField
|
|
23
|
+
*/
|
|
24
|
+
value?: T;
|
|
25
|
+
/**
|
|
26
|
+
* The array of all values for the field.
|
|
27
|
+
*
|
|
28
|
+
* Many fields only contain a single value and
|
|
29
|
+
* can be accessed via the `.value` getter
|
|
30
|
+
*
|
|
31
|
+
* @type {T[]}
|
|
32
|
+
* @memberof MetadataField
|
|
33
|
+
*/
|
|
34
|
+
values: T[];
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The MetadataField is responsible for three things:
|
|
38
|
+
* 1. Take in some raw data (strings, arrays, numbers, etc)
|
|
39
|
+
* 2. Normalize the input to an array of the input,
|
|
40
|
+
* ie. [string, string], [number, number], [Date, Date], etc
|
|
41
|
+
* 3. Cast the values to their expected `Type`
|
|
42
|
+
*
|
|
43
|
+
* This class gets instiated with a `Type` and a parser of that type. For instance, the
|
|
44
|
+
* `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
|
|
45
|
+
*
|
|
46
|
+
* When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
|
|
47
|
+
* ie:
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
* const dateField = new DateField('2020-02-13')
|
|
51
|
+
* dateField.value = Date(2020-02-13) // native javascript Date object
|
|
52
|
+
* dateField.values = [Date(2020-02-13)] // the normalized array of values
|
|
53
|
+
* dateField.rawValue = '2020-02-13' // the raw string that was passed in
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @class MetadataField
|
|
57
|
+
* @template Type The type of metadata this is (string, number, Date, etc)
|
|
58
|
+
* @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
|
|
59
|
+
*/
|
|
60
|
+
export declare class MetadataField<Type, FieldParserInterfaceType extends FieldParserInterface<Type | Type[]>> implements MetadataFieldInterface<Type> {
|
|
61
|
+
/** @inheritdoc */
|
|
62
|
+
rawValue?: MetadataRawValue;
|
|
63
|
+
/** @inheritdoc */
|
|
64
|
+
get values(): Type[];
|
|
65
|
+
/** @inheritdoc */
|
|
66
|
+
get value(): Type | undefined;
|
|
67
|
+
constructor(parser: FieldParserInterfaceType, rawValue?: MetadataRawValue);
|
|
68
|
+
private parser;
|
|
69
|
+
private parseRawValue;
|
|
70
|
+
}
|
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
import { __decorate } from "tslib";
|
|
2
|
-
import { Memoize } from 'typescript-memoize';
|
|
3
|
-
/**
|
|
4
|
-
* The MetadataField is responsible for three things:
|
|
5
|
-
* 1. Take in some raw data (strings, arrays, numbers, etc)
|
|
6
|
-
* 2. Normalize the input to an array of the input,
|
|
7
|
-
* ie. [string, string], [number, number], [Date, Date], etc
|
|
8
|
-
* 3. Cast the values to their expected `Type`
|
|
9
|
-
*
|
|
10
|
-
* This class gets instiated with a `Type` and a parser of that type. For instance, the
|
|
11
|
-
* `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
|
|
12
|
-
*
|
|
13
|
-
* When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
|
|
14
|
-
* ie:
|
|
15
|
-
*
|
|
16
|
-
* ```
|
|
17
|
-
* const dateField = new DateField('2020-02-13')
|
|
18
|
-
* dateField.value = Date(2020-02-13) // native javascript Date object
|
|
19
|
-
* dateField.values = [Date(2020-02-13)] // the normalized array of values
|
|
20
|
-
* dateField.rawValue = '2020-02-13' // the raw string that was passed in
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @class MetadataField
|
|
24
|
-
* @template Type The type of metadata this is (string, number, Date, etc)
|
|
25
|
-
* @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
|
|
26
|
-
*/
|
|
27
|
-
export class MetadataField {
|
|
28
|
-
constructor(parser, rawValue) {
|
|
29
|
-
this.parser = parser;
|
|
30
|
-
this.rawValue = rawValue;
|
|
31
|
-
}
|
|
32
|
-
/** @inheritdoc */
|
|
33
|
-
get values() {
|
|
34
|
-
const values = this.parseRawValue();
|
|
35
|
-
return values;
|
|
36
|
-
}
|
|
37
|
-
/** @inheritdoc */
|
|
38
|
-
get value() {
|
|
39
|
-
return this.values[0];
|
|
40
|
-
}
|
|
41
|
-
parseRawValue() {
|
|
42
|
-
if (this.rawValue === undefined)
|
|
43
|
-
return [];
|
|
44
|
-
const rawValues = Array.isArray(this.rawValue)
|
|
45
|
-
? this.rawValue
|
|
46
|
-
: [this.rawValue];
|
|
47
|
-
const values = [];
|
|
48
|
-
rawValues.forEach(value => {
|
|
49
|
-
const parsed = this.parser.parseValue(value);
|
|
50
|
-
if (Array.isArray(parsed)) {
|
|
51
|
-
values.push(...parsed);
|
|
52
|
-
}
|
|
53
|
-
else {
|
|
54
|
-
if (parsed !== undefined)
|
|
55
|
-
values.push(parsed);
|
|
56
|
-
}
|
|
57
|
-
});
|
|
58
|
-
return values;
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
__decorate([
|
|
62
|
-
Memoize()
|
|
63
|
-
], MetadataField.prototype, "values", null);
|
|
64
|
-
__decorate([
|
|
65
|
-
Memoize()
|
|
66
|
-
], MetadataField.prototype, "value", null);
|
|
1
|
+
import { __decorate } from "tslib";
|
|
2
|
+
import { Memoize } from 'typescript-memoize';
|
|
3
|
+
/**
|
|
4
|
+
* The MetadataField is responsible for three things:
|
|
5
|
+
* 1. Take in some raw data (strings, arrays, numbers, etc)
|
|
6
|
+
* 2. Normalize the input to an array of the input,
|
|
7
|
+
* ie. [string, string], [number, number], [Date, Date], etc
|
|
8
|
+
* 3. Cast the values to their expected `Type`
|
|
9
|
+
*
|
|
10
|
+
* This class gets instiated with a `Type` and a parser of that type. For instance, the
|
|
11
|
+
* `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
|
|
12
|
+
*
|
|
13
|
+
* When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
|
|
14
|
+
* ie:
|
|
15
|
+
*
|
|
16
|
+
* ```
|
|
17
|
+
* const dateField = new DateField('2020-02-13')
|
|
18
|
+
* dateField.value = Date(2020-02-13) // native javascript Date object
|
|
19
|
+
* dateField.values = [Date(2020-02-13)] // the normalized array of values
|
|
20
|
+
* dateField.rawValue = '2020-02-13' // the raw string that was passed in
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* @class MetadataField
|
|
24
|
+
* @template Type The type of metadata this is (string, number, Date, etc)
|
|
25
|
+
* @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
|
|
26
|
+
*/
|
|
27
|
+
export class MetadataField {
|
|
28
|
+
constructor(parser, rawValue) {
|
|
29
|
+
this.parser = parser;
|
|
30
|
+
this.rawValue = rawValue;
|
|
31
|
+
}
|
|
32
|
+
/** @inheritdoc */
|
|
33
|
+
get values() {
|
|
34
|
+
const values = this.parseRawValue();
|
|
35
|
+
return values;
|
|
36
|
+
}
|
|
37
|
+
/** @inheritdoc */
|
|
38
|
+
get value() {
|
|
39
|
+
return this.values[0];
|
|
40
|
+
}
|
|
41
|
+
parseRawValue() {
|
|
42
|
+
if (this.rawValue === undefined)
|
|
43
|
+
return [];
|
|
44
|
+
const rawValues = Array.isArray(this.rawValue)
|
|
45
|
+
? this.rawValue
|
|
46
|
+
: [this.rawValue];
|
|
47
|
+
const values = [];
|
|
48
|
+
rawValues.forEach(value => {
|
|
49
|
+
const parsed = this.parser.parseValue(value);
|
|
50
|
+
if (Array.isArray(parsed)) {
|
|
51
|
+
values.push(...parsed);
|
|
52
|
+
}
|
|
53
|
+
else {
|
|
54
|
+
if (parsed !== undefined)
|
|
55
|
+
values.push(parsed);
|
|
56
|
+
}
|
|
57
|
+
});
|
|
58
|
+
return values;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
__decorate([
|
|
62
|
+
Memoize()
|
|
63
|
+
], MetadataField.prototype, "values", null);
|
|
64
|
+
__decorate([
|
|
65
|
+
Memoize()
|
|
66
|
+
], MetadataField.prototype, "value", null);
|
|
67
67
|
//# sourceMappingURL=metadata-field.js.map
|