@siafoundation/sia-storage 0.0.12 → 0.0.14

package/dist/index.node.d.ts

@@ -73,7 +73,9 @@ export declare class PackedUpload {
    *
    * If the reader errors part-way, it's safe to continue calling
    * [add](Self::add); no object is registered for the failed call. Or call
-   * [finalize](Self::finalize) to collect the objects added so far.
+   * [finalize](Self::finalize) to collect the objects added so far. Bytes
+   * read before the error remain in the current slab as padding and stay
+   * counted in [length](Self::length) and [remaining](Self::remaining).
    *
    * ```js
    * const packed = sdk.uploadPacked();
@@ -83,6 +85,20 @@ export declare class PackedUpload {
    * ```
    */
   add(stream: ReadableStream): Promise<bigint>
+  /**
+   * Adds a new object to the upload by opening the file at `path`. Behaves
+   * like [add](Self::add) otherwise.
+   *
+   * Prefer this to [add](Self::add) for files on disk: the read stays in
+   * Rust instead of streaming each chunk through JS.
+   *
+   * ```js
+   * const packed = sdk.uploadPacked();
+   * await packed.addPath("/tmp/photo.jpg");
+   * const objects = await packed.finalize();
+   * ```
+   */
+  addPath(path: string): Promise<bigint>
   /** Cancels the upload. */
   cancel(): void
   /**
@@ -125,7 +141,7 @@ export declare class Sdk {
    * Creates a new packed upload for efficiently uploading multiple small
    * objects together. Returns a `PackedUpload` handle.
    */
-  uploadPacked(options?: UploadOptions): PackedUpload
+  uploadPacked(options?: PackedUploadOptions): PackedUpload
   /**
    * Uploads data to the Sia network.
    *
@@ -135,6 +151,14 @@ export declare class Sdk {
    * the previous ID must be updated.
    */
   upload(object: PinnedObject, stream: ReadableStream, options?: UploadOptions): Promise<PinnedObject>
+  /**
+   * Uploads the file at `path`. Behaves like [upload](Self::upload)
+   * otherwise.
+   *
+   * Prefer this to [upload](Self::upload) for files on disk: the read stays
+   * in Rust instead of streaming each chunk through JS.
+   */
+  uploadPath(object: PinnedObject, path: string, options?: UploadOptions): Promise<PinnedObject>
   /**
    * Downloads an object from the Sia network, returning a `ReadableStream`
    * of the object's data.
@@ -203,7 +227,7 @@ export interface AppMetadata {
 
 /** Download options. */
 export interface DownloadOptions {
-  maxInflight?: number
+  maxBufferedChunks?: number
   offset?: bigint
   length?: bigint
   onShardDownloaded?: (progress: ShardProgress) => void
@@ -237,6 +261,14 @@ export interface ObjectsCursor {
   after: Date
 }
 
+/** Packed upload options. */
+export interface PackedUploadOptions {
+  maxBufferedSlabs?: number
+  dataShards?: number
+  parityShards?: number
+  onShardUploaded?: (progress: ShardProgress) => void
+}
+
 /** A sector stored on a specific host. */
 export interface PinnedSector {
   root: string
@@ -245,6 +277,7 @@ export interface PinnedSector {
 
 /** A pinned slab from the indexer. */
 export interface PinnedSlab {
+  version: number
   id: string
   encryptionKey: Buffer
   minShards: number
@@ -283,6 +316,7 @@ export interface ShardProgress {
 
 /** A slab representing a contiguous erasure-coded segment of a file. */
 export interface Slab {
+  version: number
   encryptionKey: Buffer
   minShards: number
   sectors: Array<PinnedSector>
@@ -292,9 +326,10 @@ export interface Slab {
 
 /** Upload options. */
 export interface UploadOptions {
-  maxInflight?: number
+  maxBufferedSlabs?: number
   dataShards?: number
   parityShards?: number
+  startOffset?: bigint
   onShardUploaded?: (progress: ShardProgress) => void
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siafoundation/sia-storage",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "type": "module",
   "repository": {
     "type": "git",
@@ -40,6 +40,7 @@
     "build-wasm": "bun run scripts/build-wasm.ts",
     "setup": "bun run scripts/setup-rust.ts",
     "setup-napi-test": "bun run scripts/setup-napi-test.ts",
+    "typecheck": "tsc --noEmit",
     "test": "bun test src/tests/install-integration.test.ts",
     "test:browser": "bun test src/tests/vite-integration.test.ts src/tests/esbuild-integration.test.ts src/tests/webpack-integration.test.ts src/tests/rollup-integration.test.ts src/tests/nextjs-integration.test.ts",
     "test:all": "bun test",
@@ -47,17 +48,17 @@
     "publish-npm": "bun run scripts/publish.ts"
   },
   "optionalDependencies": {
-    "@siafoundation/sia-storage-darwin-arm64": "0.0.12",
-    "@siafoundation/sia-storage-darwin-x64": "0.0.12",
-    "@siafoundation/sia-storage-linux-x64-gnu": "0.0.12",
-    "@siafoundation/sia-storage-linux-arm64-gnu": "0.0.12",
-    "@siafoundation/sia-storage-win32-x64-msvc": "0.0.12"
+    "@siafoundation/sia-storage-darwin-arm64": "0.0.14",
+    "@siafoundation/sia-storage-darwin-x64": "0.0.14",
+    "@siafoundation/sia-storage-linux-x64-gnu": "0.0.14",
+    "@siafoundation/sia-storage-linux-arm64-gnu": "0.0.14",
+    "@siafoundation/sia-storage-win32-x64-msvc": "0.0.14"
   },
   "devDependencies": {
     "@types/bun": "^1.3.12",
-    "@types/node": "^25.3.5",
-    "playwright": "^1.58.2",
+    "@types/node": "^24.13.2",
+    "playwright": "^1.60.0",
     "tsup": "^8.4.0",
-    "typescript": "~5.9.3"
+    "typescript": "5.9.3"
   }
 }

package/wasm/sia_storage_wasm.d.ts

@@ -6,10 +6,10 @@
  * *This API requires the following crate features to be activated: `ReadableStreamType`*
  */
 
-type ReadableStreamType = "bytes";
+export type ReadableStreamType = "bytes";
 
 export interface DownloadOptions {
-    maxInflight?: number;
+    maxBufferedChunks?: number;
     offset?: number;
     length?: number;
     onShardDownloaded?: (progress: ShardProgress) => void;
@@ -36,6 +36,7 @@ export interface Sector {
 }
 
 export interface Slab {
+    version: number;
     encryptionKey: string;
     minShards: number;
     offset: number;
@@ -44,6 +45,7 @@ export interface Slab {
 }
 
 export interface PinnedSlab {
+    version: number;
     id: string;
     encryptionKey: string;
     minShards: number;
@@ -64,7 +66,15 @@ export interface Host {
 export interface UploadOptions {
     dataShards?: number;
     parityShards?: number;
-    maxInflight?: number;
+    maxBufferedSlabs?: number;
+    startOffset?: bigint;
+    onShardUploaded?: (progress: ShardProgress) => void;
+}
+
+export interface PackedUploadOptions {
+    dataShards?: number;
+    parityShards?: number;
+    maxBufferedSlabs?: number;
     onShardUploaded?: (progress: ShardProgress) => void;
 }
 
@@ -73,10 +83,24 @@ export interface UploadOptions {
 interface Sdk {
     download(object: PinnedObject, options?: DownloadOptions): ReadableStream;
     upload(object: PinnedObject, source: ReadableStream, options?: UploadOptions): Promise<PinnedObject>;
-    uploadPacked(options?: UploadOptions): PackedUpload;
+    uploadPacked(options?: PackedUploadOptions): PackedUpload;
 }
 
 
+/**
+ * Application info registered with the indexer.
+ */
+export interface App {
+    id: string;
+    name: string;
+    description: string;
+    logoUrl: string | undefined;
+    serviceUrl: string | undefined;
+}
+
+/**
+ * Information about the user\'s account on the indexer.
+ */
 export interface Account {
     accountKey: string;
     maxPinnedData: number;
@@ -88,14 +112,33 @@ export interface Account {
     lastUsed: Date;
 }
 
-export interface App {
-    id: string;
-    name: string;
-    description: string;
-    logoUrl: string | undefined;
-    serviceUrl: string | undefined;
+/**
+ * Progress information about a successfully uploaded or downloaded shard.
+ */
+export interface ShardProgress {
+    hostKey: string;
+    shardSize: number;
+    shardIndex: number;
+    slabIndex: number;
+    /**
+     * Elapsed time in milliseconds since the start of the shard upload or download.
+     */
+    elapsedMs: number;
 }
 
+/**
+ * Query parameters for filtering hosts.
+ */
+export interface HostQuery {
+    country: string | undefined;
+    limit: number | undefined;
+    offset: number | undefined;
+}
+
+/**
+ * TS interface for `Builder::new`\'s `app` parameter. Field names must
+ * match the Reflect reads in `helpers::make_app_metadata`.
+ */
 export interface AppMetadata {
     appId: string;
     name: string;
@@ -105,25 +148,15 @@ export interface AppMetadata {
     callbackUrl: string | undefined;
 }
 
-export interface HostQuery {
-    country: string | undefined;
-    limit: number | undefined;
-    offset: number | undefined;
-}
-
+/**
+ * TS interface for `Sdk::objectEvents`\'s `cursor` parameter. Field
+ * names must match the Reflect reads in `sdk.rs`.
+ */
 export interface ObjectsCursor {
     id: string;
     after: Date;
 }
 
-export interface ShardProgress {
-    hostKey: string;
-    shardSize: number;
-    shardIndex: number;
-    slabIndex: number;
-    elapsedMs: number;
-}
-
 export type SealedObject = SealedObject;
 
 
@@ -262,7 +295,9 @@ export class PackedUpload {
      *
      * If the reader errors part-way, it's safe to continue calling
      * [add](Self::add); no object is registered for the failed call. Or call
-     * [finalize](Self::finalize) to collect the objects added so far.
+     * [finalize](Self::finalize) to collect the objects added so far. Bytes
+     * read before the error remain in the current slab as padding and stay
+     * counted in [length](Self::length) and [remaining](Self::remaining).
      *
      * ```js
      * const packed = sdk.uploadPacked();
@@ -559,13 +594,13 @@ export interface InitOutput {
     readonly intounderlyingsink_write: (a: number, b: any) => any;
     readonly intounderlyingsource_cancel: (a: number) => void;
     readonly intounderlyingsource_pull: (a: number, b: any) => any;
-    readonly wasm_bindgen__convert__closures_____invoke__h3c6340b0d184f16e: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__hd6a792896fe4c06e: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__h3c6340b0d184f16e_3: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__h3c6340b0d184f16e_4: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__h627a0ff4e7293c58: (a: number, b: number, c: any, d: any) => void;
-    readonly wasm_bindgen__convert__closures_____invoke__h38ecd2addaae2254: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen__convert__closures_____invoke__h74323dfdd037d4a1: (a: number, b: number) => void;
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___wasm_bindgen_94d9ab53edc6bea3___sys__Undefined__core_9b3796e30d99ddb7___result__Result_____wasm_bindgen_94d9ab53edc6bea3___JsError___true_: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___wasm_bindgen_94d9ab53edc6bea3___JsValue__core_9b3796e30d99ddb7___result__Result_____wasm_bindgen_94d9ab53edc6bea3___JsError___true_: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___wasm_bindgen_94d9ab53edc6bea3___sys__Undefined__core_9b3796e30d99ddb7___result__Result_____wasm_bindgen_94d9ab53edc6bea3___JsError___true__3: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___wasm_bindgen_94d9ab53edc6bea3___sys__Undefined__core_9b3796e30d99ddb7___result__Result_____wasm_bindgen_94d9ab53edc6bea3___JsError___true__4: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___js_sys_2b0a4a9337300fde___Function_fn_wasm_bindgen_94d9ab53edc6bea3___JsValue_____wasm_bindgen_94d9ab53edc6bea3___sys__Undefined___js_sys_2b0a4a9337300fde___Function_fn_wasm_bindgen_94d9ab53edc6bea3___JsValue_____wasm_bindgen_94d9ab53edc6bea3___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke___wasm_bindgen_94d9ab53edc6bea3___JsValue______true_: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_94d9ab53edc6bea3___convert__closures_____invoke_______true_: (a: number, b: number) => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_exn_store: (a: number) => void;