@reykjavik/webtools 0.3.5 → 0.3.7

package/esm/async.js

@@ -1,3 +1,4 @@
+import { toSec as _toSec } from './http.js';
 /**
  * Simple sleep function. Returns a promise that resolves after `length`
  * milliseconds.
@@ -174,3 +175,59 @@ skipFirst) => {
 throttle.d = (delay, skipFirst) => throttle(function (fn, ...args) {
     fn.apply(this, args);
 }, delay, skipFirst);
+// ---------------------------------------------------------------------------
+// Wrap toSec to use a 90% shorter TTL in development mode
+const toSec = process.env.NODE_ENV === 'production' ? _toSec : (val) => _toSec(val) / 10;
+const DEFAULT_THROTTLING_MS = '30s';
+/**
+ * Wraps an async function with a simple, but fairly robust caching layer.
+ *
+ * Successful results are cached for `ttlMs`, while error results are
+ * throttled to avoid hammering the underlying function.
+ *
+ * Has no max size or eviction strategy; intended for caching a small,
+ * clearly bounded number of different cache "keys" (e.g. per language).
+ *
+ * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#cachifyasync
+ */
+/*#__NO_SIDE_EFFECTS__*/
+export const cachifyAsync = (opts) => {
+    const { fn, getKey = (...args) => JSON.stringify(args), customTtl, returnStale } = opts;
+    // Set up the cache object
+    const TTL_SEC = toSec(opts.ttl);
+    const THROTTLING_SEC = toSec(opts.throttle || 0) || Math.min(toSec(DEFAULT_THROTTLING_MS), TTL_SEC);
+    const _cache = new Map();
+    return (async (...args) => {
+        const now = Date.now();
+        const key = getKey(...args);
+        const cached = _cache.get(key);
+        if (cached && now < cached.freshUntil) {
+            return cached.data;
+        }
+        const lastData = returnStale !== false && (cached === null || cached === void 0 ? void 0 : cached.data);
+        const entry = {
+            // Set an initial "fresh until" that's longer than TTL_SEC to cover
+            // (somewhat) safely the time it takes for the promise to resolve,
+            // so that we don't trigger multiple calls to `fn` in parallel
+            // TODO: Build in a proper AbortSignal timeout, etc. to handle this more robustly
+            freshUntil: now + (TTL_SEC + 60) * 1000,
+            data: fn(...args).then((result) => {
+                const customTtlSec = toSec((customTtl === null || customTtl === void 0 ? void 0 : customTtl(args, result)) || 0);
+                entry.freshUntil = now + (customTtlSec || TTL_SEC) * 1000;
+                if (result.error) {
+                    if (!customTtlSec) {
+                        // Set shorter TTL on errors to allow quicker retries
+                        entry.freshUntil = now + THROTTLING_SEC * 1000;
+                    }
+                    if (lastData) {
+                        // Return last known good data if available, even if it's a bit stale
+                        return lastData;
+                    }
+                }
+                return result;
+            }),
+        };
+        _cache.set(key, entry);
+        return entry.data;
+    });
+};

package/esm/errorhandling.d.ts

@@ -119,7 +119,7 @@ export declare namespace Result {
      * Extracts the error type `E` from a `Result.Tuple<T, E>`-like
      * type, a `Promise` of such type, or a function returning either of those.
      *
-     * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#type-resultpayloadof
+     * @see https://github.com/reykjavikcity/webtools/blob/v0.3/README.md#type-resulterrorof
      */
     type ErrorOf<T extends ResultTuple<unknown> | Promise<ResultTuple<unknown>> | ((...args: Array<any>) => ResultTuple<unknown> | Promise<ResultTuple<unknown>>)> = T extends [infer E, undefined?] ? E : T extends Promise<infer P> ? P extends [infer E, undefined?] ? E : never : T extends (...args: Array<any>) => infer R ? R extends [infer E, undefined?] ? E : R extends Promise<infer P> ? P extends [infer E, undefined?] ? E : never : never : never;
 }

package/esm/index.d.ts

@@ -5,9 +5,11 @@
 /// <reference path="./fixIcelandicLocale.d.ts" />
 /// <reference path="./errorhandling.d.ts" />
 /// <reference path="./react-router/http.d.ts" />
+/// <reference path="./alertsStore/index.d.ts" />
 /// <reference path="./SiteImprove.d.tsx" />
 /// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./react-router/Wait.d.tsx" />
+/// <reference path="./alertsStore/react.d.tsx" />
 /// <reference path="./next/http.d.tsx" />
 
 export {};

package/index.d.ts

@@ -5,9 +5,11 @@
 /// <reference path="./fixIcelandicLocale.d.ts" />
 /// <reference path="./errorhandling.d.ts" />
 /// <reference path="./react-router/http.d.ts" />
+/// <reference path="./alertsStore/index.d.ts" />
 /// <reference path="./SiteImprove.d.tsx" />
 /// <reference path="./CookieHubConsent.d.tsx" />
 /// <reference path="./react-router/Wait.d.tsx" />
+/// <reference path="./alertsStore/react.d.tsx" />
 /// <reference path="./next/http.d.tsx" />
 
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.3.5",
+	"version": "0.3.7",
 	"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",
@@ -11,7 +11,8 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@reykjavik/hanna-utils": "^0.2.20"
+		"@reykjavik/hanna-utils": "^0.2.22",
+		"valibot": "^1.2.0"
 	},
 	"peerDependencies": {
 		"@vanilla-extract/css": "^1.14.1",
@@ -76,6 +77,10 @@
 			"import": "./esm/react-router/http.js",
 			"require": "./react-router/http.js"
 		},
+		"./alertsStore": {
+			"import": "./esm/alertsStore/index.js",
+			"require": "./alertsStore/index.js"
+		},
 		"./SiteImprove": {
 			"import": "./esm/SiteImprove.js",
 			"require": "./SiteImprove.js"
@@ -88,6 +93,10 @@
 			"import": "./esm/react-router/Wait.js",
 			"require": "./react-router/Wait.js"
 		},
+		"./alertsStore/react": {
+			"import": "./esm/alertsStore/react.js",
+			"require": "./alertsStore/react.js"
+		},
 		"./next/http": {
 			"import": "./esm/next/http.js",
 			"require": "./next/http.js"