@reykjavik/webtools 0.1.27 → 0.1.28

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 - ... <!-- Add new lines here. -->
 
+## 0.1.28
+
+_2024-08-26_
+
+- `@reykjavik/webtools/http`:
+  - feat: `cacheControl` now also accepts `Map<string, string>` for headers
+
 ## 0.1.27
 
 _2024-07-18_

package/README.md

@@ -112,10 +112,10 @@ codes, are also available:
 ### `cacheControl` helper
 
 **Syntax:**
-`cacheConrol(response: ServerResponse | { res: ServerResponse }, ttlCfg: TTLConfig, eTag?: string|number): void`
+`cacheConrol(response: ServerResponse | Response | Map<string, string> | { res: ServerResponse | Response }, ttlCfg: TTLConfig, eTag?: string|number): void`
 
 Use this function to quickly set the `Cache-Control` header with a `max-age=`
-on a HTTP response.
+on a HTTP response (or a `Map` object representing response headers).
 
 ```js
 import { cacheControl } from '@reykjavik/webtools/http';

package/esm/http.d.ts

@@ -168,7 +168,7 @@ type ServerResponseStub = Pick<ServerResponse, 'setHeader' | 'getHeader' | 'remo
     headers?: Record<string, string | Array<string>>;
 };
 type ResponseStub = {
-    headers: Pick<Headers, 'set' | 'get' | 'delete' | 'append'>;
+    headers: Pick<Headers, 'set' | 'get' | 'delete'>;
 };
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
@@ -176,7 +176,7 @@ type ResponseStub = {
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#getcssbundleurl
  */
-export declare const cacheControl: (response: ServerResponseStub | ResponseStub | {
+export declare const cacheControl: (response: ServerResponseStub | ResponseStub | Map<string, string> | {
     res: ServerResponseStub | ResponseStub;
 }, ttlCfg: TTLConfig, eTag?: string | number) => void;
 export {};

package/esm/http.js

@@ -147,6 +147,9 @@ export const toSec = (ttl) => {
     return Math.max(0, Math.round(ttl)) || 0;
 };
 const toRespnseStubHeaders = (response) => {
+    if (response instanceof Map) {
+        return response;
+    }
     if ('headers' in response && !('setHeader' in response)) {
         return response.headers;
     }
@@ -159,15 +162,6 @@ const toRespnseStubHeaders = (response) => {
             return val != null ? `${val}` : null;
         },
         set: (name, value) => response.setHeader(name, value),
-        append: (name, value) => {
-            const existing = response.getHeader(name);
-            if (existing) {
-                response.setHeader(name, `${existing}, ${value}`);
-            }
-            else {
-                response.setHeader(name, value);
-            }
-        },
         delete: (name) => response.removeHeader(name),
     };
 };

package/http.d.ts

@@ -168,7 +168,7 @@ type ServerResponseStub = Pick<ServerResponse, 'setHeader' | 'getHeader' | 'remo
     headers?: Record<string, string | Array<string>>;
 };
 type ResponseStub = {
-    headers: Pick<Headers, 'set' | 'get' | 'delete' | 'append'>;
+    headers: Pick<Headers, 'set' | 'get' | 'delete'>;
 };
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
@@ -176,7 +176,7 @@ type ResponseStub = {
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#getcssbundleurl
  */
-export declare const cacheControl: (response: ServerResponseStub | ResponseStub | {
+export declare const cacheControl: (response: ServerResponseStub | ResponseStub | Map<string, string> | {
     res: ServerResponseStub | ResponseStub;
 }, ttlCfg: TTLConfig, eTag?: string | number) => void;
 export {};

package/http.js

@@ -152,6 +152,9 @@ const toSec = (ttl) => {
 };
 exports.toSec = toSec;
 const toRespnseStubHeaders = (response) => {
+    if (response instanceof Map) {
+        return response;
+    }
     if ('headers' in response && !('setHeader' in response)) {
         return response.headers;
     }
@@ -164,15 +167,6 @@ const toRespnseStubHeaders = (response) => {
             return val != null ? `${val}` : null;
         },
         set: (name, value) => response.setHeader(name, value),
-        append: (name, value) => {
-            const existing = response.getHeader(name);
-            if (existing) {
-                response.setHeader(name, `${existing}, ${value}`);
-            }
-            else {
-                response.setHeader(name, value);
-            }
-        },
         delete: (name) => response.removeHeader(name),
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.1.27",
+	"version": "0.1.28",
 	"description": "Misc. JS/TS helpers used by Reykjavík City's web dev teams.",
 	"main": "index.js",
 	"repository": "ssh://git@github.com:reykjavikcity/webtools.git",