Skip to main content

Interface: IClaimingService

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

Claiming service interface.

Remarks​

Manages the multi-authority verification flow for authors to claim imported preprints. Follows ATProto principles:

  • User creates canonical record in THEIR PDS
  • Chive only recognizes and links the claim

Since​

0.1.0

Methods​

collectEvidence()​

collectEvidence(claimId): Promise<ClaimRequest>

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

Collects evidence for a claim from multiple authorities.

Parameters​

claimId​

number

Claim request ID

Returns​

Promise<ClaimRequest>

Updated claim with all collected evidence

completeClaim()​

completeClaim(claimId, canonicalUri): Promise<void>

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

Completes a claim after user creates canonical record.

Parameters​

claimId​

number

Claim request ID

canonicalUri​

string

AT-URI of user's canonical record

Returns​

Promise<void>

computeScore()​

computeScore(evidence): object

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

Computes verification score from evidence.

Parameters​

evidence​

readonly ClaimEvidence[]

All evidence items

Returns​

object

Score (0-1) and decision

decision​

decision: "auto-approve" | "expedited" | "manual" | "insufficient"

score​

score: number

findClaimable()​

findClaimable(options): Promise<{ cursor: string; preprints: ImportedPreprint[]; }>

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

Finds claimable preprints for a user.

Parameters​

options​

Search options

cursor​

string

email​

string

limit​

number

name​

string

orcid​

string

Returns​

Promise<{ cursor: string; preprints: ImportedPreprint[]; }>

getClaim()​

getClaim(claimId): Promise<null | ClaimRequest>

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

Gets a claim request by ID.

Parameters​

claimId​

number

Claim request ID

Returns​

Promise<null | ClaimRequest>

getUserClaims()​

getUserClaims(claimantDid): Promise<readonly ClaimRequest[]>

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

Gets pending claims for a user.

Parameters​

claimantDid​

string

User's DID

Returns​

Promise<readonly ClaimRequest[]>

rejectClaim()​

rejectClaim(claimId, reason, reviewerDid): Promise<void>

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

Rejects a claim.

Parameters​

claimId​

number

Claim request ID

reason​

string

Rejection reason

reviewerDid​

string

DID of reviewer

Returns​

Promise<void>

startClaim()​

startClaim(importId, claimantDid, evidence?): Promise<ClaimRequest>

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

Starts a claim request.

Parameters​

importId​

number

ID of imported preprint

claimantDid​

string

DID of user claiming

evidence?​

readonly ClaimEvidence[]

Initial evidence (e.g., from ORCID OAuth)

Returns​

Promise<ClaimRequest>

Created claim request