@httpland/compression-middleware 1.0.0-beta.1 → 1.0.0

package/README.md

@@ -29,7 +29,7 @@ For a definition of Universal HTTP middleware, see the
 Middleware convert message body and adds the `Content-Encoding` header to the
 response.
 
-Also, safely add `Accept-Encoding` to the `vary` header in response.
+Also, safely add `Accept-Encoding` to the `Vary` header in response.
 
 ```ts
 import { compression } from "https://deno.land/x/compression_middleware@$VERSION/mod.ts";

package/esm/deps.js

@@ -3,6 +3,6 @@
 export { CachingHeader, ContentNegotiationHeader, RepresentationHeader, } from "@httpland/http-utils";
 export { acceptsEncodings } from "./deps/deno.land/std@0.180.0/http/negotiation.js";
 export { parseMediaType } from "./deps/deno.land/std@0.180.0/media_types/mod.js";
-export { isNull } from "isxx";
+export { isIterable, isNull, } from "isxx";
 export { default as compressible } from "compressible";
 export { vary } from "./deps/deno.land/x/vary@1.0.0/mod.js";

package/esm/middleware.js

@@ -1,10 +1,10 @@
 // Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
 // This module is browser compatible.
-import { acceptsEncodings, ContentNegotiationHeader, vary, } from "./deps.js";
+import { acceptsEncodings, ContentNegotiationHeader, isIterable, vary, } from "./deps.js";
 import { withContentEncoding } from "./transform.js";
 import { Gzip } from "./encoders/gzip.js";
 import { Deflate } from "./encoders/deflate.js";
-const DefaultEncoders = [Gzip, Deflate];
+const BuiltInEncoders = [Gzip, Deflate];
 /** Create HTTP content compression middleware.
  *
  * @example
@@ -30,8 +30,8 @@ const DefaultEncoders = [Gzip, Deflate];
  */
 export function compression(encoders) {
     const encodingMap = {
-        ...fromEncoders(DefaultEncoders),
-        ...Array.isArray(encoders) ? fromEncoders(encoders) : encoders,
+        ...fromEncoders(BuiltInEncoders),
+        ...isIterable(encoders) ? fromEncoders(encoders) : encoders,
     };
     const encodings = Object.keys(encodingMap);
     return async (request, next) => {
@@ -50,6 +50,6 @@ export function flat(encoder) {
     return [encoder.encoding, encoder.encode];
 }
 export function fromEncoders(encoders) {
-    return Object.fromEntries(encoders.map(flat));
+    return Object.fromEntries(Array.from(encoders).map(flat));
 }
 const IDENTITY = "identity";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "@httpland/compression-middleware",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0",
   "description": "HTTP compression middleware",
   "keywords": [
     "http",

package/script/deps.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.vary = exports.compressible = exports.isNull = exports.parseMediaType = exports.acceptsEncodings = exports.RepresentationHeader = exports.ContentNegotiationHeader = exports.CachingHeader = void 0;
+exports.vary = exports.compressible = exports.isNull = exports.isIterable = exports.parseMediaType = exports.acceptsEncodings = exports.RepresentationHeader = exports.ContentNegotiationHeader = exports.CachingHeader = void 0;
 var http_utils_1 = require("@httpland/http-utils");
 Object.defineProperty(exports, "CachingHeader", { enumerable: true, get: function () { return http_utils_1.CachingHeader; } });
 Object.defineProperty(exports, "ContentNegotiationHeader", { enumerable: true, get: function () { return http_utils_1.ContentNegotiationHeader; } });
@@ -15,6 +15,7 @@ Object.defineProperty(exports, "acceptsEncodings", { enumerable: true, get: func
 var mod_js_1 = require("./deps/deno.land/std@0.180.0/media_types/mod.js");
 Object.defineProperty(exports, "parseMediaType", { enumerable: true, get: function () { return mod_js_1.parseMediaType; } });
 var isxx_1 = require("isxx");
+Object.defineProperty(exports, "isIterable", { enumerable: true, get: function () { return isxx_1.isIterable; } });
 Object.defineProperty(exports, "isNull", { enumerable: true, get: function () { return isxx_1.isNull; } });
 var compressible_1 = require("compressible");
 Object.defineProperty(exports, "compressible", { enumerable: true, get: function () { return __importDefault(compressible_1).default; } });

package/script/middleware.js

@@ -7,7 +7,7 @@ const deps_js_1 = require("./deps.js");
 const transform_js_1 = require("./transform.js");
 const gzip_js_1 = require("./encoders/gzip.js");
 const deflate_js_1 = require("./encoders/deflate.js");
-const DefaultEncoders = [gzip_js_1.Gzip, deflate_js_1.Deflate];
+const BuiltInEncoders = [gzip_js_1.Gzip, deflate_js_1.Deflate];
 /** Create HTTP content compression middleware.
  *
  * @example
@@ -33,8 +33,8 @@ const DefaultEncoders = [gzip_js_1.Gzip, deflate_js_1.Deflate];
  */
 function compression(encoders) {
     const encodingMap = {
-        ...fromEncoders(DefaultEncoders),
-        ...Array.isArray(encoders) ? fromEncoders(encoders) : encoders,
+        ...fromEncoders(BuiltInEncoders),
+        ...(0, deps_js_1.isIterable)(encoders) ? fromEncoders(encoders) : encoders,
     };
     const encodings = Object.keys(encodingMap);
     return async (request, next) => {
@@ -55,7 +55,7 @@ function flat(encoder) {
 }
 exports.flat = flat;
 function fromEncoders(encoders) {
-    return Object.fromEntries(encoders.map(flat));
+    return Object.fromEntries(Array.from(encoders).map(flat));
 }
 exports.fromEncoders = fromEncoders;
 const IDENTITY = "identity";

package/types/deps.d.ts

@@ -1,7 +1,7 @@
-export { type Middleware } from "@httpland/http-middleware";
+export { type Handler, type Middleware, } from "@httpland/http-middleware";
 export { CachingHeader, ContentNegotiationHeader, RepresentationHeader, } from "@httpland/http-utils";
 export { acceptsEncodings } from "./deps/deno.land/std@0.180.0/http/negotiation.js";
 export { parseMediaType } from "./deps/deno.land/std@0.180.0/media_types/mod.js";
-export { isNull } from "isxx";
+export { isIterable, isNull, } from "isxx";
 export { default as compressible } from "compressible";
 export { vary } from "./deps/deno.land/x/vary@1.0.0/mod.js";

package/types/middleware.d.ts

@@ -23,6 +23,6 @@ import type { Encode, Encoder, EncodingMap } from "./types.js";
  * assertEquals(response.headers.get("content-encoding"), "gzip");
  * ```
  */
-export declare function compression(encoders?: Encoder[] | EncodingMap): Middleware;
+export declare function compression(encoders?: Iterable<Encoder> | EncodingMap): Middleware;
 export declare function flat(encoder: Encoder): [encoding: string, encode: Encode];
-export declare function fromEncoders(encoders: readonly Encoder[]): EncodingMap;
+export declare function fromEncoders(encoders: Iterable<Encoder>): EncodingMap;

package/types/mod.d.ts

@@ -1,2 +1,3 @@
 export { compression } from "./middleware.js";
 export type { Encode, Encoder, EncodingMap } from "./types.js";
+export type { Handler, Middleware } from "./deps.js";