@reykjavik/webtools 0.1.24 → 0.1.26

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 - ... <!-- Add new lines here. -->
 
+## 0.1.26
+
+_2024-05-25_
+
+- `@reykjavik/webtools/fixIcelandicLocale`:
+  - fix: Emit `"*dagur, "`, not `"*dagurinn "` from `Intl.DateTimeFormat`
+
+## 0.1.25
+
+_2024-05-17_
+
+- `@reykjavik/webtools/http`:
+  - feat: `cacheControl` now also accepts standard `Response` objects
+
 ## 0.1.24
 
 _2024-03-22_

package/README.md

@@ -268,7 +268,8 @@ values.
 
 - `Intl.Collator` and `String.prototype.localeCompare`
 - `Intl.NumberFormat` and `Number.prototype.toLocaleString`
-- `Intl.DateTimeFormat` and `Date.prototype.toLocaleDateString`
+- `Intl.DateTimeFormat` and `Date.prototype.toLocaleString`,
+  `.toLocaleDateString`, and `.toLocaleTimeString`
 - `Intl.PluralRules`
 - `Intl.ListFormat`
 
@@ -341,28 +342,20 @@ editor), but there's a brief summary:
 - `scriptUrl?: string` — The full SiteImprove analytics script URL.
   (alternative to `accountId` prop).
 - `hasConsented?: boolean` — Manual GDPR 'analytics' consent flag. Allows hard
-  opt-out, but defers to
-  [`CookieHubProvider` values](./README.md#usecookiehubconsent) if they are
-  available.
+  opt-out, but defers to [`CookieHubProvider` values](#usecookiehubconsent) if
+  they are available.
 - `onLoad?: (e: unknown) => void` — Fires when the script has loaded.
 - `onError?: (e: unknown) => void` — Fires if loading the script failed.
 
 Example usage somewhere in your application:
 
-```js
+```jsz
 import { SiteImprove } from '@reykjavik/webtools/SiteImprove';
 
-// ideally emit this from your loader function
 const siteImproveAccountId = '[ACCOUNT_ID]'; // e.g. "7654321"
 
-   const location = useRouter()
-// ...then Inside root.tsx component:
-  <SiteImprove
-    accountId={siteImproveAccountId}
-    onError={(error) =>
-      Logger('error', 'An error occured initializing siteimprove', error)
-    }
-  />;
+// ...then inside your main App component
+<SiteImprove accountId={siteImproveAccountId} />;
 ```
 
 In dev mode it does NOT load the SiteImprove script and merely logs page-view

package/esm/fixIcelandicLocale.privates.js

@@ -172,7 +172,7 @@ const partMappers = {
     },
     literal: (value, lastType) => {
         if (value === ' den ') {
-            return 'inn ';
+            return ', ';
         }
         else if (value === '.' && (lastType === 'hour' || lastType === 'minute')) {
             return ':';

package/esm/http.d.ts

@@ -1,4 +1,5 @@
-import type { ServerResponse } from 'http';
+/// <reference types="node" resolution-mode="require"/>
+import { ServerResponse } from 'node:http';
 /** The client should continue the request or ignore the response if the request is already finished. */
 export declare const HTTP_100_Continue = 100;
 /** Response to an Upgrade request header from the client and indicates the protocol the server is switching to. */
@@ -163,13 +164,19 @@ export type TTLConfig = TTL | TTLKeywords | TTLObj;
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#tosec-ttl-helper
  */
 export declare const toSec: (ttl: TTL) => number;
+type ServerResponseStub = Pick<ServerResponse, 'setHeader' | 'getHeader' | 'removeHeader'> & {
+    headers?: Record<string, string | Array<string>>;
+};
+type ResponseStub = {
+    headers: Pick<Headers, 'set' | 'get' | 'delete' | 'append'>;
+};
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
  * on a HTTP response
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#getcssbundleurl
  */
-export declare const cacheControl: (response: ServerResponse | {
-    res: ServerResponse;
+export declare const cacheControl: (response: ServerResponseStub | ResponseStub | {
+    res: ServerResponseStub | ResponseStub;
 }, ttlCfg: TTLConfig, eTag?: string | number) => void;
 export {};

package/esm/http.js

@@ -146,6 +146,31 @@ export const toSec = (ttl) => {
     }
     return Math.max(0, Math.round(ttl)) || 0;
 };
+const toRespnseStubHeaders = (response) => {
+    if ('headers' in response && !('setHeader' in response)) {
+        return response.headers;
+    }
+    return {
+        get: (name) => {
+            const val = response.getHeader(name);
+            if (Array.isArray(val)) {
+                return val.join(', ');
+            }
+            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),
+    };
+};
 const stabilities = {
     revalidate: ', must-revalidate',
     immutable: ', immutable',
@@ -153,16 +178,17 @@ const stabilities = {
 };
 const setCC = (response, cc) => {
     const devModeHeader = 'X-Cache-Control';
+    const headers = toRespnseStubHeaders(response);
     // Also set `X-Cache-Control` in dev mode, because some frameworks
-    // **cough** **nextjs** **cough** forcefully override the `Cache-Control`
+    // **cough** **Nextjs** **cough** forcefully override the `Cache-Control`
     // header when the server is in dev mode.
     if (!cc) {
-        response.removeHeader('Cache-Control');
-        process.env.NODE_ENV !== 'production' && response.removeHeader(devModeHeader);
+        headers.delete('Cache-Control');
+        process.env.NODE_ENV !== 'production' && headers.delete(devModeHeader);
         return;
     }
-    response.setHeader('Cache-Control', cc);
-    process.env.NODE_ENV !== 'production' && response.setHeader(devModeHeader, cc);
+    headers.set('Cache-Control', cc);
+    process.env.NODE_ENV !== 'production' && headers.set(devModeHeader, cc);
 };
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
@@ -189,7 +215,7 @@ export const cacheControl = (response, ttlCfg, eTag) => {
         }
     }
     if (maxAge == null) {
-        response.removeHeader('Cache-Control');
+        toRespnseStubHeaders(response).delete('Cache-Control');
         return;
     }
     maxAge = toSec(maxAge);
@@ -204,5 +230,5 @@ export const cacheControl = (response, ttlCfg, eTag) => {
     const scope = opts.publ ? 'public' : 'private';
     const stability = (opts.stability && stabilities[opts.stability]) || stabilities.immutable;
     setCC(response, `${scope}, max-age=${maxAge + sWR + sIE + stability}`);
-    eTag != null && response.setHeader('ETag', eTag);
+    eTag != null && toRespnseStubHeaders(response).set('ETag', String(eTag));
 };

package/esm/remix/Wait.d.ts

@@ -37,7 +37,7 @@ export type WaitComponent<CustomProps extends Record<string, unknown> = Record<n
     displayName?: string;
 };
 /**
- * Wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
+ * A thin wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
  * component, to provide a more ergonomic API.
  *
  * If the awaited promise (`props.for`) resolves to an object with a truthy

package/esm/remix/Wait.js

@@ -1,7 +1,7 @@
 import React, { Suspense } from 'react';
 import { Await } from '@remix-run/react';
 /**
- * Wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
+ * A thin wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
  * component, to provide a more ergonomic API.
  *
  * If the awaited promise (`props.for`) resolves to an object with a truthy

package/fixIcelandicLocale.privates.js

@@ -177,7 +177,7 @@ const partMappers = {
     },
     literal: (value, lastType) => {
         if (value === ' den ') {
-            return 'inn ';
+            return ', ';
         }
         else if (value === '.' && (lastType === 'hour' || lastType === 'minute')) {
             return ':';

package/http.d.ts

@@ -1,4 +1,5 @@
-import type { ServerResponse } from 'http';
+/// <reference types="node" />
+import { ServerResponse } from 'node:http';
 /** The client should continue the request or ignore the response if the request is already finished. */
 export declare const HTTP_100_Continue = 100;
 /** Response to an Upgrade request header from the client and indicates the protocol the server is switching to. */
@@ -163,13 +164,19 @@ export type TTLConfig = TTL | TTLKeywords | TTLObj;
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#tosec-ttl-helper
  */
 export declare const toSec: (ttl: TTL) => number;
+type ServerResponseStub = Pick<ServerResponse, 'setHeader' | 'getHeader' | 'removeHeader'> & {
+    headers?: Record<string, string | Array<string>>;
+};
+type ResponseStub = {
+    headers: Pick<Headers, 'set' | 'get' | 'delete' | 'append'>;
+};
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
  * on a HTTP response
  *
  * @see https://github.com/reykjavikcity/webtools/blob/v0.1/README.md#getcssbundleurl
  */
-export declare const cacheControl: (response: ServerResponse | {
-    res: ServerResponse;
+export declare const cacheControl: (response: ServerResponseStub | ResponseStub | {
+    res: ServerResponseStub | ResponseStub;
 }, ttlCfg: TTLConfig, eTag?: string | number) => void;
 export {};

package/http.js

@@ -151,6 +151,31 @@ const toSec = (ttl) => {
     return Math.max(0, Math.round(ttl)) || 0;
 };
 exports.toSec = toSec;
+const toRespnseStubHeaders = (response) => {
+    if ('headers' in response && !('setHeader' in response)) {
+        return response.headers;
+    }
+    return {
+        get: (name) => {
+            const val = response.getHeader(name);
+            if (Array.isArray(val)) {
+                return val.join(', ');
+            }
+            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),
+    };
+};
 const stabilities = {
     revalidate: ', must-revalidate',
     immutable: ', immutable',
@@ -158,16 +183,17 @@ const stabilities = {
 };
 const setCC = (response, cc) => {
     const devModeHeader = 'X-Cache-Control';
+    const headers = toRespnseStubHeaders(response);
     // Also set `X-Cache-Control` in dev mode, because some frameworks
-    // **cough** **nextjs** **cough** forcefully override the `Cache-Control`
+    // **cough** **Nextjs** **cough** forcefully override the `Cache-Control`
     // header when the server is in dev mode.
     if (!cc) {
-        response.removeHeader('Cache-Control');
-        process.env.NODE_ENV !== 'production' && response.removeHeader(devModeHeader);
+        headers.delete('Cache-Control');
+        process.env.NODE_ENV !== 'production' && headers.delete(devModeHeader);
         return;
     }
-    response.setHeader('Cache-Control', cc);
-    process.env.NODE_ENV !== 'production' && response.setHeader(devModeHeader, cc);
+    headers.set('Cache-Control', cc);
+    process.env.NODE_ENV !== 'production' && headers.set(devModeHeader, cc);
 };
 /**
  * Use this function to quickly set the `Cache-Control` header with a `max-age=`
@@ -194,7 +220,7 @@ const cacheControl = (response, ttlCfg, eTag) => {
         }
     }
     if (maxAge == null) {
-        response.removeHeader('Cache-Control');
+        toRespnseStubHeaders(response).delete('Cache-Control');
         return;
     }
     maxAge = (0, exports.toSec)(maxAge);
@@ -209,6 +235,6 @@ const cacheControl = (response, ttlCfg, eTag) => {
     const scope = opts.publ ? 'public' : 'private';
     const stability = (opts.stability && stabilities[opts.stability]) || stabilities.immutable;
     setCC(response, `${scope}, max-age=${maxAge + sWR + sIE + stability}`);
-    eTag != null && response.setHeader('ETag', eTag);
+    eTag != null && toRespnseStubHeaders(response).set('ETag', String(eTag));
 };
 exports.cacheControl = cacheControl;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.1.24",
+	"version": "0.1.26",
 	"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",

package/remix/Wait.d.ts

@@ -37,7 +37,7 @@ export type WaitComponent<CustomProps extends Record<string, unknown> = Record<n
     displayName?: string;
 };
 /**
- * Wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
+ * A thin wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
  * component, to provide a more ergonomic API.
  *
  * If the awaited promise (`props.for`) resolves to an object with a truthy

package/remix/Wait.js

@@ -27,7 +27,7 @@ exports.Wait = void 0;
 const react_1 = __importStar(require("react"));
 const react_2 = require("@remix-run/react");
 /**
- * Wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
+ * A thin wrapper around [Remix's `Await`](https://remix.run/docs/en/2/components/await)
  * component, to provide a more ergonomic API.
  *
  * If the awaited promise (`props.for`) resolves to an object with a truthy