@bsv/sdk 1.6.14 → 1.6.16

package/docs/reference/storage.md

@@ -30,7 +30,6 @@ export interface DownloadResult {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: DownloaderConfig
 
 ```ts
@@ -42,7 +41,6 @@ export interface DownloaderConfig {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: FindFileData
 
 ```ts
@@ -57,7 +55,6 @@ export interface FindFileData {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: RenewFileResult
 
 ```ts
@@ -72,7 +69,6 @@ export interface RenewFileResult {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: UploadFileResult
 
 ```ts
@@ -85,7 +81,6 @@ export interface UploadFileResult {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: UploadableFile
 
 ```ts
@@ -98,7 +93,6 @@ export interface UploadableFile {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: UploaderConfig
 
 ```ts
@@ -113,7 +107,6 @@ See also: [WalletInterface](./wallet.md#interface-walletinterface)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Classes
 
 | |
@@ -144,7 +137,6 @@ Downloads the content from the UHRP URL after validating the hash for integrity.
 ```ts
 public async download(uhrpUrl: string): Promise<DownloadResult> 
 ```
-
 See also: [DownloadResult](./storage.md#interface-downloadresult)
 
 Returns
@@ -153,8 +145,8 @@ A promise that resolves to the downloaded content.
 
 Argument Details
 
-- **uhrpUrl**
-    - The UHRP URL to download.
++ **uhrpUrl**
+  + The UHRP URL to download.
 
 #### Method resolve
 
@@ -170,17 +162,15 @@ A promise that resolves to an array of HTTP URLs.
 
 Argument Details
 
-- **uhrpUrl**
-    - The UHRP URL to resolve.
++ **uhrpUrl**
+  + The UHRP URL to resolve.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: StorageUploader
 
 The StorageUploader class provides client-side methods for:
-
 - Uploading files with a specified retention period
 - Finding file metadata by UHRP URL
 - Listing all user uploads
@@ -208,13 +198,12 @@ Creates a new StorageUploader instance.
 ```ts
 constructor(config: UploaderConfig) 
 ```
-
 See also: [UploaderConfig](./storage.md#interface-uploaderconfig)
 
 Argument Details
 
-- **config**
-    - An object containing the storage server's URL and a wallet interface
++ **config**
+  + An object containing the storage server's URL and a wallet interface
 
 #### Method findFile
 
@@ -223,7 +212,6 @@ Retrieves metadata for a file matching the given UHRP URL from the `/find` route
 ```ts
 public async findFile(uhrpUrl: string): Promise<FindFileData> 
 ```
-
 See also: [FindFileData](./storage.md#interface-findfiledata)
 
 Returns
@@ -232,8 +220,8 @@ An object with file name, size, MIME type, and expiry time
 
 Argument Details
 
-- **uhrpUrl**
-    - The UHRP URL, e.g. "uhrp://abcd..."
++ **uhrpUrl**
+  + The UHRP URL, e.g. "uhrp://abcd..."
 
 Throws
 
@@ -260,7 +248,6 @@ If the server or the route returns an error
 Publishes a file to the storage server with the specified retention period.
 
 This will:
-
 1. Request an upload URL from the server.
 2. Perform an HTTP PUT to upload the file’s raw bytes.
 3. Return a UHRP URL referencing the file once published.
@@ -271,7 +258,6 @@ public async publishFile(params: {
     retentionPeriod: number;
 }): Promise<UploadFileResult> 
 ```
-
 See also: [UploadFileResult](./storage.md#interface-uploadfileresult), [UploadableFile](./storage.md#interface-uploadablefile)
 
 Returns
@@ -291,7 +277,6 @@ and re-mint the advertisement token on-chain.
 ```ts
 public async renewFile(uhrpUrl: string, additionalMinutes: number): Promise<RenewFileResult> 
 ```
-
 See also: [RenewFileResult](./storage.md#interface-renewfileresult)
 
 Returns
@@ -300,10 +285,10 @@ An object with the new and previous expiry times, plus any cost
 
 Argument Details
 
-- **uhrpUrl**
-    - The UHRP URL of the file (e.g., "uhrp://abcd1234...")
-- **additionalMinutes**
-    - The number of minutes to extend
++ **uhrpUrl**
+  + The UHRP URL of the file (e.g., "uhrp://abcd1234...")
++ **additionalMinutes**
+  + The number of minutes to extend
 
 Throws
 
@@ -312,7 +297,6 @@ If the request fails or the server returns an error
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Functions
 
 ## Types
@@ -354,7 +338,6 @@ See also: [fromBase58Check](./primitives.md#variable-frombase58check), [normaliz
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Variable: getURLForFile
 
 ```ts
@@ -369,7 +352,6 @@ See also: [getURLForHash](./storage.md#variable-geturlforhash), [sha256](./primi
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Variable: getURLForHash
 
 ```ts
@@ -386,7 +368,6 @@ See also: [toArray](./primitives.md#variable-toarray), [toBase58Check](./primiti
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Variable: isValidURL
 
 ```ts
@@ -406,7 +387,6 @@ See also: [getHashFromURL](./storage.md#variable-gethashfromurl)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Variable: normalizeURL
 
 ```ts

package/docs/reference/totp.md

@@ -22,7 +22,6 @@ See also: [TOTPAlgorithm](./totp.md#type-totpalgorithm)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-
 ## Classes
 
 ### Class: TOTP
@@ -43,7 +42,6 @@ Generates a Time-based One-Time Password (TOTP).
 ```ts
 static generate(secret: number[], options?: TOTPOptions): string 
 ```
-
 See also: [TOTPOptions](./totp.md#interface-totpoptions)
 
 Returns
@@ -52,10 +50,10 @@ The generated TOTP.
 
 Argument Details
 
-- **secret**
-    - The secret key for TOTP.
-- **options**
-    - Optional parameters for TOTP.
++ **secret**
+  + The secret key for TOTP.
++ **options**
+  + Optional parameters for TOTP.
 
 #### Method validate
 
@@ -64,7 +62,6 @@ Validates a Time-based One-Time Password (TOTP).
 ```ts
 static validate(secret: number[], passcode: string, options?: TOTPValidateOptions): boolean 
 ```
-
 See also: [TOTPValidateOptions](./totp.md#type-totpvalidateoptions)
 
 Returns
@@ -73,17 +70,16 @@ A boolean indicating whether the passcode is valid.
 
 Argument Details
 
-- **secret**
-    - The secret key for TOTP.
-- **passcode**
-    - The passcode to validate.
-- **options**
-    - Optional parameters for TOTP validation.
++ **secret**
+  + The secret key for TOTP.
++ **passcode**
+  + The passcode to validate.
++ **options**
+  + Optional parameters for TOTP validation.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-
 ## Functions
 
 ## Types
@@ -106,7 +102,6 @@ export type TOTPAlgorithm = "SHA-1" | "SHA-256" | "SHA-512"
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-
 ### Type: TOTPValidateOptions
 
 Options for TOTP validation.
@@ -122,5 +117,5 @@ See also: [TOTPOptions](./totp.md#interface-totpoptions)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-
 ## Variables
+