@internetarchive/metadata-service 1.0.3 → 1.0.4-webdev-7436.0

package/dist/src/models/metadata-fields/field-types/boolean.d.ts

@@ -0,0 +1,5 @@
+import { BooleanParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class BooleanField extends MetadataField<boolean, BooleanParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/boolean.js

@@ -0,0 +1,9 @@
+import { BooleanParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class BooleanField extends MetadataField {
+    constructor(rawValue) {
+        super(BooleanParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=boolean.js.map

package/dist/src/models/metadata-fields/field-types/boolean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,YAAa,SAAQ,aAAqC;IACrE,YAAY,QAA0B;QACpC,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;CACF","sourcesContent":["import { BooleanParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class BooleanField extends MetadataField<boolean, BooleanParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(BooleanParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/byte.d.ts

@@ -0,0 +1,13 @@
+import { Byte, ByteParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+/**
+ * ByteField is a unit-specific number field that
+ * returns a value in bytes
+ *
+ * @export
+ * @class ByteField
+ * @extends {MetadataField<Byte, ByteParser>}
+ */
+export declare class ByteField extends MetadataField<Byte, ByteParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/byte.js

@@ -0,0 +1,16 @@
+import { ByteParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+/**
+ * ByteField is a unit-specific number field that
+ * returns a value in bytes
+ *
+ * @export
+ * @class ByteField
+ * @extends {MetadataField<Byte, ByteParser>}
+ */
+export class ByteField extends MetadataField {
+    constructor(rawValue) {
+        super(ByteParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=byte.js.map

package/dist/src/models/metadata-fields/field-types/byte.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"byte.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/byte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,OAAO,SAAU,SAAQ,aAA+B;IAC5D,YAAY,QAA0B;QACpC,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF","sourcesContent":["import { Byte, ByteParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\n/**\n * ByteField is a unit-specific number field that\n * returns a value in bytes\n *\n * @export\n * @class ByteField\n * @extends {MetadataField<Byte, ByteParser>}\n */\nexport class ByteField extends MetadataField<Byte, ByteParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(ByteParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/date.d.ts

@@ -0,0 +1,5 @@
+import { DateParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class DateField extends MetadataField<Date, DateParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/date.js

@@ -0,0 +1,9 @@
+import { DateParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class DateField extends MetadataField {
+    constructor(rawValue) {
+        super(DateParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=date.js.map

package/dist/src/models/metadata-fields/field-types/date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/date.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,SAAU,SAAQ,aAA+B;IAC5D,YAAY,QAA0B;QACpC,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF","sourcesContent":["import { DateParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class DateField extends MetadataField<Date, DateParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(DateParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/duration.d.ts

@@ -0,0 +1,14 @@
+import { Duration, DurationParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+/**
+ * The DurationField parses different duration formats
+ * and returns a `Duration`, which is a number in seconds
+ * with decimals.
+ *
+ * @export
+ * @class DurationField
+ * @extends {MetadataField<Duration, DurationParser>}
+ */
+export declare class DurationField extends MetadataField<Duration, DurationParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/duration.js

@@ -0,0 +1,17 @@
+import { DurationParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+/**
+ * The DurationField parses different duration formats
+ * and returns a `Duration`, which is a number in seconds
+ * with decimals.
+ *
+ * @export
+ * @class DurationField
+ * @extends {MetadataField<Duration, DurationParser>}
+ */
+export class DurationField extends MetadataField {
+    constructor(rawValue) {
+        super(DurationParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=duration.js.map

package/dist/src/models/metadata-fields/field-types/duration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"duration.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/duration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAuC;IACxE,YAAY,QAA0B;QACpC,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF","sourcesContent":["import { Duration, DurationParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\n/**\n * The DurationField parses different duration formats\n * and returns a `Duration`, which is a number in seconds\n * with decimals.\n *\n * @export\n * @class DurationField\n * @extends {MetadataField<Duration, DurationParser>}\n */\nexport class DurationField extends MetadataField<Duration, DurationParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(DurationParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/list.d.ts

@@ -0,0 +1,25 @@
+import { FieldParserInterface, ListParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+/**
+ * The ListField handles parsing of a list of values.
+ *
+ * Certain fields in the metadata, like `subject` typically have a
+ * comma or semicolon-separated list of values. The `ListField`
+ * parses the list values independently and aggregates them into
+ * the main `.values` array.
+ */
+export declare class ListField<T, FieldParserInterfaceType extends FieldParserInterface<T[]>> extends MetadataField<T, FieldParserInterfaceType> {
+    constructor(rawValue: MetadataRawValue, parser: FieldParserInterfaceType);
+}
+/**
+ * The StringListField handles parsing of a list of strings.
+ */
+export declare class StringListField extends ListField<string, ListParser<string>> {
+    constructor(rawValue: MetadataRawValue);
+}
+/**
+ * The NumberListField handles parsing of a list of numbers.
+ */
+export declare class NumberListField extends ListField<number, ListParser<number>> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/list.js

@@ -0,0 +1,34 @@
+import { ListParser, NumberParser, StringParser, } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+/**
+ * The ListField handles parsing of a list of values.
+ *
+ * Certain fields in the metadata, like `subject` typically have a
+ * comma or semicolon-separated list of values. The `ListField`
+ * parses the list values independently and aggregates them into
+ * the main `.values` array.
+ */
+export class ListField extends MetadataField {
+    constructor(rawValue, parser) {
+        super(parser, rawValue);
+    }
+}
+/**
+ * The StringListField handles parsing of a list of strings.
+ */
+export class StringListField extends ListField {
+    constructor(rawValue) {
+        const parser = new ListParser(StringParser.shared);
+        super(rawValue, parser);
+    }
+}
+/**
+ * The NumberListField handles parsing of a list of numbers.
+ */
+export class NumberListField extends ListField {
+    constructor(rawValue) {
+        const parser = new ListParser(NumberParser.shared);
+        super(rawValue, parser);
+    }
+}
+// # sourceMappingURL=list.js.map

package/dist/src/models/metadata-fields/field-types/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,YAAY,EACZ,YAAY,GACb,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,OAAO,SAGX,SAAQ,aAA0C;IAClD,YAAY,QAA0B,EAAE,MAAgC;QACtE,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAqC;IACxE,YAAY,QAA0B;QACpC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAS,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAqC;IACxE,YAAY,QAA0B;QACpC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAS,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC;CACF","sourcesContent":["import {\n  FieldParserInterface,\n  ListParser,\n  NumberParser,\n  StringParser,\n} from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\n/**\n * The ListField handles parsing of a list of values.\n *\n * Certain fields in the metadata, like `subject` typically have a\n * comma or semicolon-separated list of values. The `ListField`\n * parses the list values independently and aggregates them into\n * the main `.values` array.\n */\nexport class ListField<\n  T,\n  FieldParserInterfaceType extends FieldParserInterface<T[]>\n> extends MetadataField<T, FieldParserInterfaceType> {\n  constructor(rawValue: MetadataRawValue, parser: FieldParserInterfaceType) {\n    super(parser, rawValue);\n  }\n}\n\n/**\n * The StringListField handles parsing of a list of strings.\n */\nexport class StringListField extends ListField<string, ListParser<string>> {\n  constructor(rawValue: MetadataRawValue) {\n    const parser = new ListParser<string>(StringParser.shared);\n    super(rawValue, parser);\n  }\n}\n\n/**\n * The NumberListField handles parsing of a list of numbers.\n */\nexport class NumberListField extends ListField<number, ListParser<number>> {\n  constructor(rawValue: MetadataRawValue) {\n    const parser = new ListParser<number>(NumberParser.shared);\n    super(rawValue, parser);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/mediatype.d.ts

@@ -0,0 +1,5 @@
+import { MediaType, MediaTypeParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class MediaTypeField extends MetadataField<MediaType, MediaTypeParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/mediatype.js

@@ -0,0 +1,9 @@
+import { MediaTypeParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class MediaTypeField extends MetadataField {
+    constructor(rawValue) {
+        super(MediaTypeParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=mediatype.js.map

package/dist/src/models/metadata-fields/field-types/mediatype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mediatype.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/mediatype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,cAAe,SAAQ,aAAyC;IAC3E,YAAY,QAA0B;QACpC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { MediaType, MediaTypeParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class MediaTypeField extends MetadataField<MediaType, MediaTypeParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(MediaTypeParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/number.d.ts

@@ -0,0 +1,5 @@
+import { NumberParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class NumberField extends MetadataField<number, NumberParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/number.js

@@ -0,0 +1,9 @@
+import { NumberParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class NumberField extends MetadataField {
+    constructor(rawValue) {
+        super(NumberParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=number.js.map

package/dist/src/models/metadata-fields/field-types/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,WAAY,SAAQ,aAAmC;IAClE,YAAY,QAA0B;QACpC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF","sourcesContent":["import { NumberParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class NumberField extends MetadataField<number, NumberParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(NumberParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/page-progression.d.ts

@@ -0,0 +1,5 @@
+import { PageProgression, PageProgressionParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class PageProgressionField extends MetadataField<PageProgression, PageProgressionParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/page-progression.js

@@ -0,0 +1,9 @@
+import { PageProgressionParser, } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class PageProgressionField extends MetadataField {
+    constructor(rawValue) {
+        super(PageProgressionParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=page-progression.js.map

package/dist/src/models/metadata-fields/field-types/page-progression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-progression.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/page-progression.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,GACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,oBAAqB,SAAQ,aAGzC;IACC,YAAY,QAA0B;QACpC,KAAK,CAAC,qBAAqB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF","sourcesContent":["import {\n  PageProgression,\n  PageProgressionParser,\n} from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class PageProgressionField extends MetadataField<\n  PageProgression,\n  PageProgressionParser\n> {\n  constructor(rawValue: MetadataRawValue) {\n    super(PageProgressionParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/field-types/string.d.ts

@@ -0,0 +1,5 @@
+import { StringParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class StringField extends MetadataField<string, StringParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/string.js

@@ -0,0 +1,9 @@
+import { StringParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+
+export class StringField extends MetadataField {
+    constructor(rawValue) {
+        super(StringParser.shared, rawValue);
+    }
+}
+// # sourceMappingURL=string.js.map

package/dist/src/models/metadata-fields/field-types/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../src/models/metadata-fields/field-types/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAoB,MAAM,mBAAmB,CAAC;AAEpE,MAAM,OAAO,WAAY,SAAQ,aAAmC;IAClE,YAAY,QAA0B;QACpC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF","sourcesContent":["import { StringParser } from '@internetarchive/field-parsers';\nimport { MetadataField, MetadataRawValue } from '../metadata-field';\n\nexport class StringField extends MetadataField<string, StringParser> {\n  constructor(rawValue: MetadataRawValue) {\n    super(StringParser.shared, rawValue);\n  }\n}\n"]}

package/dist/src/models/metadata-fields/metadata-field.d.ts

@@ -0,0 +1,70 @@
+import { FieldParserInterface } from '@internetarchive/field-parsers';
+/**
+ * The MetadataRawValue is all of the possible raw types we can get for a field.
+ *
+ * This allows the parsers to know if they can handle the raw value or not and
+ * how to handle it if they can.
+ */
+export declare type MetadataRawValue = string | string[] | number | boolean;
+export interface MetadataFieldInterface<T> {
+    /**
+     * The raw value received from the API response
+     *
+     * @type {MetadataRawValue}
+     * @memberof MetadataField
+     */
+    rawValue?: MetadataRawValue;
+    /**
+     * The first value if there are multiple or the only value if there is one
+     *
+     * @readonly
+     * @type {(T | undefined)}
+     * @memberof MetadataField
+     */
+    value?: T;
+    /**
+     * The array of all values for the field.
+     *
+     * Many fields only contain a single value and
+     * can be accessed via the `.value` getter
+     *
+     * @type {T[]}
+     * @memberof MetadataField
+     */
+    values: T[];
+}
+/**
+ * The MetadataField is responsible for three things:
+ * 1. Take in some raw data (strings, arrays, numbers, etc)
+ * 2. Normalize the input to an array of the input,
+ *    ie. [string, string], [number, number], [Date, Date], etc
+ * 3. Cast the values to their expected `Type`
+ *
+ * This class gets instiated with a `Type` and a parser of that type. For instance, the
+ * `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
+ *
+ * When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
+ * ie:
+ *
+ * ```
+ * const dateField = new DateField('2020-02-13')
+ * dateField.value = Date(2020-02-13) // native javascript Date object
+ * dateField.values = [Date(2020-02-13)] // the normalized array of values
+ * dateField.rawValue = '2020-02-13' // the raw string that was passed in
+ * ```
+ *
+ * @class MetadataField
+ * @template Type The type of metadata this is (string, number, Date, etc)
+ * @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
+ */
+export declare class MetadataField<Type, FieldParserInterfaceType extends FieldParserInterface<Type | Type[]>> implements MetadataFieldInterface<Type> {
+    /** @inheritdoc */
+    rawValue?: MetadataRawValue;
+    /** @inheritdoc */
+    get values(): Type[];
+    /** @inheritdoc */
+    get value(): Type | undefined;
+    constructor(parser: FieldParserInterfaceType, rawValue?: MetadataRawValue);
+    private parser;
+    private parseRawValue;
+}

package/dist/src/models/metadata-fields/metadata-field.js

@@ -0,0 +1,68 @@
+import { __decorate } from "tslib";
+import { Memoize } from 'typescript-memoize';
+/**
+ * The MetadataField is responsible for three things:
+ * 1. Take in some raw data (strings, arrays, numbers, etc)
+ * 2. Normalize the input to an array of the input,
+ *    ie. [string, string], [number, number], [Date, Date], etc
+ * 3. Cast the values to their expected `Type`
+ *
+ * This class gets instiated with a `Type` and a parser of that type. For instance, the
+ * `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.
+ *
+ * When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,
+ * ie:
+ *
+ * ```
+ * const dateField = new DateField('2020-02-13')
+ * dateField.value = Date(2020-02-13) // native javascript Date object
+ * dateField.values = [Date(2020-02-13)] // the normalized array of values
+ * dateField.rawValue = '2020-02-13' // the raw string that was passed in
+ * ```
+ *
+ * @class MetadataField
+ * @template Type The type of metadata this is (string, number, Date, etc)
+ * @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)
+ */
+export class MetadataField {
+    constructor(parser, rawValue) {
+        this.parser = parser;
+        this.rawValue = rawValue;
+    }
+
+    /** @inheritdoc */
+    get values() {
+        const values = this.parseRawValue();
+        return values;
+    }
+
+    /** @inheritdoc */
+    get value() {
+        return this.values[0];
+    }
+
+    parseRawValue() {
+        if (this.rawValue === undefined)
+            return [];
+        const rawValues = Array.isArray(this.rawValue)
+            ? this.rawValue
+            : [this.rawValue];
+        const values = [];
+        rawValues.forEach(value => {
+            const parsed = this.parser.parseValue(value);
+            if (Array.isArray(parsed)) {
+                values.push(...parsed);
+            }
+            else if (parsed !== undefined)
+                    values.push(parsed);
+        });
+        return values;
+    }
+}
+__decorate([
+    Memoize()
+], MetadataField.prototype, "values", null);
+__decorate([
+    Memoize()
+], MetadataField.prototype, "value", null);
+// # sourceMappingURL=metadata-field.js.map

package/dist/src/models/metadata-fields/metadata-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-field.js","sourceRoot":"","sources":["../../../../src/models/metadata-fields/metadata-field.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAyC7C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,aAAa;IAmBxB,YAAY,MAAgC,EAAE,QAA2B;QACvE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAdD,kBAAkB;IACP,IAAI,MAAM;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kBAAkB;IACP,IAAI,KAAK;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC;IASO,aAAa;QACnB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC5C,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,MAAM,MAAM,GAAW,EAAE,CAAC;QAC1B,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACzB,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;aACxB;iBAAM;gBACL,IAAI,MAAM,KAAK,SAAS;oBAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAjCY;IAAV,OAAO,EAAE;2CAGT;AAGU;IAAV,OAAO,EAAE;0CAET","sourcesContent":["import { Memoize } from 'typescript-memoize';\nimport { FieldParserInterface } from '@internetarchive/field-parsers';\n\n/**\n * The MetadataRawValue is all of the possible raw types we can get for a field.\n *\n * This allows the parsers to know if they can handle the raw value or not and\n * how to handle it if they can.\n */\nexport type MetadataRawValue = string | string[] | number | boolean;\n\nexport interface MetadataFieldInterface<T> {\n  /**\n   * The raw value received from the API response\n   *\n   * @type {MetadataRawValue}\n   * @memberof MetadataField\n   */\n  rawValue?: MetadataRawValue;\n\n  /**\n   * The first value if there are multiple or the only value if there is one\n   *\n   * @readonly\n   * @type {(T | undefined)}\n   * @memberof MetadataField\n   */\n  value?: T;\n\n  /**\n   * The array of all values for the field.\n   *\n   * Many fields only contain a single value and\n   * can be accessed via the `.value` getter\n   *\n   * @type {T[]}\n   * @memberof MetadataField\n   */\n  values: T[];\n}\n\n/**\n * The MetadataField is responsible for three things:\n * 1. Take in some raw data (strings, arrays, numbers, etc)\n * 2. Normalize the input to an array of the input,\n *    ie. [string, string], [number, number], [Date, Date], etc\n * 3. Cast the values to their expected `Type`\n *\n * This class gets instiated with a `Type` and a parser of that type. For instance, the\n * `DateField` is a subclass of `MetadataField` with a `Type` of `Date` and a `DateParser`.\n *\n * When using a `DateField`, you can pass it a string date and it will cast it to a javascript Date,\n * ie:\n *\n * ```\n * const dateField = new DateField('2020-02-13')\n * dateField.value = Date(2020-02-13) // native javascript Date object\n * dateField.values = [Date(2020-02-13)] // the normalized array of values\n * dateField.rawValue = '2020-02-13' // the raw string that was passed in\n * ```\n *\n * @class MetadataField\n * @template Type The type of metadata this is (string, number, Date, etc)\n * @template FieldParserInterfaceType The parser for that type (StringParser, NumberParser, etc)\n */\nexport class MetadataField<\n  Type,\n  FieldParserInterfaceType extends FieldParserInterface<Type | Type[]>\n> implements MetadataFieldInterface<Type>\n{\n  /** @inheritdoc */\n  rawValue?: MetadataRawValue;\n\n  /** @inheritdoc */\n  @Memoize() get values(): Type[] {\n    const values = this.parseRawValue();\n    return values;\n  }\n\n  /** @inheritdoc */\n  @Memoize() get value(): Type | undefined {\n    return this.values[0];\n  }\n\n  constructor(parser: FieldParserInterfaceType, rawValue?: MetadataRawValue) {\n    this.parser = parser;\n    this.rawValue = rawValue;\n  }\n\n  private parser: FieldParserInterfaceType;\n\n  private parseRawValue(): Type[] {\n    if (this.rawValue === undefined) return [];\n    const rawValues = Array.isArray(this.rawValue)\n      ? this.rawValue\n      : [this.rawValue];\n    const values: Type[] = [];\n    rawValues.forEach(value => {\n      const parsed = this.parser.parseValue(value);\n      if (Array.isArray(parsed)) {\n        values.push(...parsed);\n      } else {\n        if (parsed !== undefined) values.push(parsed);\n      }\n    });\n    return values;\n  }\n}\n"]}

package/dist/src/models/metadata.d.ts

@@ -0,0 +1,169 @@
+import { BooleanField } from './metadata-fields/field-types/boolean';
+import { DateField } from './metadata-fields/field-types/date';
+import { DurationField } from './metadata-fields/field-types/duration';
+import { NumberField } from './metadata-fields/field-types/number';
+import { StringField } from './metadata-fields/field-types/string';
+import { PageProgressionField } from './metadata-fields/field-types/page-progression';
+import { ByteField } from './metadata-fields/field-types/byte';
+import { MediaTypeField } from './metadata-fields/field-types/mediatype';
+import { StringListField } from './metadata-fields/field-types/list';
+/**
+ * Metadata is an expansive model that describes an Item.
+ *
+ * The fields in here get casted to their respective field types. See `metadata-fields/field-type`.
+ *
+ * Add additional fields as needed.
+ *
+ * @export
+ * @class Metadata
+ */
+export declare class Metadata {
+    /**
+     * This is the raw metadata reponse; useful for inspecting the raw data returned from the server.
+     *
+     * @type { string: any }
+     * @memberof Metadata
+     */
+    rawMetadata?: Record<string, any>;
+    /**
+     * The item identifier.
+     *
+     * _Note_ This is a plain string instead of a `MetadataField` since it's
+     * the primary key of the item.
+     *
+     * @type {string}
+     * @memberof Metadata
+     */
+    get identifier(): string | undefined;
+    get addeddate(): DateField | undefined;
+    get audio_codec(): StringField | undefined;
+    get audio_sample_rate(): NumberField | undefined;
+    get avg_rating(): NumberField | undefined;
+    /**
+     * All of the collections that an Item is in, including
+     * all of the side-loaded collections from the ListAPI
+     * and SimpleListsAPI like `fav-*`
+     *
+     * @type {StringField}
+     * @memberof Metadata
+     */
+    get collection(): StringField | undefined;
+    /**
+     * The "natural" collections for an item before augmentation
+     * by side-loaded collections like ListsAPI and SimpleLists
+     *
+     * The `collection` field above includes things like all of
+     * the `fav-*` collections, whereas this is only the collections
+     * that have been directly added in the hierarchy.
+     *
+     * @type {StringField}
+     * @memberof Metadata
+     */
+    get collections_raw(): StringField | undefined;
+    /**
+     * The size of a collection in bytes
+     *
+     * @type {ByteField}
+     * @memberof Metadata
+     */
+    get collection_size(): ByteField | undefined;
+    get contributor(): StringField | undefined;
+    get coverage(): StringField | undefined;
+    get creator(): StringField | undefined;
+    get collection_layout(): StringField | undefined;
+    get date(): DateField | undefined;
+    get description(): StringField | undefined;
+    /**
+     * All time download count
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get downloads(): NumberField | undefined;
+    /**
+     * The item duration in seconds
+     *
+     * @type {DurationField}
+     * @memberof Metadata
+     */
+    get duration(): DurationField | undefined;
+    get 'external-identifier'(): StringField | undefined;
+    /**
+     * The number of files in an item
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get files_count(): NumberField | undefined;
+    get indexdate(): DateField | undefined;
+    get isbn(): StringField | undefined;
+    get issue(): StringField | undefined;
+    /**
+     * For collections, the number of items in the collection
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get item_count(): NumberField | undefined;
+    /**
+     * The size of the item in bytes
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get item_size(): ByteField | undefined;
+    get language(): StringField | undefined;
+    get length(): DurationField | undefined;
+    get lineage(): StringField | undefined;
+    /**
+     * The number of downloads in the last month
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get month(): NumberField | undefined;
+    get mediatype(): MediaTypeField | undefined;
+    get noindex(): BooleanField | undefined;
+    get notes(): StringField | undefined;
+    /**
+     * The number of users that have favorited the item
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get num_favorites(): NumberField | undefined;
+    get num_reviews(): NumberField | undefined;
+    get openlibrary_edition(): StringField | undefined;
+    get openlibrary_work(): StringField | undefined;
+    get page_progression(): PageProgressionField | undefined;
+    get partner(): StringField | undefined;
+    get ppi(): NumberField | undefined;
+    get publicdate(): DateField | undefined;
+    get publisher(): StringField | undefined;
+    get reviewdate(): DateField | undefined;
+    get runtime(): DurationField | undefined;
+    get scanner(): StringField | undefined;
+    get source(): StringField | undefined;
+    get start_localtime(): DateField | undefined;
+    get start_time(): DateField | undefined;
+    get stop_time(): DateField | undefined;
+    get subject(): StringListField | undefined;
+    get taper(): StringField | undefined;
+    get title(): StringField | undefined;
+    get transferer(): StringField | undefined;
+    get track(): NumberField | undefined;
+    get type(): StringField | undefined;
+    get uploader(): StringField | undefined;
+    get utc_offset(): NumberField | undefined;
+    get venue(): StringField | undefined;
+    get volume(): StringField | undefined;
+    /**
+     * The number of downloads in the last week
+     *
+     * @type {NumberField}
+     * @memberof Metadata
+     */
+    get week(): NumberField | undefined;
+    get year(): DateField | undefined;
+    constructor(json: Record<string, any>);
+}