Skip to main content

Type Alias: ImportSource

ImportSource: string

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

External preprint source identifier.

Remarks​

Import sources are EXTENSIBLE - any plugin can define its own source identifier. This is intentionally a string type (not a union) to allow third-party plugins to introduce new sources without modifying core Chive code.

Format requirements:

  • Lowercase alphanumeric characters only (a-z, 0-9)
  • 2-50 characters long
  • No special characters, hyphens, or underscores

The canonical source of truth for validation is importSourceSchema in src/api/schemas/claiming.ts. The WELL_KNOWN_SOURCES constant provides metadata for built-in sources (display names, categories) but does NOT restrict what source identifiers are valid.

Example​

// Built-in plugin source
readonly source: ImportSource = 'arxiv';

// Third-party plugin with custom source
readonly source: ImportSource = 'mybiorxiv';

@public

Since​

0.1.0