@reykjavik/webtools 0.1.9 → 0.1.10

package/CHANGELOG.md

@@ -1,9 +1,18 @@
-# Change Log for `es-in-css`
+# Change Log for `@reykjavik/webtools`
 
 ## Upcoming...
 
 - ... <!-- Add new lines here. -->
 
+## 0.1.10
+
+_2024-02-14_
+
+- `@reykjavik/webtools/http`
+  - feat: Add the rest of the more obscure HTTP status constants (WebDAV,
+    etc.)
+  - fix: Add `429`, `432`, `451` to `HTTP_CLIENT_ERROR_ALL` type
+
 ## 0.1.9
 
 _2023-04-27_

package/CookieHubConsent.d.ts

@@ -1,4 +1,4 @@
-import { ReactNode } from 'react';
+import React, { ReactNode } from 'react';
 import { EitherObj } from '@reykjavik/hanna-utils';
 declare global {
     interface Window {
@@ -220,7 +220,7 @@ export type CookieHubProviderProps = EitherObj<{
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1##cookiehubprovider-component
  */
-export declare const CookieHubProvider: (props: CookieHubProviderProps) => JSX.Element;
+export declare const CookieHubProvider: (props: CookieHubProviderProps) => React.JSX.Element;
 /**
  * Returns up-to-date cookie consent flags. For use in React components or hook
  * functions.

package/CookieHubConsent.js

@@ -74,7 +74,9 @@ const CookieHubProvider = (props) => {
                 ? props.scriptUrl
                 : scriptUrlTemplate.replace(idToken, props.accountId);
         script.onload = () => {
-            window.cookiehub.load(Object.assign(Object.assign({}, opts), { onInitialise(status) {
+            window.cookiehub.load({
+                ...opts,
+                onInitialise(status) {
                     const analytics = this.hasConsented('analytics');
                     const preferences = this.hasConsented('preferences');
                     const marketing = this.hasConsented('marketing');
@@ -96,16 +98,27 @@ const CookieHubProvider = (props) => {
                     if (category === 'necessary') {
                         return;
                     }
-                    setState((state) => (Object.assign(Object.assign({}, state), { consent: Object.assign(Object.assign({}, state.consent), { [category]: true }) })));
+                    setState((state) => ({
+                        ...state,
+                        consent: { ...state.consent, [category]: true },
+                    }));
                     opts.onAllow && opts.onAllow.call(this, category);
                 },
                 onRevoke(category) {
                     if (category === 'necessary') {
                         return;
                     }
-                    setState((state) => (Object.assign(Object.assign({}, state), { consent: Object.assign(Object.assign({}, state.consent), { [category]: false }) })));
+                    setState((state) => ({
+                        ...state,
+                        consent: { ...state.consent, [category]: false },
+                    }));
                     opts.onAllow && opts.onAllow.call(this, category);
-                }, cookie: Object.assign({ secure: true }, opts.cookie) }));
+                },
+                cookie: {
+                    secure: true,
+                    ...opts.cookie,
+                },
+            });
             moveCookiehubScriptInDomTree();
         };
         props.onError && (script.onerror = props.onError);

package/README.md

@@ -3,11 +3,13 @@
 Miscellaneous JavaScript/TypeScript helpers used by Reykjavík City's web dev
 teams.
 
-This library is split up into multple individual modules to help keep your
+This library is split up into multiple individual modules to help keep your
 bundles slim and aid tree-shaking.
 
 ```
+npm install @reykjavik/webtools
 yarn add @reykjavik/webtools
+bun add @reykjavik/webtools
 ```
 
 **Table of Contents:**
@@ -31,6 +33,8 @@ yarn add @reykjavik/webtools
   - [`SiteImprove` component](#siteimprove-component)
   - [`pingSiteImprove` helper](#pingsiteimprove-helper)
   - [`pingSiteImproveOutbound` helper](#pingsiteimproveoutbound-helper)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
 
 <!-- prettier-ignore-start -->
 
@@ -158,8 +162,8 @@ behavior.
 
 ### `toSec` TTL helper
 
-**Syntax:** <code>toSec; (ttl: number | `${number}${'s'|'m'|'h'|'d'|'w'}`) =>
-number</code>
+**Syntax:**
+`` toSec; (ttl: number | `${number}${'s'|'m'|'h'|'d'|'w'}`) => number ``
 
 Converts a `TTL` (max-age) value into seconds, and returns `0` for bad and/or
 negative input values.
@@ -416,12 +420,23 @@ applications and perform custom event tracking.
 A component for loading a SiteImprove analytics script and set up page-view
 tracking across Next.js routes.
 
-It also automatically logs all out-öbound link clicks.
+It also automatically logs all out-bound link clicks.
+
+Example usage in pages/\_app.tsx
 
 ```js
 import { SiteImprove } from '@reykjavik/webtools/next/SiteImprove';
 
 const siteImproveAccountId = '[ACCOUNT_ID]'; // e.g. "7654321"
+
+// Inside MyApp component
+<Component {...pageProps} />
+<SiteImprove
+  accountId={siteImproveAccountId}
+  onError={(error) =>
+    Logger('error', 'An error occured initializing siteimprove', error)
+  }
+/>;
 ```
 
 The component has an optional `hasConsented` prop which can be used to
@@ -441,7 +456,7 @@ editor), but there's a brief summary:
   (alternative to `accountId` prop).
 - `hasConstented?: boolean` — Manual GDPR 'analytics' consent flag. Allows
   hard opt-out, but defers to
-  [`CookieHubProvider` values](#usecookiehubconsent) by default.
+  [`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.
 
@@ -478,13 +493,21 @@ import { pingSiteImproveOutbound } from '@reykjavik/webtools/next/SiteImprove';
 const handleSubmit = () => {
   // perform submit action...
   if (success) {
-    const fileUrl ='/download/report.pdf'
+    const fileUrl = '/download/report.pdf';
     pingSiteImproveOutbound(fileUrl);
-    document.location.href = fileUrl
+    document.location.href = fileUrl;
   }
 };
+```
 
+---
 
+## Contributing
+
+This project uses the [Bun runtime](https://bun.sh) for development (tests,
+build, etc.)
+
+PRs are welcoms!
 
 ---
 
@@ -492,4 +515,7 @@ const handleSubmit = () => {
 
 See
 [CHANGELOG.md](https://github.com/reykjavikcity/webtools/blob/main/CHANGELOG.md)
+
+```
+
 ```

package/esm/CookieHubConsent.d.ts

@@ -1,4 +1,4 @@
-import { ReactNode } from 'react';
+import React, { ReactNode } from 'react';
 import { EitherObj } from '@reykjavik/hanna-utils';
 declare global {
     interface Window {
@@ -220,7 +220,7 @@ export type CookieHubProviderProps = EitherObj<{
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1##cookiehubprovider-component
  */
-export declare const CookieHubProvider: (props: CookieHubProviderProps) => JSX.Element;
+export declare const CookieHubProvider: (props: CookieHubProviderProps) => React.JSX.Element;
 /**
  * Returns up-to-date cookie consent flags. For use in React components or hook
  * functions.

package/esm/CookieHubConsent.js

@@ -48,7 +48,9 @@ export const CookieHubProvider = (props) => {
                 ? props.scriptUrl
                 : scriptUrlTemplate.replace(idToken, props.accountId);
         script.onload = () => {
-            window.cookiehub.load(Object.assign(Object.assign({}, opts), { onInitialise(status) {
+            window.cookiehub.load({
+                ...opts,
+                onInitialise(status) {
                     const analytics = this.hasConsented('analytics');
                     const preferences = this.hasConsented('preferences');
                     const marketing = this.hasConsented('marketing');
@@ -70,16 +72,27 @@ export const CookieHubProvider = (props) => {
                     if (category === 'necessary') {
                         return;
                     }
-                    setState((state) => (Object.assign(Object.assign({}, state), { consent: Object.assign(Object.assign({}, state.consent), { [category]: true }) })));
+                    setState((state) => ({
+                        ...state,
+                        consent: { ...state.consent, [category]: true },
+                    }));
                     opts.onAllow && opts.onAllow.call(this, category);
                 },
                 onRevoke(category) {
                     if (category === 'necessary') {
                         return;
                     }
-                    setState((state) => (Object.assign(Object.assign({}, state), { consent: Object.assign(Object.assign({}, state.consent), { [category]: false }) })));
+                    setState((state) => ({
+                        ...state,
+                        consent: { ...state.consent, [category]: false },
+                    }));
                     opts.onAllow && opts.onAllow.call(this, category);
-                }, cookie: Object.assign({ secure: true }, opts.cookie) }));
+                },
+                cookie: {
+                    secure: true,
+                    ...opts.cookie,
+                },
+            });
             moveCookiehubScriptInDomTree();
         };
         props.onError && (script.onerror = props.onError);

package/esm/http.d.ts

@@ -3,6 +3,10 @@ import { ServerResponse } from 'http';
 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. */
 export declare const HTTP_101_SwitchingProtocols = 101;
+/** (WebDAV) The server has received and is processing the request, but no response is available yet. */
+export declare const HTTP_102_Processing = 102;
+/** This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources. */
+export declare const HTTP_103_EarlyHints = 103;
 /** The request succeeded, and the response body contains the requested resource. */
 export declare const HTTP_200_OK = 200;
 /** The request succeeded, and a new resource was created as a result. This is typically the response sent after POST or PUT requests. */
@@ -12,8 +16,16 @@ export declare const HTTP_202_Accepted = 202;
 export declare const HTTP_203_NonAuthoritativeInformation = 203;
 /** The response body is empty. */
 export declare const HTTP_204_NoContent = 204;
+/** Tells the user agent to reset the document which sent this request. */
+export declare const HTTP_205_ResetContent = 205;
 /** The request succeeded, but the returned metadata is not necessarily complete. */
 export declare const HTTP_206_PartialContent = 206;
+/** (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate. */
+export declare const HTTP_207_MultiStatus = 207;
+/** (WebDAV) Used inside a `<dav:propstat>` response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. */
+export declare const HTTP_208_AlreadyReported = 208;
+/** (HTTP Delta Encoding) The server has fulfilled a `GET` request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */
+export declare const HTTP_226_IMUsed = 226;
 /**
  * Only safe to use in response to GET and HEAD requests
  *
@@ -70,6 +82,12 @@ export declare const HTTP_417_ExpectationFailed = 417;
 export declare const HTTP_418_ImATeapot = 418;
 /** The request was directed at a server that is not able to produce a response. */
 export declare const HTTP_421_MisdirectedRequest = 421;
+/** (WebDAV) The request was well-formed but was unable to be followed due to semantic errors. */
+export declare const HTTP_422_UnprocessableContent = 422;
+/** (WebDAV) The resource that is being accessed is locked. */
+export declare const HTTP_423_Locked = 423;
+/** (WebDAV) The request failed due to failure of a previous request. */
+export declare const HTTP_424_FailedDependency = 424;
 /** The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */
 export declare const HTTP_426_UpgradeRequired = 426;
 /** The origin server requires the request to be conditional. */
@@ -94,6 +112,10 @@ export declare const HTTP_504_GatewayTimeout = 504;
 export declare const HTTP_505_HTTPVersionNotSupported = 505;
 /** The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself. */
 export declare const HTTP_506_VariantAlsoNegotiates = 506;
+/** (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
+export declare const HTTP_507_InsufficientStorage = 507;
+/** (WebDAV) The server detected an infinite loop while processing the request. */
+export declare const HTTP_508_LoopDetected = 508;
 /** Further extensions to the request are required for the server to fulfill it. */
 export declare const HTTP_510_NotExtended = 510;
 /** The client needs to authenticate to gain network access. */
@@ -108,11 +130,11 @@ export type HTTP_CLIENT_ERROR = HTTP_NOT_FOUND | HTTP_BANNED;
 export type HTTP_SERVER_ERROR = typeof HTTP_500_InternalServerError;
 export type HTTP_ERROR = HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
 export type HTTP_STATUS = HTTP_INFO_ALL | HTTP_SUCCESS_ALL | HTTP_REDIRECTION_ALL | HTTP_CLIENT_ERROR_ALL | HTTP_SERVER_ERROR_ALL;
-export type HTTP_INFO_ALL = HTTP_INFO;
-export type HTTP_SUCCESS_ALL = HTTP_SUCCESS | typeof HTTP_203_NonAuthoritativeInformation | typeof HTTP_204_NoContent | typeof HTTP_206_PartialContent;
+export type HTTP_INFO_ALL = HTTP_INFO | typeof HTTP_102_Processing | typeof HTTP_103_EarlyHints;
+export type HTTP_SUCCESS_ALL = HTTP_SUCCESS | typeof HTTP_203_NonAuthoritativeInformation | typeof HTTP_204_NoContent | typeof HTTP_205_ResetContent | typeof HTTP_206_PartialContent | typeof HTTP_207_MultiStatus | typeof HTTP_208_AlreadyReported | typeof HTTP_226_IMUsed;
 export type HTTP_REDIRECTION_ALL = HTTP_REDIRECTION;
-export type HTTP_CLIENT_ERROR_ALL = HTTP_CLIENT_ERROR | typeof HTTP_405_MethodNotAllowed | typeof HTTP_406_NotAcceptable | typeof HTTP_407_ProxyAuthenticationRequired | typeof HTTP_408_RequestTimeout | typeof HTTP_409_Conflict | typeof HTTP_411_LengthRequired | typeof HTTP_412_PreconditionFailed | typeof HTTP_413_PayloadTooLarge | typeof HTTP_414_URITooLong | typeof HTTP_415_UnsupportedMediaType | typeof HTTP_416_RangeNotSatisfiable | typeof HTTP_417_ExpectationFailed | typeof HTTP_418_ImATeapot | typeof HTTP_421_MisdirectedRequest | typeof HTTP_426_UpgradeRequired | typeof HTTP_428_PreconditionRequired;
-export type HTTP_SERVER_ERROR_ALL = HTTP_SERVER_ERROR | typeof HTTP_501_NotImplemented | typeof HTTP_502_BadGateway | typeof HTTP_503_ServiceUnavailable | typeof HTTP_504_GatewayTimeout | typeof HTTP_505_HTTPVersionNotSupported | typeof HTTP_506_VariantAlsoNegotiates | typeof HTTP_510_NotExtended | typeof HTTP_511_NetworkAuthenticationRequired;
+export type HTTP_CLIENT_ERROR_ALL = HTTP_CLIENT_ERROR | typeof HTTP_405_MethodNotAllowed | typeof HTTP_406_NotAcceptable | typeof HTTP_407_ProxyAuthenticationRequired | typeof HTTP_408_RequestTimeout | typeof HTTP_409_Conflict | typeof HTTP_411_LengthRequired | typeof HTTP_412_PreconditionFailed | typeof HTTP_413_PayloadTooLarge | typeof HTTP_414_URITooLong | typeof HTTP_415_UnsupportedMediaType | typeof HTTP_416_RangeNotSatisfiable | typeof HTTP_417_ExpectationFailed | typeof HTTP_418_ImATeapot | typeof HTTP_421_MisdirectedRequest | typeof HTTP_422_UnprocessableContent | typeof HTTP_423_Locked | typeof HTTP_424_FailedDependency | typeof HTTP_426_UpgradeRequired | typeof HTTP_428_PreconditionRequired | typeof HTTP_429_TooManyRequests | typeof HTTP_431_RequestHeaderFieldsTooLarge | typeof HTTP_451_UnavailableForLegalReasons;
+export type HTTP_SERVER_ERROR_ALL = HTTP_SERVER_ERROR | typeof HTTP_501_NotImplemented | typeof HTTP_502_BadGateway | typeof HTTP_503_ServiceUnavailable | typeof HTTP_504_GatewayTimeout | typeof HTTP_505_HTTPVersionNotSupported | typeof HTTP_506_VariantAlsoNegotiates | typeof HTTP_507_InsufficientStorage | typeof HTTP_508_LoopDetected | typeof HTTP_510_NotExtended | typeof HTTP_511_NetworkAuthenticationRequired;
 export type HTTP_ERROR_ALL = HTTP_CLIENT_ERROR_ALL | HTTP_SERVER_ERROR_ALL;
 type TimeUnit = 's' | 'm' | 'h' | 'd' | 'w';
 export type TTL = number | `${number}${TimeUnit}`;

package/esm/http.js

@@ -3,6 +3,10 @@
 export const HTTP_100_Continue = 100;
 /** Response to an Upgrade request header from the client and indicates the protocol the server is switching to. */
 export const HTTP_101_SwitchingProtocols = 101;
+/** (WebDAV) The server has received and is processing the request, but no response is available yet. */
+export const HTTP_102_Processing = 102;
+/** This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources. */
+export const HTTP_103_EarlyHints = 103;
 // SUCCESS
 /** The request succeeded, and the response body contains the requested resource. */
 export const HTTP_200_OK = 200;
@@ -14,8 +18,16 @@ export const HTTP_202_Accepted = 202;
 export const HTTP_203_NonAuthoritativeInformation = 203;
 /** The response body is empty. */
 export const HTTP_204_NoContent = 204;
+/** Tells the user agent to reset the document which sent this request. */
+export const HTTP_205_ResetContent = 205;
 /** The request succeeded, but the returned metadata is not necessarily complete. */
 export const HTTP_206_PartialContent = 206;
+/** (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate. */
+export const HTTP_207_MultiStatus = 207;
+/** (WebDAV) Used inside a `<dav:propstat>` response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. */
+export const HTTP_208_AlreadyReported = 208;
+/** (HTTP Delta Encoding) The server has fulfilled a `GET` request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */
+export const HTTP_226_IMUsed = 226;
 // REDIRECTION
 /**
  * Only safe to use in response to GET and HEAD requests
@@ -74,6 +86,12 @@ export const HTTP_417_ExpectationFailed = 417;
 export const HTTP_418_ImATeapot = 418;
 /** The request was directed at a server that is not able to produce a response. */
 export const HTTP_421_MisdirectedRequest = 421;
+/** (WebDAV) The request was well-formed but was unable to be followed due to semantic errors. */
+export const HTTP_422_UnprocessableContent = 422;
+/** (WebDAV) The resource that is being accessed is locked. */
+export const HTTP_423_Locked = 423;
+/** (WebDAV) The request failed due to failure of a previous request. */
+export const HTTP_424_FailedDependency = 424;
 /** The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */
 export const HTTP_426_UpgradeRequired = 426;
 /** The origin server requires the request to be conditional. */
@@ -99,6 +117,10 @@ export const HTTP_504_GatewayTimeout = 504;
 export const HTTP_505_HTTPVersionNotSupported = 505;
 /** The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself. */
 export const HTTP_506_VariantAlsoNegotiates = 506;
+/** (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
+export const HTTP_507_InsufficientStorage = 507;
+/** (WebDAV) The server detected an infinite loop while processing the request. */
+export const HTTP_508_LoopDetected = 508;
 /** Further extensions to the request are required for the server to fulfill it. */
 export const HTTP_510_NotExtended = 510;
 /** The client needs to authenticate to gain network access. */

package/esm/index.d.ts

@@ -1,6 +1,6 @@
-/// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./http.d.ts" />
-/// <reference path="./next/http.d.tsx" />
+/// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./next/SiteImprove.d.tsx" />
+/// <reference path="./next/http.d.tsx" />
 
 export {};

package/esm/next/SiteImprove.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from 'react';
 import { EitherObj } from '@reykjavik/hanna-utils';
 declare global {
     interface Window {
@@ -43,6 +43,19 @@ type SiteImproveCustomEvent = [
     action: string,
     label?: string
 ];
+/**
+ * A small helper for tracking custom UI events and reporting them to SiteImrove.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
+ */
+export declare const pingSiteImprove: (category: string, action: string, label?: string) => void;
+/**
+ * A small helper for reporting to SiteImrove when the user is programmatically
+ * being sent to a different URL/resource.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
+ */
+export declare const pingSiteImproveOutbound: (ourl: string) => void;
 export type SiteImproveProps = EitherObj<{
     /**
      * Your SiteImprove account ID.
@@ -65,8 +78,8 @@ export type SiteImproveProps = EitherObj<{
      *
      * A value of `false` prevents the analytics script being loaded.
      *
-     * Any other value causes the component to defer to the `CookieHubProvider`
-     * component, and only applies if the cookiehub flag is undefined.
+     * A value of `true` still defers to the 'analytics' consent state provided
+     * by the `CookieHubProvider` component (if present).
      */
     hasConstented?: boolean;
     /**
@@ -84,18 +97,5 @@ export type SiteImproveProps = EitherObj<{
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1##siteimprove-component
  */
-export declare const SiteImprove: (props: SiteImproveProps) => JSX.Element | null;
-/**
- * A small helper for tracking custom UI events and reporting them to SiteImrove.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
- */
-export declare const pingSiteImprove: (category: string, action: string, label?: string) => void;
-/**
- * A small helper for reporting to SiteImrove when the user is programmatically
- * being sent to a different URL/resource.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
- */
-export declare const pingSiteImproveOutbound: (ourl: string) => void;
+export declare const SiteImprove: (props: SiteImproveProps) => React.JSX.Element | null;
 export {};

package/esm/next/SiteImprove.js

@@ -1,7 +1,9 @@
 import React, { useEffect } from 'react';
 import { Router } from 'next/router.js';
-import Script from 'next/script.js';
+import NextScript from 'next/script.js';
 import { useCookieHubConsent } from '../CookieHubConsent.js';
+// Fixes an issue with `next/script` types when `pkgJson.type === "module"`
+const Script = NextScript;
 // END: Mock typing of SiteImprove's event tracking API
 // --------------------------------------------------------------------------
 //
@@ -19,6 +21,34 @@ const _emitEvent = typeof window === 'undefined'
             console.info('SiteImprove:', event);
         }
     };
+// ---------------------------------------------------------------------------
+/**
+ * A small helper for tracking custom UI events and reporting them to SiteImrove.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
+ */
+export const pingSiteImprove = (category, action, label) => {
+    if (process.env.NODE_ENV === 'development' &&
+        (!window._sz || window._sz._jit_defined_)) {
+        console.warn('`pingSiteImprove` was called before SiteImprove script was loaded.');
+    }
+    _emitEvent(['event', category, action, label]);
+};
+// ---------------------------------------------------------------------------
+/**
+ * A small helper for reporting to SiteImrove when the user is programmatically
+ * being sent to a different URL/resource.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
+ */
+export const pingSiteImproveOutbound = (ourl) => {
+    if (process.env.NODE_ENV === 'development' &&
+        (!window._sz || window._sz._jit_defined_)) {
+        console.warn('`pingSiteImproveOutbound` was called before SiteImprove script was loaded.');
+    }
+    _emitEvent(['request', { ourl, ref: document.location.href }]);
+};
+// ---------------------------------------------------------------------------
 /*
   SiteImprove's "trackdynamic" (page view) event requires both the new URL
   and the old (referer) URL.
@@ -89,25 +119,26 @@ export const SiteImprove = (props) => {
     const consented = (analytics && props.hasConstented !== false) ||
         (analytics === undefined && props.hasConstented);
     useEffect(() => {
-        if (consented) {
-            if (process.env.NODE_ENV !== 'production') {
-                console.info('Mock loading SiteImprove in development mode.', props.scriptUrl || props.accountId);
-                if (!window._sz) {
-                    setTimeout(() => {
-                        window._sz = window._sz || [];
-                    }, 300);
-                }
+        if (!consented) {
+            return;
+        }
+        if (process.env.NODE_ENV !== 'production') {
+            console.info('Mock loading SiteImprove in development mode.', props.scriptUrl || props.accountId);
+            if (!window._sz) {
+                setTimeout(() => {
+                    window._sz = window._sz || [];
+                }, 300);
             }
-            const routerEvents = Router.events;
-            routerEvents.on('routeChangeStart', captureRefUrl);
-            routerEvents.on('routeChangeComplete', sendRoutingEvent);
-            const stopLoggingOutboundLinks = logOutboundLinks();
-            return () => {
-                routerEvents.off('routeChangeStart', captureRefUrl);
-                routerEvents.off('routeChangeComplete', sendRoutingEvent);
-                stopLoggingOutboundLinks();
-            };
         }
+        const routerEvents = Router.events;
+        routerEvents.on('routeChangeStart', captureRefUrl);
+        routerEvents.on('routeChangeComplete', sendRoutingEvent);
+        const stopLoggingOutboundLinks = logOutboundLinks();
+        return () => {
+            routerEvents.off('routeChangeStart', captureRefUrl);
+            routerEvents.off('routeChangeComplete', sendRoutingEvent);
+            stopLoggingOutboundLinks();
+        };
     }, 
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [consented]);
@@ -119,30 +150,3 @@ export const SiteImprove = (props) => {
         : scriptUrlTemplate.replace(idToken, props.accountId);
     return (React.createElement(Script, { type: "text/javascript", strategy: "afterInteractive", src: scriptUrl, onLoad: props.onLoad, onError: props.onError }));
 };
-// ---------------------------------------------------------------------------
-/**
- * A small helper for tracking custom UI events and reporting them to SiteImrove.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
- */
-export const pingSiteImprove = (category, action, label) => {
-    if (process.env.NODE_ENV === 'development' &&
-        (!window._sz || window._sz._jit_defined_)) {
-        console.warn('`pingSiteImprove` was called before SiteImprove script was loaded.');
-    }
-    _emitEvent(['event', category, action, label]);
-};
-// ---------------------------------------------------------------------------
-/**
- * A small helper for reporting to SiteImrove when the user is programmatically
- * being sent to a different URL/resource.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
- */
-export const pingSiteImproveOutbound = (ourl) => {
-    if (process.env.NODE_ENV === 'development' &&
-        (!window._sz || window._sz._jit_defined_)) {
-        console.warn('`pingSiteImproveOutbound` was called before SiteImprove script was loaded.');
-    }
-    _emitEvent(['request', { ourl, ref: document.location.href }]);
-};

package/esm/next/http.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import React, { FunctionComponent } from 'react';
 import { Cleanup } from '@reykjavik/hanna-utils';
 import { ServerResponse } from 'http';
@@ -46,7 +46,7 @@ export declare const makeErrorizeAppHOC: <EP extends Partial<ErrorProps>>(ErrorP
 /**
  * Use this method to inside a `getServerSideProps` method (or API route)
  * to return an `HTTP_304_NotModified` response with an empty props object,
- * in a way that doesn't make TypeScript at you.
+ * in a way that doesn't make TypeScript shout at you.
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1#notmodified304-helper
  */

package/esm/next/http.js

@@ -1,14 +1,3 @@
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 import React from 'react';
 import { cacheControl, HTTP_304_NotModified } from '../http.js';
 /*
@@ -27,12 +16,15 @@ const showErrorPage = (response, error, ttl = '2s') => {
         typeof error === 'number'
             ? { statusCode: error }
             : error;
-    const { statusCode, message } = error, otherProps = __rest(error, ["statusCode", "message"]);
+    const { statusCode, message, ...otherProps } = error;
     response = 'res' in response ? response.res : response;
     response.statusCode = error.statusCode;
     cacheControl(response, ttl);
     return {
-        props: Object.assign(Object.assign({}, otherProps), { __error: { statusCode, message } }),
+        props: {
+            ...otherProps,
+            __error: { statusCode, message },
+        },
     };
 };
 // ===========================================================================
@@ -49,13 +41,16 @@ export const makeErrorizeAppHOC = (ErrorPage) => {
         const ErrorizedApp = (appProps) => {
             const { pageProps } = appProps;
             if (pageProps.__error) {
-                const { __error } = pageProps, otherProps = __rest(pageProps, ["__error"]);
-                return (React.createElement(App, Object.assign({}, appProps, { Component: ErrorPage, pageProps: Object.assign(Object.assign({}, otherProps), __error) })));
+                const { __error, ...otherProps } = pageProps;
+                return (React.createElement(App, { ...appProps, Component: ErrorPage, pageProps: {
+                        ...otherProps,
+                        ...__error,
+                    } }));
             }
-            return React.createElement(App, Object.assign({}, appProps));
+            return React.createElement(App, { ...appProps });
         };
         ErrorizedApp.getInitialProps = App.getInitialProps;
-        ErrorizedApp.displayName = 'Errorized' + (App.displayName || App.name || 'App');
+        ErrorizedApp.displayName = `Errorized${App.displayName || App.name || 'App'}`;
         return ErrorizedApp;
     };
     withErrorHandling.showErrorPage = showErrorPage;
@@ -65,7 +60,7 @@ export const makeErrorizeAppHOC = (ErrorPage) => {
 /**
  * Use this method to inside a `getServerSideProps` method (or API route)
  * to return an `HTTP_304_NotModified` response with an empty props object,
- * in a way that doesn't make TypeScript at you.
+ * in a way that doesn't make TypeScript shout at you.
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1#notmodified304-helper
  */

package/http.d.ts

@@ -3,6 +3,10 @@ import { ServerResponse } from 'http';
 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. */
 export declare const HTTP_101_SwitchingProtocols = 101;
+/** (WebDAV) The server has received and is processing the request, but no response is available yet. */
+export declare const HTTP_102_Processing = 102;
+/** This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources. */
+export declare const HTTP_103_EarlyHints = 103;
 /** The request succeeded, and the response body contains the requested resource. */
 export declare const HTTP_200_OK = 200;
 /** The request succeeded, and a new resource was created as a result. This is typically the response sent after POST or PUT requests. */
@@ -12,8 +16,16 @@ export declare const HTTP_202_Accepted = 202;
 export declare const HTTP_203_NonAuthoritativeInformation = 203;
 /** The response body is empty. */
 export declare const HTTP_204_NoContent = 204;
+/** Tells the user agent to reset the document which sent this request. */
+export declare const HTTP_205_ResetContent = 205;
 /** The request succeeded, but the returned metadata is not necessarily complete. */
 export declare const HTTP_206_PartialContent = 206;
+/** (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate. */
+export declare const HTTP_207_MultiStatus = 207;
+/** (WebDAV) Used inside a `<dav:propstat>` response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. */
+export declare const HTTP_208_AlreadyReported = 208;
+/** (HTTP Delta Encoding) The server has fulfilled a `GET` request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */
+export declare const HTTP_226_IMUsed = 226;
 /**
  * Only safe to use in response to GET and HEAD requests
  *
@@ -70,6 +82,12 @@ export declare const HTTP_417_ExpectationFailed = 417;
 export declare const HTTP_418_ImATeapot = 418;
 /** The request was directed at a server that is not able to produce a response. */
 export declare const HTTP_421_MisdirectedRequest = 421;
+/** (WebDAV) The request was well-formed but was unable to be followed due to semantic errors. */
+export declare const HTTP_422_UnprocessableContent = 422;
+/** (WebDAV) The resource that is being accessed is locked. */
+export declare const HTTP_423_Locked = 423;
+/** (WebDAV) The request failed due to failure of a previous request. */
+export declare const HTTP_424_FailedDependency = 424;
 /** The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */
 export declare const HTTP_426_UpgradeRequired = 426;
 /** The origin server requires the request to be conditional. */
@@ -94,6 +112,10 @@ export declare const HTTP_504_GatewayTimeout = 504;
 export declare const HTTP_505_HTTPVersionNotSupported = 505;
 /** The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself. */
 export declare const HTTP_506_VariantAlsoNegotiates = 506;
+/** (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
+export declare const HTTP_507_InsufficientStorage = 507;
+/** (WebDAV) The server detected an infinite loop while processing the request. */
+export declare const HTTP_508_LoopDetected = 508;
 /** Further extensions to the request are required for the server to fulfill it. */
 export declare const HTTP_510_NotExtended = 510;
 /** The client needs to authenticate to gain network access. */
@@ -108,11 +130,11 @@ export type HTTP_CLIENT_ERROR = HTTP_NOT_FOUND | HTTP_BANNED;
 export type HTTP_SERVER_ERROR = typeof HTTP_500_InternalServerError;
 export type HTTP_ERROR = HTTP_CLIENT_ERROR | HTTP_SERVER_ERROR;
 export type HTTP_STATUS = HTTP_INFO_ALL | HTTP_SUCCESS_ALL | HTTP_REDIRECTION_ALL | HTTP_CLIENT_ERROR_ALL | HTTP_SERVER_ERROR_ALL;
-export type HTTP_INFO_ALL = HTTP_INFO;
-export type HTTP_SUCCESS_ALL = HTTP_SUCCESS | typeof HTTP_203_NonAuthoritativeInformation | typeof HTTP_204_NoContent | typeof HTTP_206_PartialContent;
+export type HTTP_INFO_ALL = HTTP_INFO | typeof HTTP_102_Processing | typeof HTTP_103_EarlyHints;
+export type HTTP_SUCCESS_ALL = HTTP_SUCCESS | typeof HTTP_203_NonAuthoritativeInformation | typeof HTTP_204_NoContent | typeof HTTP_205_ResetContent | typeof HTTP_206_PartialContent | typeof HTTP_207_MultiStatus | typeof HTTP_208_AlreadyReported | typeof HTTP_226_IMUsed;
 export type HTTP_REDIRECTION_ALL = HTTP_REDIRECTION;
-export type HTTP_CLIENT_ERROR_ALL = HTTP_CLIENT_ERROR | typeof HTTP_405_MethodNotAllowed | typeof HTTP_406_NotAcceptable | typeof HTTP_407_ProxyAuthenticationRequired | typeof HTTP_408_RequestTimeout | typeof HTTP_409_Conflict | typeof HTTP_411_LengthRequired | typeof HTTP_412_PreconditionFailed | typeof HTTP_413_PayloadTooLarge | typeof HTTP_414_URITooLong | typeof HTTP_415_UnsupportedMediaType | typeof HTTP_416_RangeNotSatisfiable | typeof HTTP_417_ExpectationFailed | typeof HTTP_418_ImATeapot | typeof HTTP_421_MisdirectedRequest | typeof HTTP_426_UpgradeRequired | typeof HTTP_428_PreconditionRequired;
-export type HTTP_SERVER_ERROR_ALL = HTTP_SERVER_ERROR | typeof HTTP_501_NotImplemented | typeof HTTP_502_BadGateway | typeof HTTP_503_ServiceUnavailable | typeof HTTP_504_GatewayTimeout | typeof HTTP_505_HTTPVersionNotSupported | typeof HTTP_506_VariantAlsoNegotiates | typeof HTTP_510_NotExtended | typeof HTTP_511_NetworkAuthenticationRequired;
+export type HTTP_CLIENT_ERROR_ALL = HTTP_CLIENT_ERROR | typeof HTTP_405_MethodNotAllowed | typeof HTTP_406_NotAcceptable | typeof HTTP_407_ProxyAuthenticationRequired | typeof HTTP_408_RequestTimeout | typeof HTTP_409_Conflict | typeof HTTP_411_LengthRequired | typeof HTTP_412_PreconditionFailed | typeof HTTP_413_PayloadTooLarge | typeof HTTP_414_URITooLong | typeof HTTP_415_UnsupportedMediaType | typeof HTTP_416_RangeNotSatisfiable | typeof HTTP_417_ExpectationFailed | typeof HTTP_418_ImATeapot | typeof HTTP_421_MisdirectedRequest | typeof HTTP_422_UnprocessableContent | typeof HTTP_423_Locked | typeof HTTP_424_FailedDependency | typeof HTTP_426_UpgradeRequired | typeof HTTP_428_PreconditionRequired | typeof HTTP_429_TooManyRequests | typeof HTTP_431_RequestHeaderFieldsTooLarge | typeof HTTP_451_UnavailableForLegalReasons;
+export type HTTP_SERVER_ERROR_ALL = HTTP_SERVER_ERROR | typeof HTTP_501_NotImplemented | typeof HTTP_502_BadGateway | typeof HTTP_503_ServiceUnavailable | typeof HTTP_504_GatewayTimeout | typeof HTTP_505_HTTPVersionNotSupported | typeof HTTP_506_VariantAlsoNegotiates | typeof HTTP_507_InsufficientStorage | typeof HTTP_508_LoopDetected | typeof HTTP_510_NotExtended | typeof HTTP_511_NetworkAuthenticationRequired;
 export type HTTP_ERROR_ALL = HTTP_CLIENT_ERROR_ALL | HTTP_SERVER_ERROR_ALL;
 type TimeUnit = 's' | 'm' | 'h' | 'd' | 'w';
 export type TTL = number | `${number}${TimeUnit}`;

package/http.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cacheControl = exports.toSec = exports.HTTP_511_NetworkAuthenticationRequired = exports.HTTP_510_NotExtended = exports.HTTP_506_VariantAlsoNegotiates = exports.HTTP_505_HTTPVersionNotSupported = exports.HTTP_504_GatewayTimeout = exports.HTTP_503_ServiceUnavailable = exports.HTTP_502_BadGateway = exports.HTTP_501_NotImplemented = exports.HTTP_500_InternalServerError = exports.HTTP_451_UnavailableForLegalReasons = exports.HTTP_431_RequestHeaderFieldsTooLarge = exports.HTTP_429_TooManyRequests = exports.HTTP_428_PreconditionRequired = exports.HTTP_426_UpgradeRequired = exports.HTTP_421_MisdirectedRequest = exports.HTTP_418_ImATeapot = exports.HTTP_417_ExpectationFailed = exports.HTTP_416_RangeNotSatisfiable = exports.HTTP_415_UnsupportedMediaType = exports.HTTP_414_URITooLong = exports.HTTP_413_PayloadTooLarge = exports.HTTP_412_PreconditionFailed = exports.HTTP_411_LengthRequired = exports.HTTP_410_Gone = exports.HTTP_409_Conflict = exports.HTTP_408_RequestTimeout = exports.HTTP_407_ProxyAuthenticationRequired = exports.HTTP_406_NotAcceptable = exports.HTTP_405_MethodNotAllowed = exports.HTTP_404_NotFound = exports.HTTP_403_Forbidden = exports.HTTP_401_Unauthorized = exports.HTTP_400_BadRequest = exports.HTTP_308_PermanentRedirect = exports.HTTP_307_TemporaryRedirect = exports.HTTP_304_NotModified = exports.HTTP_303_SeeOther = exports.HTTP_302_Found = exports.HTTP_301_MovedPermanently = exports.HTTP_206_PartialContent = exports.HTTP_204_NoContent = exports.HTTP_203_NonAuthoritativeInformation = exports.HTTP_202_Accepted = exports.HTTP_201_Created = exports.HTTP_200_OK = exports.HTTP_101_SwitchingProtocols = exports.HTTP_100_Continue = void 0;
+exports.HTTP_502_BadGateway = exports.HTTP_501_NotImplemented = exports.HTTP_500_InternalServerError = exports.HTTP_451_UnavailableForLegalReasons = exports.HTTP_431_RequestHeaderFieldsTooLarge = exports.HTTP_429_TooManyRequests = exports.HTTP_428_PreconditionRequired = exports.HTTP_426_UpgradeRequired = exports.HTTP_424_FailedDependency = exports.HTTP_423_Locked = exports.HTTP_422_UnprocessableContent = exports.HTTP_421_MisdirectedRequest = exports.HTTP_418_ImATeapot = exports.HTTP_417_ExpectationFailed = exports.HTTP_416_RangeNotSatisfiable = exports.HTTP_415_UnsupportedMediaType = exports.HTTP_414_URITooLong = exports.HTTP_413_PayloadTooLarge = exports.HTTP_412_PreconditionFailed = exports.HTTP_411_LengthRequired = exports.HTTP_410_Gone = exports.HTTP_409_Conflict = exports.HTTP_408_RequestTimeout = exports.HTTP_407_ProxyAuthenticationRequired = exports.HTTP_406_NotAcceptable = exports.HTTP_405_MethodNotAllowed = exports.HTTP_404_NotFound = exports.HTTP_403_Forbidden = exports.HTTP_401_Unauthorized = exports.HTTP_400_BadRequest = exports.HTTP_308_PermanentRedirect = exports.HTTP_307_TemporaryRedirect = exports.HTTP_304_NotModified = exports.HTTP_303_SeeOther = exports.HTTP_302_Found = exports.HTTP_301_MovedPermanently = exports.HTTP_226_IMUsed = exports.HTTP_208_AlreadyReported = exports.HTTP_207_MultiStatus = exports.HTTP_206_PartialContent = exports.HTTP_205_ResetContent = exports.HTTP_204_NoContent = exports.HTTP_203_NonAuthoritativeInformation = exports.HTTP_202_Accepted = exports.HTTP_201_Created = exports.HTTP_200_OK = exports.HTTP_103_EarlyHints = exports.HTTP_102_Processing = exports.HTTP_101_SwitchingProtocols = exports.HTTP_100_Continue = void 0;
+exports.cacheControl = exports.toSec = exports.HTTP_511_NetworkAuthenticationRequired = exports.HTTP_510_NotExtended = exports.HTTP_508_LoopDetected = exports.HTTP_507_InsufficientStorage = exports.HTTP_506_VariantAlsoNegotiates = exports.HTTP_505_HTTPVersionNotSupported = exports.HTTP_504_GatewayTimeout = exports.HTTP_503_ServiceUnavailable = void 0;
 // INFORMATION
 /** The client should continue the request or ignore the response if the request is already finished. */
 exports.HTTP_100_Continue = 100;
 /** Response to an Upgrade request header from the client and indicates the protocol the server is switching to. */
 exports.HTTP_101_SwitchingProtocols = 101;
+/** (WebDAV) The server has received and is processing the request, but no response is available yet. */
+exports.HTTP_102_Processing = 102;
+/** This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources. */
+exports.HTTP_103_EarlyHints = 103;
 // SUCCESS
 /** The request succeeded, and the response body contains the requested resource. */
 exports.HTTP_200_OK = 200;
@@ -17,8 +22,16 @@ exports.HTTP_202_Accepted = 202;
 exports.HTTP_203_NonAuthoritativeInformation = 203;
 /** The response body is empty. */
 exports.HTTP_204_NoContent = 204;
+/** Tells the user agent to reset the document which sent this request. */
+exports.HTTP_205_ResetContent = 205;
 /** The request succeeded, but the returned metadata is not necessarily complete. */
 exports.HTTP_206_PartialContent = 206;
+/** (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate. */
+exports.HTTP_207_MultiStatus = 207;
+/** (WebDAV) Used inside a `<dav:propstat>` response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection. */
+exports.HTTP_208_AlreadyReported = 208;
+/** (HTTP Delta Encoding) The server has fulfilled a `GET` request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */
+exports.HTTP_226_IMUsed = 226;
 // REDIRECTION
 /**
  * Only safe to use in response to GET and HEAD requests
@@ -77,6 +90,12 @@ exports.HTTP_417_ExpectationFailed = 417;
 exports.HTTP_418_ImATeapot = 418;
 /** The request was directed at a server that is not able to produce a response. */
 exports.HTTP_421_MisdirectedRequest = 421;
+/** (WebDAV) The request was well-formed but was unable to be followed due to semantic errors. */
+exports.HTTP_422_UnprocessableContent = 422;
+/** (WebDAV) The resource that is being accessed is locked. */
+exports.HTTP_423_Locked = 423;
+/** (WebDAV) The request failed due to failure of a previous request. */
+exports.HTTP_424_FailedDependency = 424;
 /** The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */
 exports.HTTP_426_UpgradeRequired = 426;
 /** The origin server requires the request to be conditional. */
@@ -102,6 +121,10 @@ exports.HTTP_504_GatewayTimeout = 504;
 exports.HTTP_505_HTTPVersionNotSupported = 505;
 /** The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself. */
 exports.HTTP_506_VariantAlsoNegotiates = 506;
+/** (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
+exports.HTTP_507_InsufficientStorage = 507;
+/** (WebDAV) The server detected an infinite loop while processing the request. */
+exports.HTTP_508_LoopDetected = 508;
 /** Further extensions to the request are required for the server to fulfill it. */
 exports.HTTP_510_NotExtended = 510;
 /** The client needs to authenticate to gain network access. */

package/index.d.ts

@@ -1,6 +1,6 @@
-/// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./http.d.ts" />
-/// <reference path="./next/http.d.tsx" />
+/// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./next/SiteImprove.d.tsx" />
+/// <reference path="./next/http.d.tsx" />
 
 export {};

package/next/SiteImprove.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from 'react';
 import { EitherObj } from '@reykjavik/hanna-utils';
 declare global {
     interface Window {
@@ -43,6 +43,19 @@ type SiteImproveCustomEvent = [
     action: string,
     label?: string
 ];
+/**
+ * A small helper for tracking custom UI events and reporting them to SiteImrove.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
+ */
+export declare const pingSiteImprove: (category: string, action: string, label?: string) => void;
+/**
+ * A small helper for reporting to SiteImrove when the user is programmatically
+ * being sent to a different URL/resource.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
+ */
+export declare const pingSiteImproveOutbound: (ourl: string) => void;
 export type SiteImproveProps = EitherObj<{
     /**
      * Your SiteImprove account ID.
@@ -65,8 +78,8 @@ export type SiteImproveProps = EitherObj<{
      *
      * A value of `false` prevents the analytics script being loaded.
      *
-     * Any other value causes the component to defer to the `CookieHubProvider`
-     * component, and only applies if the cookiehub flag is undefined.
+     * A value of `true` still defers to the 'analytics' consent state provided
+     * by the `CookieHubProvider` component (if present).
      */
     hasConstented?: boolean;
     /**
@@ -84,18 +97,5 @@ export type SiteImproveProps = EitherObj<{
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1##siteimprove-component
  */
-export declare const SiteImprove: (props: SiteImproveProps) => JSX.Element | null;
-/**
- * A small helper for tracking custom UI events and reporting them to SiteImrove.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
- */
-export declare const pingSiteImprove: (category: string, action: string, label?: string) => void;
-/**
- * A small helper for reporting to SiteImrove when the user is programmatically
- * being sent to a different URL/resource.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
- */
-export declare const pingSiteImproveOutbound: (ourl: string) => void;
+export declare const SiteImprove: (props: SiteImproveProps) => React.JSX.Element | null;
 export {};

package/next/SiteImprove.js

@@ -26,11 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pingSiteImproveOutbound = exports.pingSiteImprove = exports.SiteImprove = void 0;
+exports.SiteImprove = exports.pingSiteImproveOutbound = exports.pingSiteImprove = void 0;
 const react_1 = __importStar(require("react"));
 const router_js_1 = require("next/router.js");
 const script_js_1 = __importDefault(require("next/script.js"));
 const CookieHubConsent_js_1 = require("../CookieHubConsent.js");
+// Fixes an issue with `next/script` types when `pkgJson.type === "module"`
+const Script = script_js_1.default;
 // END: Mock typing of SiteImprove's event tracking API
 // --------------------------------------------------------------------------
 //
@@ -48,6 +50,36 @@ const _emitEvent = typeof window === 'undefined'
             console.info('SiteImprove:', event);
         }
     };
+// ---------------------------------------------------------------------------
+/**
+ * A small helper for tracking custom UI events and reporting them to SiteImrove.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
+ */
+const pingSiteImprove = (category, action, label) => {
+    if (process.env.NODE_ENV === 'development' &&
+        (!window._sz || window._sz._jit_defined_)) {
+        console.warn('`pingSiteImprove` was called before SiteImprove script was loaded.');
+    }
+    _emitEvent(['event', category, action, label]);
+};
+exports.pingSiteImprove = pingSiteImprove;
+// ---------------------------------------------------------------------------
+/**
+ * A small helper for reporting to SiteImrove when the user is programmatically
+ * being sent to a different URL/resource.
+ *
+ * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
+ */
+const pingSiteImproveOutbound = (ourl) => {
+    if (process.env.NODE_ENV === 'development' &&
+        (!window._sz || window._sz._jit_defined_)) {
+        console.warn('`pingSiteImproveOutbound` was called before SiteImprove script was loaded.');
+    }
+    _emitEvent(['request', { ourl, ref: document.location.href }]);
+};
+exports.pingSiteImproveOutbound = pingSiteImproveOutbound;
+// ---------------------------------------------------------------------------
 /*
   SiteImprove's "trackdynamic" (page view) event requires both the new URL
   and the old (referer) URL.
@@ -118,25 +150,26 @@ const SiteImprove = (props) => {
     const consented = (analytics && props.hasConstented !== false) ||
         (analytics === undefined && props.hasConstented);
     (0, react_1.useEffect)(() => {
-        if (consented) {
-            if (process.env.NODE_ENV !== 'production') {
-                console.info('Mock loading SiteImprove in development mode.', props.scriptUrl || props.accountId);
-                if (!window._sz) {
-                    setTimeout(() => {
-                        window._sz = window._sz || [];
-                    }, 300);
-                }
+        if (!consented) {
+            return;
+        }
+        if (process.env.NODE_ENV !== 'production') {
+            console.info('Mock loading SiteImprove in development mode.', props.scriptUrl || props.accountId);
+            if (!window._sz) {
+                setTimeout(() => {
+                    window._sz = window._sz || [];
+                }, 300);
             }
-            const routerEvents = router_js_1.Router.events;
-            routerEvents.on('routeChangeStart', captureRefUrl);
-            routerEvents.on('routeChangeComplete', sendRoutingEvent);
-            const stopLoggingOutboundLinks = logOutboundLinks();
-            return () => {
-                routerEvents.off('routeChangeStart', captureRefUrl);
-                routerEvents.off('routeChangeComplete', sendRoutingEvent);
-                stopLoggingOutboundLinks();
-            };
         }
+        const routerEvents = router_js_1.Router.events;
+        routerEvents.on('routeChangeStart', captureRefUrl);
+        routerEvents.on('routeChangeComplete', sendRoutingEvent);
+        const stopLoggingOutboundLinks = logOutboundLinks();
+        return () => {
+            routerEvents.off('routeChangeStart', captureRefUrl);
+            routerEvents.off('routeChangeComplete', sendRoutingEvent);
+            stopLoggingOutboundLinks();
+        };
     }, 
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [consented]);
@@ -146,35 +179,6 @@ const SiteImprove = (props) => {
     const scriptUrl = props.scriptUrl != null
         ? props.scriptUrl
         : scriptUrlTemplate.replace(idToken, props.accountId);
-    return (react_1.default.createElement(script_js_1.default, { type: "text/javascript", strategy: "afterInteractive", src: scriptUrl, onLoad: props.onLoad, onError: props.onError }));
+    return (react_1.default.createElement(Script, { type: "text/javascript", strategy: "afterInteractive", src: scriptUrl, onLoad: props.onLoad, onError: props.onError }));
 };
 exports.SiteImprove = SiteImprove;
-// ---------------------------------------------------------------------------
-/**
- * A small helper for tracking custom UI events and reporting them to SiteImrove.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimprove-helper
- */
-const pingSiteImprove = (category, action, label) => {
-    if (process.env.NODE_ENV === 'development' &&
-        (!window._sz || window._sz._jit_defined_)) {
-        console.warn('`pingSiteImprove` was called before SiteImprove script was loaded.');
-    }
-    _emitEvent(['event', category, action, label]);
-};
-exports.pingSiteImprove = pingSiteImprove;
-// ---------------------------------------------------------------------------
-/**
- * A small helper for reporting to SiteImrove when the user is programmatically
- * being sent to a different URL/resource.
- *
- * @see https://github.com/reykjavikcity/webtools/tree/v0.1##pingsiteimproveoutbound-helper
- */
-const pingSiteImproveOutbound = (ourl) => {
-    if (process.env.NODE_ENV === 'development' &&
-        (!window._sz || window._sz._jit_defined_)) {
-        console.warn('`pingSiteImproveOutbound` was called before SiteImprove script was loaded.');
-    }
-    _emitEvent(['request', { ourl, ref: document.location.href }]);
-};
-exports.pingSiteImproveOutbound = pingSiteImproveOutbound;

package/next/http.d.ts

@@ -46,7 +46,7 @@ export declare const makeErrorizeAppHOC: <EP extends Partial<ErrorProps>>(ErrorP
 /**
  * Use this method to inside a `getServerSideProps` method (or API route)
  * to return an `HTTP_304_NotModified` response with an empty props object,
- * in a way that doesn't make TypeScript at you.
+ * in a way that doesn't make TypeScript shout at you.
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1#notmodified304-helper
  */

package/next/http.js

@@ -13,17 +13,6 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -47,12 +36,15 @@ const showErrorPage = (response, error, ttl = '2s') => {
         typeof error === 'number'
             ? { statusCode: error }
             : error;
-    const { statusCode, message } = error, otherProps = __rest(error, ["statusCode", "message"]);
+    const { statusCode, message, ...otherProps } = error;
     response = 'res' in response ? response.res : response;
     response.statusCode = error.statusCode;
     (0, http_js_1.cacheControl)(response, ttl);
     return {
-        props: Object.assign(Object.assign({}, otherProps), { __error: { statusCode, message } }),
+        props: {
+            ...otherProps,
+            __error: { statusCode, message },
+        },
     };
 };
 // ===========================================================================
@@ -69,13 +61,16 @@ const makeErrorizeAppHOC = (ErrorPage) => {
         const ErrorizedApp = (appProps) => {
             const { pageProps } = appProps;
             if (pageProps.__error) {
-                const { __error } = pageProps, otherProps = __rest(pageProps, ["__error"]);
-                return (react_1.default.createElement(App, Object.assign({}, appProps, { Component: ErrorPage, pageProps: Object.assign(Object.assign({}, otherProps), __error) })));
+                const { __error, ...otherProps } = pageProps;
+                return (react_1.default.createElement(App, { ...appProps, Component: ErrorPage, pageProps: {
+                        ...otherProps,
+                        ...__error,
+                    } }));
             }
-            return react_1.default.createElement(App, Object.assign({}, appProps));
+            return react_1.default.createElement(App, { ...appProps });
         };
         ErrorizedApp.getInitialProps = App.getInitialProps;
-        ErrorizedApp.displayName = 'Errorized' + (App.displayName || App.name || 'App');
+        ErrorizedApp.displayName = `Errorized${App.displayName || App.name || 'App'}`;
         return ErrorizedApp;
     };
     withErrorHandling.showErrorPage = showErrorPage;
@@ -86,7 +81,7 @@ exports.makeErrorizeAppHOC = makeErrorizeAppHOC;
 /**
  * Use this method to inside a `getServerSideProps` method (or API route)
  * to return an `HTTP_304_NotModified` response with an empty props object,
- * in a way that doesn't make TypeScript at you.
+ * in a way that doesn't make TypeScript shout at you.
  *
  * @see https://github.com/reykjavikcity/webtools/tree/v0.1#notmodified304-helper
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.1.9",
+	"version": "0.1.10",
 	"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",
@@ -23,25 +23,25 @@
 	},
 	"sideEffects": false,
 	"exports": {
-		"./CookieHubConsent": {
-			"import": "./esm/CookieHubConsent.js",
-			"require": "./CookieHubConsent.js"
+		".": {
+			"import": "./esm/index.js",
+			"require": "./index.js"
 		},
 		"./http": {
 			"import": "./esm/http.js",
 			"require": "./http.js"
 		},
-		".": {
-			"import": "./esm/index.js",
-			"require": "./index.js"
-		},
-		"./next/http": {
-			"import": "./esm/next/http.js",
-			"require": "./next/http.js"
+		"./CookieHubConsent": {
+			"import": "./esm/CookieHubConsent.js",
+			"require": "./CookieHubConsent.js"
 		},
 		"./next/SiteImprove": {
 			"import": "./esm/next/SiteImprove.js",
 			"require": "./next/SiteImprove.js"
+		},
+		"./next/http": {
+			"import": "./esm/next/http.js",
+			"require": "./next/http.js"
 		}
 	}
 }