@internetarchive/metadata-service 1.0.4 → 1.0.5-alpha1

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

@@ -1,169 +0,0 @@
-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>);
-}