Class SlotHelpers

Hierarchy

SlotHelpers

Index

Constructors

constructor

Methods

Constructors

constructor

new SlotHelpers(): SlotHelpers

Returns SlotHelpers

Methods

Static addHashAndKey

addHashAndKey(slot: SDKDecryptedSlot): Promise<SDKDecryptedSlot>

- Defined in packages/sdk/src/util/slot-helpers.ts:136
Add a verification hash and key to the Slot. This is necessary to share an Item that you own. This should only be done for items you own, not on-shared items!

Parameters
- slot: SDKDecryptedSlot
Returns Promise<SDKDecryptedSlot>

Static anyDuplicateSlotNames

anyDuplicateSlotNames(slots: { name?: string }[]): boolean

- Defined in packages/sdk/src/util/slot-helpers.ts:155
Parameters
- slots: { name?: string }[]
Returns boolean

Static decryptSlot

decryptSlot(credentials: IDEK, slot: Slot): Promise<SDKDecryptedSlot>

- Defined in packages/sdk/src/util/slot-helpers.ts:21
Updates 'value' to the decrypted 'encrypted_value', decrypts encrypted_value_verification_key and checks value_verification_hash (if present), and sets 'encrypted' to false.

Parameters
- credentials: IDEK
- slot: Slot
Returns Promise<SDKDecryptedSlot>

Static encryptSlot

encryptSlot<T>(credentials: IDEK, slot: T): Promise<Omit<T, "value" | "value_verification_key"> & { encrypted: boolean; encrypted_value: undefined | string; encrypted_value_verification_key: undefined | string }>

- Defined in packages/sdk/src/util/slot-helpers.ts:90
Encrypt the value in the Slot. Undefined values are not changed.

After successful encryption, Slot.encrypted = true and Slot.value is deleted.

Type parameters
- T: { value?: null | string; value_verification_key?: null | SymmetricKey }
Parameters
- credentials: IDEK
- slot: T
Returns Promise<Omit<T, "value" | "value_verification_key"> & { encrypted: boolean; encrypted_value: undefined | string; encrypted_value_verification_key: undefined | string }>

Static findWithEncryptedValue

findWithEncryptedValue<T>(slots: T[]): undefined | T

- Defined in packages/sdk/src/util/slot-helpers.ts:169
Type parameters
- T
Parameters
- slots: T[]
Returns undefined | T

Static nameFromLabel

nameFromLabel(label: string): string

- Defined in packages/sdk/src/util/slot-helpers.ts:177
Convert Slot names to labels as per the backend URL-safe encoding. For example A Slot/name? becomes a_slot_name.

Parameters
- label: string
Returns string

Static toEncryptedSlotValue

toEncryptedSlotValue(credentials: IDEK, slot: SDKDecryptedSlot): Promise<EncryptedSlotValue>

- Defined in packages/sdk/src/util/slot-helpers.ts:185
Encrypts a slot and adds verification hash and verification key for sharing. Use to POST share data.

Parameters
- credentials: IDEK
- slot: SDKDecryptedSlot
Returns Promise<EncryptedSlotValue>

Generated using TypeDoc