@serwist/range-requests 9.0.0-preview.8 → 9.0.0

package/dist/index.d.ts

@@ -1,4 +1,2 @@
-import { RangeRequestsPlugin } from "./RangeRequestsPlugin.js";
-import { createPartialResponse } from "./createPartialResponse.js";
-export { createPartialResponse, RangeRequestsPlugin };
+export { createPartialResponse, RangeRequestsPlugin } from "serwist";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,127 +1 @@
-import { assert, SerwistError, logger } from '@serwist/core/internal';
-
-function calculateEffectiveBoundaries(blob, start, end) {
-    if (process.env.NODE_ENV !== "production") {
-        assert.isInstance(blob, Blob, {
-            moduleName: "@serwist/range-requests",
-            funcName: "calculateEffectiveBoundaries",
-            paramName: "blob"
-        });
-    }
-    const blobSize = blob.size;
-    if (end && end > blobSize || start && start < 0) {
-        throw new SerwistError("range-not-satisfiable", {
-            size: blobSize,
-            end,
-            start
-        });
-    }
-    let effectiveStart;
-    let effectiveEnd;
-    if (start !== undefined && end !== undefined) {
-        effectiveStart = start;
-        effectiveEnd = end + 1;
-    } else if (start !== undefined && end === undefined) {
-        effectiveStart = start;
-        effectiveEnd = blobSize;
-    } else if (end !== undefined && start === undefined) {
-        effectiveStart = blobSize - end;
-        effectiveEnd = blobSize;
-    }
-    return {
-        start: effectiveStart,
-        end: effectiveEnd
-    };
-}
-
-function parseRangeHeader(rangeHeader) {
-    if (process.env.NODE_ENV !== "production") {
-        assert.isType(rangeHeader, "string", {
-            moduleName: "@serwist/range-requests",
-            funcName: "parseRangeHeader",
-            paramName: "rangeHeader"
-        });
-    }
-    const normalizedRangeHeader = rangeHeader.trim().toLowerCase();
-    if (!normalizedRangeHeader.startsWith("bytes=")) {
-        throw new SerwistError("unit-must-be-bytes", {
-            normalizedRangeHeader
-        });
-    }
-    if (normalizedRangeHeader.includes(",")) {
-        throw new SerwistError("single-range-only", {
-            normalizedRangeHeader
-        });
-    }
-    const rangeParts = /(\d*)-(\d*)/.exec(normalizedRangeHeader);
-    if (!rangeParts || !(rangeParts[1] || rangeParts[2])) {
-        throw new SerwistError("invalid-range-values", {
-            normalizedRangeHeader
-        });
-    }
-    return {
-        start: rangeParts[1] === "" ? undefined : Number(rangeParts[1]),
-        end: rangeParts[2] === "" ? undefined : Number(rangeParts[2])
-    };
-}
-
-async function createPartialResponse(request, originalResponse) {
-    try {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isInstance(request, Request, {
-                moduleName: "@serwist/range-requests",
-                funcName: "createPartialResponse",
-                paramName: "request"
-            });
-            assert.isInstance(originalResponse, Response, {
-                moduleName: "@serwist/range-requests",
-                funcName: "createPartialResponse",
-                paramName: "originalResponse"
-            });
-        }
-        if (originalResponse.status === 206) {
-            return originalResponse;
-        }
-        const rangeHeader = request.headers.get("range");
-        if (!rangeHeader) {
-            throw new SerwistError("no-range-header");
-        }
-        const boundaries = parseRangeHeader(rangeHeader);
-        const originalBlob = await originalResponse.blob();
-        const effectiveBoundaries = calculateEffectiveBoundaries(originalBlob, boundaries.start, boundaries.end);
-        const slicedBlob = originalBlob.slice(effectiveBoundaries.start, effectiveBoundaries.end);
-        const slicedBlobSize = slicedBlob.size;
-        const slicedResponse = new Response(slicedBlob, {
-            status: 206,
-            statusText: "Partial Content",
-            headers: originalResponse.headers
-        });
-        slicedResponse.headers.set("Content-Length", String(slicedBlobSize));
-        slicedResponse.headers.set("Content-Range", `bytes ${effectiveBoundaries.start}-${effectiveBoundaries.end - 1}/` + `${originalBlob.size}`);
-        return slicedResponse;
-    } catch (error) {
-        if (process.env.NODE_ENV !== "production") {
-            logger.warn("Unable to construct a partial response; returning a " + "416 Range Not Satisfiable response instead.");
-            logger.groupCollapsed("View details here.");
-            logger.log(error);
-            logger.log(request);
-            logger.log(originalResponse);
-            logger.groupEnd();
-        }
-        return new Response("", {
-            status: 416,
-            statusText: "Range Not Satisfiable"
-        });
-    }
-}
-
-class RangeRequestsPlugin {
-    cachedResponseWillBeUsed = async ({ request, cachedResponse })=>{
-        if (cachedResponse && request.headers.has("range")) {
-            return await createPartialResponse(request, cachedResponse);
-        }
-        return cachedResponse;
-    };
-}
-
-export { RangeRequestsPlugin, createPartialResponse };
+export { RangeRequestsPlugin, createPartialResponse } from 'serwist';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/range-requests",
-  "version": "9.0.0-preview.8",
+  "version": "9.0.0",
   "type": "module",
   "description": "This library creates a new Response, given a source Response and a Range header value.",
   "files": [
@@ -20,7 +20,7 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
+  "repository": "https://github.com/serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
@@ -33,12 +33,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/core": "9.0.0-preview.8"
+    "serwist": "9.0.0"
   },
   "devDependencies": {
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.8"
+    "rollup": "4.14.3",
+    "typescript": "5.5.0-dev.20240415",
+    "@serwist/configs": "9.0.0"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
@@ -50,7 +50,6 @@
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
     "typecheck": "tsc"
   }

package/src/index.ts

@@ -1,12 +1 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { RangeRequestsPlugin } from "./RangeRequestsPlugin.js";
-import { createPartialResponse } from "./createPartialResponse.js";
-
-export { createPartialResponse, RangeRequestsPlugin };
+export { createPartialResponse, RangeRequestsPlugin } from "serwist";

package/dist/RangeRequestsPlugin.d.ts

@@ -1,20 +0,0 @@
-import type { SerwistPlugin } from "@serwist/core";
-/**
- * The range request plugin makes it easy for a request with a 'Range' header to
- * be fulfilled by a cached response.
- *
- * It does this by intercepting the `cachedResponseWillBeUsed` plugin callback
- * and returning the appropriate subset of the cached response body.
- */
-declare class RangeRequestsPlugin implements SerwistPlugin {
-    /**
-     * @param options
-     * @returns If request contains a 'Range' header, then a
-     * new response with status 206 whose body is a subset of `cachedResponse` is
-     * returned. Otherwise, `cachedResponse` is returned as-is.
-     * @private
-     */
-    cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"];
-}
-export { RangeRequestsPlugin };
-//# sourceMappingURL=RangeRequestsPlugin.d.ts.map

package/dist/RangeRequestsPlugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RangeRequestsPlugin.d.ts","sourceRoot":"","sources":["../src/RangeRequestsPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD;;;;;;GAMG;AACH,cAAM,mBAAoB,YAAW,aAAa;IAChD;;;;;;OAMG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAUjE;CACH;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/createPartialResponse.d.ts

@@ -1,19 +0,0 @@
-/**
- * Given a `Request` and `Response` objects as input, this will return a
- * promise for a new `Response`.
- *
- * If the original `Response` already contains partial content (i.e. it has
- * a status of 206), then this assumes it already fulfills the `Range:`
- * requirements, and will return it as-is.
- *
- * @param request A request, which should contain a Range:
- * header.
- * @param originalResponse A response.
- * @returns Either a `206 Partial Content` response, with
- * the response body set to the slice of content specified by the request's
- * `Range:` header, or a `416 Range Not Satisfiable` response if the
- * conditions of the `Range:` header can't be met.
- */
-declare function createPartialResponse(request: Request, originalResponse: Response): Promise<Response>;
-export { createPartialResponse };
-//# sourceMappingURL=createPartialResponse.d.ts.map

package/dist/createPartialResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createPartialResponse.d.ts","sourceRoot":"","sources":["../src/createPartialResponse.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;GAeG;AACH,iBAAe,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CA8DpG;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/utils/calculateEffectiveBoundaries.d.ts

@@ -1,15 +0,0 @@
-/**
- * @param blob A source blob.
- * @param start The offset to use as the start of the
- * slice.
- * @param end The offset to use as the end of the slice.
- * @returns An object with `start` and `end` properties, reflecting
- * the effective boundaries to use given the size of the blob.
- * @private
- */
-declare function calculateEffectiveBoundaries(blob: Blob, start?: number, end?: number): {
-    start: number;
-    end: number;
-};
-export { calculateEffectiveBoundaries };
-//# sourceMappingURL=calculateEffectiveBoundaries.d.ts.map

package/dist/utils/calculateEffectiveBoundaries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"calculateEffectiveBoundaries.d.ts","sourceRoot":"","sources":["../../src/utils/calculateEffectiveBoundaries.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,iBAAS,4BAA4B,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAsC9G;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

package/dist/utils/parseRangeHeader.d.ts

@@ -1,13 +0,0 @@
-/**
- * @param rangeHeader A Range: header value.
- * @returns An object with `start` and `end` properties, reflecting
- * the parsed value of the Range: header. If either the `start` or `end` are
- * omitted, then `null` will be returned.
- * @private
- */
-declare function parseRangeHeader(rangeHeader: string): {
-    start?: number;
-    end?: number;
-};
-export { parseRangeHeader };
-//# sourceMappingURL=parseRangeHeader.d.ts.map

package/dist/utils/parseRangeHeader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parseRangeHeader.d.ts","sourceRoot":"","sources":["../../src/utils/parseRangeHeader.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,iBAAS,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CA+BA;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/src/RangeRequestsPlugin.ts

@@ -1,41 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import type { SerwistPlugin } from "@serwist/core";
-
-import { createPartialResponse } from "./createPartialResponse.js";
-
-/**
- * The range request plugin makes it easy for a request with a 'Range' header to
- * be fulfilled by a cached response.
- *
- * It does this by intercepting the `cachedResponseWillBeUsed` plugin callback
- * and returning the appropriate subset of the cached response body.
- */
-class RangeRequestsPlugin implements SerwistPlugin {
-  /**
-   * @param options
-   * @returns If request contains a 'Range' header, then a
-   * new response with status 206 whose body is a subset of `cachedResponse` is
-   * returned. Otherwise, `cachedResponse` is returned as-is.
-   * @private
-   */
-  cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"] = async ({ request, cachedResponse }) => {
-    // Only return a sliced response if there's something valid in the cache,
-    // and there's a Range: header in the request.
-    if (cachedResponse && request.headers.has("range")) {
-      return await createPartialResponse(request, cachedResponse);
-    }
-
-    // If there was no Range: header, or if cachedResponse wasn't valid, just
-    // pass it through as-is.
-    return cachedResponse;
-  };
-}
-
-export { RangeRequestsPlugin };

package/src/createPartialResponse.ts

@@ -1,94 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { assert, SerwistError, logger } from "@serwist/core/internal";
-
-import { calculateEffectiveBoundaries } from "./utils/calculateEffectiveBoundaries.js";
-import { parseRangeHeader } from "./utils/parseRangeHeader.js";
-
-/**
- * Given a `Request` and `Response` objects as input, this will return a
- * promise for a new `Response`.
- *
- * If the original `Response` already contains partial content (i.e. it has
- * a status of 206), then this assumes it already fulfills the `Range:`
- * requirements, and will return it as-is.
- *
- * @param request A request, which should contain a Range:
- * header.
- * @param originalResponse A response.
- * @returns Either a `206 Partial Content` response, with
- * the response body set to the slice of content specified by the request's
- * `Range:` header, or a `416 Range Not Satisfiable` response if the
- * conditions of the `Range:` header can't be met.
- */
-async function createPartialResponse(request: Request, originalResponse: Response): Promise<Response> {
-  try {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isInstance(request, Request, {
-        moduleName: "@serwist/range-requests",
-        funcName: "createPartialResponse",
-        paramName: "request",
-      });
-
-      assert!.isInstance(originalResponse, Response, {
-        moduleName: "@serwist/range-requests",
-        funcName: "createPartialResponse",
-        paramName: "originalResponse",
-      });
-    }
-
-    if (originalResponse.status === 206) {
-      // If we already have a 206, then just pass it through as-is;
-      // see https://github.com/GoogleChrome/workbox/issues/1720
-      return originalResponse;
-    }
-
-    const rangeHeader = request.headers.get("range");
-    if (!rangeHeader) {
-      throw new SerwistError("no-range-header");
-    }
-
-    const boundaries = parseRangeHeader(rangeHeader);
-    const originalBlob = await originalResponse.blob();
-
-    const effectiveBoundaries = calculateEffectiveBoundaries(originalBlob, boundaries.start, boundaries.end);
-
-    const slicedBlob = originalBlob.slice(effectiveBoundaries.start, effectiveBoundaries.end);
-    const slicedBlobSize = slicedBlob.size;
-
-    const slicedResponse = new Response(slicedBlob, {
-      // Status code 206 is for a Partial Content response.
-      // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206
-      status: 206,
-      statusText: "Partial Content",
-      headers: originalResponse.headers,
-    });
-
-    slicedResponse.headers.set("Content-Length", String(slicedBlobSize));
-    slicedResponse.headers.set("Content-Range", `bytes ${effectiveBoundaries.start}-${effectiveBoundaries.end - 1}/` + `${originalBlob.size}`);
-
-    return slicedResponse;
-  } catch (error) {
-    if (process.env.NODE_ENV !== "production") {
-      logger.warn("Unable to construct a partial response; returning a " + "416 Range Not Satisfiable response instead.");
-      logger.groupCollapsed("View details here.");
-      logger.log(error);
-      logger.log(request);
-      logger.log(originalResponse);
-      logger.groupEnd();
-    }
-
-    return new Response("", {
-      status: 416,
-      statusText: "Range Not Satisfiable",
-    });
-  }
-}
-
-export { createPartialResponse };

package/src/utils/calculateEffectiveBoundaries.ts

@@ -1,60 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { assert, SerwistError } from "@serwist/core/internal";
-
-/**
- * @param blob A source blob.
- * @param start The offset to use as the start of the
- * slice.
- * @param end The offset to use as the end of the slice.
- * @returns An object with `start` and `end` properties, reflecting
- * the effective boundaries to use given the size of the blob.
- * @private
- */
-function calculateEffectiveBoundaries(blob: Blob, start?: number, end?: number): { start: number; end: number } {
-  if (process.env.NODE_ENV !== "production") {
-    assert!.isInstance(blob, Blob, {
-      moduleName: "@serwist/range-requests",
-      funcName: "calculateEffectiveBoundaries",
-      paramName: "blob",
-    });
-  }
-
-  const blobSize = blob.size;
-
-  if ((end && end > blobSize) || (start && start < 0)) {
-    throw new SerwistError("range-not-satisfiable", {
-      size: blobSize,
-      end,
-      start,
-    });
-  }
-
-  let effectiveStart: number;
-  let effectiveEnd: number;
-
-  if (start !== undefined && end !== undefined) {
-    effectiveStart = start;
-    // Range values are inclusive, so add 1 to the value.
-    effectiveEnd = end + 1;
-  } else if (start !== undefined && end === undefined) {
-    effectiveStart = start;
-    effectiveEnd = blobSize;
-  } else if (end !== undefined && start === undefined) {
-    effectiveStart = blobSize - end;
-    effectiveEnd = blobSize;
-  }
-
-  return {
-    start: effectiveStart!,
-    end: effectiveEnd!,
-  };
-}
-
-export { calculateEffectiveBoundaries };

package/src/utils/parseRangeHeader.ts

@@ -1,54 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { assert, SerwistError } from "@serwist/core/internal";
-
-/**
- * @param rangeHeader A Range: header value.
- * @returns An object with `start` and `end` properties, reflecting
- * the parsed value of the Range: header. If either the `start` or `end` are
- * omitted, then `null` will be returned.
- * @private
- */
-function parseRangeHeader(rangeHeader: string): {
-  start?: number;
-  end?: number;
-} {
-  if (process.env.NODE_ENV !== "production") {
-    assert!.isType(rangeHeader, "string", {
-      moduleName: "@serwist/range-requests",
-      funcName: "parseRangeHeader",
-      paramName: "rangeHeader",
-    });
-  }
-
-  const normalizedRangeHeader = rangeHeader.trim().toLowerCase();
-  if (!normalizedRangeHeader.startsWith("bytes=")) {
-    throw new SerwistError("unit-must-be-bytes", { normalizedRangeHeader });
-  }
-
-  // Specifying multiple ranges separate by commas is valid syntax, but this
-  // library only attempts to handle a single, contiguous sequence of bytes.
-  // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range#Syntax
-  if (normalizedRangeHeader.includes(",")) {
-    throw new SerwistError("single-range-only", { normalizedRangeHeader });
-  }
-
-  const rangeParts = /(\d*)-(\d*)/.exec(normalizedRangeHeader);
-  // We need either at least one of the start or end values.
-  if (!rangeParts || !(rangeParts[1] || rangeParts[2])) {
-    throw new SerwistError("invalid-range-values", { normalizedRangeHeader });
-  }
-
-  return {
-    start: rangeParts[1] === "" ? undefined : Number(rangeParts[1]),
-    end: rangeParts[2] === "" ? undefined : Number(rangeParts[2]),
-  };
-}
-
-export { parseRangeHeader };