@internetarchive/metadata-service 1.0.4 → 1.0.5-alpha1

package/dist/src/models/metadata.js

@@ -1,685 +0,0 @@
-import { __decorate } from "tslib";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Memoize } from 'typescript-memoize';
-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 class Metadata {
-    constructor(json) {
-        this.rawMetadata = json;
-    }
-
-    /**
-     * 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() {
-        let _a;
-        return (_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.identifier;
-    }
-
-    get addeddate() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.addeddate)
-            ? new DateField(this.rawMetadata.addeddate)
-            : undefined;
-    }
-
-    get audio_codec() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.audio_codec)
-            ? new StringField(this.rawMetadata.audio_codec)
-            : undefined;
-    }
-
-    get audio_sample_rate() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.audio_sample_rate)
-            ? new NumberField(this.rawMetadata.audio_sample_rate)
-            : undefined;
-    }
-
-    get avg_rating() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.avg_rating)
-            ? new NumberField(this.rawMetadata.avg_rating)
-            : 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() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.collection)
-            ? new StringField(this.rawMetadata.collection)
-            : 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() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.collections_raw)
-            ? new StringField(this.rawMetadata.collections_raw)
-            : undefined;
-    }
-
-    /**
-     * The size of a collection in bytes
-     *
-     * @type {ByteField}
-     * @memberof Metadata
-     */
-    get collection_size() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.collection_size)
-            ? new ByteField(this.rawMetadata.collection_size)
-            : undefined;
-    }
-
-    get contributor() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.contributor)
-            ? new StringField(this.rawMetadata.contributor)
-            : undefined;
-    }
-
-    get coverage() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.coverage)
-            ? new StringField(this.rawMetadata.coverage)
-            : undefined;
-    }
-
-    get creator() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.creator)
-            ? new StringField(this.rawMetadata.creator)
-            : undefined;
-    }
-
-    get collection_layout() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.collection_layout)
-            ? new StringField(this.rawMetadata.collection_layout)
-            : undefined;
-    }
-
-    get date() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.date)
-            ? new DateField(this.rawMetadata.date)
-            : undefined;
-    }
-
-    get description() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.description)
-            ? new StringField(this.rawMetadata.description)
-            : undefined;
-    }
-
-    /**
-     * All time download count
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get downloads() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.downloads)
-            ? new NumberField(this.rawMetadata.downloads)
-            : undefined;
-    }
-
-    /**
-     * The item duration in seconds
-     *
-     * @type {DurationField}
-     * @memberof Metadata
-     */
-    get duration() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.duration)
-            ? new DurationField(this.rawMetadata.duration)
-            : undefined;
-    }
-
-    get 'external-identifier'() {
-        let _a; let _b;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a['external-identifier'])
-            ? new StringField((_b = this.rawMetadata) === null || _b === void 0 ? void 0 : _b['external-identifier'])
-            : undefined;
-    }
-
-    /**
-     * The number of files in an item
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get files_count() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.files_count)
-            ? new NumberField(this.rawMetadata.files_count)
-            : undefined;
-    }
-
-    get indexdate() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.indexdate)
-            ? new DateField(this.rawMetadata.indexdate)
-            : undefined;
-    }
-
-    get isbn() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.isbn)
-            ? new StringField(this.rawMetadata.isbn)
-            : undefined;
-    }
-
-    get issue() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.issue)
-            ? new StringField(this.rawMetadata.issue)
-            : undefined;
-    }
-
-    /**
-     * For collections, the number of items in the collection
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get item_count() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.item_count)
-            ? new NumberField(this.rawMetadata.item_count)
-            : undefined;
-    }
-
-    /**
-     * The size of the item in bytes
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get item_size() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.item_size)
-            ? new ByteField(this.rawMetadata.item_size)
-            : undefined;
-    }
-
-    get language() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.language)
-            ? new StringField(this.rawMetadata.language)
-            : undefined;
-    }
-
-    get length() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.length)
-            ? new DurationField(this.rawMetadata.length)
-            : undefined;
-    }
-
-    get lineage() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.lineage)
-            ? new StringField(this.rawMetadata.lineage)
-            : undefined;
-    }
-
-    /**
-     * The number of downloads in the last month
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get month() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.month)
-            ? new NumberField(this.rawMetadata.month)
-            : undefined;
-    }
-
-    get mediatype() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.mediatype)
-            ? new MediaTypeField(this.rawMetadata.mediatype)
-            : undefined;
-    }
-
-    get noindex() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.noindex)
-            ? new BooleanField(this.rawMetadata.noindex)
-            : undefined;
-    }
-
-    get notes() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.notes)
-            ? new StringField(this.rawMetadata.notes)
-            : undefined;
-    }
-
-    /**
-     * The number of users that have favorited the item
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get num_favorites() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.num_favorites)
-            ? new NumberField(this.rawMetadata.num_favorites)
-            : undefined;
-    }
-
-    get num_reviews() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.num_reviews)
-            ? new NumberField(this.rawMetadata.num_reviews)
-            : undefined;
-    }
-
-    get openlibrary_edition() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.openlibrary_edition)
-            ? new StringField(this.rawMetadata.openlibrary_edition)
-            : undefined;
-    }
-
-    get openlibrary_work() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.openlibrary_work)
-            ? new StringField(this.rawMetadata.openlibrary_work)
-            : undefined;
-    }
-
-    get page_progression() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.page_progression)
-            ? new PageProgressionField(this.rawMetadata.page_progression)
-            : undefined;
-    }
-
-    get partner() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.partner)
-            ? new StringField(this.rawMetadata.partner)
-            : undefined;
-    }
-
-    get ppi() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.ppi)
-            ? new NumberField(this.rawMetadata.ppi)
-            : undefined;
-    }
-
-    get publicdate() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.publicdate)
-            ? new DateField(this.rawMetadata.publicdate)
-            : undefined;
-    }
-
-    get publisher() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.publisher)
-            ? new StringField(this.rawMetadata.publisher)
-            : undefined;
-    }
-
-    get reviewdate() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.reviewdate)
-            ? new DateField(this.rawMetadata.reviewdate)
-            : undefined;
-    }
-
-    get runtime() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.runtime)
-            ? new DurationField(this.rawMetadata.runtime)
-            : undefined;
-    }
-
-    get scanner() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.scanner)
-            ? new StringField(this.rawMetadata.scanner)
-            : undefined;
-    }
-
-    get source() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.source)
-            ? new StringField(this.rawMetadata.source)
-            : undefined;
-    }
-
-    get start_localtime() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.start_localtime)
-            ? new DateField(this.rawMetadata.start_localtime)
-            : undefined;
-    }
-
-    get start_time() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.start_time)
-            ? new DateField(this.rawMetadata.start_time)
-            : undefined;
-    }
-
-    get stop_time() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.stop_time)
-            ? new DateField(this.rawMetadata.stop_time)
-            : undefined;
-    }
-
-    get subject() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.subject)
-            ? new StringListField(this.rawMetadata.subject)
-            : undefined;
-    }
-
-    get taper() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.taper)
-            ? new StringField(this.rawMetadata.taper)
-            : undefined;
-    }
-
-    get title() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.title)
-            ? new StringField(this.rawMetadata.title)
-            : undefined;
-    }
-
-    get transferer() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.transferer)
-            ? new StringField(this.rawMetadata.transferer)
-            : undefined;
-    }
-
-    get track() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.track)
-            ? new NumberField(this.rawMetadata.track)
-            : undefined;
-    }
-
-    get type() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.type)
-            ? new StringField(this.rawMetadata.type)
-            : undefined;
-    }
-
-    get uploader() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.uploader)
-            ? new StringField(this.rawMetadata.uploader)
-            : undefined;
-    }
-
-    get utc_offset() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.utc_offset)
-            ? new NumberField(this.rawMetadata.utc_offset)
-            : undefined;
-    }
-
-    get venue() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.venue)
-            ? new StringField(this.rawMetadata.venue)
-            : undefined;
-    }
-
-    get volume() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.volume)
-            ? new StringField(this.rawMetadata.volume)
-            : undefined;
-    }
-
-    /**
-     * The number of downloads in the last week
-     *
-     * @type {NumberField}
-     * @memberof Metadata
-     */
-    get week() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.week)
-            ? new NumberField(this.rawMetadata.week)
-            : undefined;
-    }
-
-    get year() {
-        let _a;
-        return ((_a = this.rawMetadata) === null || _a === void 0 ? void 0 : _a.year)
-            ? new DateField(this.rawMetadata.year)
-            : undefined;
-    }
-}
-__decorate([
-    Memoize()
-], Metadata.prototype, "addeddate", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "audio_codec", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "audio_sample_rate", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "avg_rating", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "collection", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "collections_raw", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "collection_size", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "contributor", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "coverage", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "creator", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "collection_layout", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "date", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "description", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "downloads", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "duration", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "external-identifier", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "files_count", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "indexdate", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "isbn", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "issue", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "item_count", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "item_size", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "language", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "length", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "lineage", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "month", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "mediatype", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "noindex", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "notes", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "num_favorites", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "num_reviews", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "openlibrary_edition", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "openlibrary_work", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "page_progression", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "partner", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "ppi", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "publicdate", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "publisher", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "reviewdate", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "runtime", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "scanner", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "source", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "start_localtime", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "start_time", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "stop_time", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "subject", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "taper", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "title", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "transferer", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "track", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "type", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "uploader", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "utc_offset", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "venue", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "volume", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "week", null);
-__decorate([
-    Memoize()
-], Metadata.prototype, "year", null);
-// # sourceMappingURL=metadata.js.map