Skip to main content

Interface: IClaimingService

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

Claiming service interface.

Remarks​

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

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

Since​

0.1.0

Methods​

approveCoauthorRequest()​

approveCoauthorRequest(requestId, ownerDid): Promise<void>

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

Approves a co-author request.

Parameters​

requestId​

number

ID of the request

ownerDid​

string

DID of the owner (must match eprint_owner_did)

Returns​

Promise<void>

completeClaim()​

completeClaim(claimId, canonicalUri): Promise<void>

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

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>

dismissSuggestion()​

dismissSuggestion(userDid, source, externalId): Promise<void>

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

Dismisses a paper suggestion so it is not shown again.

Parameters​

userDid​

string

DID of the user dismissing the suggestion

source​

string

External source of the paper (e.g., 'arxiv')

externalId​

string

Source-specific identifier of the paper

Returns​

Promise<void>

findClaimable()​

findClaimable(options): Promise<{ cursor: string; eprints: ImportedEprint[]; }>

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

Finds claimable eprints for a user.

Parameters​

options​

Search options

cursor​

string

email​

string

limit​

number

name​

string

orcid​

string

Returns​

Promise<{ cursor: string; eprints: ImportedEprint[]; }>

getClaim()​

getClaim(claimId): Promise<null | ClaimRequest>

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

Gets a claim request by ID.

Parameters​

claimId​

number

Claim request ID

Returns​

Promise<null | ClaimRequest>

getCoauthorRequest()​

getCoauthorRequest(requestId): Promise<null | CoauthorClaimRequest>

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

Gets a co-author request by ID.

Parameters​

requestId​

number

Request ID

Returns​

Promise<null | CoauthorClaimRequest>

getCoauthorRequestsByClaimant()​

getCoauthorRequestsByClaimant(claimantDid): Promise<readonly CoauthorClaimRequest[]>

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

Gets co-author requests made by a claimant.

Parameters​

claimantDid​

string

DID of the claimant

Returns​

Promise<readonly CoauthorClaimRequest[]>

getCoauthorRequestsForOwner()​

getCoauthorRequestsForOwner(ownerDid): Promise<readonly CoauthorClaimRequest[]>

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

Gets pending co-author requests for a PDS owner.

Parameters​

ownerDid​

string

DID of the PDS owner

Returns​

Promise<readonly CoauthorClaimRequest[]>

getUserClaims()​

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

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

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:1817

Rejects a claim.

Parameters​

claimId​

number

Claim request ID

reason​

string

Rejection reason

reviewerDid​

string

DID of reviewer

Returns​

Promise<void>

rejectCoauthorRequest()​

rejectCoauthorRequest(requestId, ownerDid, reason?): Promise<void>

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

Rejects a co-author request.

Parameters​

requestId​

number

ID of the request

ownerDid​

string

DID of the owner (must match eprint_owner_did)

reason?​

string

Optional rejection reason

Returns​

Promise<void>

requestCoauthorship()​

requestCoauthorship(eprintUri, eprintOwnerDid, claimantDid, claimantName, authorIndex, authorName, message?): Promise<CoauthorClaimRequest>

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

Requests co-authorship on an existing eprint.

Parameters​

eprintUri​

string

AT-URI of the eprint record

eprintOwnerDid​

string

DID of the PDS owner

claimantDid​

string

DID of the person requesting

claimantName​

string

Display name for the request

authorIndex​

number

Index of the author entry being claimed (0-based)

authorName​

string

Name of the author entry being claimed

message?​

string

Optional message to PDS owner

Returns​

Promise<CoauthorClaimRequest>

startClaim()​

startClaim(importId, claimantDid): Promise<ClaimRequest>

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

Starts a claim request.

Parameters​

importId​

number

ID of imported eprint

claimantDid​

string

DID of user claiming

Returns​

Promise<ClaimRequest>

Created claim request