Skip to main content

Interface: Eprint

Defined in: src/types/models/eprint.ts:703

Eprint domain model.

Remarks​

Represents a scholarly eprint indexed by Chive. This model captures comprehensive metadata from the user's PDS record including publication status, linked published versions, external identifiers, repositories, funding, and conference presentations.

ATProto Compliance:

  • documentBlobRef is a reference (CID pointer), not blob data
  • Actual document remains in user's PDS
  • Record is rebuildable from firehose

Properties​

abstract​

readonly abstract: AnnotationBody

Defined in: src/types/models/eprint.ts:770

Eprint abstract (rich text with embedded references).

Remarks​

Supports @ triggers for object nodes (institutions, persons, topics) and # triggers for type nodes (fields, facets, contribution-types).

abstractPlainText?​

readonly optional abstractPlainText: string

Defined in: src/types/models/eprint.ts:781

Plain text version of the abstract for search indexing.

Remarks​

Auto-generated from the rich text abstract by extracting plain text from all items. Used for full-text search and display in contexts that don't support rich text. Optional since it can be derived from the abstract field at indexing time.

authors​

readonly authors: readonly EprintAuthor[]

Defined in: src/types/models/eprint.ts:721

All authors with contributions, affiliations, and metadata.

Remarks​

Unified author list including primary and co-authors. Order is determined by each author's order property.

cid​

readonly cid: CID

Defined in: src/types/models/eprint.ts:712

CID of this eprint version.

conferencePresentation?​

readonly optional conferencePresentation: ConferencePresentation

Defined in: src/types/models/eprint.ts:939

Conference presentation.

Remarks​

Information about conference where this work was presented.

createdAt​

readonly createdAt: Timestamp

Defined in: src/types/models/eprint.ts:944

Eprint creation timestamp.

documentBlobRef​

readonly documentBlobRef: BlobRef

Defined in: src/types/models/eprint.ts:791

Blob reference to primary document in user's PDS.

Remarks​

This is a BlobRef (metadata), not the document itself. Supports multiple formats (PDF, DOCX, HTML, Markdown, LaTeX, Jupyter, etc.). Fetch document via IRepository.getBlob() for proxying.

documentFormat​

readonly documentFormat: DocumentFormat

Defined in: src/types/models/eprint.ts:800

Detected or user-specified document format.

Remarks​

Auto-detected from MIME type and magic bytes, but can be overridden by user if detection is incorrect.

externalIds?​

readonly optional externalIds: ExternalIds

Defined in: src/types/models/eprint.ts:914

External persistent identifiers.

Remarks​

Links to external systems (arXiv, PubMed, SSRN, OpenAlex, etc.) for discovery and interoperability.

facets​

readonly facets: readonly FacetFilter[]

Defined in: src/types/models/eprint.ts:822

Faceted classification values.

Remarks​

Optional facets for additional classification dimensions.

fields?​

readonly optional fields: readonly object[]

Defined in: src/types/models/eprint.ts:831

Research field references from the knowledge graph.

Remarks​

Links to field nodes in the knowledge graph for categorization. These are knowledge graph nodes, not a fixed taxonomy.

funding?​

readonly optional funding: readonly FundingSource[]

Defined in: src/types/models/eprint.ts:931

Funding sources.

Remarks​

Links to CrossRef Funder Registry and ROR for standardized IDs.

keywords​

readonly keywords: readonly string[]

Defined in: src/types/models/eprint.ts:814

Author-provided keywords.

license​

readonly license: string

Defined in: src/types/models/eprint.ts:868

License (SPDX identifier).

Example​

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

See​

SPDX License List

licenseUri?​

readonly optional licenseUri: AtUri

Defined in: src/types/models/eprint.ts:878

AT-URI to license node in the knowledge graph.

Remarks​

Points to a governance-controlled license node (subkind=license). Optional; when present, provides canonical license reference. The license field contains the SPDX identifier for fallback.

paperDid?​

readonly optional paperDid: DID

Defined in: src/types/models/eprint.ts:742

DID of the paper's own account (if paper has its own PDS).

Remarks​

Optional field for paper-centric account model. When set, blobs and the record itself live in the paper's PDS. When undefined, they live in the submitter's PDS.

See​

Discussion #3

previousVersionUri?​

readonly optional previousVersionUri: AtUri

Defined in: src/types/models/eprint.ts:848

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

publicationStatus​

readonly publicationStatus: PublicationStatus

Defined in: src/types/models/eprint.ts:887

Current publication status.

Remarks​

Tracks progression from eprint through review to publication. Defaults to 'eprint' for new submissions.

publishedVersion?​

readonly optional publishedVersion: PublishedVersion

Defined in: src/types/models/eprint.ts:896

Link to the published version (Version of Record).

Remarks​

Populated when eprint has been published in a journal. Uses CrossRef isPreprintOf relation pattern.

relatedWorks?​

readonly optional relatedWorks: readonly RelatedWork[]

Defined in: src/types/models/eprint.ts:905

Related works.

Remarks​

Links to related eprints, datasets, software, and prior versions using DataCite-compatible relation types.

repositories?​

readonly optional repositories: Repositories

Defined in: src/types/models/eprint.ts:923

Linked repositories.

Remarks​

Code, data, protocols, and materials repositories. Supports Software Heritage archival and RRIDs.

submittedBy​

readonly submittedBy: DID

Defined in: src/types/models/eprint.ts:730

DID of the human user who submitted this eprint.

Remarks​

Always set to the human who performed the submission. May or may not appear in the authors list.

supplementaryMaterials?​

readonly optional supplementaryMaterials: readonly SupplementaryMaterial[]

Defined in: src/types/models/eprint.ts:809

Supplementary materials attached to this eprint.

Remarks​

Additional files (appendices, figures, data, code, notebooks). Each item has metadata including category and display order.

title​

readonly title: string

Defined in: src/types/models/eprint.ts:751

Eprint title (plain text).

Remarks​

Used for search indexing and fallback display. Always present even if titleRich is available.

titleRich?​

readonly optional titleRich: AnnotationBody

Defined in: src/types/models/eprint.ts:761

Rich title with formatting and entity references.

Remarks​

Optional rich text array for titles containing LaTeX, subscripts, superscripts, or entity references. When present, clients should use this for display and fall back to title for search and simple contexts.

updatedAt?​

readonly optional updatedAt: Timestamp

Defined in: src/types/models/eprint.ts:949

Last update timestamp.

uri​

readonly uri: AtUri

Defined in: src/types/models/eprint.ts:707

AT URI of the eprint record.

version​

readonly version: number

Defined in: src/types/models/eprint.ts:843

Version number (1-indexed).

Remarks​

Increments with each new version posted by author.

versionNotes?​

readonly optional versionNotes: string

Defined in: src/types/models/eprint.ts:859

Changelog describing changes in this version.

Remarks​

Optional field provided by authors when uploading a new version. Describes what changed compared to the previous version.

Example​

"Fixed typos in section 3, updated methodology, added new references"