recovery/history-recovery API

Source-derived exports, parameter and result types, public methods and source links.

This reference is generated from the checked-out TypeScript exports. Types and signatures describe the package contract; source presence does not establish deployment or service availability. Error expressions below are direct throws, not an exhaustive list of failures from dependencies.

Source module. See the reference index for package import boundaries and verification scope.

detectHistoricalPrivateRecords

Import from @trustlink/tsn-sdk. Implementation, line 37.

detectHistoricalPrivateRecords(inventory: PrivateHistoryInventory): PrivateHistoryState

getRecoveryOptions

Import from @trustlink/tsn-sdk. Implementation, line 56.

getRecoveryOptions(inventory: PrivateHistoryInventory): RecoveryOption[]

PrivateHistoryInventory

Import from @trustlink/tsn-sdk. Implementation, line 11.

PrivateHistoryInventory.historicalReceiptCount

Source, line 12.

historicalReceiptCount: number

PrivateHistoryInventory.accessibleHistoricalReceiptCount

Source, line 13.

accessibleHistoricalReceiptCount: number

PrivateHistoryInventory.activeApprovingDeviceCount

Source, line 14.

activeApprovingDeviceCount: number

PrivateHistoryInventory.activeRecoveryCredentialCount

Source, line 15.

activeRecoveryCredentialCount: number

PrivateHistoryRecoveryRequest

Import from @trustlink/tsn-sdk. Implementation, line 24.

PrivateHistoryRecoveryRequest.recoveryRequestId

Source, line 25.

recoveryRequestId: string

PrivateHistoryRecoveryRequest.tinCommitment

Source, line 26.

tinCommitment: string

PrivateHistoryRecoveryRequest.requestingDeviceId

Source, line 27.

requestingDeviceId: string

PrivateHistoryRecoveryRequest.requestingDeviceEncryptionKeyFingerprint

Source, line 28.

requestingDeviceEncryptionKeyFingerprint: string

PrivateHistoryRecoveryRequest.scope

Source, line 29.

scope: HistoryRecoveryScope

PrivateHistoryRecoveryRequest.selectedReceiptIds

Source, line 30.

selectedReceiptIds: string[] | undefined

PrivateHistoryRecoveryRequest.nonce

Source, line 31.

nonce: string

PrivateHistoryRecoveryRequest.issuedAt

Source, line 32.

issuedAt: string

PrivateHistoryRecoveryRequest.expiresAt

Source, line 33.

expiresAt: string

PrivateHistoryRecoveryRequest.status

Source, line 34.

status: "expired" | "completed" | "approved" | "awaiting-approval" | "revoked"

PrivateHistoryState

Import from @trustlink/tsn-sdk. Implementation, line 3.

export type PrivateHistoryState =
  | { status: "none" }
  | { status: "available" }
  | { status: "recovery-required"; message: "Historical private records found. Authorize secure recovery to restore access on this device." }
  | { status: "recovery-unavailable"; message: "Historical private records cannot be restored because no authorized device or recovery credential is available." };

RecoveryMethod

Import from @trustlink/tsn-sdk. Implementation, line 9.

export type RecoveryMethod = "authorized-device" | "recovery-credential";

RecoveryOption

Import from @trustlink/tsn-sdk. Implementation, line 18.

RecoveryOption.method

Source, line 19.

method: RecoveryMethod

RecoveryOption.recommended

Source, line 20.

recommended: boolean

RecoveryOption.label

Source, line 21.

label: string

validateRecoveryScope

Import from @trustlink/tsn-sdk. Implementation, line 67.

validateRecoveryScope(request: PrivateHistoryRecoveryRequest): { valid: true; } | { valid: false; reason: string; }