@siafoundation/sia-storage 0.1.5 → 0.2.0

package/wasm/sia_storage_wasm.d.ts

@@ -58,6 +58,40 @@ export interface PackedUploadOptions {
 }
 
 
+/**
+ * A signed request to create a pre-authorized key in indexd.
+ */
+export type SignedPreAuthorizedKeyRequest = {
+    publicKey: string;
+    signature: string;
+    connectKey: string;
+    expiration: string;
+    totalUses: number;
+    allowedAppID?: string;
+};
+
+/**
+ * An unsigned request to create a pre-authorized key in indexd.
+ */
+export interface PreAuthorizedKeyRequest {
+    /**
+     * The connect key used to authorize connections.
+     */
+    connectKey: string;
+    /**
+     * When the authorization expires.
+     */
+    expiration: Date;
+    /**
+     * The maximum number of authorized connections.
+     */
+    totalUses: number;
+    /**
+     * The permitted application, or any application when absent.
+     */
+    allowedAppID?: string | null;
+}
+
 /**
  * Application info registered with the indexer.
  */
@@ -129,8 +163,9 @@ export interface AppMetadata {
 }
 
 /**
- * TS interface for `Sdk::objectEvents`'s `cursor` parameter. Field
- * names must match the Reflect reads in `sdk.rs`.
+ * TS interface for the `cursor` parameter of `Sdk::objectEvents` and
+ * `Sdk::objectEventSummaries`. Field names must match the Reflect reads in
+ * `objects_cursor_from_js`.
  */
 export interface ObjectsCursor {
     id: string;
@@ -205,10 +240,9 @@ export class Builder {
     [Symbol.dispose](): void;
     /**
      * Connects using a pre-authorized key, bypassing the interactive approval
-     * flow, and returns a Sdk. `preAuthorizedKeySeed` is the 32-byte
-     * pre-authorized private key (Uint8Array); `mnemonic` derives the app key.
+     * flow, and returns a Sdk. `mnemonic` derives the app key.
      */
-    connectPreAuthorized(pre_authorized_key_seed: Uint8Array, mnemonic: string): Promise<Sdk>;
+    connectPreAuthorized(pre_authorized_key: PreAuthorizedKey, mnemonic: string): Promise<Sdk>;
     /**
      * Attempts to connect using an existing AppKey.
      * Returns a Sdk if the key is valid, or undefined if not registered.
@@ -323,9 +357,29 @@ export class ObjectEvent {
 }
 
 /**
- * An object listed without its slabs, as `SharedSdk.objectSummaries` returns
- * it. It describes the object but cannot be downloaded. Fetch the full
- * object with `SharedSdk.object(id)` to download it.
+ * An object event from the indexer, without the object's slabs.
+ */
+export class ObjectEventSummary {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly deleted: boolean;
+    readonly id: string;
+    /**
+     * Returns the object associated with this event, if it exists.
+     */
+    readonly object: ObjectSummary | undefined;
+    /**
+     * Returns the time the event occurred.
+     */
+    readonly updatedAt: Date;
+}
+
+/**
+ * An object listed without its slabs, as `Sdk.objectEventSummaries` and
+ * `SharedSdk.objectSummaries` return it. It describes the object but cannot
+ * be downloaded. Fetch the full object with `Sdk.object(id)` or
+ * `SharedSdk.object(id)` to download it.
  */
 export class ObjectSummary {
     private constructor();
@@ -477,6 +531,42 @@ export class PinnedObject {
     updatedAt(): Date;
 }
 
+/**
+ * A key used to authorize application connections with indexd.
+ */
+export class PreAuthorizedKey {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Exports the key as a 32-byte seed.
+     */
+    export(): Uint8Array;
+    /**
+     * Imports a pre-authorized key from a 32-byte seed.
+     */
+    static import(seed: Uint8Array): PreAuthorizedKey;
+    /**
+     * Generates a new pre-authorized key.
+     */
+    constructor();
+    /**
+     * Returns the Ed25519 public key as a string.
+     */
+    publicKey(): string;
+    /**
+     * Signs a message and returns its 64-byte signature.
+     */
+    sign(message: Uint8Array): Uint8Array;
+    /**
+     * Returns a signed request for creating a pre-authorized key in indexd.
+     */
+    signRequest(request: PreAuthorizedKeyRequest): SignedPreAuthorizedKeyRequest;
+    /**
+     * Verifies a message signature using this key.
+     */
+    verifySignature(message: Uint8Array, signature: Uint8Array): boolean;
+}
+
 /**
  * The main Sia storage SDK. Provides methods for uploading, downloading,
  * and managing objects on the Sia storage network via an indexer.
@@ -525,6 +615,10 @@ export class Sdk {
      * Returns a `PinnedObject` handle for use with download, share, seal, etc.
      */
     object(key_hex: string): Promise<PinnedObject>;
+    /**
+     * Returns object events from the indexer without the objects' slabs.
+     */
+    objectEventSummaries(cursor: ObjectsCursor | null | undefined, limit: number): Promise<ObjectEventSummary[]>;
     /**
      * Returns object events for syncing local state with the indexer.
      */
@@ -717,6 +811,7 @@ export interface InitOutput {
     readonly __wbg_builder_free: (a: number, b: number) => void;
     readonly __wbg_keyrecord_free: (a: number, b: number) => void;
     readonly __wbg_objectevent_free: (a: number, b: number) => void;
+    readonly __wbg_objecteventsummary_free: (a: number, b: number) => void;
     readonly __wbg_objectsummary_free: (a: number, b: number) => void;
     readonly __wbg_packedupload_free: (a: number, b: number) => void;
     readonly __wbg_pinnedobject_free: (a: number, b: number) => void;
@@ -727,7 +822,7 @@ export interface InitOutput {
     readonly appkey_publicKey: (a: number) => [number, number];
     readonly appkey_sign: (a: number, b: number, c: number) => [number, number];
     readonly appkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
-    readonly builder_connectPreAuthorized: (a: number, b: number, c: number, d: number, e: number) => any;
+    readonly builder_connectPreAuthorized: (a: number, b: number, c: number, d: number) => any;
     readonly builder_connected: (a: number, b: number) => any;
     readonly builder_matchesExistingAppKey: (a: number, b: number, c: number) => any;
     readonly builder_new: (a: number, b: number, c: any) => [number, number, number];
@@ -746,6 +841,10 @@ export interface InitOutput {
     readonly objectevent_id: (a: number) => [number, number];
     readonly objectevent_object: (a: number) => number;
     readonly objectevent_updatedAt: (a: number) => any;
+    readonly objecteventsummary_deleted: (a: number) => number;
+    readonly objecteventsummary_id: (a: number) => [number, number];
+    readonly objecteventsummary_object: (a: number) => number;
+    readonly objecteventsummary_updatedAt: (a: number) => any;
     readonly objectsummary_createdAt: (a: number) => any;
     readonly objectsummary_id: (a: number) => [number, number];
     readonly objectsummary_metadata: (a: number) => [number, number];
@@ -770,6 +869,13 @@ export interface InitOutput {
     readonly pinnedobject_truncate: (a: number, b: bigint) => number;
     readonly pinnedobject_updateMetadata: (a: number, b: number, c: number) => void;
     readonly pinnedobject_updatedAt: (a: number) => any;
+    readonly preauthorizedkey_export: (a: number) => [number, number];
+    readonly preauthorizedkey_import: (a: number, b: number) => [number, number, number];
+    readonly preauthorizedkey_new: () => number;
+    readonly preauthorizedkey_publicKey: (a: number) => [number, number];
+    readonly preauthorizedkey_sign: (a: number, b: number, c: number) => [number, number];
+    readonly preauthorizedkey_signRequest: (a: number, b: any) => [number, number, number];
+    readonly preauthorizedkey_verifySignature: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
     readonly sdk_account: (a: number) => any;
     readonly sdk_appKey: (a: number) => number;
     readonly sdk_createSharingKey: (a: number, b: number, c: number, d: number) => any;
@@ -777,6 +883,7 @@ export interface InitOutput {
     readonly sdk_download: (a: number, b: number, c: number) => [number, number, number];
     readonly sdk_hosts: (a: number, b: number) => any;
     readonly sdk_object: (a: number, b: number, c: number) => any;
+    readonly sdk_objectEventSummaries: (a: number, b: any, c: number) => any;
     readonly sdk_objectEvents: (a: number, b: any, c: number) => any;
     readonly sdk_objectFromShareUrl: (a: number, b: number, c: number) => any;
     readonly sdk_objectShareUrl: (a: number, b: number, c: any) => [number, number, number, number];
@@ -803,6 +910,7 @@ export interface InitOutput {
     readonly sharingkey_publicKey: (a: number) => [number, number];
     readonly sharingkey_seed: (a: number) => [number, number];
     readonly validateRecoveryPhrase: (a: number, b: number) => [number, number];
+    readonly __wbg_preauthorizedkey_free: (a: number, b: number) => void;
     readonly __wbg_sharingkey_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
     readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;
@@ -821,7 +929,7 @@ export interface InitOutput {
     readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___wasm_bindgen_63576b009277873___sys__Undefined__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_63576b009277873___JsError___true_: (a: number, b: number, c: any) => [number, number];
     readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___wasm_bindgen_63576b009277873___sys__Undefined__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_63576b009277873___JsError___true__3: (a: number, b: number, c: any) => [number, number];
     readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___wasm_bindgen_63576b009277873___sys__Undefined__core_37ee0ce0c4cd57d5___result__Result_____wasm_bindgen_63576b009277873___JsError___true__4: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___js_sys_eaf17bee0f0de45e___Function_fn_wasm_bindgen_63576b009277873___JsValue_____wasm_bindgen_63576b009277873___sys__Undefined___js_sys_eaf17bee0f0de45e___Function_fn_wasm_bindgen_63576b009277873___JsValue_____wasm_bindgen_63576b009277873___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___js_sys_89dff7ebd9bf220e___Function_fn_wasm_bindgen_63576b009277873___JsValue_____wasm_bindgen_63576b009277873___sys__Undefined___js_sys_89dff7ebd9bf220e___Function_fn_wasm_bindgen_63576b009277873___JsValue_____wasm_bindgen_63576b009277873___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
     readonly wasm_bindgen_63576b009277873___convert__closures_____invoke___wasm_bindgen_63576b009277873___JsValue______true_: (a: number, b: number, c: any) => void;
     readonly wasm_bindgen_63576b009277873___convert__closures_____invoke_______true_: (a: number, b: number) => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;