@ar.io/sdk 3.12.0-beta.5 → 3.12.0-beta.7

package/lib/types/common/wayfinder/wayfinder.d.ts

@@ -13,8 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import EventEmitter from 'node:events';
-import { PassThrough, Readable } from 'node:stream';
+import { EventEmitter } from 'eventemitter3';
 import { DataVerificationStrategy, GatewaysProvider, RoutingStrategy } from '../../types/wayfinder.js';
 import { Logger } from '../logger.js';
 type WayfinderHttpClient = typeof fetch;
@@ -35,69 +34,56 @@ export declare const resolveWayfinderUrl: ({ originalUrl, selectedGateway, logge
  * Wayfinder event emitter with verification events
  */
 export type WayfinderEvent = {
-    type: 'verification-succeeded';
-    txId: string;
-} | {
-    type: 'verification-failed';
-    txId: string;
-    error: Error;
-} | {
-    type: 'verification-skipped';
-    originalUrl: string;
-} | {
-    type: 'verification-progress';
-    txId: string;
-    processedBytes: number;
-    totalBytes: number;
-} | {
-    type: 'routing-started';
-    originalUrl: string;
-} | {
-    type: 'routing-skipped';
-    originalUrl: string;
-} | {
-    type: 'routing-succeeded';
-    originalUrl: string;
-    selectedGateway: string;
-    redirectUrl: string;
-} | {
-    type: 'routing-failed';
-    originalUrl: string;
-    error: Error;
-} | {
-    type: 'identified-transaction-id';
-    originalUrl: string;
-    selectedGateway: string;
-    txId: string;
+    'verification-succeeded': {
+        txId: string;
+    };
+    'verification-failed': Error;
+    'verification-skipped': {
+        originalUrl: string;
+    };
+    'verification-progress': {
+        txId: string;
+        processedBytes: number;
+        totalBytes: number;
+    };
+    'routing-started': {
+        originalUrl: string;
+    };
+    'routing-skipped': {
+        originalUrl: string;
+    };
+    'routing-succeeded': {
+        originalUrl: string;
+        selectedGateway: string;
+        redirectUrl: string;
+    };
+    'routing-failed': Error;
+    'identified-transaction-id': {
+        originalUrl: string;
+        selectedGateway: string;
+        txId: string;
+    };
 };
 export interface WayfinderEventArgs {
-    onVerificationPassed?: (payload: Omit<Extract<WayfinderEvent, {
-        type: 'verification-succeeded';
-    }>, 'type'>) => void;
-    onVerificationFailed?: (payload: Omit<Extract<WayfinderEvent, {
-        type: 'verification-failed';
-    }>, 'type'>) => void;
-    onVerificationProgress?: (payload: Omit<Extract<WayfinderEvent, {
-        type: 'verification-progress';
-    }>, 'type'>) => void;
+    onVerificationSucceeded?: (payload: WayfinderEvent['verification-succeeded']) => void;
+    onVerificationFailed?: (payload: WayfinderEvent['verification-failed']) => void;
+    onVerificationProgress?: (payload: WayfinderEvent['verification-progress']) => void;
 }
-export declare class WayfinderEmitter extends EventEmitter {
-    constructor({ onVerificationPassed, onVerificationFailed, onVerificationProgress, }?: WayfinderEventArgs);
-    emit<E extends WayfinderEvent['type']>(event: E, payload: Omit<Extract<WayfinderEvent, {
-        type: E;
-    }>, 'type'>): boolean;
-    on<E extends WayfinderEvent['type']>(event: E, listener: (payload: Omit<Extract<WayfinderEvent, {
-        type: E;
-    }>, 'type'>) => void): this;
+export declare class WayfinderEmitter extends EventEmitter<WayfinderEvent> {
+    constructor({ onVerificationSucceeded, onVerificationFailed, onVerificationProgress, }?: WayfinderEventArgs);
 }
-export declare function tapAndVerifyStream<T extends Readable | ReadableStream>({ originalStream, contentLength, verifyData, txId, emitter, strict, }: {
-    originalStream: T;
+export declare function tapAndVerifyReadableStream({ originalStream, contentLength, verifyData, txId, emitter, strict, }: {
+    originalStream: ReadableStream;
     contentLength: number;
     verifyData: DataVerificationStrategy['verifyData'];
     txId: string;
     emitter?: WayfinderEmitter;
     strict?: boolean;
-}): T extends Readable ? PassThrough : T;
+}): ReadableStream;
+/**
+ * Gets the sandbox hash for a given transaction id
+ */
+export declare function sandboxFromId(id: string): string;
 /**
  * Creates a wrapped fetch function that supports ar:// protocol
  *
@@ -120,7 +106,7 @@ export declare const createWayfinderClient: ({ resolveUrl, verifyData, selectGat
     logger?: Logger;
     emitter?: WayfinderEmitter;
     strict?: boolean;
-}) => WayfinderHttpClient;
+}) => (url: string, init?: RequestInit) => Promise<Response>;
 /**
  * The main class for the wayfinder
  */
@@ -259,7 +245,7 @@ export declare class Wayfinder {
      * @param logger - the logger to use for logging
      * @param strict - if true, verification will be blocking and will fail requests if verification fails; if false, verification will be non-blocking
      */
-    constructor({ logger, gatewaysProvider, routingStrategy, verificationStrategy, events, strict, }: {
+    constructor({ logger, gatewaysProvider, routingStrategy, verificationStrategy, events, strict, }?: {
         routingStrategy?: RoutingStrategy;
         gatewaysProvider?: GatewaysProvider;
         verificationStrategy?: DataVerificationStrategy;

package/lib/types/types/wayfinder.d.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Readable } from 'stream';
 export interface RoutingStrategy {
     selectGateway: ({ gateways }: {
         gateways: URL[];
@@ -22,6 +21,7 @@ export interface RoutingStrategy {
 export interface GatewaysProvider {
     getGateways: () => Promise<URL[]>;
 }
+export type DataStream = AsyncIterable<Uint8Array> | ReadableStream<Uint8Array>;
 export interface DataVerificationStrategy {
     /**
      * Verifies the provided data for a given txId
@@ -35,7 +35,7 @@ export interface DataVerificationStrategy {
      * @returns the hash of the data
      */
     verifyData: ({ data, txId, }: {
-        data: Buffer | Readable | ReadableStream;
+        data: DataStream;
         txId: string;
     }) => Promise<void>;
 }

package/lib/types/utils/hash.d.ts

@@ -1,4 +1,8 @@
-import { Readable } from 'stream';
-export declare const hashReadableToB64Url: (stream: Readable, algorithm?: string) => Promise<string>;
-export declare const hashReadableStreamToB64Url: (stream: ReadableStream, algorithm?: string) => Promise<string>;
-export declare const hashBufferToB64Url: (buffer: Buffer, algorithm?: string) => string;
+import { DataStream } from '../types/wayfinder.js';
+export declare const isAsyncIterable: <T = unknown>(x: any) => x is AsyncIterable<T>;
+export declare const isReadableStream: <T = unknown>(x: any) => x is ReadableStream<T>;
+export declare const readableStreamToAsyncIterable: (stream: ReadableStream<Uint8Array>) => AsyncIterable<Uint8Array>;
+export declare const hashDataStreamToB64Url: (stream: DataStream, algorithm?: string) => Promise<string>;
+export declare const convertDataStreamToDataRoot: ({ dataStream, }: {
+    dataStream: DataStream;
+}) => Promise<string>;

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.12.0-beta.4";
+export declare const version = "3.12.0-beta.6";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.12.0-beta.5",
+  "version": "3.12.0-beta.7",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -136,6 +136,7 @@
     "eventemitter3": "^5.0.1",
     "plimit-lit": "^3.0.1",
     "prompts": "^2.4.2",
+    "rfc4648": "^1.5.4",
     "winston": "^3.13.0",
     "zod": "^3.23.8"
   },