Interface: ExternalSearchQuery

Defined in: src/types/interfaces/plugin.interface.ts:1273

Search query parameters for external eprint sources.

Remarks

Used by SearchablePlugin implementations to query external APIs on demand. Supports author name, title, DOI, and source-specific IDs.

Distinct from SearchQuery in search.interface.ts which is for internal Elasticsearch queries.

Since

0.1.0

Properties

author?

readonly optional author: string

Defined in: src/types/interfaces/plugin.interface.ts:1281

Author name to search for.

Remarks

Matches against author names in the external source. The matching algorithm is source-specific.

---

authorProfileIds?

readonly optional authorProfileIds: Readonly<Record<string, string>>

Defined in: src/types/interfaces/plugin.interface.ts:1322

Source-specific author profile ID for direct author lookup.

Remarks

When provided, plugins that support profile-based search (e.g., OpenReview) can use this to fetch papers directly by author ID instead of text search. Keys are source names, values are profile IDs.

Example

{ openreview: "~Aaron_Steven_White1", arxiv: "white_a_1" }

---

categories?

readonly optional categories: readonly string[]

Defined in: src/types/interfaces/plugin.interface.ts:1310

Filter by categories/subjects (source-specific).

---

doi?

readonly optional doi: string

Defined in: src/types/interfaces/plugin.interface.ts:1291

DOI to search for (exact match).

---

externalId?

readonly optional externalId: string

Defined in: src/types/interfaces/plugin.interface.ts:1298

Source-specific external ID (exact match).

Example

"2401.12345" for arXiv, "007123" for LingBuzz

---

limit?

readonly optional limit: number

Defined in: src/types/interfaces/plugin.interface.ts:1305

Maximum number of results to return.

Default Value

10

---

title?

readonly optional title: string

Defined in: src/types/interfaces/plugin.interface.ts:1286

Title or partial title to search for.