Skip to main content

Interface: StoredPreprint

Defined in: src/types/interfaces/storage.interface.ts:31

Stored preprint metadata in Chive's index.

Remarks​

This is an INDEX record, not the source of truth. The authoritative preprint data lives in the user's PDS. This record enables fast searching and browsing without hitting individual PDSes.

Properties​

abstract​

readonly abstract: string

Defined in: src/types/interfaces/storage.interface.ts:64

Preprint abstract.

Remarks​

Indexed for full-text search.

author​

readonly author: DID

Defined in: src/types/interfaces/storage.interface.ts:48

Author's DID.

cid​

readonly cid: CID

Defined in: src/types/interfaces/storage.interface.ts:43

CID of the indexed preprint version.

Remarks​

Used to detect when PDS has a newer version (staleness check).

createdAt​

readonly createdAt: Date

Defined in: src/types/interfaces/storage.interface.ts:125

When the preprint was created (from record).

indexedAt​

readonly indexedAt: Date

Defined in: src/types/interfaces/storage.interface.ts:120

When this record was indexed by Chive.

keywords?​

readonly optional keywords: readonly string[]

Defined in: src/types/interfaces/storage.interface.ts:97

Keywords for searchability and categorization.

Remarks​

User-provided keywords for the preprint. Indexed for full-text search.

license​

readonly license: string

Defined in: src/types/interfaces/storage.interface.ts:104

License (SPDX identifier).

Example​

"CC-BY-4.0", "MIT", "Apache-2.0"

pdfBlobRef​

readonly pdfBlobRef: BlobRef

Defined in: src/types/interfaces/storage.interface.ts:73

Blob reference to PDF in user's PDS.

Remarks​

This is a BlobRef (CID pointer), not blob data. The actual PDF remains in the user's PDS.

pdsUrl​

readonly pdsUrl: string

Defined in: src/types/interfaces/storage.interface.ts:115

URL of the user's PDS where this preprint lives.

Remarks​

Used for:

  • Staleness detection (checking for updates)
  • Fetching blobs for proxying
  • Rebuilding index from source

previousVersionUri?​

readonly optional previousVersionUri: AtUri

Defined in: src/types/interfaces/storage.interface.ts:81

AT URI of previous version (if this is an update).

Remarks​

Used to build version chains for preprints with multiple revisions.

title​

readonly title: string

Defined in: src/types/interfaces/storage.interface.ts:56

Preprint title.

Remarks​

Indexed for full-text search and faceted filtering.

uri​

readonly uri: AtUri

Defined in: src/types/interfaces/storage.interface.ts:35

AT URI of the preprint record.

versionNotes?​

readonly optional versionNotes: string

Defined in: src/types/interfaces/storage.interface.ts:89

Changelog describing changes in this version.

Remarks​

Optional field provided by authors when uploading a new version.