import { BooleanField, DateField, MediaTypeField, NumberField } from '@internetarchive/iaux-item-metadata'; import { StringField } from '@internetarchive/iaux-item-metadata'; import { SearchMetadata } from '../search-metadata'; /** * A model that describes a textual hit from a full text search via the PPS endpoint. * * The fields in here are cast to their respective field types. See `metadata-fields/field-type`. * * Add additional fields as needed. * * @export * @class TextHit */ export declare class TextHit { /** * This is the raw hit response; useful for inspecting the raw data * returned from the server. */ readonly rawMetadata: Readonly>; readonly fields: Readonly; constructor(json: Record); /** * The item identifier. * * _Note_: This is a plain string instead of a `MetadataField` since it's * the primary key of the item. */ get identifier(): string | undefined; /** * Synthesized in processing of FTS API hit; TBD * Optional. */ get highlight(): StringField | undefined; /** * May be stale in FTS. * Optional. */ get addeddate(): DateField | undefined; /** Optional. */ get avg_rating(): NumberField | undefined; /** Multivalued. */ get collection(): StringField | undefined; get created_on(): DateField | undefined; /** * Optional. * Multivalued. */ get creator(): StringField | undefined; /** Optional. */ get date(): DateField | undefined; /** * Contents of hilighting in FTS API hit, TBD * Optional. * Multivalued. */ get description(): StringField | undefined; /** * Total views over ITEM (not text) lifetime, updated by audit consultation with Views API. * Optional. */ get downloads(): NumberField | undefined; get filename(): StringField | undefined; get file_basename(): StringField | undefined; get file_creation_mtime(): NumberField | undefined; /** * Format varies. * Optional. */ get issue(): StringField | undefined; get mediatype(): MediaTypeField | undefined; /** Optional. */ get page_num(): NumberField | undefined; /** Optional. */ get publicdate(): DateField | undefined; /** * Computed in processing of FTS API hit. */ get result_in_subfile(): BooleanField | undefined; /** Optional. */ get reviewdate(): DateField | undefined; /** * Format varies. * Optional. */ get source(): StringField | undefined; /** * Optional. * Multivalued. */ get subject(): StringField | undefined; /** Optional. */ get title(): StringField | undefined; get updated_on(): DateField | undefined; /** * Computed from date. * Optional. */ get year(): NumberField | undefined; /** * Synthesized in processing of FTS API hit; TBD * Optional. */ get __href__(): StringField | undefined; }