@helia/verified-fetch 3.0.1 → 3.1.0

package/dist/src/utils/byte-range-context.d.ts

@@ -1,5 +1,12 @@
 import type { SupportedBodyTypes } from '../types.js';
 import type { ComponentLogger } from '@libp2p/interface';
+interface RequestRange {
+    start: number | undefined;
+    end: number | undefined;
+}
+interface ByteRange extends RequestRange {
+    size: number | undefined;
+}
 export declare class ByteRangeContext {
     private readonly headers?;
     readonly isRangeRequest: boolean;
@@ -10,14 +17,24 @@ export declare class ByteRangeContext {
     private _body;
     private readonly rangeRequestHeader;
     private readonly log;
-    private readonly requestRangeStart;
-    private readonly requestRangeEnd;
-    private byteStart;
-    private byteEnd;
-    private byteSize;
+    /**
+     * multiPartBoundary is required for multipart responses
+     */
+    private readonly multiPartBoundary?;
+    private readonly requestRanges;
+    private byteRanges;
+    readonly isMultiRangeRequest: boolean;
+    private _isValidRangeRequest;
     constructor(logger: ComponentLogger, headers?: HeadersInit | undefined);
-    setBody(body: SupportedBodyTypes): void;
-    getBody(): SupportedBodyTypes;
+    getByteRanges(): ByteRange[];
+    /**
+     * You can pass a function when you need to support multi-range requests but have your own slicing logic, such as in the case of dag-pb/unixfs.
+     *
+     * @param bodyOrProvider - A supported body type or a function that returns a supported body type.
+     * @param contentType - The content type of the body.
+     */
+    setBody(bodyOrProvider: SupportedBodyTypes | ((range: ByteRange) => AsyncGenerator<Uint8Array, void, unknown>), contentType?: string): void;
+    getBody(responseContentType?: string): SupportedBodyTypes;
     private getSlicedBody;
     /**
      * Sometimes, we need to set the fileSize explicitly because we can't calculate
@@ -29,23 +46,18 @@ export declare class ByteRangeContext {
     getFileSize(): number | null | undefined;
     private isValidByteStart;
     private isValidByteEnd;
+    private isValidByteRange;
     /**
      * We may get the values required to determine if this is a valid range request at different times
      * so we need to calculate it when asked.
      */
     get isValidRangeRequest(): boolean;
-    /**
-     * Given all the information we have, this function returns the offset that will be used when:
-     * 1. calling unixfs.cat
-     * 2. slicing the body
-     */
-    get offset(): number;
     /**
      * Given all the information we have, this function returns the length that will be used when:
      * 1. calling unixfs.cat
      * 2. slicing the body
      */
-    get length(): number | undefined;
+    getLength(range?: ByteRange): number | undefined;
     /**
      * Converts a range request header into helia/unixfs supported range options
      * Note that the gateway specification says we "MAY" support multiple ranges (https://specs.ipfs.tech/http-gateways/path-gateway/#range-request-header) but we don't
@@ -56,14 +68,23 @@ export declare class ByteRangeContext {
      * Range: bytes=<range-start>-<range-end>
      * Range: bytes=<range-start>-
      * Range: bytes=-<suffix-length> // must pass size so we can calculate the offset. suffix-length is the number of bytes from the end of the file.
-     *
-     * NOT SUPPORTED:
      * Range: bytes=<range-start>-<range-end>, <range-start>-<range-end>
      * Range: bytes=<range-start>-<range-end>, <range-start>-<range-end>, <range-start>-<range-end>
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range#directives
      */
     private setOffsetDetails;
+    /**
+     * Helper to convert a SliceableBody to a Uint8Array
+     */
+    private convertToUint8Array;
+    private getMultipartBody;
+    private getSlicedBodyForRange;
+    /**
+     * Returns the content type for the response.
+     * For multipart ranges, this will be multipart/byteranges with a boundary.
+     */
+    getContentType(): string | undefined;
     /**
      * This function returns the value of the "content-range" header.
      *
@@ -76,5 +97,7 @@ export declare class ByteRangeContext {
      * - Content-Range: <unit> <byteStart>-<byteEnd>/*
      */
     get contentRangeHeaderValue(): string;
+    private createRangeStream;
 }
+export {};
 //# sourceMappingURL=byte-range-context.d.ts.map

package/dist/src/utils/byte-range-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"byte-range-context.d.ts","sourceRoot":"","sources":["../../../src/utils/byte-range-context.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAuChE,qBAAa,gBAAgB;IAgBW,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAf/D,SAAgB,cAAc,EAAE,OAAO,CAAA;IAEvC;;OAEG;IACH,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAe;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,QAAQ,CAAoB;gBAEvB,MAAM,EAAE,eAAe,EAAmB,OAAO,CAAC,EAAE,WAAW,YAAA;IAyBrE,OAAO,CAAE,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAQxC,OAAO,IAAK,kBAAkB;IA4BrC,OAAO,CAAC,aAAa;IA+BrB;;;;;OAKG;IACI,WAAW,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI;IAOhD,WAAW,IAAK,MAAM,GAAG,IAAI,GAAG,SAAS;IAIhD,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,cAAc;IAetB;;;OAGG;IACH,IAAW,mBAAmB,IAAK,OAAO,CAmCzC;IAED;;;;OAIG;IACH,IAAW,MAAM,IAAK,MAAM,CAE3B;IAED;;;;OAIG;IACH,IAAW,MAAM,IAAK,MAAM,GAAG,SAAS,CAUvC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;;;;;OAUG;IAEH,IAAW,uBAAuB,IAAK,MAAM,CAW5C;CACF"}
+{"version":3,"file":"byte-range-context.d.ts","sourceRoot":"","sources":["../../../src/utils/byte-range-context.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAIhE,UAAU,YAAY;IACpB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CACxB;AAED,UAAU,SAAU,SAAQ,YAAY;IACtC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB;AAuDD,qBAAa,gBAAgB;IAqBW,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IApB/D,SAAgB,cAAc,EAAE,OAAO,CAAA;IAEvC;;OAEG;IACH,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,KAAK,CAA2B;IACxC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAQ;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0D;IACxF,OAAO,CAAC,UAAU,CAAkB;IACpC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAQ;IAG7C,OAAO,CAAC,oBAAoB,CAAiB;gBAEhC,MAAM,EAAE,eAAe,EAAmB,OAAO,CAAC,EAAE,WAAW,YAAA;IA8BrE,aAAa,IAAK,SAAS,EAAE;IAIpC;;;;;OAKG;IACI,OAAO,CACZ,cAAc,EAAE,kBAAkB,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,KAAK,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,EACtG,WAAW,GAAE,MAAmC,GAC/C,IAAI;IAaA,OAAO,CAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,kBAAkB;IAsCjE,OAAO,CAAC,aAAa;IA+BrB;;;;;OAKG;IACI,WAAW,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI;IAQhD,WAAW,IAAK,MAAM,GAAG,IAAI,GAAG,SAAS;IAIhD,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,gBAAgB;IAcxB;;;OAGG;IACH,IAAW,mBAAmB,IAAK,OAAO,CAuBzC;IAcD;;;;OAIG;IACI,SAAS,CAAE,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IA0BxD;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,gBAAgB;IAwBxB;;OAEG;YACW,mBAAmB;YAwBjB,gBAAgB;IAyChC,OAAO,CAAC,qBAAqB;IAwB7B;;;OAGG;IACI,cAAc,IAAK,MAAM,GAAG,SAAS;IAO5C;;;;;;;;;;OAUG;IAEH,IAAW,uBAAuB,IAAK,MAAM,CAuB5C;IAGD,OAAO,CAAC,iBAAiB;CA8D1B"}